Skip to content

Commit 1dcd27e

Browse files
author
Doc Deploy Bot
committed
Deployed dde0b71 to dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 5a1b82d commit 1dcd27e

2 files changed

Lines changed: 17 additions & 20 deletions

File tree

dev/guides/user-containers/readme/index.html

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -827,9 +827,9 @@
827827
</li>
828828

829829
<li class="md-nav__item">
830-
<a href="#shutdown-request" class="md-nav__link">
830+
<a href="#shutdown-request-via-shutdown-endpoint" class="md-nav__link">
831831
<span class="md-ellipsis">
832-
Shutdown Request
832+
Shutdown Request via /shutdown endpoint
833833
</span>
834834
</a>
835835

@@ -1671,9 +1671,9 @@
16711671
</li>
16721672

16731673
<li class="md-nav__item">
1674-
<a href="#shutdown-request" class="md-nav__link">
1674+
<a href="#shutdown-request-via-shutdown-endpoint" class="md-nav__link">
16751675
<span class="md-ellipsis">
1676-
Shutdown Request
1676+
Shutdown Request via /shutdown endpoint
16771677
</span>
16781678
</a>
16791679

@@ -2217,11 +2217,15 @@ <h4 id="long-running-processes">Long-Running Processes</h4>
22172217
The software will ignore the result of the containers and proceed to the Teardown phase, where the
22182218
containers will be destroyed. This can be useful for long-running processes where the exit code is
22192219
not important.</p>
2220-
<h4 id="shutdown-request">Shutdown Request</h4>
2220+
<h4 id="shutdown-request-via-shutdown-endpoint">Shutdown Request via <code>/shutdown</code> endpoint</h4>
22212221
<p>The request is sent using HTTPS (TLS required; client verifies server using a CA certificate from
22222222
the Kubernetes <code>nnf-dm-usercontainer-server-tls</code> secret).</p>
2223-
<p>The token is taken from the workflow specific token that is generated by the NNF software, if
2224-
necessary.</p>
2223+
<p>The token is taken from the workflow-specific token generated by the NNF software, if specified. See
2224+
the <code>requires=user-container-auth</code> argument in <a href="../../user-interactions/readme/#command-arguments">Command
2225+
Arguments</a>. Using this keyword in your directive
2226+
instructs the NNF software to create a workflow-specific token that is used here. If the <code>requires</code>
2227+
argument is not used, then no token will be generated, and no authorization will be sent in the
2228+
request.</p>
22252229
<p>Headers:</p>
22262230
<table>
22272231
<thead>
@@ -2243,19 +2247,13 @@ <h4 id="shutdown-request">Shutdown Request</h4>
22432247
<td>Authorization</td>
22442248
<td>Optional</td>
22452249
<td>Bearer TOKEN...</td>
2246-
<td>Bearer token for authentication (if token provided)</td>
2250+
<td>Bearer token for authentication (if token is requested by workflow)</td>
22472251
</tr>
22482252
<tr>
22492253
<td>X-Auth-Type</td>
22502254
<td>Optional</td>
22512255
<td>XOAUTH2</td>
2252-
<td>Indicates XOAUTH2 token type (if token is provided)</td>
2253-
</tr>
2254-
<tr>
2255-
<td>Accepts-version</td>
2256-
<td>Optional</td>
2257-
<td>1.0</td>
2258-
<td>API version (required for copy-offload)</td>
2256+
<td>Indicates XOAUTH2 token type (if token is requested by workflow)</td>
22592257
</tr>
22602258
</tbody>
22612259
</table>
@@ -2270,10 +2268,9 @@ <h4 id="shutdown-request">Shutdown Request</h4>
22702268
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="na">Content-Type</span><span class="o">:</span> <span class="l">application/json</span>
22712269
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="na">Authorization</span><span class="o">:</span> <span class="l">Bearer eyJhbG...</span>
22722270
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="na">X-Auth-Type</span><span class="o">:</span> <span class="l">XOAUTH2</span>
2273-
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="na">Accepts-version</span><span class="o">:</span> <span class="l">1.0</span>
2274-
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="na">Content-Length</span><span class="o">:</span> <span class="l">23</span>
2275-
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a>
2276-
<a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="p">{</span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;shutdown&quot;</span><span class="p">}</span>
2271+
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="na">Content-Length</span><span class="o">:</span> <span class="l">23</span>
2272+
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a>
2273+
<a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="p">{</span><span class="nt">&quot;message&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;shutdown&quot;</span><span class="p">}</span>
22772274
</code></pre></div>
22782275
<h4 id="recap">Recap</h4>
22792276
<p>To recap the PostRun behavior:</p>

dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)