docs: explain schedule state values #24160
Conversation
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
| @@ -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! |
Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com>
* 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 <aimee.ukasick@hashicorp.com>
|
I'm going to lock this pull request because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active contributions. |
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