Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 49cf0fe.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Jan 3, 2025
1 parent 6d84f9d commit 270f9d5
Show file tree
Hide file tree
Showing 7 changed files with 164 additions and 36 deletions.
Binary file added develop/_images/4.0_file_editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,8 @@ Here we have a checkbox ``enable_cuda_version`` that will show
data:
hide-cuda-version-when-un-checked: true
.. _dynamic-bc-apps-data-label:

Dynamic Element Labels
**********************

Expand Down
76 changes: 71 additions & 5 deletions develop/_sources/release-notes/v4.0-release-notes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ Additionally, we want to thank Robin Karlsson at CSC - IT Center for Science for

We'd also like to give a big thank you to those listed below for their first time contributing to this release:

* ``NucciTheBoss`` made their first contribution in #3371
* ``codecat555`` made their first contribution in #3424
* ``avivkeller`` made their first contribution in #3544
* ``ashton22305`` made their first contribution in #3549
* ``TheGamer1002`` made their first contribution in #3619
* ``ryanbcox`` made their first contribution in #3677
* ``giuliolibrando`` made their first contribution in #3776
* ``guruevi`` made their first contribution in #3795
* ``euler-room`` made their first contribution in #3866
* ``ahmed-mgd`` made their first contribution in #3973


Breaking Changes
Expand Down Expand Up @@ -134,6 +144,20 @@ SELinux Changes
New Features and Enhancements
-----------------------------

Requied Announcements.
......................

:ref:`configure_announcements` have been updated in 4.0 as seen in `Announcements Are Dismissible by Default.`_
breaking change above.

Along with that breaking change, there is also a very exciting feature you now use:
*required* announcements.

*Required* annoucments must be accepted before any page can be loaded. This is useful
to present users with a Terms of Service (TOS) or End User License Agreement (EULA)
or similar. The users will not be able to do anything with Open OnDemand until they've
accepted this annoucments.

Global Batch Connect Items
..........................

Expand All @@ -151,6 +175,10 @@ for noVNC batch connect applications using the two ``ondemand.d``
properties :ref:`novnc_default_compression <novnc_default_compression>`
and :ref:`novnc_default_quality <novnc_default_quality>`.

Prior versions of Open OnDemand had these default values hard coded.
Now sites can set these defaults if they wish to provide their users
with higher quality defaults, for example.

Batch Connect Sessions Poll Delay
.................................

Expand All @@ -161,15 +189,15 @@ every 10 seconds by default.
Sites that wish to change this behavior must use the hidden environment
variable ``POLL_DELAY``.

In version 4.0, this setting is now a documented configuration, with ``POLL_DELAY`` being
deprecated. See :ref:`the bc_sessions_poll_delay documentation <bc_sessions_poll_delay>`
In version 4.0, this setting is now a documented configuration, with the
hidden environment variable ``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.
Your center may have deployed the `OSC System Status Application`_.

Version 4.0 now includes this application natively, though it
currently supports only Slurm clusters.
Expand All @@ -193,13 +221,32 @@ the form item or ``false`` to show the form item.

Responding to ``false`` is new feature in version 4.0.

This was added as a convenience for some forms

New data-label Directive.
.........................

Version 4.0 adds the ``data-label`` directive. This is used to update
the help text on a given form when certain choices are made. An example of
may be a ``node_type`` select widget that can change it's help text based
on which node type the user has selected.

:ref:`dynamic-bc-apps-data-label` is the complete documentation for this
feature.

User Mapping Now Accepts User Identifiers.
..........................................

User mapping scripts can now return a UID instead of a username.
This is particularly useful for centers that have multiple domains where
username collisions may occur.

For example if the two users ``annie.oakley@osc.edu`` and ``annie.oakley@caltech.edu``
both *incorrectly* map to the user ``annie.oakley``, you will now be able to return
the unique number that is their UID (User Identifier) and therefore have
no collisions.


Interactive Apps Can Have a Text Header.
........................................

Expand All @@ -225,12 +272,17 @@ XDMoD Efficiency Widget Update
XDMoD job details widget now displays job efficiency calculations
for CPU usage, memory usage and elapsed time.

Prior versions of Open OnDemand only showed efficiency calculations
for CPU.

Edit and Delete Interactive Application Saved Settings
......................................................

Since launching saved settings for interactive applications
in version 3.1, version 4.0 now offers the ability to edit and delete
these saved settings.
these saved settings. This gives your users the ability to maintain
their saved settings whereas in prior releases they could only create
them, not edit or delete them.

See :ref:`edit-save-interactive-app-saved-settings` for more
details.
Expand All @@ -248,6 +300,18 @@ valid users on that system.
This change ensures that centers that delete users (by removing them from LDAP)
will also clean up related processes on the OnDemand machine.

File Editor Interface Update.
.............................

The interface for the file editor has been updated. Users will note
that this page now has the navigation bar. The previous navigation
bar entires have been moved to the left.

The figure below is an image of how the file editor appears in 4.0.

.. figure:: /images/4.0_file_editor.png
:alt: An image showing the file editor as it appears in 4.0 with the Open OnDemand navigation bar and a new panel to the left for saving and other file editor specific options.

Upgrade Instructions
--------------------

Expand Down Expand Up @@ -409,3 +473,5 @@ Upgrade Instructions
.. code-block:: sh
sudo dnf downgrade mod_auth_openidc
.. _OSC System Status application: https://github.com/osc/osc-systemstatus.
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ <h2>Hiding entire elements<a class="headerlink" href="#hiding-entire-elements" t
</div>
</section>
<section id="dynamic-element-labels">
<h2>Dynamic Element Labels<a class="headerlink" href="#dynamic-element-labels" title="Link to this heading"></a></h2>
<span id="dynamic-bc-apps-data-label"></span><h2>Dynamic Element Labels<a class="headerlink" href="#dynamic-element-labels" title="Link to this heading"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">data-label-*</span></code> directive allows you to change the label of another
form element based on the selected option in a select widget.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">attributes</span><span class="p">:</span>
Expand Down
Binary file modified develop/objects.inv
Binary file not shown.
Loading

0 comments on commit 270f9d5

Please sign in to comment.