[ci skip] Autodoc commit for 7f6862e.

latest/_sources/how-tos/app-development/interactive/submit.rst.txt

@@ -96,23 +96,41 @@ The three possible configuration options that can be used in the
 Each of these configuration options take a set of their own configuration
 options described below.
 
-Configure Batch Connect
-```````````````````````
+Batch Connect Template types
+````````````````````````````
 
-All batch scripts are generated from either the ``basic`` template or the
-``vnc`` template specified with the following configuration option:
+Open OnDemand has three distinct batch connect template types.
+These template types determine the resulting shell scripts that wrap
+your batch connect application.
+
+For example the ``vnc`` type will provide a script that boots up a
+VNC server, exports a ``DISPLAY`` variable and other utilities to
+ensure that the job has been bootstrapped appropriately to
+start GUI applications.
+
+The options available are ``basic``, ``vnc`` or ``vnc_container``.
+``vnc_container`` is basically just like ``vnc`` only in that it
+boostraps the VNC programs inside a container instead of on the
+host machine.
 
 .. describe:: template (String)
 
-   the template used for rendering the batch script (``"basic"`` or ``"vnc"``)
+    The template used to create the wrapper script for your batch connect
+    application.
 
-   Default
-     ``"basic"``
+    Default
+      Generate a basic wrapper script for HTTP applications.
 
-   Example
-     Render a batch script for a VNC Interactive Application
+      .. code-block:: yaml
 
-     .. code-block:: yaml
+        ---
+        batch_connect:
+          template: "basic"
+
+    Example
+      Generate a wrapper script for a VNC interactive application.
+
+      .. code-block:: yaml
 
         # ${HOME}/ondemand/dev/my_app/submit.yml.erb
         ---

latest/_sources/reference/files/submit-yml-erb.rst.txt

@@ -16,6 +16,7 @@ These are reference pages, you can see
 
    submit-yml/basic-bc-options
    submit-yml/vnc-bc-options
+   submit-yml/vnc-container-bc-options
    submit-yml/script
 
 Simple Example

latest/_sources/reference/files/submit-yml/vnc-container-bc-options.rst.txt

@@ -0,0 +1,142 @@
+.. _vnc-container-bc-options:
+
+Batch Connect VNC Container Options
+===================================
+
+
+All the options in :ref:`vnc-bc-options` apply in addition to what's listed below.
+
+        # @option context [#to_s] :container_path ("vnc_container.sif") the path
+        #   to the container with VNC
+        # @option context [#to_s] :container_bindpath ("") paths to bind into
+        #   the container with VNC
+        # @option context [#to_s] :container_module ("singularity") the module
+        #   that loads Singularity or Apptainer with Lmod. Supports versions (i.e.
+        #   apptainer/1.10). If Singularity or Apptainer are installed at a 
+        #   system level (i.e., no module loaded to activate), set this to an
+        #   empty string.
+        # @option context [#to_s] :container_command ("singularity") the 
+        #   singularity or apptainer execution command
+
+  .. code-block:: yaml
+  
+    batch_connect:
+      template: "vnc_container"
+      # other 'vnc' or 'basic' options removed for brevity.
+      container_path: "vnc_container.sif"
+      container_bindpath: ""
+      container_module: "singularity"
+      container_command: "singularity"
+
+
+.. describe:: container_path (String, "vnc_container.sif")
+
+    The full path to the container image you wish to boot.
+
+    Default
+      Load the vnc_container.sif image.
+
+      .. code-block:: yaml
+
+        container_path: "vnc_container.sif"
+
+    Example
+      Provide an absolute path to a ``vnc_container.sif`` image.
+
+      .. code-block:: yaml
+
+        container_path: "/absolute/path/to/my/container/vnc_container.sif"
+
+.. describe:: container_bindpath (String, "")
+
+    A comma seperated list of mountpoints you wish to bind into the container.
+
+    Default
+      Do not bind any paths into the container.
+
+      .. code-block:: yaml
+
+        container_bindpath: ""
+
+    Example
+      Bind /etc, /dev and /usr into the container.
+
+      .. code-block:: yaml
+
+        container_bindpath: "/etc,/dev,/usr"
+
+.. describe:: container_module (String, "singularity")
+
+    The module to load before starting the container.
+
+    Default
+      Load the ``singularity`` module.
+
+      .. code-block:: yaml
+
+        container_module: "singularity"
+
+    Example
+      Load the ``singularity/1.1.3`` module.
+
+      .. code-block:: yaml
+
+        container_module: "singularity/1.1.3"
+
+.. describe:: container_command (String, "singularity")
+
+    The command used to start the container.
+
+    Default
+      Use the ``singularity`` command.
+
+      .. code-block:: yaml
+
+        container_module: "singularity"
+
+    Example
+      Use the ``apptainer`` command.
+
+      .. code-block:: yaml
+
+        container_module: "apptainer"
+
+
+Starter def file
+................
+
+This is a ``.def`` file that we've tested this feature with.
+You can use this as an example to start and update as required.
+
+
+.. note::
+  Note that we're installing turbovnc and websockify *inside*
+  the container. This is important as all processes will run
+  inside the contianer and not on the host.
+
+  You can still install these on the host machine, but they will
+  need to be mounted inside the container as the processes are
+  expected to be ran *inside* the container.
+
+.. code-block:: singularity
+
+  Bootstrap: docker
+
+  From: rockylinux/rockylinux:8
+
+  %environment
+    PATH=/opt/TurboVNC/bin:$PATH
+    LANGUAGE="en_US.UTF-8"
+    LC_ALL="en_US.UTF-8"
+    LANG="en_US.UTF-8"
+
+  %post   
+      dnf install -y epel-release
+      dnf groupinstall -y xfce
+      dnf install -y python3-pip xorg-x11-xauth
+      pip3 install ts
+      dnf install -y https://yum.osc.edu/ondemand/latest/compute/el8Server/x86_64/python3-websockify-0.10.0-1.el8.noarch.rpm
+      dnf install -y https://yum.osc.edu/ondemand/latest/compute/el8Server/x86_64/turbovnc-2.2.5-1.el8.x86_64.rpm
+      dnf clean all
+      chown root:root /opt/TurboVNC/etc/turbovncserver-security.conf
+      rm -rf /var/cache/dnf/*

latest/how-tos/app-development/interactive.html

@@ -286,7 +286,7 @@
 </li>
 <li class="toctree-l1"><a class="reference internal" href="interactive/submit.html">Job Submission (submit.yml.erb)</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="interactive/submit.html#configuration">Configuration</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="interactive/submit.html#configure-batch-connect">Configure Batch Connect</a></li>
+<li class="toctree-l3"><a class="reference internal" href="interactive/submit.html#batch-connect-template-types">Batch Connect Template types</a></li>
 <li class="toctree-l3"><a class="reference internal" href="interactive/submit.html#configure-script">Configure Script</a></li>
 </ul>
 </li>

latest/how-tos/app-development/interactive/submit.html

@@ -315,18 +315,33 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
 
 <p>Each of these configuration options take a set of their own configuration
 options described below.</p>
-<div class="section" id="configure-batch-connect">
-<h3>Configure Batch Connect<a class="headerlink" href="#configure-batch-connect" title="Permalink to this headline">¶</a></h3>
-<p>All batch scripts are generated from either the <code class="docutils literal notranslate"><span class="pre">basic</span></code> template or the
-<code class="docutils literal notranslate"><span class="pre">vnc</span></code> template specified with the following configuration option:</p>
+<div class="section" id="batch-connect-template-types">
+<h3>Batch Connect Template types<a class="headerlink" href="#batch-connect-template-types" title="Permalink to this headline">¶</a></h3>
+<p>Open OnDemand has three distinct batch connect template types.
+These template types determine the resulting shell scripts that wrap
+your batch connect application.</p>
+<p>For example the <code class="docutils literal notranslate"><span class="pre">vnc</span></code> type will provide a script that boots up a
+VNC server, exports a <code class="docutils literal notranslate"><span class="pre">DISPLAY</span></code> variable and other utilities to
+ensure that the job has been bootstrapped appropriately to
+start GUI applications.</p>
+<p>The options available are <code class="docutils literal notranslate"><span class="pre">basic</span></code>, <code class="docutils literal notranslate"><span class="pre">vnc</span></code> or <code class="docutils literal notranslate"><span class="pre">vnc_container</span></code>.
+<code class="docutils literal notranslate"><span class="pre">vnc_container</span></code> is basically just like <code class="docutils literal notranslate"><span class="pre">vnc</span></code> only in that it
+boostraps the VNC programs inside a container instead of on the
+host machine.</p>
 <dl class="describe">
 <dt>
 <code class="sig-name descname">template (String)</code></dt>
-<dd><p>the template used for rendering the batch script (<code class="docutils literal notranslate"><span class="pre">&quot;basic&quot;</span></code> or <code class="docutils literal notranslate"><span class="pre">&quot;vnc&quot;</span></code>)</p>
+<dd><p>The template used to create the wrapper script for your batch connect
+application.</p>
 <dl>
-<dt>Default</dt><dd><p><code class="docutils literal notranslate"><span class="pre">&quot;basic&quot;</span></code></p>
+<dt>Default</dt><dd><p>Generate a basic wrapper script for HTTP applications.</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nn">---</span><span class="w"></span>
+<span class="nt">batch_connect</span><span class="p">:</span><span class="w"></span>
+<span class="w">  </span><span class="nt">template</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;basic&quot;</span><span class="w"></span>
+</pre></div>
+</div>
 </dd>
-<dt>Example</dt><dd><p>Render a batch script for a VNC Interactive Application</p>
+<dt>Example</dt><dd><p>Generate a wrapper script for a VNC interactive application.</p>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="c1"># ${HOME}/ondemand/dev/my_app/submit.yml.erb</span><span class="w"></span>
 <span class="nn">---</span><span class="w"></span>
 <span class="nt">batch_connect</span><span class="p">:</span><span class="w"></span>

latest/reference/files/submit-yml-erb.html

@@ -131,6 +131,7 @@
 <li class="toctree-l2 current"><a class="current reference internal" href="#">submit.yml.erb</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="submit-yml/basic-bc-options.html">Basic Batch Connect Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="submit-yml/vnc-bc-options.html">Batch Connect VNC Options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="submit-yml/vnc-container-bc-options.html">Batch Connect VNC Container Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="submit-yml/script.html">Batch Connect Script Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#simple-example">Simple Example</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#setting-batch-connect-options-globally">Setting Batch Connect Options Globally</a></li>
@@ -225,6 +226,10 @@
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="submit-yml/basic-bc-options.html">Basic Batch Connect Options</a></li>
 <li class="toctree-l1"><a class="reference internal" href="submit-yml/vnc-bc-options.html">Batch Connect VNC Options</a></li>
+<li class="toctree-l1"><a class="reference internal" href="submit-yml/vnc-container-bc-options.html">Batch Connect VNC Container Options</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="submit-yml/vnc-container-bc-options.html#starter-def-file">Starter def file</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="submit-yml/script.html">Batch Connect Script Options</a></li>
 </ul>
 </div>

latest/reference/files/submit-yml/basic-bc-options.html

@@ -131,6 +131,7 @@
 <li class="toctree-l2 current"><a class="reference internal" href="../submit-yml-erb.html">submit.yml.erb</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">Basic Batch Connect Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="vnc-bc-options.html">Batch Connect VNC Options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="vnc-container-bc-options.html">Batch Connect VNC Container Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="script.html">Batch Connect Script Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../submit-yml-erb.html#simple-example">Simple Example</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../submit-yml-erb.html#setting-batch-connect-options-globally">Setting Batch Connect Options Globally</a></li>

latest/reference/files/submit-yml/script.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="ood-portal-generator" href="../../commands/ood-portal-generator.html" />
-    <link rel="prev" title="Batch Connect VNC Options" href="vnc-bc-options.html" />
+    <link rel="prev" title="Batch Connect VNC Container Options" href="vnc-container-bc-options.html" />
 
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-34776817-3"></script>
 <script>
@@ -131,6 +131,7 @@
 <li class="toctree-l2 current"><a class="reference internal" href="../submit-yml-erb.html">submit.yml.erb</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="basic-bc-options.html">Basic Batch Connect Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="vnc-bc-options.html">Batch Connect VNC Options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="vnc-container-bc-options.html">Batch Connect VNC Container Options</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">Batch Connect Script Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../submit-yml-erb.html#simple-example">Simple Example</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../submit-yml-erb.html#setting-batch-connect-options-globally">Setting Batch Connect Options Globally</a></li>
@@ -687,7 +688,7 @@
         <a href="../../commands/ood-portal-generator.html" class="btn btn-neutral float-right" title="ood-portal-generator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="vnc-bc-options.html" class="btn btn-neutral float-left" title="Batch Connect VNC Options" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="vnc-container-bc-options.html" class="btn btn-neutral float-left" title="Batch Connect VNC Container Options" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>
 

latest/reference/files/submit-yml/vnc-bc-options.html

@@ -39,7 +39,7 @@
   <link rel="stylesheet" href="../../../_static/tabs.css" type="text/css" />
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="Batch Connect Script Options" href="script.html" />
+    <link rel="next" title="Batch Connect VNC Container Options" href="vnc-container-bc-options.html" />
     <link rel="prev" title="Basic Batch Connect Options" href="basic-bc-options.html" />
 
 <script async src="https://www.googletagmanager.com/gtag/js?id=UA-34776817-3"></script>
@@ -131,6 +131,7 @@
 <li class="toctree-l2 current"><a class="reference internal" href="../submit-yml-erb.html">submit.yml.erb</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="basic-bc-options.html">Basic Batch Connect Options</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">Batch Connect VNC Options</a></li>
+<li class="toctree-l3"><a class="reference internal" href="vnc-container-bc-options.html">Batch Connect VNC Container Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="script.html">Batch Connect Script Options</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../submit-yml-erb.html#simple-example">Simple Example</a></li>
 <li class="toctree-l3"><a class="reference internal" href="../submit-yml-erb.html#setting-batch-connect-options-globally">Setting Batch Connect Options Globally</a></li>
@@ -453,7 +454,7 @@
 
     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 
-        <a href="script.html" class="btn btn-neutral float-right" title="Batch Connect Script Options" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
+        <a href="vnc-container-bc-options.html" class="btn btn-neutral float-right" title="Batch Connect VNC Container Options" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
         <a href="basic-bc-options.html" class="btn btn-neutral float-left" title="Basic Batch Connect Options" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>