docs: explain schedule state values #24160
Merged
Conversation
This file contains 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
GET /v1/client/allocation/:alloc_id/pause?task=:task_name is a tiny but critical API for observability of tasks with a schedule. This PR explains each of the values which might be returned.
schmichael
added
theme/website
gulducat
reviewed
Oct 16, 2024
| @@ -1039,5 +1039,22 @@ $ nomad operator api /v1/client/allocation/23f520cc-629a-46ff-395f-0661e7aa939e/ | |||
| } | |||
| ``` | |||
|
|
|||
| #### Field Reference | |||
There was a problem hiding this comment.
commenting here, though it mostly applies elsewhere.
this is the ScheduleState for reads, but for writes, there is a different ScheduleState. its values are listed over in the CLI doc: https://github.com/hashicorp/nomad/blob/v1.9.0/website/content/docs/commands/alloc/pause.mdx#pause-options (http server code here)
- do we want a reference section like this up under override on this page, with values that match
-statein the CLI doc? - do we want the CLI doc to include more detail under
-statusto align with what's being added here? - maybe the CLI help output, too? https://github.com/hashicorp/nomad/blob/v1.9.0/command/alloc_pause.go#L36-L44
There was a problem hiding this comment.
I updated the POST/PUT API docs which I think is good for now.
|
@schmichael Thanks for this update! I'll review after you've addressed Daniel's feedback. |
|
Docs fixed, preview link updated, thanks for the thorough review! |
aimeeu
approved these changes
Oct 17, 2024
Co-authored-by: Aimee Ukasick <[email protected]>
Juanadelacuesta
pushed a commit
that referenced
this pull request
Nov 4, 2024
* docs: explain schedule state values GET /v1/client/allocation/:alloc_id/pause?task=:task_name is a tiny but critical API for observability of tasks with a schedule. This PR explains each of the values which might be returned. * correct docstring * add missing state and expand PUT docs --------- Co-authored-by: Aimee Ukasick <[email protected]>
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.
GET /v1/client/allocation/:alloc_id/pause?task=:task_name is a tiny but critical API for observability of tasks with a schedule. This PR explains each of the values which might be returned.
Preview: https://nomad-csj1dlx3r-hashicorp.vercel.app/nomad/api-docs/allocations#override-pause-schedule-state
Internal: NET-11261