https://dev.arvados.org/https://dev.arvados.org/favicon.ico?15576888422016-08-31T19:59:49ZArvadosArvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=425412016-08-31T19:59:49ZRadhika Chippadaradhika@curoverse.com
<ul><li><strong>Target version</strong> set to <i>2016-09-14 sprint</i></li></ul> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=425492016-08-31T20:07:23ZRadhika Chippadaradhika@curoverse.com
<ul><li><strong>Assigned To</strong> set to <i>Radhika Chippada</i></li></ul> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=425602016-08-31T20:18:13ZRadhika Chippadaradhika@curoverse.com
<ul><li><strong>Story points</strong> set to <i>1.0</i></li></ul> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=427792016-09-06T19:57:09ZRadhika Chippadaradhika@curoverse.com
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>In Progress</i></li></ul> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=428312016-09-08T13:49:09ZPeter Amstutzpeter.amstutz@curii.com
<ul></ul><p>Reviewing 9835-container-api-doc @ <a class="changeset" title="9835: Container and ContainerRequest documentation." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/769189c406bb42761f4d7bfe35fd2cc36edcef00">769189c406bb42761f4d7bfe35fd2cc36edcef00</a></p>
<p>Instead of linking to the wiki, please copy the "mount types" table into the API documentation.</p>
<p>Instead of linking to the wiki, please copy the "container states" table into the API documentation.</p>
<p>Please add a table listing fields for <code>runtime_constraints</code></p>
<p>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".</p>
<p>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."</p>
<p>Reword "Portable data hash of the log collection." -> "Portable data hash of the collection containing logs from a completed container run."</p>
<p>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).</p>
<p>Need a note that setting the priority of a committed container request to 0 may cancel a running container.</p>
<p>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.)</p>
<p>"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."</p>
<p>"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."</p> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=428742016-09-09T00:50:30ZRadhika Chippadaradhika@curoverse.com
<ul></ul><p>Created the subtask <a class="issue tracker-5 status-3 priority-4 priority-default closed child" title="Task: Update Containers related documentation to explain how container reuse works. (Resolved)" href="https://dev.arvados.org/issues/9999">#9999</a> to address the environment related concern and addressed all the other comments at <a class="changeset" title="9835: more details such as mount_types added." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/f00a2304c3668e74c6ab53e27793166b02b709d2">f00a230</a></p> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=429452016-09-13T15:13:39ZPeter Amstutzpeter.amstutz@curii.com
<ul></ul><p>Mount types table:</p>
<p>The "Discussion" column is unused and should be removed.</p>
<p>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.</p>
<p>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."</p>
<p>The "Runtime constraints" has the note "Required when in “Committed” state." but Containers don't have a "Committed" state, only requests do.</p> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=429952016-09-13T20:55:12ZPeter Amstutzpeter.amstutz@curii.com
<ul></ul><p>LGTM @ <a class="changeset" title="9835: mount_types improvements." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/e8db2a47dd834640eeafeb7fa6741d725c1fac9c">e8db2a4</a></p> Arvados - Idea #9835: [Crunch2][Documentation] Add containers and container_requests to API Reference -> API Methodshttps://dev.arvados.org/issues/9835?journal_id=430022016-09-13T23:55:06ZRadhika Chippadaradhika@curoverse.com
<ul><li><strong>Status</strong> changed from <i>In Progress</i> to <i>Resolved</i></li><li><strong>% Done</strong> changed from <i>0</i> to <i>100</i></li></ul><p>Applied in changeset arvados|commit:39c12f4da6dcdbfa1a4232dc849d303692dfb401.</p>