Document serverless run, status, and health CLI commands - #770
Open
promptless[bot] wants to merge 2 commits into
Open
Document serverless run, status, and health CLI commands#770promptless[bot] wants to merge 2 commits into
promptless[bot] wants to merge 2 commits into
Conversation
Add reference sections for the new runpodctl serverless invoke-time subcommands (run, status, health) introduced in runpod/runpodctl#316 (CON-688), including input/payload rules, wait behavior, exit codes, and the timeout/job_failed error semantics.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Documents three new invoke-time Serverless subcommands added to
runpodctlin runpod/runpodctl#316 (CON-688), on therunpodctl serverlessCLI reference page. The reference previously covered only the endpoint-management verbs (list,get,create,update,delete), so these were undocumented.run— submit a job (via--input,--input-file, or stdin), wait for a terminal status, and print the response. Covers the JSON-object payload rule, the local 10 MiB request-body limit, automaticinputnesting,--wait/--no-waitbehavior (and that they are mutually exclusive), the stdout/stderr split, and exit codes with the newtimeoutandjob_failederror semantics.status— check or poll a previously submitted job by endpoint and job ID; the follow-up torun --no-waitor an expired wait.health— print an endpoint's health response, with the caveat that it can answer for a recently deleted endpoint (invoke-side caching), so it is not a reliable existence check.Notes
c094cac86526a446cb4358bcb100e5098f85885f), including the two validations added after the initial draft: the local 10 MiB/runbody-size limit (measured on the compacted{"input": ...}request body) and the--no-wait/--waitmutual-exclusivity check, both rejected locally as usage errors before any request.runpodctl/reference/runpodctl-serverless.mdx. The page is already in navigation; no config change needed.Generated by Promptless.