[ARVADOS] created: 1.1.4-698-g0853b16ad

[Git user]

        at  0853b16ad82a6b4411f04910d0035a2c653cfc29 (commit)


commit 0853b16ad82a6b4411f04910d0035a2c653cfc29
Author: Peter Amstutz <pamstutz at veritasgenetics.com>
Date:   Tue Jul 24 11:53:51 2018 -0400

    13570: Add section describing RAM allocation behavior.
    
    Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz at veritasgenetics.com>

diff --git a/doc/api/execution.html.textile.liquid b/doc/api/execution.html.textile.liquid
index 3c7347dd6..96f730522 100644
--- a/doc/api/execution.html.textile.liquid
+++ b/doc/api/execution.html.textile.liquid
@@ -22,6 +22,14 @@ h2. Container API
 
 !(full-width){{site.baseurl}}/images/Crunch_dispatch.svg!
 
+h2. Requesting RAM for containers
+
+The @runtime_constraints@ section of a container specifies working RAM (@ram@) and keep cache (@keep_cache_ram@).  If not specified, containers get a default keep cache (@container_default_keep_cache_ram@, default 256 MiB).  The total RAM requested for a container is the sum of working RAM, keep cache, and an additional RAM reservation configured by the admin (@ReserveExtraRAM@ in the dispatcher configuration, default zero).
+
+The total RAM request is used to schedule containers onto compute nodes.  RAM allocations are enforced using kernel controls such as cgroups.
+
+When running on the cloud, the memory request (along with CPU and disk) is used to select (and possibly boot) an instance type with adequate resources to run the container.  Instance type RAM is derated 5% from the published specification to accomodate virtual machine, kernel and system services overhead.  This means, for example, a node with a published size of 4 GiB is assumed to only have 3891 MiB available for running containers.
+
 h2. Job API (deprecated)
 
 # To submit work, create a "job":{{site.baseurl}}/api/methods/jobs.html .  If the same job has been submitted in the past, it will return an existing job in @Completed@ state.

-----------------------------------------------------------------------


hooks/post-receive
--