[ci skip] Autodoc commit for f9f8523.

develop/_sources/reference/files/ondemand-d-ymls.rst.txt

@@ -989,3 +989,24 @@ Configuration Properties
     .. code-block:: yaml
 
       bc_sessions_poll_delay: 30000
+
+.. _status_poll_delay:
+
+.. describe:: status_poll_delay (Integer, 10000)
+
+  How long the client browser should wait, in milliseconds,
+  to update the system status page.
+
+  Default
+    The default poll delay of 10000 (10 seconds).
+
+    .. code-block:: yaml
+
+      status_poll_delay: 10000
+
+  Example
+    Increase the poll delay to 30000 (30 seconds).
+
+    .. code-block:: yaml
+
+      status_poll_delay: 30000

develop/_sources/release-notes/v4.0-release-notes.rst.txt

@@ -13,6 +13,8 @@ New Features
 
 - `Global Batch Connect items`_
 - `noVNC quality and compression defaults`_
+- `Batch connect sessions poll delay`_
+- `System Status application`_
 
 Thanks!
 -------
@@ -136,3 +138,24 @@ variable ``POLL_DELAY``.
 In 4.0 this is a documented configuration with ``POLL_DELAY`` being
 deprecated. See :ref:`the bc_sessions_poll_delay documentation <bc_sessions_poll_delay>`
 for more details.
+
+System Status application
+.........................
+
+Your center may have deployed OSC's system status application:
+https://github.com/osc/osc-systemstatus.
+
+4.0 now ships with this application natively, though it
+only supports Slurm clusters in this release.
+
+Here's an example image from OSC detailing the system status of
+our clusters.
+
+.. figure:: /images/system-status.png
+    :alt: An image showing the system status application. There are 4 panels for each cluster. Each panel shows the number of nodes available, cores available, GPUs available jobs running and jobs queued. It also shows percentages available for nodes, cores and GPUs.
+
+This application will poll for updates at regular intervals to automatically
+update the page. The default is 10 seconds. See :ref:`the documentation on status_poll_dela <status_poll_delay>`
+for more details.
+
+Visit :ref:`disabling_applications` to disable this application.

develop/reference/files/ondemand-d-ymls.html

@@ -1179,6 +1179,25 @@
 </dl>
 </dd></dl>
 
+<span class="target" id="status-poll-delay"></span><dl class="describe">
+<dt>
+<code class="sig-name descname">status_poll_delay (Integer, 10000)</code></dt>
+<dd><p>How long the client browser should wait, in milliseconds,
+to update the system status page.</p>
+<dl>
+<dt>Default</dt><dd><p>The default poll delay of 10000 (10 seconds).</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">status_poll_delay</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10000</span><span class="w"></span>
+</pre></div>
+</div>
+</dd>
+<dt>Example</dt><dd><p>Increase the poll delay to 30000 (30 seconds).</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">status_poll_delay</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">30000</span><span class="w"></span>
+</pre></div>
+</div>
+</dd>
+</dl>
+</dd></dl>
+
 </div>
 </div>
 

develop/release-notes/v4.0-release-notes.html

@@ -144,6 +144,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#global-batch-connect-items">Global Batch Connect items</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#novnc-quality-and-compression-defaults">noVNC quality and compression defaults</a></li>
 <li class="toctree-l4"><a class="reference internal" href="#batch-connect-sessions-poll-delay">Batch connect sessions poll delay</a></li>
+<li class="toctree-l4"><a class="reference internal" href="#system-status-application">System Status application</a></li>
 </ul>
 </li>
 </ul>
@@ -245,6 +246,8 @@ <h2>New Features<a class="headerlink" href="#new-features" title="Permalink to t
 <ul class="simple">
 <li><p><a class="reference internal" href="#global-batch-connect-items">Global Batch Connect items</a></p></li>
 <li><p><a class="reference internal" href="#novnc-quality-and-compression-defaults">noVNC quality and compression defaults</a></p></li>
+<li><p><a class="reference internal" href="#batch-connect-sessions-poll-delay">Batch connect sessions poll delay</a></p></li>
+<li><p><a class="reference internal" href="#system-status-application">System Status application</a></p></li>
 </ul>
 </div>
 <div class="section" id="thanks">
@@ -378,6 +381,22 @@ <h3>Batch connect sessions poll delay<a class="headerlink" href="#batch-connect-
 deprecated. See <a class="reference internal" href="../reference/files/ondemand-d-ymls.html#bc-sessions-poll-delay"><span class="std std-ref">the bc_sessions_poll_delay documentation</span></a>
 for more details.</p>
 </div>
+<div class="section" id="system-status-application">
+<h3>System Status application<a class="headerlink" href="#system-status-application" title="Permalink to this headline">¶</a></h3>
+<p>Your center may have deployed OSC’s system status application:
+<a class="reference external" href="https://github.com/osc/osc-systemstatus">https://github.com/osc/osc-systemstatus</a>.</p>
+<p>4.0 now ships with this application natively, though it
+only supports Slurm clusters in this release.</p>
+<p>Here’s an example image from OSC detailing the system status of
+our clusters.</p>
+<div class="figure align-default">
+<img alt="An image showing the system status application. There are 4 panels for each cluster. Each panel shows the number of nodes available, cores available, GPUs available jobs running and jobs queued. It also shows percentages available for nodes, cores and GPUs." src="../_images/system-status.png" />
+</div>
+<p>This application will poll for updates at regular intervals to automatically
+update the page. The default is 10 seconds. See <a class="reference internal" href="../reference/files/ondemand-d-ymls.html#status-poll-delay"><span class="std std-ref">the documentation on status_poll_dela</span></a>
+for more details.</p>
+<p>Visit <a class="reference internal" href="../customizations.html#disabling-applications"><span class="std std-ref">Disabling applications</span></a> to disable this application.</p>
+</div>
 </div>
 </div>