[ci skip] Autodoc commit for 2bccb64.

OSC · Dec 5, 2023 · 80d974d · 80d974d
1 parent d399433
commit 80d974d
Show file tree

Hide file tree

Showing 20 changed files with 406 additions and 5 deletions.
diff --git a/develop/_sources/installation/add-cluster-config.rst.txt b/develop/_sources/installation/add-cluster-config.rst.txt
@@ -82,6 +82,7 @@ client binaries.
    resource-manager/systemd
    resource-manager/bin-override-example
    resource-manager/test
+   resource-manager/advanced-configs
 
 .. _puppet module: https://forge.puppet.com/modules/osc/openondemand
 .. _ansible role: https://galaxy.ansible.com/osc/open_ondemand
diff --git a/develop/_sources/installation/resource-manager/advanced-configs.rst.txt b/develop/_sources/installation/resource-manager/advanced-configs.rst.txt
@@ -0,0 +1,42 @@
+.. _advanced-resource-manager-configs:
+
+Advanced Resource Manager Configrations
+=======================================
+
+This page details advanced settings for any resource manager
+that could be helpful in using Open OnDemand.
+
+Visualization Nodes
+-------------------
+
+At OSC we offer ``visualization`` nodes that attach the X11 session
+to a GPU so that any rendering can occur on the GPU itself.
+
+We've defined ``vis`` as a `Slurm GRES`_ that jobs can request (i.e.,
+some batch connect applications request this `Slurm GRES`_).
+
+We use a `Slurm prolog`_ to do the actual work of attaching the X11
+session to the GPU.
+
+Other resource managers may have a similar facility for doing work 
+just before the job starts running.
+
+This is an example of that `Slurm prolog`_. 
+
+.. code-block:: bash
+
+  if [[ "$SLURM_LOCALID" == "0" && "$SLURM_JOB_GRES" == *"vis"* ]]; then
+    if [ -n "$CUDA_VISIBLE_DEVICES" ]; then
+      FIRSTGPU=$(echo $CUDA_VISIBLE_DEVICES | tr ',' "\n" | head -1)
+      setsid /usr/bin/X :${FIRSTGPU} -noreset >& /dev/null &
+      sleep 2
+      if [ -n "$DISPLAY" ]; then
+        echo "export OLDDISPLAY=$DISPLAY"
+      fi
+      echo "export DISPLAY=:$FIRSTGPU"
+    fi
+  fi
+
+
+.. _Slurm prolog: https://slurm.schedmd.com/prolog_epilog.html
+.. _Slurm GRES: https://slurm.schedmd.com/gres.html
diff --git a/develop/how-tos/app-development/interactive/setup.html b/develop/how-tos/app-development/interactive/setup.html
@@ -40,7 +40,7 @@
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="1. Software Requirements" href="setup/software-requirements.html" />
-    <link rel="prev" title="Test Configuration" href="../../../installation/resource-manager/test.html" />
+    <link rel="prev" title="Advanced Resource Manager Configrations" href="../../../installation/resource-manager/advanced-configs.html" />
 
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-34776817-3"></script>
 <script>
@@ -235,7 +235,7 @@
         <a href="setup/software-requirements.html" class="btn btn-neutral float-right" title="1. Software Requirements" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="../../../installation/resource-manager/test.html" class="btn btn-neutral float-left" title="Test Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="../../../installation/resource-manager/advanced-configs.html" class="btn btn-neutral float-left" title="Advanced Resource Manager Configrations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

diff --git a/develop/index.html b/develop/index.html
@@ -263,6 +263,7 @@ <h2>Special Thanks<a class="headerlink" href="#special-thanks" title="Permalink
 <li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/systemd.html">Systemd</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
 <li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/test.html">Test Configuration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a><ul>

diff --git a/develop/installation/add-cluster-config.html b/develop/installation/add-cluster-config.html
@@ -118,6 +118,7 @@
 <li class="toctree-l2"><a class="reference internal" href="resource-manager/systemd.html">Systemd</a></li>
 <li class="toctree-l2"><a class="reference internal" href="resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
 <li class="toctree-l2"><a class="reference internal" href="resource-manager/test.html">Test Configuration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
@@ -279,6 +280,7 @@
 <li class="toctree-l1"><a class="reference internal" href="resource-manager/systemd.html">Systemd</a></li>
 <li class="toctree-l1"><a class="reference internal" href="resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
 <li class="toctree-l1"><a class="reference internal" href="resource-manager/test.html">Test Configuration</a></li>
+<li class="toctree-l1"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
 </ul>
 </div>
 </div>

diff --git a/develop/installation/cluster-config-schema.html b/develop/installation/cluster-config-schema.html
@@ -132,6 +132,7 @@
 <li class="toctree-l2"><a class="reference internal" href="resource-manager/systemd.html">Systemd</a></li>
 <li class="toctree-l2"><a class="reference internal" href="resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
 <li class="toctree-l2"><a class="reference internal" href="resource-manager/test.html">Test Configuration</a></li>
+<li class="toctree-l2"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>