[ARVADOS] updated: 520b07e1add8fcbe9eb0e0bb22eed42c1c2c5b5e
Git user
git at public.curoverse.com
Thu Sep 22 12:14:47 EDT 2016
Summary of changes:
doc/api/methods/container_requests.html.textile.liquid | 1 +
doc/api/schema/ContainerRequest.html.textile.liquid | 6 ++++++
2 files changed, 7 insertions(+)
via 520b07e1add8fcbe9eb0e0bb22eed42c1c2c5b5e (commit)
from 5e81b09c9023711cd193569a1ec877c9d7bb8953 (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 520b07e1add8fcbe9eb0e0bb22eed42c1c2c5b5e
Author: radhika <radhika at curoverse.com>
Date: Thu Sep 22 12:14:19 2016 -0400
10036: Update ContainerRequest API documentation about canceling a conatiner_request.
diff --git a/doc/api/methods/container_requests.html.textile.liquid b/doc/api/methods/container_requests.html.textile.liquid
index 88a53a2..2603079 100644
--- a/doc/api/methods/container_requests.html.textile.liquid
+++ b/doc/api/methods/container_requests.html.textile.liquid
@@ -71,4 +71,5 @@ table(table table-bordered table-condensed).
{% include 'notebox_begin' %}
Setting the priority of a committed container_request to 0 may cancel a running container assigned for it.
+See "Canceling a ContainerRequest":{{site.baseurl}}/api/schema/ContainerRequest.html#cancel_container for further details.
{% include 'notebox_end' %}
diff --git a/doc/api/schema/ContainerRequest.html.textile.liquid b/doc/api/schema/ContainerRequest.html.textile.liquid
index 8abb5b3..48c624a 100644
--- a/doc/api/schema/ContainerRequest.html.textile.liquid
+++ b/doc/api/schema/ContainerRequest.html.textile.liquid
@@ -62,3 +62,9 @@ The system will use the following scheme to determine which Container to conside
{% include 'notebox_begin' %}
Currently, container reuse is the default behavior and a mechanism to skip reuse is not supported.
{% include 'notebox_end' %}
+
+h2(#cancel_container). Canceling a ContainerRequest
+
+A ContainerRequest may be canceled by setting it's priority to 0, using an update call.
+
+When a ContainerRequest is canceled, it will still reflect the state of the Container it is associated with via the container_uuid attribute. If that Container is being reused by any other container_requests that are still active, i.e., not yet canceled, that Container may continue to run or be scheduled to run by the system in future. However, if no other container_requests are using that Contianer, then the Container will get canceled as well.
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list