[Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methods
#5 Updated by Peter Amstutz over 3 years ago
Reviewing 9835-container-api-doc @ 769189c406bb42761f4d7bfe35fd2cc36edcef00
Instead of linking to the wiki, please copy the "mount types" table into the API documentation.
Instead of linking to the wiki, please copy the "container states" table into the API documentation.
Please add a table listing fields for
Reword "Captures information about the environment in which a Crunch2 process was run" to "Precisely describes the environment in which a Crunch2 process should run".
Reword "Clients can read Container records, but only the system can create or modify them." -> "Container records are created by the system to fulfill container requests."
Reword "Portable data hash of the log collection." -> "Portable data hash of the collection containing logs from a completed container run."
Instead of notes like "Must be equal to a ContainerRequest’s environment in order to satisfy the ContainerRequest." we should add a section to ContainerRequest that describes the criteria for fulfilling a container request (we might not be able to write that until Lucas finishes the branch, though).
Need a note that setting the priority of a committed container request to 0 may cancel a running container.
Inconsistent labeling of which fields are required, should list required/optional for all fields (or note that all fields are required or optional unless otherwise noted.)
"Set by the system to the uuid of a container corresponding to the user’s token, if one exists." -> "The uuid of the parent container that created this container request, if any. Represents a process tree."
"When the referenced container ends, the container request is automatically completed." -> "The priority of this container request is inherited from the parent container, if the parent container is cancelled, this container request will be cancelled as well."
#7 Updated by Peter Amstutz over 3 years ago
Mount types table:
The "Discussion" column is unused and should be removed.
The "Description" column is cramped and rendering as a thin column of text that is very hard to read. Suggest merging text from "Expected keys" and "Description" into a single column.
The description for the "API" flag under "runtime_constraints" is wrong. The "API" flag description should say "When set, ARVADOS_API_HOST and ARVADOS_API_TOKEN will be set, and container will have networking enabled for access the Arvados API server."
The "Runtime constraints" has the note "Required when in “Committed” state." but Containers don't have a "Committed" state, only requests do.