Deployed 1308ccf to v2.13 with MkDocs 1.5.2 and mike 1.1.2

v2.13/admin/runai-setup/authentication/researcher-authentication/index.html

@@ -28,7 +28,7 @@
 <a id=__codelineno-2-2 name=__codelineno-2-2 href=#__codelineno-2-2></a><span class="p p-Indicator">-</span><span class=w> </span><span class=s>&quot;oidc-client-id=&lt;CLIENT-ID&gt;&quot;</span>
 <a id=__codelineno-2-3 name=__codelineno-2-3 href=#__codelineno-2-3></a><span class="p p-Indicator">-</span><span class=w> </span><span class=s>&quot;oidc-issuer-url=&lt;URL&gt;&quot;</span>
 <a id=__codelineno-2-4 name=__codelineno-2-4 href=#__codelineno-2-4></a><span class="p p-Indicator">-</span><span class=w> </span><span class=s>&quot;oidc-username-prefix=-&quot;</span>
-</code></pre></div> <p>If working via Rancher UI, need to add the flag as part of the cluster provisioning. </p> <p>Under <code>Cluster Management | Create</code>, turn on RKE2 and select a platform. Under <code>Cluster Configuration | Advanced | Additional API Server Args</code>. Add the Run:ai flags as <code>&lt;key&gt;=&lt;value&gt;</code> (e.g. <code>oidc-username-prefix=-</code>).</p> <p>At the time of writing, the flags cannot be changed after the cluster has been provisioned due to a Rancher bug.</p> </div> <div class=tabbed-block> <p>Install <a href=https://cloud.google.com/kubernetes-engine/docs/how-to/oidc#enable-oidc target=_blank>Anthos identity service</a> by running:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>gcloud container clusters update &lt;gke-cluster-name&gt; \
+</code></pre></div> <p>If working via Rancher UI, need to add the flag as part of the cluster provisioning. </p> <p>Under <code>Cluster Management | Create</code>, turn on RKE2 and select a platform. Under <code>Cluster Configuration | Advanced | Additional API Server Args</code>. Add the Run:ai flags as <code>&lt;key&gt;=&lt;value&gt;</code> (e.g. <code>oidc-username-prefix=-</code>).</p> </div> <div class=tabbed-block> <p>Install <a href=https://cloud.google.com/kubernetes-engine/docs/how-to/oidc#enable-oidc target=_blank>Anthos identity service</a> by running:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-3-1 name=__codelineno-3-1 href=#__codelineno-3-1></a>gcloud container clusters update &lt;gke-cluster-name&gt; \
 <a id=__codelineno-3-2 name=__codelineno-3-2 href=#__codelineno-3-2></a>    --enable-identity-service --project=&lt;gcp-project-name&gt; --zone=&lt;gcp-zone-name&gt;
 </code></pre></div> <p>Install the <a href=https://github.com/mikefarah/yq target=_blank>yq</a> utility and run:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a>kubectl get clientconfig default -n kube-public -o yaml &gt; login-config.yaml
 <a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a>yq -i e &quot;.spec +={\&quot;authentication\&quot;:[{\&quot;name\&quot;:\&quot;oidc\&quot;,\&quot;oidc\&quot;:{\&quot;clientID\&quot;:\&quot;$OIDC_CLIENT_ID\&quot;,\&quot;issuerURI\&quot;:\&quot;$OIDC_ISSUER_URL\&quot;,\&quot;kubectlRedirectURI\&quot;:\&quot;http://localhost:8000/callback\&quot;,\&quot;userClaim\&quot;:\&quot;sub\&quot;,\&quot;userPrefix\&quot;:\&quot;$OIDC_USERNAME_PREFIX\&quot;}}]}&quot; login-config.yaml
@@ -81,7 +81,7 @@
 <a id=__codelineno-6-44 name=__codelineno-6-44 href=#__codelineno-6-44></a>--oidc-client-id<span class=o>=</span>runai
 <a id=__codelineno-6-45 name=__codelineno-6-45 href=#__codelineno-6-45></a>--oidc-issuer-url<span class=o>=</span>https://app.run.ai/auth/realms/&lt;REALM-NAME&gt;
 <a id=__codelineno-6-46 name=__codelineno-6-46 href=#__codelineno-6-46></a>--oidc-username-prefix<span class=o>=</span>-
-</code></pre></div> <p>All nodes with the <code>kube api server</code> role will automatically restart with the new flag.</p> </div> <div class=tabbed-block> <p>Please contact Run:ai customer support.</p> </div> <div class=tabbed-block> <p>See specific instructions in the documentation of the Kubernetes distribution. </p> </div> </div> </div> <h2 id=command-line-interface-access>Command-line Interface Access<a class=headerlink href=#command-line-interface-access title="Permanent link">&para;</a></h2> <p>To control access to Run:ai (and Kubernetes) resources, you must modify the Kubernetes configuration file. The file is distributed to users as part of the <a href=../../../researcher-setup/cli-install#kubernetes-configuration>Command-line interface installation</a>. </p> <p>When making changes to the file, keep a copy of the original file to be used for cluster administration. After making the modifications, distribute the modified file to Researchers. </p> <ul> <li>Under the <code>~/.kube</code> directory edit the <code>config</code> file, remove the administrative user, and replace it with text from <code>Settings | General | Researcher Authentication</code> | <code>Client Configuration</code>. </li> <li>Under <code>contexts | context | user</code> change the user to <code>runai-authenticated-user</code>.</li> </ul> <h2 id=test-via-command-line-interface>Test via Command-line interface<a class=headerlink href=#test-via-command-line-interface title="Permanent link">&para;</a></h2> <ul> <li>Run: <code>runai login</code> (in OpenShift environments use <code>oc login</code> rather than <code>runai login</code>).</li> <li>You will be prompted for a username and password. In a single sign-on flow, you will be asked to copy a link to a browser, log in and return a code. </li> <li>Once login is successful, submit a Job.</li> <li>If the Job was submitted with a Project to which you have no access, your access will be denied. </li> <li>If the Job was submitted with a Project to which you have access, your access will be granted.</li> </ul> <p>You can also submit a Job from the Run:ai User interface and verify that the new job shows on the job list with your user name. </p> <h2 id=test-via-user-interface>Test via User Interface<a class=headerlink href=#test-via-user-interface title="Permanent link">&para;</a></h2> <ul> <li>Open the Run:ai user interface, go to <code>Jobs</code>.</li> <li>On the top-right, select <code>Submit Job</code>. </li> </ul> <div class="admonition tip"> <p class=admonition-title>Tip</p> <p>If you do not see the button or it is disabled, then you either do not have <code>Researcher</code> access or the cluster has not been set up correctly. For more information, refer to <a href=../../../admin-ui-setup/overview/ >user interface overview</a>.</p> </div> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2023-07-25T13:00:28+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-07-25</span> <br> Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2021-10-19T13:51:49+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2021-10-19</span> </small> </div> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
+</code></pre></div> <p>All nodes with the <code>kube api server</code> role will automatically restart with the new flag.</p> </div> <div class=tabbed-block> <p>Please contact Run:ai customer support.</p> </div> <div class=tabbed-block> <p>See specific instructions in the documentation of the Kubernetes distribution. </p> </div> </div> </div> <h2 id=command-line-interface-access>Command-line Interface Access<a class=headerlink href=#command-line-interface-access title="Permanent link">&para;</a></h2> <p>To control access to Run:ai (and Kubernetes) resources, you must modify the Kubernetes configuration file. The file is distributed to users as part of the <a href=../../../researcher-setup/cli-install#kubernetes-configuration>Command-line interface installation</a>. </p> <p>When making changes to the file, keep a copy of the original file to be used for cluster administration. After making the modifications, distribute the modified file to Researchers. </p> <ul> <li>Under the <code>~/.kube</code> directory edit the <code>config</code> file, remove the administrative user, and replace it with text from <code>Settings | General | Researcher Authentication</code> | <code>Client Configuration</code>. </li> <li>Under <code>contexts | context | user</code> change the user to <code>runai-authenticated-user</code>.</li> </ul> <h2 id=test-via-command-line-interface>Test via Command-line interface<a class=headerlink href=#test-via-command-line-interface title="Permanent link">&para;</a></h2> <ul> <li>Run: <code>runai login</code> (in OpenShift environments use <code>oc login</code> rather than <code>runai login</code>).</li> <li>You will be prompted for a username and password. In a single sign-on flow, you will be asked to copy a link to a browser, log in and return a code. </li> <li>Once login is successful, submit a Job.</li> <li>If the Job was submitted with a Project to which you have no access, your access will be denied. </li> <li>If the Job was submitted with a Project to which you have access, your access will be granted.</li> </ul> <p>You can also submit a Job from the Run:ai User interface and verify that the new job shows on the job list with your user name. </p> <h2 id=test-via-user-interface>Test via User Interface<a class=headerlink href=#test-via-user-interface title="Permanent link">&para;</a></h2> <ul> <li>Open the Run:ai user interface, go to <code>Jobs</code>.</li> <li>On the top-right, select <code>Submit Job</code>. </li> </ul> <div class="admonition tip"> <p class=admonition-title>Tip</p> <p>If you do not see the button or it is disabled, then you either do not have <code>Researcher</code> access or the cluster has not been set up correctly. For more information, refer to <a href=../../../admin-ui-setup/overview/ >user interface overview</a>.</p> </div> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2023-08-14T13:31:35+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-08-14</span> <br> Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2021-10-19T13:51:49+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2021-10-19</span> </small> </div> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
 </script> <!-- Synchronize Giscus theme with palette --> <script>
     var giscus = document.querySelector("script[src*=giscus]")
 

v2.13/developer/cluster-api/submit-yaml/index.html

@@ -73,7 +73,7 @@
 <a id=__codelineno-3-23 name=__codelineno-3-23 href=#__codelineno-3-23></a><span class=w>        </span><span class=nt>port1</span><span class=p>:</span>
 <a id=__codelineno-3-24 name=__codelineno-3-24 href=#__codelineno-3-24></a><span class=w>          </span><span class=nt>value</span><span class=p>:</span>
 <a id=__codelineno-3-25 name=__codelineno-3-25 href=#__codelineno-3-25></a><span class=w>            </span><span class=nt>container</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">8000</span>
-</code></pre></div> <ol> <li>Possible metrics can be <code>cpu-utilization</code>, <code>latency</code>, <code>throughput</code>, <code>concurrency</code>, <code>gpu-utilization</code>, <code>custom</code>. Different metrics may require additional <a href=../../../admin/runai-setup/cluster-setup/cluster-prerequisites/#inference>installations</a> at the cluster level. </li> <li>Inference requires a port to receive requests.</li> </ol> <h2 id=suspendresume-interactivetraining-workload>Suspend/Resume Interactive/Training Workload<a class=headerlink href=#suspendresume-interactivetraining-workload title="Permanent link">&para;</a></h2> <p>to suspend trainig <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=nt>apiVersion</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">run.ai/v2alpha1</span>
+</code></pre></div> <ol> <li>Possible metrics can be <code>cpu-utilization</code>, <code>latency</code>, <code>throughput</code>, <code>concurrency</code>, <code>gpu-utilization</code>, <code>custom</code>. Different metrics may require additional <a href=../../../admin/runai-setup/cluster-setup/cluster-prerequisites/#inference>installations</a> at the cluster level.</li> <li>Inference requires a port to receive requests.</li> </ol> <h2 id=suspendresume-interactivetraining-workload>Suspend/Resume Interactive/Training Workload<a class=headerlink href=#suspendresume-interactivetraining-workload title="Permanent link">&para;</a></h2> <p>To suspend training:</p> <div class=highlight><pre><span></span><code><a id=__codelineno-4-1 name=__codelineno-4-1 href=#__codelineno-4-1></a><span class=nt>apiVersion</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">run.ai/v2alpha1</span>
 <a id=__codelineno-4-2 name=__codelineno-4-2 href=#__codelineno-4-2></a><span class=nt>kind</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">TrainingWorkload</span><span class=w> </span><span class=c1># </span>
 <a id=__codelineno-4-3 name=__codelineno-4-3 href=#__codelineno-4-3></a><span class=nt>metadata</span><span class=p>:</span>
 <a id=__codelineno-4-4 name=__codelineno-4-4 href=#__codelineno-4-4></a><span class=w>  </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">job-1</span><span class=w>  </span><span class=c1>#  </span>
@@ -87,7 +87,7 @@
 <a id=__codelineno-4-12 name=__codelineno-4-12 href=#__codelineno-4-12></a><span class=w>    </span><span class=nt>value</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">gcr.io/run-ai-demo/quickstart</span>
 <a id=__codelineno-4-13 name=__codelineno-4-13 href=#__codelineno-4-13></a><span class=w>  </span><span class=nt>name</span><span class=p>:</span>
 <a id=__codelineno-4-14 name=__codelineno-4-14 href=#__codelineno-4-14></a><span class=w>    </span><span class=nt>value</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">job-1</span><span class=w> </span><span class=c1># </span>
-</code></pre></div> In order to suspend workload set <code>active</code> value to <code>false</code> To reume it back either set <code>active</code> value to <code>true</code> or remove it entirly. </p> <h2 id=see-also>See Also<a class=headerlink href=#see-also title="Permanent link">&para;</a></h2> <ul> <li>To understand how to connect to the inference workload, see <a href=../../../Researcher/Walkthroughs/quickstart-inference/ >Inference Quickstart</a>.</li> <li>To learn more about Inference and Run:ai see <a href=../../../admin/workloads/inference-overview/ >Inference overview</a>.</li> </ul> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2023-05-28T08:31:22+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-05-28</span> <br> Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2022-05-01T17:47:03+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2022-05-01</span> </small> </div> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
+</code></pre></div> <p>In order to suspend the workload, set <code>active</code> to <code>false</code>. To resume the workload, either set <code>active</code> to <code>true</code> or remove it entirely.</p> <h2 id=see-also>See Also<a class=headerlink href=#see-also title="Permanent link">&para;</a></h2> <ul> <li>To understand how to connect to the inference workload, see <a href=../../../Researcher/Walkthroughs/quickstart-inference/ >Inference Quickstart</a>.</li> <li>To learn more about Inference and Run:ai see <a href=../../../admin/workloads/inference-overview/ >Inference overview</a>.</li> </ul> <hr> <div class=md-source-file> <small> Last update: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2023-08-15T07:45:41+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2023-08-15</span> <br> Created: <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago"><span class=timeago datetime=2022-05-01T17:47:03+00:00 locale=en></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date">2022-05-01</span> </small> </div> <!-- Giscus --> <!-- <h2 id="__comments">Comments</h2> --> <!-- Replace with generated snippet --> <script src=https://giscus.app/client.js data-repo=run-ai/docs data-repo-id="MDEwOlJlcG9zaXRvcnkyODAxODMxOTY=" data-category=General data-category-id=MDE4OkRpc2N1c3Npb25DYXRlZ29yeTE1MTA2MDU4 data-mapping=pathname data-strict=0 data-reactions-enabled=1 data-emit-metadata=0 data-input-position=bottom data-theme=light data-lang=en crossorigin=anonymous async>
 </script> <!-- Synchronize Giscus theme with palette --> <script>
     var giscus = document.querySelector("script[src*=giscus]")