Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates around 3.1 packaging changes #827

Merged
merged 4 commits into from
Oct 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.3'
release = u'3.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
4 changes: 2 additions & 2 deletions source/how-tos/debug/debug-apache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Restart services

sudo systemctl try-restart httpd

.. tab:: Ubuntu
.. tab:: Ubuntu & Debian

.. code-block:: sh

Expand Down Expand Up @@ -73,7 +73,7 @@ Or you're using the wrong hostname in your browser.

sudo /sbin/httpd -S

.. tab:: Ubuntu
.. tab:: Ubuntu & Debian

.. code-block:: sh

Expand Down
39 changes: 22 additions & 17 deletions source/how-tos/monitoring/prometheus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Dependencies:
Install via RPM
--------------------------

For RHEL/CentOS 7 and RHEL/Rocky 8 systems the `ondemand_exporter`_ can be installed via RPM.
For yum/dnf based systems the `ondemand_exporter`_ can be installed via RPM.

.. code-block:: sh

Expand All @@ -34,22 +34,24 @@ For RHEL/CentOS 7 and RHEL/Rocky 8 systems the `ondemand_exporter`_ can be insta
The RPM will install the following files that should work out of the box:

- **RHEL/CentOS 7 only**: /opt/rh/httpd24/root/etc/httpd/conf.d/ondemand_exporter.conf
- **RHEL/Rocky 8 only**: /etc/httpd/conf.d/ondemand_exporter.conf
- **RHEL/Rocky/AlmaLinux 8 & 9 only**: /etc/httpd/conf.d/ondemand_exporter.conf
- /etc/sudoers.d/ondemand_exporter

Ensure that the new Apache configuration is loaded by restarting Apache

RHEL/CentOS 7
.. tabs::

.. code-block:: sh
.. tab:: RHEL/CentOS 7

sudo systemctl restart httpd24-httpd
.. code-block:: sh

RHEL/Rocky 8
sudo systemctl restart httpd24-httpd

.. code-block:: sh
.. tab:: RHEL/Rocky/Alma Linux 8 & 9

sudo systemctl restart httpd
.. code-block:: sh

sudo systemctl restart httpd

Start the service

Expand All @@ -69,7 +71,7 @@ Check for the `ondemand_exporter Latest Release`_ version number. Replace ``VER

.. code-block:: sh

VERSION="0.8.0"
VERSION="0.10.0"
ARCHIVE="ondemand_exporter-${VERSION}.linux-amd64"
wget -O /tmp/${ARCHIVE}.tar.gz https://github.com/OSC/ondemand_exporter/releases/download/v${VERSION}/${ARCHIVE}.tar.gz
tar xf /tmp/${ARCHIVE}.tar.gz -C /tmp
Expand All @@ -78,19 +80,21 @@ Check for the `ondemand_exporter Latest Release`_ version number. Replace ``VER
sudo install -o root -g root -m 0644 /tmp/${ARCHIVE}/files/ondemand_exporter.service /etc/systemd/system/
sudo systemctl daemon-reload

RHEL/CentOS 7
.. tabs::

.. code-block:: sh
.. tab:: RHEL/CentOS 7

sudo install -o root -g root -m 0440 /tmp/${ARCHIVE}/files/apache.conf /opt/rh/httpd24/root/etc/httpd/conf.d/ondemand_exporter.conf
sudo systemctl restart httpd24-httpd
.. code-block:: sh

RHEL/Rocky 8
sudo install -o root -g root -m 0440 /tmp/${ARCHIVE}/files/apache.conf /opt/rh/httpd24/root/etc/httpd/conf.d/ondemand_exporter.conf
sudo systemctl restart httpd24-httpd

.. code-block:: sh
.. tab:: RHEL/Rocky/Alma Linux 8 & 9

.. code-block:: sh

sudo install -o root -g root -m 0440 /tmp/${ARCHIVE}/files/apache.conf /etc/httpd/conf.d/ondemand_exporter.conf
sudo systemctl restart httpd
sudo install -o root -g root -m 0440 /tmp/${ARCHIVE}/files/apache.conf /etc/httpd/conf.d/ondemand_exporter.conf
sudo systemctl restart httpd

**(Optional)** If Passenger was not installed via ``ondemand-passenger`` RPM. Adjust the path to ``passenger-status`` as needed

Expand All @@ -101,6 +105,7 @@ RHEL/Rocky 8
[Service]
Environment="PASSENGER_STATUS=/usr/sbin/passenger-status"
EOF
sudo systemctl daemon-reload

Start the service

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 Debian 12 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
4 changes: 2 additions & 2 deletions source/installation/add-ssl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ authority.

sudo yum update ca-certificates

.. tab:: Ubuntu
.. tab:: Ubuntu & Debian

.. code:: sh

Expand All @@ -96,7 +96,7 @@ authority you're using and run these commands to copy it to the appropriate plac
sudo cp <CA CERT location> /etc/pki/ca-trust/source/anchors/
sudo update-ca-trust

.. tab:: Ubuntu
.. tab:: Ubuntu & Debian

.. code:: sh

Expand Down
83 changes: 68 additions & 15 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 All @@ -40,20 +40,21 @@ Some operating systems use `Software Collections`_ to satisfy these.
sudo yum install centos-release-scl epel-release


.. tab:: RockyLinux 8
.. tab:: RockyLinux/Alma Linux 8

.. code-block:: sh

sudo dnf config-manager --set-enabled powertools
sudo dnf install epel-release
sudo dnf module enable ruby:3.0 nodejs:14
sudo dnf module enable ruby:3.1 nodejs:18

.. tab:: RockyLinux 9
.. tab:: RockyLinux/Alma Linux 9

.. code-block:: sh

sudo dnf config-manager --set-enabled crb
sudo dnf install epel-release
sudo dnf module enable ruby:3.1 nodejs:18

.. tab:: RHEL 7

Expand All @@ -74,7 +75,7 @@ Some operating systems use `Software Collections`_ to satisfy these.
.. code-block:: sh

sudo dnf install epel-release
sudo dnf module enable ruby:3.0 nodejs:14
sudo dnf module enable ruby:3.1 nodejs:18
sudo subscription-manager repos --enable codeready-builder-for-rhel-8-x86_64-rpms


Expand All @@ -83,34 +84,79 @@ Some operating systems use `Software Collections`_ to satisfy these.
.. code-block:: sh

sudo dnf install epel-release
sudo dnf module enable ruby:3.0 nodejs:16
sudo dnf module enable ruby:3.1 nodejs:18
sudo subscription-manager repos --enable codeready-builder-for-rhel-9-x86_64-rpms

2. Add repository and install
-----------------------------

.. 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 dnf install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.el8.noarch.rpm

sudo dnf install ondemand

.. tab:: RedHat/Rocky Linux/AlmaLinux 9

.. code-block:: sh

sudo dnf install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.el9.noarch.rpm

sudo dnf 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-focal_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-jammy_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:: Debian 12

.. 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-bookworm_all.deb https://apt.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web_{{ ondemand_version }}.0-bookworm_all.deb
sudo apt install /tmp/ondemand-release-web_{{ ondemand_version }}.0-bookworm_all.deb
sudo apt update

sudo apt install ondemand

.. tab:: Amazon Linux 2023

.. code-block:: sh

sudo dnf install https://yum.osc.edu/ondemand/{{ ondemand_version }}/ondemand-release-web-{{ ondemand_version }}-1.amzn2023.noarch.rpm

sudo dnf install ondemand

3. Start services
-----------------

Expand All @@ -131,13 +177,20 @@ Some operating systems use `Software Collections`_ to satisfy these.
sudo systemctl start httpd
sudo systemctl enable httpd

.. tab:: Ubuntu
.. tab:: Ubuntu & Debian

.. code-block:: sh

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 All @@ -152,7 +205,7 @@ After adding authentication, but before actually testing that it works, you shou

You may also want to :ref:`enable SELinux <modify-system-security>`.

If you're seeing the default Apache page (Ubuntu users will) you will have to :ref:`debug virtualhosts <show-virtualhosts>`
If you're seeing the default Apache page (Ubuntu & Debian users will) you will have to :ref:`debug virtualhosts <show-virtualhosts>`
and likely :ref:`configure a servername <ood-portal-generator-servername>`.

Building From Source
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
Loading