diff --git a/docs/source/chatops/chatops.rst b/docs/source/chatops/chatops.rst index 8a06c7e9..56fc76c7 100644 --- a/docs/source/chatops/chatops.rst +++ b/docs/source/chatops/chatops.rst @@ -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`` diff --git a/docs/source/development/sources.rst b/docs/source/development/sources.rst index 240f4ce7..ce0d5101 100644 --- a/docs/source/development/sources.rst +++ b/docs/source/development/sources.rst @@ -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 diff --git a/docs/source/install/ansible.rst b/docs/source/install/ansible.rst index e6344693..08cfc9a9 100644 --- a/docs/source/install/ansible.rst +++ b/docs/source/install/ansible.rst @@ -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 ` also apply. @@ -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. diff --git a/docs/source/install/config/config.rst b/docs/source/install/config/config.rst index 97ce2397..de6a8eeb 100644 --- a/docs/source/install/config/config.rst +++ b/docs/source/install/config/config.rst @@ -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: diff --git a/docs/source/install/config/windows_runners.rst b/docs/source/install/config/windows_runners.rst index b93e3967..068e273c 100644 --- a/docs/source/install/config/windows_runners.rst +++ b/docs/source/install/config/windows_runners.rst @@ -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 @@ -33,7 +33,7 @@ or obtain a pre-built binary. * **Ubuntu**: Instructions and binary packages for 14.04 and 16.04 are available `here `_. -* **RHEL/CentOS**: `These instructions `_ explain how to build RPMs for RHEL/CentOS systems. +* **RHEL/RockyLinux/CentOS**: `These instructions `_ explain how to build RPMs for RHEL/RockyLinux/CentOS systems. Supported Windows Versions -------------------------- diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst index d88b542b..95274aa4 100644 --- a/docs/source/install/index.rst +++ b/docs/source/install/index.rst @@ -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 `, :doc:`Ubuntu 20 `, - :doc:`RHEL/CentOS 7 `, :doc:`RHEL/CentOS 8 `) and adapt them to + :doc:`RHEL/CentOS 7 `, :doc:`RHEL/RockyLinux/CentOS 8 `) and adapt them to your needs. Here's some `additional guidance `_ for setting up an internal mirror for the |st2| repos. @@ -49,7 +49,7 @@ Read the :doc:`/install/ewc` documentation for more. Grab a **clean** 64-bit Linux system that fits the :doc:`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 @@ -57,7 +57,7 @@ on Ubuntu, or ``sudo yum install curl nss`` on RHEL/CentOS. Then run this comman 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. @@ -94,7 +94,7 @@ For more details on reference deployments, or OS-specific installation instructi Ubuntu 18.04 Ubuntu 20.04 RHEL 7 / CentOS 7 - RHEL 8 / CentOS 8 + RHEL 8 / RockyLinux 8 / CentOS 8 Vagrant / OVA Docker Ansible Playbooks diff --git a/docs/source/install/puppet.rst b/docs/source/install/puppet.rst index 49a522fe..7a513e8c 100644 --- a/docs/source/install/puppet.rst +++ b/docs/source/install/puppet.rst @@ -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 ` also apply. diff --git a/docs/source/install/rhel8.rst b/docs/source/install/rhel8.rst index 05326192..a4720c38 100644 --- a/docs/source/install/rhel8.rst +++ b/docs/source/install/rhel8.rst @@ -13,10 +13,13 @@ Please check the :doc:`supported versions and system requirements `_ +.. 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 -------------------- diff --git a/docs/source/install/system_requirements.rst b/docs/source/install/system_requirements.rst index 05280dc2..e54dd2c1 100644 --- a/docs/source/install/system_requirements.rst +++ b/docs/source/install/system_requirements.rst @@ -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 ` for more details about our Linux distribution support policy. @@ -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 `_ | `bento/ubuntu-18.04 `_ | `Ubuntu Server 18.04 LTS Bionic `_ | -+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `Ubuntu 20.04 `_ | `bento/ubuntu-20.04 `_ | `Ubuntu Server 20.04 LTS Focal `_ | -+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `RHEL 8 `_ / | `bento/centos-8.2 `_ | `Red Hat Enterprise Linux (RHEL) 8 (HVM) `_ | -| `CentOS 8.2 `_ | | | -+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| `RHEL 7 `_ / | `bento/centos-7.4 `_ | `Red Hat Enterprise Linux (RHEL) 7.2 (HVM) `_ | -| `CentOS 7 `_ | | | -+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Linux (64-bit) | Vagrant Box | Amazon AWS AMI | ++=======================================================================================================+================================================================================+===================================================================================================================================================================+ +| `Ubuntu 18.04 `_ | `bento/ubuntu-18.04 `_ | `Ubuntu Server 18.04 LTS Bionic `_ | ++-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `Ubuntu 20.04 `_ | `bento/ubuntu-20.04 `_ | `Ubuntu Server 20.04 LTS Focal `_ | ++-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `RHEL 8 `_ / | `bento/rockylinux-8.5 `_ | `Red Hat Enterprise Linux (RHEL) 8 (HVM) `_ | +| `RockyLinux 8 `_ | | | ++-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| `RHEL 7 `_ / | `bento/centos-7.4 `_ | `Red Hat Enterprise Linux (RHEL) 7.2 (HVM) `_ | +| `CentOS 7 `_ | | | ++-------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ This is the recommended minimum sizing for testing and deploying |st2|: @@ -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``. + diff --git a/docs/source/install/uninstall.rst b/docs/source/install/uninstall.rst index 40b33d2a..6e73620e 100644 --- a/docs/source/install/uninstall.rst +++ b/docs/source/install/uninstall.rst @@ -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 @@ -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: @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/source/install/upgrades.rst b/docs/source/install/upgrades.rst index cd3d599d..00ee40ea 100644 --- a/docs/source/install/upgrades.rst +++ b/docs/source/install/upgrades.rst @@ -57,7 +57,7 @@ note the URLs that failed on retrieval should be ``https://packagecloud.io/Stack W: Failed to fetch https://packagecloud.io/StackStorm/stable/ubuntu/dists/xenial/InRelease The following signatures couldn't be verified because the public key is not available: NO_PUBKEY C2E73424D59097AB W: Some index files failed to download. They have been ignored, or old ones used instead. -For |st2| community version on RHEL/CentOS, run the following command to update the keys. If you +For |st2| community version on RHEL/CentOS/RockyLinux, run the following command to update the keys. If you are running a non production version of StackStorm, then replace ``stable`` in the URL with the appropriate repository name. @@ -75,7 +75,7 @@ repository name. Replace ```` with your enterprise license key. curl -s https://packagecloud.io/install/repositories/StackStorm/stable/script.rpm.sh | sudo bash curl -s https://:@packagecloud.io/install/repositories/StackStorm/enterprise/script.rpm.sh | sudo bash -If the new gpg keys are not setup in advanced on RHEL/CentOS, running ``yum update`` will auto-retrieve +If the new gpg keys are not setup in advanced on RHEL/CentOS/RockyLinux, running ``yum update`` will auto-retrieve the new gpg key for appropriate respository. ``yum update`` will ask if you want to import the new gpg keys. Verify that the key is retrieved from ``https://packagecloud.io/StackStorm/stable/gpgkey`` for the |st2| community and enter ``y`` to confirm. For |st2| enterprise repo, an additional key needs to be retrieved from @@ -134,7 +134,7 @@ This is the standard upgrade procedure: sudo apt-get install --only-upgrade st2 st2web st2chatops - RHEL/CentOS: + RHEL/CentOS/RockyLinux: .. sourcecode:: bash @@ -184,7 +184,7 @@ v3.5 curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash - sudo apt-get install --only-upgrade nodejs st2chatops - RHEL/CentOS: + RHEL/CentOS/RockyLinux: .. sourcecode:: bash diff --git a/docs/source/packs.rst b/docs/source/packs.rst index 82fde524..80c97ad4 100644 --- a/docs/source/packs.rst +++ b/docs/source/packs.rst @@ -327,7 +327,7 @@ Proxy Configuration via Environment Variables On Ubuntu systems, edit ``/etc/default/st2actionrunner`` and ``/etc/default/st2api`` to set the proxy configuration environment variables. -For RHEL/CentOS systems, edit ``/etc/sysconfig/st2actionrunner`` and ``/etc/sysconfig/st2api``. +For RHEL/RockyLinux/CentOS systems, edit ``/etc/sysconfig/st2actionrunner`` and ``/etc/sysconfig/st2api``. |st2| will use these environment variables for pack installation. The file contents should look as follows: diff --git a/docs/source/reference/content_version.rst b/docs/source/reference/content_version.rst index 509f3af7..c8912795 100644 --- a/docs/source/reference/content_version.rst +++ b/docs/source/reference/content_version.rst @@ -7,7 +7,7 @@ Using a Specific Version of Pack Content When Running an Action the latest stable version of git is recommended. If you are using Ubuntu 14.04, the latest stable version of git can be installed directly from the - `official git ppa `_. For RHEL / CentOS, + `official git ppa `_. For RHEL / RockyLinux / CentOS, the latest version can be found in the `IUS repos `_. By default, when running an execution for an action from a pack on disk which is a git repository, diff --git a/docs/source/reference/ha.rst b/docs/source/reference/ha.rst index 06d3c8a0..c40a03d9 100644 --- a/docs/source/reference/ha.rst +++ b/docs/source/reference/ha.rst @@ -291,7 +291,7 @@ In this section we provide a highly opinionated and therefore prescriptive appro |st2| in HA. This deployment has 3 independent boxes which we categorize as "controller box" and "blueprint box." We'll call these boxes ``st2-multi-node-cntl``, ``st2-multi-node-1`` and ``st2-multi-node-2``. For the sake of reference we will be using Ubuntu 18.04 as the base OS. -Obviously you can also use RedHat/CentOS. +Obviously you can also use RedHat/RockyLinux/CentOS. .. figure :: /_static/images/st2-deployment-multi-node.png :align: center diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst index 8847e60f..89395140 100644 --- a/docs/source/roadmap.rst +++ b/docs/source/roadmap.rst @@ -16,10 +16,10 @@ contributions. Here's our plans for the next releases. the feature. Pull Requests are open to anyone. -3.6 +3.7 --- -* The roadmap for ``3.6`` is in the works, stay tuned! +* The roadmap for ``3.7`` is in the works, stay tuned! Monitor the `master branch `_ to see how we're progressing. @@ -58,6 +58,14 @@ Submit a PR! Release History --------------- +.. rubric:: Done in v3.6 + +* RabbitMQ:** Updated all OS to use latest RabbitMQ +* Security improvements:** Use Jinja sandbox to mitigate against CVE-2021-44657 +* API changes:** Additional option to remove files when deleting packs +* Service configuration:** Changes made to simplify the service configuration to make it simpler to change ports used by services +* Profiling:** New flags to support debugging and profiling --enable-profiler and --enable-eventlet-blocking-detection + .. rubric:: Done in v3.5 * **Ubuntu Focal:** Add support for Ubuntu 20.04, with Python 3.8 and Mongo 4.4