From 733834f1ec2586cfa151fb5e1b389df5954a57bc Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Wed, 15 Jan 2025 10:32:50 -0500 Subject: [PATCH 01/14] fix this pages mispellings --- source/release-notes/v1.5-release-notes.rst | 34 ++++++++++----------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/source/release-notes/v1.5-release-notes.rst b/source/release-notes/v1.5-release-notes.rst index 599907cd1..a145c69bf 100644 --- a/source/release-notes/v1.5-release-notes.rst +++ b/source/release-notes/v1.5-release-notes.rst @@ -47,12 +47,12 @@ Upgrading from v1.4 ``/opt/rh/httpd24/root/etc/httpd/conf.d/ood-portal.conf`` being modified. Your previous ``ood-portal.conf`` file will be copied to a backup in the same directory, which you may need to restore if you have made custom modifications to this file. - Ensure that the resulting ``ood-portal.conf`` Apache config has ``SetEnv OOD_PUN_SOCKET_ROOT "/var/run/nginx"`` + Ensure that the resulting ``ood-portal.conf`` Apache configuration has ``SetEnv OOD_PUN_SOCKET_ROOT "/var/run/nginx"`` changed to ``SetEnv OOD_PUN_SOCKET_ROOT "/var/run/ondemand-nginx"``. .. warning:: - The nginx RPM used by ondemand in 1.4 is no longer maintained. If you use nginx outside of OnDemand it's recommended to re-install using nginx from repositories such as EPEL after upgrading OnDemand to 1.5. + The Nginx RPM used by ondemand in 1.4 is no longer maintained. If you use Nginx outside of OnDemand it's recommended to re-install using Nginx from repositories such as EPEL after upgrading OnDemand to 1.5. .. code-block:: sh @@ -66,9 +66,9 @@ Upgrading from v1.4 #. Clean up NGINX directories from prior versions of OOD - The ondemand RPM should have copied all the nginx configurations, tmp files and logs from their previous locations to their new locations if the defaults were not changed. Once the functionality of the OnDemand 1.5 upgrade is verified it is safe to remove these old paths. + The ondemand RPM should have copied all the Nginx configurations, temporary files and logs from their previous locations to their new locations if the defaults were not changed. Once the functionality of the OnDemand 1.5 upgrade is verified it is safe to remove these old paths. - .. warning:: If the host running OnDemand has other applications using NGINX then special care needs to be taken not to delete files belonging to the other applications. + .. warning:: If the host running OnDemand has other applications using Nginx then special care needs to be taken not to delete files belonging to the other applications. .. code-block:: sh @@ -110,7 +110,7 @@ Upgrading from v1.3 ``/opt/rh/httpd24/root/etc/httpd/conf.d/ood-portal.conf`` being modified. Your previous ``ood-portal.conf`` file will be copied to a backup in the same directory, which you may need to restore if you have made custom modifications to this file. - Ensure that the resulting ``ood-portal.conf`` Apache config has ``SetEnv OOD_PUN_SOCKET_ROOT "/var/run/nginx"`` + Ensure that the resulting ``ood-portal.conf`` Apache configuration has ``SetEnv OOD_PUN_SOCKET_ROOT "/var/run/nginx"`` changed to ``SetEnv OOD_PUN_SOCKET_ROOT "/var/run/ondemand-nginx"``. #. Optionally remove dependencies from prior versions of OOD @@ -119,9 +119,9 @@ Upgrading from v1.3 sudo yum remove nodejs010\* rh-passenger40\* rh-ruby22\* nginx16\* git19\* v8314\* -#. Clean up NGINX directories from prior versions of OOD +#. Clean up Nginx directories from prior versions of OOD - The ondemand RPM should have copied all the nginx configurations, tmp files and logs from their previous locations to their new locations if the defaults were not changed. Once the functionality of the OnDemand 1.5 upgrade is verified it is safe to remove these old paths. + The ondemand RPM should have copied all the Nginx configurations, temporary files and logs from their previous locations to their new locations if the defaults were not changed. Once the functionality of the OnDemand 1.5 upgrade is verified it is safe to remove these old paths. .. warning:: If the host running OnDemand has other applications using NGINX then special care needs to be taken not to delete files belonging to the other applications. @@ -131,7 +131,7 @@ Upgrading from v1.3 sudo rm -rf /var/lib/nginx/tmp/* sudo rm -rf /var/log/nginx/* -#. Rebuild any custom Node.js or Ruby apps +#. Rebuild any custom NodeJS or Ruby apps Since we upgraded to Ruby 2.4 from 2.2 and NodeJS 0.10 to NodeJS 6 any custom Passenger apps in Ruby or NodeJS that have their dependencies installed in @@ -160,7 +160,7 @@ Upgrading from v1.3 #. Verify Navbar contains all the apps you want. The behavior changed from 1.3 to 1.5 so by default all categories of any sys - app found appear as dropdown menus without the need for configuration changes. + app found appear as drop-down menus without the need for configuration changes. As a result menus may appear that you do not expect, if previously you were relying @@ -178,7 +178,7 @@ Upgrading from v1.3 Infrastructure Version Changes ------------------------------ -OnDemand's infrastructure components have been merged into a monolithic repository. Component changelogs have been frozen and the parent repository will now track all infrastructure changes: `OnDemand 1.5.2 `__. `Diff with 1.4.10 `__ +OnDemand's infrastructure components have been merged into a monolithic repository. Component change-logs have been frozen and the parent repository will now track all infrastructure changes: `OnDemand 1.5.2 `__. `Diff with 1.4.10 `__ Application Version Changes @@ -217,10 +217,10 @@ it was updated from for each of the system web applications in this release. Details ------- -Add ondemand SCL and use SCL nginx and passenger +Add ondemand SCL and use SCL Nginx and passenger ................................................ -This upgrade adds a new ``ondemand`` software collection that is the only software collection needed to interact with OnDemand. This new softare collection will load all the collections needed by OnDemand. The Passenger and NGINX dependencies have been repackaged under this new ``ondemand`` SCL so those packages will no longer interfere with Passenger of NGINX packages from other repositories. +This upgrade adds a new ``ondemand`` software collection that is the only software collection needed to interact with OnDemand. This new software collection will load all the collections needed by OnDemand. The Passenger and NGINX dependencies have been repackaged under this new ``ondemand`` SCL so those packages will no longer interfere with Passenger of NGINX packages from other repositories. .. warning:: @@ -232,7 +232,7 @@ This upgrade adds a new ``ondemand`` software collection that is the only softwa .. warning:: - nginx_stage now loads the ``ondemand`` SCL via ``/opt/ood/nginx_stage/etc/profile`` before loading ``/etc/ood/profile``. + ``nginx_stage`` now loads the ``ondemand`` SCL via ``/opt/ood/nginx_stage/etc/profile`` before loading ``/etc/ood/profile``. .. code:: @@ -264,7 +264,7 @@ Easier customization of home page text ...................................... Using Rails support for internationalization, we localized the html that -shows the logo and tagline on the OnDemand home page, as well as the motd +shows the logo and tagline on the OnDemand home page, as well as the MOTD section title. This enables admins to configure most of the home page html and MOTD section title @@ -278,7 +278,7 @@ RStudio with varying versions of R ................................................ We added a new tutorial for setting up a Singularity based RStudio interactive -app that replaces the need for proot and enables the version of RStudio and the +app that replaces the need for ``proot`` and enables the version of RStudio and the version of R to vary. See :ref:`app-development-tutorials-rstudio` for details. @@ -287,7 +287,7 @@ Peer to peer app sharing ................................................ Added documentation on peer to peer app sharing, a feature that when enabled -allows privleged users to deploy OnDemand apps, both Passenger and Interactive, +allows privileged users to deploy OnDemand apps, both Passenger and Interactive, to their home directory (or another directory specified by the admin) so that other users (peers) can launch these apps. This is also known as "executable sharing" because it is similar to how a user can add another user's script to @@ -298,6 +298,6 @@ See :ref:`app_sharing` for details. Documentation update for Keycloak and Duo ................................................ -Updated :ref:`authentication-tutorial-oidc-keycloak-rhel7` for Keycloak 4.8.3. Added documenation on setting up two factor authentication using Duo with Keycloak via SSSD (see :ref:`authentication-duo-2fa-with-keycloak`). +Updated :ref:`authentication-tutorial-oidc-keycloak-rhel7` for Keycloak 4.8.3. Added documentation on setting up two factor authentication using Duo with Keycloak via SSSD (see :ref:`authentication-duo-2fa-with-keycloak`). .. _Release 1.4 navbar config: https://osc.github.io/ood-documentation/release-1.4/customization.html#dashboard-navbar-config \ No newline at end of file From 3d6ea9304c81c6a21107395cd8d03569bef955b2 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Wed, 15 Jan 2025 10:47:09 -0500 Subject: [PATCH 02/14] fix this pages mispellings --- source/release-notes/v1.8-release-notes.rst | 40 ++++++++++----------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/source/release-notes/v1.8-release-notes.rst b/source/release-notes/v1.8-release-notes.rst index 773494f93..3882c7a74 100644 --- a/source/release-notes/v1.8-release-notes.rst +++ b/source/release-notes/v1.8-release-notes.rst @@ -14,7 +14,7 @@ Highlights in 1.8: - `Batch Connect apps now support disabling caching on fields`_ - `Extended view support for GridEngine clusters`_ - `Torque and Slurm schedulers now support QoS fields`_ -- `Shell hosts are now protected behind allowlists`_ +- `Shell hosts are now protected behind allow-lists`_ - `Chinese localization`_ - `Ability to add additional info to batch connect app`_ - `Support for SVG dashboard logos`_ @@ -28,7 +28,7 @@ Special thanks -------------- Special thanks to https://github.com/374365283 and https://github.com/flybirdkh -of Shanghai Jiao Tong University (https://hpc.sjtu.edu.cn/) for `Chinese localization`_! +of ``Shanghai Jiao Tong University`` (https://hpc.sjtu.edu.cn/) for `Chinese localization`_! Thanks to `Ben Plessinger`_ and the whole `University of Buffalo Center for Computational Research`_ team for help in XDMoD @@ -39,9 +39,9 @@ Upgrading from v1.7 Before upgrading to v1.8, please consider the following: -.. warning:: Shell hosts are now protected behind allowlists. After upgrading, you may need to - set a default SSH host and add the compute nodes to the allowlists, as well as any other hosts - you want to enable access to through the Shell app that are not already specified in the cluster config. +.. warning:: Shell hosts are now protected behind allow-lists. After upgrading, you may need to + set a default SSH host and add the compute nodes to the allow-lists, as well as any other hosts + you want to enable access to through the Shell app that are not already specified in the cluster configuration. `See the entry in the release notes for more information. <#shell-hosts-are-now-protected-behind-allowlists>`_ @@ -101,7 +101,7 @@ Details Beta XDMoD integration in the dashboard ....................................... -If your site also uses `XDMoD`_ with the Job Performance module (formerlly called SUPReMM) for job performance analysis, +If your site also uses `XDMoD`_ with the Job Performance module (formerly called SUPReMM) for job performance analysis, you can configure OnDemandOpen OnDemand to display the Job Efficiency reports from XDMoD on the OnDemand dashboard. See the :ref:`documentation on enabling XDMoD integration ` for more details. @@ -114,15 +114,15 @@ See :ref:`Dex Authentication ` for details on OnDemand Dex. You no longer need to do ``DISABLE_SAFARI_BASIC_AUTH_WARNING=1`` and you can safely remove this from the configuration as this ENV var will be ignored. -Support mod_auth_openidc configuration via ood-portal-generator -............................................................... +Support ``mod_auth_openidc`` configuration via ood-portal-generator +................................................................... The Open OnDemand Portal :ref:`ood-portal-generator-configuration` file now supports defining `mod_auth_openidc`_ configurations directly. Beta CCQ Scheduler support .......................... -We now have beta `Cloudy Cluster`_ support for their ccq scheduler. You can find +We now have beta `Cloudy Cluster`_ support for their ``ccq`` scheduler. You can find :ref:`documentation on how to configure the cluster here `. Retain completed jobs panel for debugging @@ -145,7 +145,7 @@ Where previous configuration look like this, with only a single cluster. cluster: "my_cluster" Configurations will now accept an array like the example below. This will create a -dropdown select menu item at the top of the form where users can choose between +drop-down select menu item at the top of the form where users can choose between the two options. .. code-block:: yaml @@ -161,7 +161,7 @@ Batch Connect apps now support disabling caching on fields .......................................................... When a user submits the web form for an interactive app (batch connect) the form -values the user set are stored in a cache file that is used to pre-populate the web +values the user set are stored in a cache file that is used to prepopulate the web form in the future. In some cases, setting the default value of the form field to a previously used value is undesirable. You can now disable this caching feature for every app, on a per app basis, or on a per field basis. @@ -192,15 +192,15 @@ Torque and Slurm schedulers now support the quality of service (QoS) fields. In Torque this translates to ``-l qos=best`` and in Slurm it is ``--qos best``. -Shell hosts are now protected behind allowlists -............................................... +Shell hosts are now protected behind allow-lists +................................................ -Shell hosts are now protected behind allowlists. This means administrators now need -to explicitly add hosts to an allowlist for users to be able to access them through +Shell hosts are now protected behind allow-lists. This means administrators now need +to explicitly add hosts to an allow-list for users to be able to access them through the shell app. -Any login host of a cluster config will be allowed, assuming that cluster is not -configured as "hidden" in the metadata section of the cluster config. +Any login host of a cluster configuration will be allowed, assuming that cluster is not +configured as "hidden" in the metadata section of the cluster configuration. However, administrators will need to add a configuration for compute nodes and any additional hosts they wish to allow access to. @@ -229,7 +229,7 @@ in ``/etc/ood/config/nginx_stage.yml`` Ability to add additional info to batch connect app ................................................... -You can now add an info.html.erb file to an interactive app (batch connect) +You can now add an ``info.html.erb`` file to an interactive app (batch connect) directory and it will render and display in the job panel. This is useful for providing documentation links for an app.q :ref:`See the documentation on info.html.erb for more details. ` @@ -252,7 +252,7 @@ Better max file upload support .............................. While FILE_UPLOAD_MAX configuration has existed for some time, 1.8 adds the corresponding -nginx configuration so that sites can set the upload max to settings larger than 10 GiB. +Nginx configuration so that sites can set the upload max to settings larger than 10 GiB. :ref:`See the section in the customization page for more details. ` @@ -267,7 +267,7 @@ IE 11 support was officially dropped. See :ref:`Browser Requirements ` can now be run without needing to install gem dependencies into the application directory. The following gems were added for this purpose: .. code-block:: ruby From a74dc5cbc204fc2b501953443ac6a86d8eeb7fb3 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Wed, 15 Jan 2025 10:52:48 -0500 Subject: [PATCH 03/14] fix this pages mispellings --- source/release-notes/v4.0-release-notes.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/release-notes/v4.0-release-notes.rst b/source/release-notes/v4.0-release-notes.rst index 877b9c85d..e6a60f114 100644 --- a/source/release-notes/v4.0-release-notes.rst +++ b/source/release-notes/v4.0-release-notes.rst @@ -15,7 +15,7 @@ Thank you to all of the community members who contributed code, suggestions, bug We want to thank: -Leonard Wisniewski, Aday Bujeda, and Michael Reekie at Harvard University: Institute for Quantitative Social Science for their contributions around widgets for saved settings and XDMoD, required and dismissible announcements, a configurable number of applications in the apps table, modular support for custom Javascript files, and additional support for OnDemand extensions and customizations. +Leonard Wisniewski, Aday Bujeda, and Michael Reekie at Harvard University: Institute for Quantitative Social Science for their contributions around widgets for saved settings and XDMoD, required and dismissible announcements, a configurable number of applications in the apps table, modular support for custom JavaScript files, and additional support for OnDemand extensions and customizations. Robin Karlsson at CSC - IT Center for Science for his contributions around application cards, improving large file upload and allowlist handling, bug fixes for partial file paths and the file browser, and file success if chown fails and Simon Westersund at CSC - IT Center for Science for his contributions around cleaning PUNs and associated files of disabled users. @@ -135,10 +135,10 @@ This release updates the following dependencies: provided by the OnDemand RPM must be rebuilt or supply their own :ref:`nodejs_starter_app_wrapper` to use the older version of NodeJs. - .. warning:: Ubuntu 24.04 and Debian 12 are no longer supported on ppc64le due to NodeJS 20 not being available on that architecture. + .. warning:: Ubuntu 24.04 and Debian 12 are no longer supported on ``ppc64le`` due to NodeJS 20 not being available on that architecture. -.. warning:: OnDemand repos no longer provide ``mod_auth_openidc`` or ``cjose``. +.. warning:: OnDemand repositories no longer provide ``mod_auth_openidc`` or ``cjose``. SELinux Changes --------------- @@ -291,8 +291,8 @@ created but not modified or removed. See :ref:`edit-save-interactive-app-saved-settings` for more details. -nginx_clean Now Cleans PUNs for Disabled Users. -............................................... +``nginx_clean`` Now Cleans PUNs for Disabled Users. +................................................... The helper method ``nginx_clean`` in the ``nginx_stage`` library will now remove PUNs and associated files for users @@ -399,7 +399,7 @@ Upgrade Instructions sudo dnf install -y https://yum.osc.edu/ondemand/4.0/ondemand-release-web-4.0-1.amzn2023.noarch.rpm -#. (**RHEL/Rocky/AlmaLinux 8 & 9 only**) Enable dependency repos. +#. (**RHEL/Rocky/AlmaLinux 8 & 9 only**) Enable dependency repositories. .. code-block:: sh From dd0b70f803e14489db5c7218fce6a04ee8e1dcbe Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Wed, 15 Jan 2025 11:17:47 -0500 Subject: [PATCH 04/14] fix this pages mispellings --- source/release-notes/v1.3-release-notes.rst | 38 ++++++++++----------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/source/release-notes/v1.3-release-notes.rst b/source/release-notes/v1.3-release-notes.rst index 96b5b3284..948d32370 100644 --- a/source/release-notes/v1.3-release-notes.rst +++ b/source/release-notes/v1.3-release-notes.rst @@ -7,9 +7,9 @@ Highlights in 1.3: - `RPM based installation`_ - `Store configuration under /etc instead of under app directories`_ -- `Config changes no longer require app rebuilds`_ -- `Xfce support Interactive Desktops`_ -- `Cluster config verification script`_ +- `Configuration changes no longer require app rebuilds`_ +- `XFCE support Interactive Desktops`_ +- `Cluster configuration verification script`_ - `Ignore apps if they have a period in directory name`_ - `Enable multiple Dashboard announcements with embedded HTML`_ - `Open "help" links in new window`_ @@ -235,7 +235,7 @@ RPM based installation This is the biggest change and constitutes the bulk of this release's work. RPM based installation will now be the default and documented way to install and -update OnDemand. The latest rpms that are in use at OSC can be accessed from +update OnDemand. The latest RPMs that are in use at OSC can be accessed from https://yum.osc.edu/ondemand/latest/ and the stable releases will be available in specific release version directories, such as https://yum.osc.edu/ondemand/1.3/. @@ -248,32 +248,32 @@ configuration for OnDemand: 1. All configuration can be moved to files under /etc/ood 2. Modifications to configuration only require Passenger app, Per User NINGX, - or Apache server restart (with the exception of the ood-portal-generater - config) + or Apache server restart (with the exception of the ood-portal-generator + configuration) Since all configuration is stored under /etc/ood this directory can be easily managed by Puppet or versioned in a git repository. -Config changes no longer require app rebuilds +Configuration changes no longer require app rebuilds .................................................................. It is now much faster to make and test configuration changes. For most configuration changes, you can make the change and then select "Restart Web -Server" from the "Help" or "Develop" dropdown to see the change. +Server" from the "Help" or "Develop" drop-down to see the change. -Xfce support Interactive Desktops +XFCE support Interactive Desktops .................................................................. -We now have documentation for enabling Xfce 4+ as the desktop environment for -OnDemand Interactive Desktops. Xfce is the desktop environment we now use +We now have documentation for enabling XFCE 4+ as the desktop environment for +OnDemand Interactive Desktops. XFCE is the desktop environment we now use internally at OSC. See :ref:`enable-desktops-modify-form-attributes` for -documentation on how to use Xfce in OnDemand. +documentation on how to use XFCE in OnDemand. -Cluster config verification script +Cluster configuration verification script .................................................................. A Rake task has been added to the Dashboard app that will submit and check the -status of jobs for each cluster specified in the cluster config. This provides +status of jobs for each cluster specified in the cluster configuration. This provides a quick way to verify that OnDemand has been properly configured for a new cluster and should speed up installation. See :ref:`resource-manager-test` in the cluster configuration documentation for more details. @@ -289,13 +289,13 @@ directory in the app deployment directory, e.g., :file:`../.hidden-app/`. Enable multiple Dashboard announcements with embedded HTML .................................................................. -Site-wide dashboard announcement support in OnDemand has been expanded. Orinally we supported a file ``/etc/ood/config/announcement.md`` but now a YAML file ``/etc/ood/config/announcement.yml`` can be used. A collection of markdown and yaml announcements in ``/etc/ood/config/announcements.d/`` can be added. The yaml file provides extra benefits: +Site-wide dashboard announcement support in OnDemand has been expanded. Originally we supported a file ``/etc/ood/config/announcement.md`` but now a YAML file ``/etc/ood/config/announcement.yml`` can be used. A collection of markdown and YAML announcements in ``/etc/ood/config/announcements.d/`` can be added. The YAML file provides extra benefits: -#. Pre process file using ERB so that ERB tags can provide per-request dynamic modification of the announcement +#. Preprocess file using ERB so that ERB tags can provide per-request dynamic modification of the announcement #. Control the color of announcement with ``:type`` which is the Bootstrap alert name (``warning``, ``info``, ``success``, or ``danger``) #. Control whether announcement appears or not by setting ``:msg`` to a string or ``nil`` -The ability to use ERB means we can set the msg to nil after a certain time period. For example: +The ability to use ERB means we can set the ``msg`` to nil after a certain time period. For example: .. code-block:: erb @@ -333,7 +333,7 @@ Better debugging of Interactive Apps by logging shell commands .................................................................. Whenever an Interactive Session is started from the Dashboard, the shell -command used to submit the job is logged to the user's NGINX config to help +command used to submit the job is logged to the user's NGINX configuration to help with debugging Interactive Apps. Job Composer: Optionally hide Account field in Job Options @@ -345,7 +345,7 @@ resource manager (whether it is ``-A`` or ``-P`` or ``--account``, etc.). Howeve sites do not use this, and others use different mechanisms for accounting. Long term we want to support flexible configuration of this web form, but for now we have added the ability to hide this Account field from the web form. This field -is hidden by adding to the Job Composer's env file: +is hidden by adding to the Job Composer's ``env`` file: ``OOD_SHOW_JOB_OPTIONS_ACCOUNT_FIELD=0`` Active Jobs: display list of nodes that a job is running on From ceba7c1fd322393f7c88fb57e94b4b6126626bf7 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Wed, 15 Jan 2025 11:36:51 -0500 Subject: [PATCH 05/14] fix this pages mispellings --- source/release-notes/v1.7-release-notes.rst | 34 ++++++++++----------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/source/release-notes/v1.7-release-notes.rst b/source/release-notes/v1.7-release-notes.rst index eb2c3600b..7fbae496f 100644 --- a/source/release-notes/v1.7-release-notes.rst +++ b/source/release-notes/v1.7-release-notes.rst @@ -19,7 +19,7 @@ Highlights in 1.7: - `Regenerate ood-portal.conf with every apache restart`_ - `Support sanitizing job names`_ - `nginx_clean support for a specific user`_ -- `Dashboard now alerts on malformed cluster configs`_ +- `Dashboard now alerts on malformed cluster configurations`_ - `Job composer now shows suggested scripts`_ - `Add ability to disable SSH to compute node link in batch connect session card`_ - `Reduced installation size by 30 percent`_ @@ -193,7 +193,7 @@ See :ref:`these docs ` on how to configure and enable this fea Titles for Files menu entries ............................. -The shortcuts in the files dropdown menu can now show an optional title along with the +The shortcuts in the files drop-down menu can now show an optional title along with the directory path. The :ref:`original documentation ` on this feature has been updated to reflect the new options. @@ -231,10 +231,10 @@ Regenerate ood-portal.conf with every apache restart .................................................... Systemd will now regenerate the ood-portal.conf before every apache restart. This means -administrators can now edit the ``ood_portal.yml`` configuration and then restart httpd +administrators can now edit the ``ood_portal.yml`` configuration and then restart ``httpd`` directly without having to do the additional step of running the ``ood-portal-generator``. -Apache httpd will read the new configuration, because a new ood-portal.conf will have +Apache ``httpd`` will read the new configuration, because a new ood-portal.conf will have been written just before restarting. However you will have to follow the upgrade instructions (above), and then this will @@ -253,18 +253,18 @@ characters from being used in job names. For example if you do not want to use names (as is the case with some :ref:`Grid Engine ` versions) you would set ``OOD_JOB_NAME_ILLEGAL_CHARS: '/'`` in the ``pun_custom_env`` attribute of ``nginx_stage.yml``. -nginx_clean support for a specific user -....................................... +``nginx_clean`` support for a specific user +............................................ The ``nginx_stage nginx_clean`` command now supports a ``-u`` or ``--user`` option so it may -kill a specific users' PUN. For example ``nginx_stage nginx_clean -u johndoe`` would only -kill johndoe's PUN and disregard all the others. +kill a specific users' PUN. For example ``nginx_stage nginx_clean -u john`` would only +kill john's PUN and disregard all the others. -Dashboard now alerts on malformed cluster configs -................................................. +Dashboard now alerts on malformed cluster configurations +........................................................ Prior to 1.7 the dashboard would not start if there was a cluster cluster definition file -(the files in ``/etc/ood/config/clusters.d/``) that had invalid yaml. +(the files in ``/etc/ood/config/clusters.d/``) that had invalid YAML. The dashboard now handles this gracefully and shows an error message to the user stating that this file is unusable and should indicate the line of the file that is problematic. @@ -272,17 +272,17 @@ this file is unusable and should indicate the line of the file that is problemat Job composer now shows suggested scripts ........................................ -When changing the job script in the job composer the user is now presented with a dropdown of +When changing the job script in the job composer the user is now presented with a drop-down of 'Suggested Files' first along with 'Other valid files'. Files in folder will be suggested if they match any of these criteria: -1. Have one of these extensions: ".sh", ".job", ".slurm", ".batch", ".qsub", ".sbatch", ".srun", ".bsub" +1. Have one of these extensions: ``.sh``, ``.job``, ``.slurm``, ``.batch``, ``.qsub``, ``.sbatch``, ``.srun``, and ``.bsub``. 2. The file starts with a shebang line (#!) 3. Has a resource manager's directive (#PBS, #SBATCH, #BSUB or #$) in the first 1000 characters. Other valid files only have to meet a size requirement of less than ``OOD_MAX_SCRIPT_SIZE_KB`` which -defaults to 65 (meaning 65 kb). +defaults to 65 (meaning 65 kilobytes). Add ability to disable SSH to compute node link in batch connect session card ............................................................................. @@ -298,9 +298,9 @@ Reduced installation size by 30 percent We reduced the size of the main OnDemand RPM by nearly 40%. -The 1.6 ondemand-1.6.22-1.el7.x86_64.rpm was 162M and in 1.7 this has been reduced by 63M to a total of 99M, split between two RPMs: ondemand-gems-1.7.10-1.7.10-2.el7.x86_64.rpm with 68M, and ondemand-1.7.10-2.el7.x86_64.rpm with 31M. This is in part due to switching to a monorepo at https://github.com/osc/ondemand and installing all the gems into a central shared location, installed using the new ondemand-gems RPM. +The 1.6 ``ondemand-1.6.22-1.el7.x86_64.rpm`` was 162M and in 1.7 this has been reduced by 63M to a total of 99M, split between two RPMs: ``ondemand-gems-1.7.10-1.7.10-2.el7.x86_64.rpm`` with 68M, and ``ondemand-1.7.10-2.el7.x86_64.rpm`` with 31M. This is in part due to switching to a single repository at https://github.com/osc/ondemand and installing all the gems into a central shared location, installed using the new ondemand-gems RPM. -The resulting sizes of the two main install directories, /opt/ood and /var/www/ood/apps/sys, were in total reduced by 181M: +The resulting sizes of the two main install directories, ``/opt/ood`` and ``/var/www/ood/apps/sys``, were in total reduced by 181M: .. code-block:: sh @@ -325,6 +325,6 @@ New shared OnDemand gem sets The new ondemand-gems RPMs allow other Passenger apps to be developed using the same gems that the core OnDemand apps use. If you do ``scl enable ondemand`` and then ``gem list`` you can see all the gems available. -Because the ondemand-gems RPMs will include the version in the RPM name, it is possible to install multiple versions of these RPMs on the same system. For example, "ondemand-gems-1.7.10" is the name and "1.7.10-2.el7.x86_64.rpm" is the version of ondemand-gems-1.7.10-1.7.10-2.el7.x86_64.rpm. That way you can upgrade to newer versions of OnDemand but still have the ability to provide apps access to older gems by installing the older gem sets. +Because the ondemand-gems RPMs will include the version in the RPM name, it is possible to install multiple versions of these RPMs on the same system. For example, ``ondemand-gems-1.7.10`` is the name and ``1.7.10-2.el7.x86_64.rpm`` is the version of ``ondemand-gems-1.7.10-1.7.10-2.el7.x86_64.rpm``. That way you can upgrade to newer versions of OnDemand but still have the ability to provide apps access to older gems by installing the older gem sets. Having multiple versions of ondemand-gems RPMs ensure that any custom apps relying on gems provided by OnDemand will not break as OnDemand is upgraded as previous installs of ondemand-gems will remain installed when OnDemand is upgraded. From 5d149aa85e7f3615569146694806727c163ab3e8 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Wed, 15 Jan 2025 15:10:23 -0500 Subject: [PATCH 06/14] fix this pages mispellings --- source/release-notes/v1.4-release-notes.rst | 36 +++++++++--------- source/release-notes/v3.1-release-notes.rst | 42 ++++++++++----------- 2 files changed, 39 insertions(+), 39 deletions(-) diff --git a/source/release-notes/v1.4-release-notes.rst b/source/release-notes/v1.4-release-notes.rst index 5f2cbc1e8..c559b78d7 100644 --- a/source/release-notes/v1.4-release-notes.rst +++ b/source/release-notes/v1.4-release-notes.rst @@ -6,13 +6,13 @@ v1.4 Release Notes Highlights in 1.4: - `Upgrade to Ruby 2.4, NodeJS 6, Passenger 5`_ -- `Security Enhancement - PUN autogenerates secret key base if none is set`_ +- `Security Enhancement - PUN auto-generates secret key base if none is set`_ - `Security Enhancement: App development mode is disabled by default`_ - `Security Enhancement: Enable whitelisting of directories in several core apps`_ - `Security Enhancement: Require SSH for all hosts in Shell app`_ -- `Add ability to include Javascript in Batch Connect apps`_ +- `Add ability to include JavaScript in Batch Connect apps`_ - `Better environment setting`_ -- `Customizable error pages for missing home dirs`_ +- `Customizable error pages for missing home directories`_ - `Experimental SGE/UGE support`_ - `Fixed copy and paste issues in the Shell app for Firefox`_ - `Improve default discoverability of apps in the Dashboard's navbar`_ @@ -48,9 +48,9 @@ Upgrading from v1.3 .. warning:: - The nginx RPM used by ondemand will upgrade the nginx RPMs provided by EPEL, if they are installed. + The Nginx RPM used by ondemand will upgrade the Nginx RPMs provided by EPEL, if they are installed. -#. Rebuild any custom Node.js or Ruby apps +#. Rebuild any custom NodeJs or Ruby apps Since we upgraded to Ruby 2.4 from 2.2 and NodeJS 0.10 to NodeJS 6 any custom Passenger apps in Ruby or NodeJS that have their dependencies installed in @@ -79,7 +79,7 @@ Upgrading from v1.3 #. Verify Navbar contains all the apps you want. The behavior changed from 1.3 to 1.4 so by default all categories of any sys - app found appear as dropdown menus without the need for configuration changes. + app found appear as drop-down menus without the need for configuration changes. As a result menus may appear that you do not expect, if previously you were relying @@ -158,16 +158,16 @@ This upgrade updates our dependencies to Software Collections Ruby 2.4 and NodeJ .. warning:: - The Per User NGINX temporary directory has been moved from ``/var/lib/nginx`` to ``/var/tmp/nginx`` due to an issue with more restrictive permissions with NGINX 1.14. + The Per User NGINX temporary directory has been moved from ``/var/lib/nginx`` to ``/var/tmp/nginx`` due to an issue with more restrictive permissions with Nginx 1.14. A consequence of this NGINX 1.14 upgrade is that NGINX directories like ``/var/log/nginx`` have become more restrictive - owned by the nginx user and set by default to 700. -Security Enhancement - PUN autogenerates secret key base if none is set -....................................................................... +Security Enhancement - PUN auto-generates secret key base if none is set +........................................................................ -The PUN will autogenerate its own unique per-user secret key base string which is generated at first launch if it doesn't exist. This is used by Rails apps to encrypt cookies and overrides the default one set in `env.production `__. +The PUN will auto-generate its own unique per-user secret key base string which is generated at first launch if it doesn't exist. This is used by Rails apps to encrypt cookies and overrides the default one set in `env.production `__. Security Enhancement: App development mode is disabled by default ................................................................. @@ -177,23 +177,23 @@ Development mode disabled by default: application development gives increased ac Security Enhancement: Enable whitelisting of directories in several core apps ............................................................................. -The file editor, file browser and job composer now support an optional whitelist of browseable/editable directories. Directories and files not in the whitelist will never be forbidden to users. The whitelist is controlled by the environment variable ``WHITELIST_PATH``, which is best be defined by editing ``/etc/ood/config/nginx_stage.yml`` under the ``pun_custom_env`` map. +The file editor, file browser and job composer now support an optional whitelist of browse-able/editable directories. Directories and files not in the whitelist will never be forbidden to users. The whitelist is controlled by the environment variable ``WHITELIST_PATH``, which is best be defined by editing ``/etc/ood/config/nginx_stage.yml`` under the ``pun_custom_env`` map. Security Enhancement: Require SSH for all hosts in Shell app ............................................................. Prior to this release it was possible for OOD users to change the URL in the shell application and connect directly to the web node by starting a Bash shell on localhost. Given that this ability for arbitrary user access is counter intuitive to how web servers are typically managed, the exemption for localhost has been removed; users will always use SSH to connect to any host, allowing SSH access controls to work. -Add ability to include Javascript in Batch Connect apps +Add ability to include JavaScript in Batch Connect apps ....................................................... -Batch Connect applications may now define a Javascript file to add interactive frontend functionality. `Github OSC/ood-dashboard#426 `_. +Batch Connect applications may now define a JavaScript file to add interactive frontend functionality. `Github OSC/ood-dashboard#426 `_. The contents of this JavaScript file will be embedded in ``