https://dev.arvados.org/https://dev.arvados.org/favicon.ico?15576888422022-10-26T15:43:09ZArvadosArvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1073392022-10-26T15:43:09ZTom Cleggtom@curii.com
<ul><li><strong>Description</strong> updated (<a title="View differences" href="/journals/107339/diff?detail_id=103998">diff</a>)</li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1073412022-10-26T15:45:02ZTom Cleggtom@curii.com
<ul><li><strong>Assigned To</strong> set to <i>Tom Clegg</i></li><li><strong>Description</strong> updated (<a title="View differences" href="/journals/107341/diff?detail_id=104000">diff</a>)</li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1077182022-11-08T19:14:38ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2022-11-09 sprint</i> to <i>2022-11-23 sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1077602022-11-08T19:53:03ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2022-11-23 sprint</i> to <i>2022-12-07 Sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1081802022-11-18T21:48:33ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2022-12-07 Sprint</i> to <i>2022-12-21 Sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1083992022-11-23T18:14:42ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2022-12-21 Sprint</i> to <i>2023-01-18 sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1084112022-11-23T18:31:49ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2023-01-18 sprint</i> to <i>2023-02-01 sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1084572022-11-23T18:59:04ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2023-02-01 sprint</i> to <i>2023-02-15 sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1096512023-01-11T17:56:28ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2023-02-15 sprint</i> to <i>Future</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1097922023-01-11T21:30:51ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Release</strong> set to <i>59</i></li><li><strong>Story points</strong> set to <i>0.5</i></li><li><strong>Target version</strong> deleted (<del><i>Future</i></del>)</li><li><strong>Assigned To</strong> deleted (<del><i>Tom Clegg</i></del>)</li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1098012023-01-11T22:03:16ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> set to <i>To be scheduled</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1101072023-01-18T17:29:26ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>To be scheduled</i> to <i>2023-02-01 sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1101152023-01-18T17:39:00ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Assigned To</strong> set to <i>Tom Clegg</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1104422023-01-30T15:37:30ZTom Cleggtom@curii.com
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>In Progress</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1104462023-01-30T20:44:38ZTom Cleggtom@curii.com
<ul><li><strong>File</strong> <a href="/attachments/3234">7da8a84dd.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3234/7da8a84dd.png">7da8a84dd.png</a> added</li></ul><p>Draft for discussion</p>
<p><img src="https://dev.arvados.org/attachments/download/3234/7da8a84dd.png" alt="" /></p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1104562023-01-30T22:48:17ZTom Cleggtom@curii.com
<ul><li><strong>File</strong> <a href="/attachments/3235">32ec983b8.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3235/32ec983b8.png">32ec983b8.png</a> added</li></ul><p>Another possibility</p>
<p><img src="https://dev.arvados.org/attachments/download/3235/32ec983b8.png" alt="" /></p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1104602023-01-31T14:32:48ZPeter Amstutzpeter.amstutz@curii.com
<ul></ul><p>Tom Clegg wrote in <a href="#note-17">#note-17</a>:</p>
<blockquote>
<p>Another possibility</p>
<p><img src="https://dev.arvados.org/attachments/download/3235/32ec983b8.png" alt="" /></p>
</blockquote>
<p>Yes, I like this one better.</p>
<p>Might be worth noting you can go to "Cancelled" state from any of the Committed states, and then making it clearer that "Cancelled" can happen as a result of either "system error" or "priority set to 0".</p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1104642023-01-31T15:00:45ZBrett Smithbrett.smith@curii.com
<ul><li><strong>File</strong> <a href="/attachments/3240">PXL_20230131_144714264.jpg</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3240/PXL_20230131_144714264.jpg">PXL_20230131_144714264.jpg</a> added</li></ul><p>Putting up my own idea. Apologies for my chicken scratch. Here are the key things I think are relevant:</p>
<ul>
<li>We present the lifecycle as basically linear, and then throughout that process there are a series of off-ramps that all lead to the container request having state=Final. I think this lends itself well to a two-column presentation, where the first column represents the full normal lifecycle and then the second column are the end states that the different off-ramps take you to.</li>
<li>Boxes represent object state, arrows represent different actors changing those objects' state. Boxes document what object is changing (container request and/or container) and the key field changes that occurred from the action. Arrows document both who is acting on an object (user, API server independently, Crunch) and what the change is.</li>
<li>IMO the two-layer presentation of container request state and container state in Tom's suggestion is a little too clever and dense. I would rather have each box document both the state of the container request <em>and</em> its associated container (if any).</li>
<li>I used a lot of abbreviations for space. We should spell everything out. CR = container request. c_uuid = <code>container_uuid</code>. "User cancels CR" = User updates container request with <code>priority</code>=0. My descriptions of the transitions between Queued→Locked→Running might be a little off, please correct, I more wanted to get the structure out than exactly right.</li>
<li>We could highlight other key fields that change like <code>log_uuid</code>, <code>output_uuid</code>, etc.</li>
<li>I forgot to draw an arrow for "Container runs to completion," oops.</li>
<li>We could probably add judicious color outlines to distinguish end states with no container, cancelled container, failed container, and successful container.</li>
</ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1105262023-01-31T21:29:48ZTom Cleggtom@curii.com
<ul><li><strong>File</strong> <a href="/attachments/3241">d2c770ed6.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3241/d2c770ed6.png">d2c770ed6.png</a> added</li></ul><p>I gave up trying to coerce the graphviz layout. Using color to indicate the end states seems to work OK though.</p>
<p><img src="https://dev.arvados.org/attachments/download/3241/d2c770ed6.png" alt="" /></p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1105302023-01-31T22:13:46ZBrett Smithbrett.smith@curii.com
<ul></ul><p>I like this version best so far. I appreciate the simplification of "user does something" vs. "Arvados does something" without getting into specific components, I think that's a good improvement, thanks.</p>
<p>Without specifying the presentation too much here are things I worry about:</p>
<ul>
<li>I'm not sure how I feel about the "assigned" shorthand. Do we use that anywhere else? For newer Arvados users I'm not sure if it would be clear enough.</li>
<li>For some of the arrow labels, especially labels that are rendered between two arrows, I don't think it's obvious which arrow they go with.</li>
<li>In general the way the whole graph tends to lean left just feels really awkward. Even if we could just get it to lean right instead, I feel like that would be an improvement, since it matches the direction of our text.</li>
</ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1105842023-02-01T16:38:25ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Target version</strong> changed from <i>2023-02-01 sprint</i> to <i>2023-02-15 sprint</i></li></ul> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1106312023-02-01T19:18:35ZTom Cleggtom@curii.com
<ul><li><strong>File</strong> <a href="/attachments/3243">e6da4efc4.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3243/e6da4efc4.png">e6da4efc4.png</a> added</li></ul><p><img src="https://dev.arvados.org/attachments/download/3243/e6da4efc4.png" alt="" /></p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1106332023-02-01T19:45:53ZTom Cleggtom@curii.com
<ul></ul><p>19624-priority-doc @ <a class="changeset" title="19624: Layout graph L->R, say "update" instead of "assign". Arvados-DCO-1.1-Signed-off-by: Tom C..." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/e6da4efc43f0b913964eb570c0f52336573abbe8">e6da4efc43f0b913964eb570c0f52336573abbe8</a></p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1106582023-02-01T21:15:35ZBrett Smithbrett.smith@curii.com
<ul><li><strong>File</strong> <a href="/attachments/3245">ContainerRequestLifecycle.dot.svg</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3245/ContainerRequestLifecycle.dot.svg">ContainerRequestLifecycle.dot.svg</a> added</li><li><strong>File</strong> <a href="/attachments/3244">ContainerRequestLifecycle.dot</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/3244/ContainerRequestLifecycle.dot">ContainerRequestLifecycle.dot</a> added</li></ul><p>If you like this version I can just tack it onto the branch, let me know.</p>
<p><img src="ContainerRequestLifecycle.dot.svg" alt="" /></p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1106902023-02-02T14:53:35ZBrett Smithbrett.smith@curii.com
<ul></ul><p>Tom Clegg wrote in <a href="#note-24">#note-24</a>:</p>
<blockquote>
<p>19624-priority-doc @ <a class="changeset" title="19624: Layout graph L->R, say "update" instead of "assign". Arvados-DCO-1.1-Signed-off-by: Tom C..." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/e6da4efc43f0b913964eb570c0f52336573abbe8">e6da4efc43f0b913964eb570c0f52336573abbe8</a></p>
</blockquote>
<p>The text and the way the diagram is included look good to me. Let me know what you think about the edited diagram and I think we're good either way. Thanks.</p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1106972023-02-02T15:23:17ZTom Cleggtom@curii.com
<ul></ul><p>Brett Smith wrote in <a href="#note-25">#note-25</a>:</p>
<blockquote>
<p>If you like this version I can just tack it onto the branch, let me know.</p>
</blockquote>
<p>Yes please. That layout is definitely better.</p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1107082023-02-02T16:33:25ZBrett Smithbrett.smith@curii.com
<ul></ul><p>Tom Clegg wrote in <a href="#note-27">#note-27</a>:</p>
<blockquote>
<p>Yes please. That layout is definitely better.</p>
</blockquote>
<p><a class="changeset" title="19624: Layout container request lifecycle in two columns Provide a more readable layout. Normal ..." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/f196aa21e83d75d8fb2e77c9119a650034cb5cac">f196aa21e83d75d8fb2e77c9119a650034cb5cac</a> - Unless you see any issues I think this is good to merge, thanks.</p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1107302023-02-02T21:54:26ZTom Cleggtom@curii.com
<ul><li><strong>Status</strong> changed from <i>In Progress</i> to <i>Resolved</i></li></ul><p>Applied in changeset <a class="changeset" title="Merge branch '19624-priority-doc' fixes #19624 Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@cu..." href="https://dev.arvados.org/projects/arvados/repository/arvados/revisions/e75f2cd097eb9c8e541576fadce46e09c51c7dab">arvados|e75f2cd097eb9c8e541576fadce46e09c51c7dab</a>.</p> Arvados - Bug #19624: Better documentation of interaction between priority 0 and container statehttps://dev.arvados.org/issues/19624?journal_id=1130162023-03-07T19:48:53ZPeter Amstutzpeter.amstutz@curii.com
<ul><li><strong>Release</strong> set to <i>57</i></li></ul>