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

Document changes for Rocky and add 3.6 roadmap #1108

Merged
merged 2 commits into from
Feb 4, 2022
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
2 changes: 1 addition & 1 deletion docs/source/chatops/chatops.rst
Original file line number Diff line number Diff line change
Expand Up @@ -261,5 +261,5 @@ Logging
=======

ChatOps logs are written to ``/var/log/st2/st2chatops.log`` on non systemd-based distros. For
systemd-based distros (Ubuntu 18/20, RHEL/CentOS 7/8), you can access the logs via
systemd-based distros (Ubuntu 18/20, RHEL/RockyLinux/CentOS 7/8), you can access the logs via
``journalctl --unit=st2chatops``
4 changes: 2 additions & 2 deletions docs/source/development/sources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Ubuntu
apt-get install mongodb mongodb-server
apt-get install rabbitmq-server

CentOS/RHEL
-----------
RockyLinux/CentOS/RHEL
----------------------

.. note::
For RHEL 7.x you may need to enable the optional server rpms repository to be able to install the python3-devel RPM
Expand Down
7 changes: 5 additions & 2 deletions docs/source/install/ansible.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ Our Ansible playbooks support the same platforms as manual installation, i.e.:
* Ubuntu Bionic (18.04)
* Ubuntu Focal (20.04)
* RHEL 7/CentOS 7
* RHEL 8/CentOS 8
* RHEL 8/RockyLinux 8/CentOS 8

.. note::
|st2| is verified on RHEL/RockyLinux ``8.x`` distributions, but our RPMs should be compatible with other RHEL``8.x`` derivatives, e.g. CentOS 8 Stream.

The same system size :doc:`requirements </install/system_requirements>` also apply.

Expand Down Expand Up @@ -50,7 +53,7 @@ Roles
Behind the scenes the ``stackstorm.yml`` play is composed of the following Ansible ``roles`` for a
complete installation:

- ``epel`` - Repository with extra packages for ``RHEL/CentOS``.
- ``epel`` - Repository with extra packages for ``RHEL/RockyLinux/CentOS``.
- ``mongodb`` - Main DB storage engine.
- ``rabbitmq`` - Message broker.
- ``st2repos`` - Adds |st2| PackageCloud repositories.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/install/config/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -406,13 +406,13 @@ By default, the logs can be found in ``/var/log/st2``.
Configure The Number of Action Runner Workers
---------------------------------------------

In CentOS/RHEL the number of action workers defaults to 10. In Ubuntu the number of workers
In CentOS/RockyLinux/RHEL the number of action workers defaults to 10. In Ubuntu the number of workers
defaults to the number of CPU cores the machine has. You may wish to increase the number of workers
in an HA setup or on system with plenty of resources.

The number of workers can be increased by modifying the environment variable ``WORKERS``. To persist
the number of ``st2actionrunner`` workers, create or edit the environment variable file for your
distribution and add the number of workers, eg. 25: ``WORKERS=25``. On RHEL/CentOS we use the
distribution and add the number of workers, eg. 25: ``WORKERS=25``. On RHEL/RockyLinux/CentOS we use the
``/etc/sysconfig/st2actionrunner`` file and on Ubuntu use the ``/etc/default/st2actionrunner``
file to pass custom environment variables to the ``st2actionrunner`` service/unit:

Expand Down
4 changes: 2 additions & 2 deletions docs/source/install/config/windows_runners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Samba client is available in standard APT and Yum repositories. To install it on

sudo apt-get install smbclient

To install on RHEL/CentOS, run:
To install on RHEL/RockyLinux/CentOS, run:

.. sourcecode:: bash

Expand All @@ -33,7 +33,7 @@ or obtain a pre-built binary.

* **Ubuntu**: Instructions and binary packages for 14.04 and 16.04 are available `here <https://doublefault0.wordpress.com/2017/02/21/winexe-1-1-ubuntu-16-04/>`_.

* **RHEL/CentOS**: `These instructions <https://github.com/beardedeagle/winexe-rpm>`_ explain how to build RPMs for RHEL/CentOS systems.
* **RHEL/RockyLinux/CentOS**: `These instructions <https://github.com/beardedeagle/winexe-rpm>`_ explain how to build RPMs for RHEL/RockyLinux/CentOS systems.

Supported Windows Versions
--------------------------
Expand Down
8 changes: 4 additions & 4 deletions docs/source/install/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Here's an overview of the options:
* **Manual Installation:** Have custom needs? Maybe no Internet access from your servers? Or just
don't like using scripted installs? Read the manual installation instructions for your OS
(:doc:`Ubuntu 18 </install/u18>`, :doc:`Ubuntu 20 </install/u20>`,
:doc:`RHEL/CentOS 7 </install/rhel7>`, :doc:`RHEL/CentOS 8 </install/rhel8>`) and adapt them to
:doc:`RHEL/CentOS 7 </install/rhel7>`, :doc:`RHEL/RockyLinux/CentOS 8 </install/rhel8>`) and adapt them to
your needs. Here's some `additional guidance
<https://stackstorm.com/2017/02/10/installing-stackstorm-offline-systems/>`_ for setting up an
internal mirror for the |st2| repos.
Expand Down Expand Up @@ -49,15 +49,15 @@ Read the :doc:`/install/ewc` documentation for more.

Grab a **clean** 64-bit Linux system that fits the :doc:`system requirements
<system_requirements>`. Make sure that ``curl`` is up to date using ``sudo apt-get install curl``
on Ubuntu, or ``sudo yum install curl nss`` on RHEL/CentOS. Then run this command:
on Ubuntu, or ``sudo yum install curl nss`` on RHEL/RockyLinux/CentOS. Then run this command:

.. code-block:: bash

bash <(curl -sSL https://stackstorm.com/packages/install.sh) --user=st2admin --password=Ch@ngeMe

This is an opinionated installation of |st2|. It will download and install all components, as per
the :doc:`single host reference deployment <./overview>`. It assumes that you have a clean, basic
installation of Ubuntu or RHEL/CentOS.
installation of Ubuntu or RHEL/RockyLinux/CentOS.

If you are trying to install |st2| on a server with other applications, or local customisations,
you may run into problems. In that case, you should use one of the manual installation methods.
Expand Down Expand Up @@ -94,7 +94,7 @@ For more details on reference deployments, or OS-specific installation instructi
Ubuntu 18.04 <u18>
Ubuntu 20.04 <u20>
RHEL 7 / CentOS 7 <rhel7>
RHEL 8 / CentOS 8 <rhel8>
RHEL 8 / RockyLinux 8 / CentOS 8 <rhel8>
Vagrant / OVA <vagrant>
Docker <docker>
Ansible Playbooks <ansible>
Expand Down
5 changes: 4 additions & 1 deletion docs/source/install/puppet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ The Puppet module supports the same platforms as manual installation, i.e.:
* Ubuntu Trusty (14.04)
* Ubuntu Xenial (16.04)
* RHEL 7/CentOS 7
* RHEL 8/CentOS 8
* RHEL 8/RockyLinux 8/CentOS 8

.. note::
|st2| is verified on RHEL/RockyLinux ``8.x`` distributions, but our RPMs should be compatible with other RHEL``8.x`` derivatives, e.g. CentOS 8 Stream.

The same system size :doc:`requirements </install/system_requirements>` also apply.

Expand Down
5 changes: 4 additions & 1 deletion docs/source/install/rhel8.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,13 @@ Please check the :doc:`supported versions and system requirements <system_requir

.. note::

|st2| on RHEL 8/CentOS 8 runs all services, actions and sensors using Python 3 **only**. It
|st2| on RHEL 8/RockyLinux/CentOS 8 runs all services, actions and sensors using Python 3 **only**. It
does not support Python 2 actions. `More info about python in RHEL 8 and CentOS 8.
<https://developers.redhat.com/blog/2019/05/07/what-no-python-in-red-hat-enterprise-linux-8/>`_

.. note::
|st2| is verified on RHEL/RockyLinux ``8.x`` distributions, but our RPMs should be compatible with other RHEL``8.x`` derivatives, e.g. CentOS 8 Stream.

Minimal Installation
--------------------

Expand Down
34 changes: 18 additions & 16 deletions docs/source/install/system_requirements.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
System Requirements
===================

|st2| requires Ubuntu, RHEL or CentOS Linux. It is not supported on any other Linux distributions.
|st2| requires Ubuntu, RHEL, RockyLinux or CentOS Linux. It is not supported on any other Linux distributions.
The table below lists the supported Linux versions, along with the Vagrant Boxes and Amazon AWS
instances we use for testing. See :ref:`below <ref-os-support-policy>` for more details about
our Linux distribution support policy.
Expand All @@ -15,19 +15,19 @@ be automatically added when you install |st2|.
Please note that only 64-bit architecture is supported.


+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Linux (64-bit) | Vagrant Box | Amazon AWS AMI |
+=======================================================================================================+==============================================================================+===================================================================================================================================================================+
| `Ubuntu 18.04 <http://cdimage.ubuntu.com/releases/18.04.2/release/ubuntu-18.04.2-server-amd64.iso>`_ | `bento/ubuntu-18.04 <https://app.vagrantup.com/bento/boxes/ubuntu-18.04>`_ | `Ubuntu Server 18.04 LTS Bionic <https://aws.amazon.com/marketplace/pp/B07CQ33QKV/>`_ |
+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Ubuntu 20.04 <http://releases.ubuntu.com/focal/ubuntu-20.04.2-live-server-amd64.iso>`_ | `bento/ubuntu-20.04 <https://app.vagrantup.com/bento/boxes/ubuntu-20.04>`_ | `Ubuntu Server 20.04 LTS Focal <https://aws.amazon.com/marketplace/pp/B087QQNGF1>`_ |
+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `RHEL 8 <https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux>`_ / | `bento/centos-8.2 <https://app.vagrantup.com/bento/boxes/centos-8.2>`_ | `Red Hat Enterprise Linux (RHEL) 8 (HVM) <https://aws.amazon.com/marketplace/pp/B07T4SQ5RZ?qid=1581005023484&sr=0-5&ref_=brs_res_product_title>`_ |
| `CentOS 8.2 <http://mirrors.rit.edu/centos/8.2.2004/isos/x86_64/>`_ | | |
+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `RHEL 7 <https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux>`_ / | `bento/centos-7.4 <https://app.vagrantup.com/bento/boxes/centos-7.4>`_ | `Red Hat Enterprise Linux (RHEL) 7.2 (HVM) <https://aws.amazon.com/marketplace/pp/B019NS7T5I/ref=srh_res_product_title?ie=UTF8&sr=0-2&qid=1457037671547>`_ |
| `CentOS 7 <http://isoredirect.centos.org/centos/7/isos/x86_64/CentOS-7-x86_64-Minimal-1708.iso>`_ | | |
+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Linux (64-bit) | Vagrant Box | Amazon AWS AMI |
+=======================================================================================================+================================================================================+===================================================================================================================================================================+
| `Ubuntu 18.04 <http://cdimage.ubuntu.com/releases/18.04.2/release/ubuntu-18.04.2-server-amd64.iso>`_ | `bento/ubuntu-18.04 <https://app.vagrantup.com/bento/boxes/ubuntu-18.04>`_ | `Ubuntu Server 18.04 LTS Bionic <https://aws.amazon.com/marketplace/pp/B07CQ33QKV/>`_ |
+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `Ubuntu 20.04 <http://releases.ubuntu.com/focal/ubuntu-20.04.2-live-server-amd64.iso>`_ | `bento/ubuntu-20.04 <https://app.vagrantup.com/bento/boxes/ubuntu-20.04>`_ | `Ubuntu Server 20.04 LTS Focal <https://aws.amazon.com/marketplace/pp/B087QQNGF1>`_ |
+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `RHEL 8 <https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux>`_ / | `bento/rockylinux-8.5 <https://app.vagrantup.com/bento/boxes/rockylinux-8.4>`_ | `Red Hat Enterprise Linux (RHEL) 8 (HVM) <https://aws.amazon.com/marketplace/pp/B07T4SQ5RZ?qid=1581005023484&sr=0-5&ref_=brs_res_product_title>`_ |
| `RockyLinux 8 <https://rockylinux.org/download/>`_ | | |
+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| `RHEL 7 <https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux>`_ / | `bento/centos-7.4 <https://app.vagrantup.com/bento/boxes/centos-7.4>`_ | `Red Hat Enterprise Linux (RHEL) 7.2 (HVM) <https://aws.amazon.com/marketplace/pp/B019NS7T5I/ref=srh_res_product_title?ie=UTF8&sr=0-2&qid=1457037671547>`_ |
| `CentOS 7 <http://isoredirect.centos.org/centos/7/isos/x86_64/CentOS-7-x86_64-Minimal-1708.iso>`_ | | |
+-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+

This is the recommended minimum sizing for testing and deploying |st2|:

Expand Down Expand Up @@ -67,14 +67,16 @@ If any other services are currently using these ports, |st2| may fail to install
Linux Distribution Support Policy
---------------------------------

StackStorm only support Ubuntu and RHEL/CentOS Linux distributions. In general, it is supported
StackStorm only support Ubuntu and RHEL/RockyLinux/CentOS Linux distributions. In general, it is supported
on the two most recent major supported releases for those distributions. Specifically:

* **Ubuntu**: Current LTS releases are supported. Today this is ``18.04`` and ``20.04``.

* **RHEL/CentOS**: We currently support RHEL/CentOS ``7.x`` and ``8.x``. In general, we recommend using
* **RHEL/CentOS**: We currently support RHEL/CentOS ``7.x`` and RHEL/RockyLinux ``8.x``. In general, we recommend using
the most recent version in that series, but any version may be used.
|st2| is verified on RHEL/RockyLinux ``8.x`` distributions, but our RPMs should be compatible with other RHEL``8.x`` derivatives, e.g. CentOS 8 Stream.

Support for RHEL/CentOS ``6.x`` has been removed. |st2| 3.2 is the last release that supported RHEL/CentOS ``6.x``.

Support for Ubuntu ``16.04`` has been removed. |st2| 3.4 is the last release that supported RHEL/CentOS ``16.04``.

12 changes: 6 additions & 6 deletions docs/source/install/uninstall.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ below. Only execute the instructions for your distribution.
sudo service rabbitmq-server stop
sudo service redis-server stop

* RHEL/CentOS 7.x/8.x:
* RHEL/CentOS/RockyLinux:

.. sourcecode:: bash

Expand Down Expand Up @@ -84,7 +84,7 @@ below. Only execute the instructions for your distribution.
sudo apt-get purge st2 st2chatops st2web bwc-ui st2flow


* RHEL/CentOS 7.x/8.x:
* RHEL/CentOS/RockyLinux:

If you are using StackStorm only:

Expand All @@ -106,7 +106,7 @@ below. Only execute the instructions for your distribution.
3. Remove |st2| System User
---------------------------

* Ubuntu/RHEL/CentOS:
* Ubuntu/RHEL/CentOS/RockyLinux:

.. sourcecode:: bash

Expand All @@ -123,7 +123,7 @@ below. Only execute the instructions for your distribution.

sudo apt-get purge mongodb-org* rabbitmq-server erlang* nginx nodejs redis-server

* RHEL/CentOS:
* RHEL/CentOS/RockyLinux:

.. sourcecode:: bash

Expand All @@ -145,7 +145,7 @@ below. Only execute the instructions for your distribution.
sudo rm -f /etc/apt/sources.list.d/StackStorm* /etc/apt/sources.list.d/nodesource*
sudo rm -f /etc/apt/sources.list.d/rabbitmq*

* RHEL/CentOS:
* RHEL/CentOS/RockyLinux:

.. sourcecode:: bash

Expand All @@ -170,7 +170,7 @@ last pieces.
sudo rm -rf /etc/redis/redis.conf /var/lib/redis
sudo userdel -r redis

* RHEL/CentOS:
* RHEL/CentOS/RockyLinux:

.. sourcecode:: bash

Expand Down
Loading