[ARVADOS] updated: 1.3.0-2057-g7865cc21d
Git user
git at public.arvados.org
Mon Jan 13 22:09:03 UTC 2020
Summary of changes:
doc/api/dispatch.html.textile.liquid | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
via 7865cc21ddf12ac264bcc6f8f0b31f075faf6eb5 (commit)
via a36cdcee0e155d3cd057e5c9835cc36d9f6b0452 (commit)
from 21b4ab9d1db2cddeb77908c6fe575be041d9ff6c (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 7865cc21ddf12ac264bcc6f8f0b31f075faf6eb5
Author: Tom Clegg <tom at tomclegg.ca>
Date: Mon Jan 13 17:08:40 2020 -0500
15823: Use "instance" more consistently, note other terms.
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom at tomclegg.ca>
diff --git a/doc/api/dispatch.html.textile.liquid b/doc/api/dispatch.html.textile.liquid
index 9bbe2ed62..8ca8b0df4 100644
--- a/doc/api/dispatch.html.textile.liquid
+++ b/doc/api/dispatch.html.textile.liquid
@@ -21,6 +21,8 @@ Example:
These APIs are not available via @arv@ CLI tool.
+Note: the term "instance" here refers to a virtual machine provided by a cloud computing service. The alternate terms "cloud VM" and "worker node" are sometimes used as well in config files and log messages.
+
h3. List containers
@GET /arvados/v1/dispatch/containers@
@@ -64,13 +66,13 @@ h3. Terminate a container
@POST /arvados/v1/dispatch/containers/kill?container_uuid={uuid}&reason={string}@
-Make a single attempt to terminate the indicated container on the relevant cloud VM. (The caller can implement a delay-and-retry loop if needed.)
+Make a single attempt to terminate the indicated container on the relevant instance. (The caller can implement a delay-and-retry loop if needed.)
A container terminated this way will end with state @Cancelled@ if its docker container had already started, or @Queued@ if it was terminated while setting up the runtime environment.
The provided @reason@ string will appear in the dispatcher's log, but not in the user-visible container log.
-If the provided @container_uuid@ is not scheduled/running on a worker node, the response status will be 404.
+If the provided @container_uuid@ is not scheduled/running on an instance, the response status will be 404.
h3. List instances
commit a36cdcee0e155d3cd057e5c9835cc36d9f6b0452
Author: Tom Clegg <tom at tomclegg.ca>
Date: Mon Jan 13 17:08:16 2020 -0500
15823: Mention instance_type section.
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom at tomclegg.ca>
diff --git a/doc/api/dispatch.html.textile.liquid b/doc/api/dispatch.html.textile.liquid
index 1ca1279ee..9bbe2ed62 100644
--- a/doc/api/dispatch.html.textile.liquid
+++ b/doc/api/dispatch.html.textile.liquid
@@ -27,7 +27,9 @@ h3. List containers
Return a list of containers that are either ready to dispatch, or being started/monitored by the dispatcher.
-The response provides @uuid@, @priority@, and @state@ fields for each container. Other fields of the container records are not loaded by the dispatcher, and will have empty/zero values here (e.g., @{...,"created_at":"0001-01-01T00:00:00Z","command":[],...}@).
+Each entry in the returned list of @items@ includes:
+* an @instance_type@ entry with the name and attributes of the instance type that will be used to schedule the container (chosen from the @InstanceTypes@ section of your cluster config file); and
+* a @container@ entry with selected attributes of the container itself, including @uuid@, @priority@, @runtime_constraints@, and @state at . Other fields of the container records are not loaded by the dispatcher, and will have empty/zero values here (e.g., @{...,"created_at":"0001-01-01T00:00:00Z","command":[],...}@).
Example response:
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list