Skip to content

Commit

Permalink
Documentation updates around 3.1 packaging changes
Browse files Browse the repository at this point in the history
Document architectures and new release package naming

Fixes #826 #825 #823 #821 #820
  • Loading branch information
treydock committed Jun 20, 2023
1 parent ef1de90 commit 7626c6b
Show file tree
Hide file tree
Showing 7 changed files with 261 additions and 20 deletions.
17 changes: 14 additions & 3 deletions source/authentication/dex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,22 @@ Installing OnDemand Dex package

First the OnDemand yum repos must be enabled, see :ref:`install-software`.

Install the ``ondemand-dex`` RPM:
Install the ``ondemand-dex`` package:

.. code-block:: sh
.. tabs::

.. tab:: yum/dnf

.. code-block:: sh
sudo yum install ondemand-dex
.. tab:: apt

.. code-block:: sh
sudo yum install ondemand-dex
sudo apt-get install ondemand-dex
Installing OnDemand Dex from source
-----------------------------------
Expand Down
4 changes: 2 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@
# built documents.
#
# The short X.Y version.
version = u'3.0'
version = u'3.1'
# The full version, including alpha/beta/rc tags.
release = u'3.0.0'
release = u'3.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Installation
The OnDemand host machine needs to be setup *similarly* to a login node. This
means that it will need:

- RedHat/CentOS 7+ or Ubuntu 20.04-22.04
- RedHat/CentOS 7+ or Ubuntu 20.04-22.04 or Amazon Linux 2023
- the resource manager (e.g., Torque, Slurm, or LSF) client binaries and
libraries used by the batch servers installed
- configuration on both OnDemand node **and batch servers** to be able to
Expand Down
57 changes: 49 additions & 8 deletions source/installation/install-software.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Install Software
Open OnDemand uses these packages, among many others.

- `Apache HTTP Server 2.4`_
- Ruby 2.7 with :command:`rake`, :command:`bundler`, and development
- Ruby 3.0 with :command:`rake`, :command:`bundler`, and development
libraries
- Node.js 14

Expand All @@ -19,8 +19,8 @@ Some operating systems use `Software Collections`_ to satisfy these.

.. warning::

Be sure to check :ref:`Supported Operating Systems <os-support>` before proceeding with install to verify
you are on a supported operating system.
Be sure to check :ref:`Supported Operating Systems and Architectures <os-support>` before proceeding with install to verify
you are on a supported operating system and architecture.

.. warning::

Expand Down Expand Up @@ -91,26 +91,60 @@ Some operating systems use `Software Collections`_ to satisfy these.

.. tabs::

.. tab:: yum/dnf
.. tab:: RedHat/CentOS 7

.. code-block:: sh
sudo yum install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.noarch.rpm
sudo yum install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.el7.noarch.rpm
sudo yum install ondemand
.. tab:: RedHat/Rocky Linux/AlmaLinux 8

.. tab:: apt
.. code-block:: sh
sudo yum install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.el8.noarch.rpm
sudo yum install ondemand
.. tab:: RedHat/Rocky Linux/AlmaLinux 9

.. code-block:: sh
sudo yum install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.el9.noarch.rpm
sudo yum install ondemand
.. tab:: Ubuntu 20.04

.. code-block:: sh
sudo apt install apt-transport-https ca-certificates
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0_all.deb
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0_all.deb
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-focal_all.deb
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-focal_all.deb
sudo apt update
sudo apt install ondemand
.. tab:: Ubuntu 22.04

.. code-block:: sh
sudo apt install apt-transport-https ca-certificates
wget -O /tmp/ondemand-release-web_{{ ondemand_version }}.0_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-jammy_all.deb
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-jammy_all.deb
sudo apt update
sudo apt install ondemand
.. tab:: Amazon Linux 2023

.. code-block:: sh
sudo yum install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.amzn2023.noarch.rpm
sudo yum install ondemand
3. Start services
-----------------

Expand Down Expand Up @@ -138,6 +172,13 @@ Some operating systems use `Software Collections`_ to satisfy these.
sudo systemctl start apache2
sudo systemctl enable apache2
.. tab:: Amazon Linux 2023

.. code-block:: sh
sudo systemctl start httpd
sudo systemctl enable httpd
4. Verify installation
----------------------

Expand Down
1 change: 1 addition & 0 deletions source/release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Release Notes
.. toctree::
:maxdepth: 2

release-notes/v3.1-release-notes
release-notes/v3.0-release-notes
release-notes/v2.0-release-notes
release-notes/v1.8-release-notes
Expand Down
180 changes: 180 additions & 0 deletions source/release-notes/v3.1-release-notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
.. _v3.1-release-notes:

v3.1 Release Notes
==================

Administrative changes
----------------------

- `Deprecations`_
- `Dependency updates`_
- `Upgrade directions`_

New Features
------------

- `aarch64 and ppc64le packages`_
- `Amazon Linux 2023 packages`_

Details of administrative changes
---------------------------------

Deprecations
............

RedHat/CentOS 7 packages deprecated
***********************************

OnDemand 3.1 will be the last OnDemand release to support RedHat/CentOS 7.

Dependency updates
..................

This release updates the following dependencies:

- Passenger 6.0.17
- NGINX 1.22.1
- ondemand-dex 2.36.0
- mod_auth_openidc 2.4.14.1 (RHEL 7 & 8 only)

Upgrade directions
..................

.. warning::

As always please update the *development* or *test* instances of OnDemand installed at your center first to test and verify before you modify the *production* instance.

.. warning::

The OnDemand upgrade has only been tested going from 3.0.x to 3.1.x.

#. Update OnDemand release RPM

.. tabs::

.. tab:: RedHat/CentOS 7

.. code-block:: sh
sudo yum install -y https://yum.osc.edu/ondemand/3.1/ondemand-release-web-3.1-1.el7.noarch.rpm
.. tab:: RedHat/Rocky Linux/AlmaLinux 8

.. code-block:: sh
sudo yum install -y https://yum.osc.edu/ondemand/3.1/ondemand-release-web-3.1-1.el8.noarch.rpm
.. tab:: RedHat/Rocky Linux/AlmaLinux 8

.. code-block:: sh
sudo yum install -y https://yum.osc.edu/ondemand/3.1/ondemand-release-web-3.1-1.el9.noarch.rpm
.. tab:: Ubuntu 20.04

.. code-block:: sh
wget -O /tmp/ondemand-release-web_3.1.0-focal_all.deb https://apt.osc.edu/ondemand/3.1/ondemand-release-web_3.1.0-focal_all.deb
sudo apt install /tmp/ondemand-release-web_3.1.0-focal_all.deb
sudo apt update
.. tab:: Ubuntu 22.04

.. code-block:: sh
wget -O /tmp/ondemand-release-web_3.1.0-jammy_all.deb https://apt.osc.edu/ondemand/3.1/ondemand-release-web_3.1.0-jammy_all.deb
sudo apt install /tmp/ondemand-release-web_3.1.0-jammy_all.deb
sudo apt update
#. Update OnDemand

.. tabs::

.. tab:: yum/dnf

.. code-block:: sh
sudo yum clean all
sudo yum update ondemand
.. tab:: apt

.. code-block:: sh
sudo apt-get --only-upgrade install ondemand
#. (Optional) If using Dex based authentiction, update the ``ondemand-dex`` package.

.. tabs::

.. tab:: yum/dnf

.. code-block:: sh
sudo yum update ondemand-dex
.. tab:: apt

.. code-block:: sh
sudo apt-get --only-upgrade install ondemand-dex
#. Update Apache configuration and restart Apache.

.. code-block:: sh
sudo /opt/ood/ood-portal-generator/sbin/update_ood_portal
.. tabs::

.. tab:: RedHat/CentOS 7

.. code-block:: sh
sudo systemctl try-restart httpd24-httpd.service
.. tab:: RedHat/Rocky Linux/AlmaLinux 8 & 9

.. code-block:: sh
sudo systemctl try-restart httpd
.. tab:: Ubuntu 20.04 & 22.04

.. code-block:: sh
sudo systemctl try-restart apache2
#. (Optional) If ``ondemand-dex`` was installed, restart the ``ondemand-dex`` service.

.. code-block:: sh
sudo systemctl try-restart ondemand-dex.service
#. (Optional) If ``ondemand-selinux`` was installed, see :ref:`ood_selinux_updates`

#. Force all PUNs to restart

.. code-block:: sh
sudo /opt/ood/nginx_stage/sbin/nginx_stage nginx_clean -f
Details of new features
-----------------------

aarch64 and ppc64le packages
............................

Added aarch64 and ppc64le packages for some operation systems.
See :ref:`Supported Operating Systems and Architectures <os-support>`
for a full list of which operating systems support aarch64 and ppc64le.


Amazon Linux 2023 packages
..........................

Added Amazon Linux 2023 packages.
See :ref:`install-software` for installation instructions.
20 changes: 14 additions & 6 deletions source/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,21 @@ Supported Operating Systems

.. _os-support:

At this time OnDemand only supports the following operating systems:
At this time OnDemand only supports the following operating systems and architectures:

- RedHat/CentOS 7
- RedHat/Rocky Linux/AlmaLinux 8
- RedHat/Rocky Linux/AlmaLinux 9
- Ubuntu 20.04
- Ubuntu 22.04
.. role:: raw-html(raw)
:format: html

.. csv-table:: Operating System and Architecture Support
:header: "","x86_64","aarch64","ppc64le"
:stub-columns: 1

"RedHat/CentOS 7",:raw-html:`&#9989;`,:raw-html:`&#9989;`,:raw-html:`&#9989;`
"RedHat/Rocky Linux/AlmaLinux 8",:raw-html:`&#9989;`,:raw-html:`&#9989;`,:raw-html:`&#9989;`
"RedHat/Rocky Linux/AlmaLinux 9",:raw-html:`&#9989;`,:raw-html:`&#9989;`,:raw-html:`&#9989;`
"Ubuntu 20.04",:raw-html:`&#9989;`,:raw-html:`&#9989;`,:raw-html:`&#10060;`
"Ubuntu 22.04",:raw-html:`&#9989;`,:raw-html:`&#9989;`,:raw-html:`&#10060;`
"Amazon Linux 2023",:raw-html:`&#9989;`,:raw-html:`&#9989;`,:raw-html:`&#10060;`

Software Requirements
---------------------
Expand Down

0 comments on commit 7626c6b

Please sign in to comment.