From 520b07e1add8fcbe9eb0e0bb22eed42c1c2c5b5e Mon Sep 17 00:00:00 2001 From: radhika Date: Thu, 22 Sep 2016 12:14:19 -0400 Subject: [PATCH] 10036: Update ContainerRequest API documentation about canceling a conatiner_request. --- doc/api/methods/container_requests.html.textile.liquid | 1 + doc/api/schema/ContainerRequest.html.textile.liquid | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/doc/api/methods/container_requests.html.textile.liquid b/doc/api/methods/container_requests.html.textile.liquid index 88a53a2389..2603079560 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 8abb5b38d8..48c624a69e 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. -- 2.30.2