diff --git a/docs/source/install/rhel8.rst b/docs/source/install/rhel8.rst index 52f10777..da5314ff 100644 --- a/docs/source/install/rhel8.rst +++ b/docs/source/install/rhel8.rst @@ -1,5 +1,5 @@ -RHEL 8/CentOS 8 -=============== +RHEL 8/RockyLinux 8 +======================================================================== .. include:: common/intro.rst @@ -7,24 +7,18 @@ RHEL 8/CentOS 8 :local: System Requirements -------------------- +------------------------------------------------------------------------ Please check the :doc:`supported versions and system requirements `. -.. note:: - - |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. - `_ - .. 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 --------------------- +------------------------------------------------------------------------ Adjust SELinux Policies -~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If your system has SELinux in Enforcing mode, please follow these instructions to adjust SELinux policies. This is needed for successful installation. If you are not happy with these policies, @@ -55,7 +49,7 @@ you may want to tweak them according to your security practices. adjust policy configurations when SELinux is disabled. You can ignore this error. Install Dependencies -~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: __mongodb_note.rst @@ -86,7 +80,7 @@ Install MongoDB, RabbitMQ, and Redis: Setup Repositories -~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following script will detect your platform and architecture and setup the appropriate |st2| repository. It will also add the the GPG key used for package signing. @@ -96,7 +90,7 @@ repository. It will also add the the GPG key used for package signing. curl -s https://packagecloud.io/install/repositories/StackStorm/stable/script.rpm.sh | sudo bash Install |st2| Components -~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. code-block:: bash @@ -105,27 +99,27 @@ Install |st2| Components .. include:: common/configure_components.rst Setup Datastore Encryption -~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: common/datastore_crypto_key.rst Configure SSH and SUDO -~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: common/configure_ssh_and_sudo.rst Start Services -~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: common/start_services.rst Verify -~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: common/verify.rst Configure Authentication ------------------------- +------------------------------------------------------------------------ The reference deployment uses a file-based authentication provider for simplicity. Refer to :doc:`/authentication` to configure and use PAM or LDAP authentication backends. @@ -144,7 +138,7 @@ To set up authentication with file-based provider: .. include:: common/configure_authentication.rst Install WebUI and Setup SSL Termination ---------------------------------------- +------------------------------------------------------------------------ `NGINX `_ is used to serve WebUI static files, redirect HTTP to HTTPS, provide SSL termination, and reverse-proxy st2auth and st2api API endpoints. To set it up: install the @@ -212,7 +206,7 @@ survive reboot. .. include:: common/api_access.rst Setup ChatOps -------------- +------------------------------------------------------------------------ If you already run a Hubot instance, you can install the `hubot-stackstorm plugin `_ and configure |st2| environment variables, as @@ -262,7 +256,7 @@ is to use the `st2chatops `_ package. * That's it! Go to your Chat room and begin ChatOps-ing. Read more in the :doc:`/chatops/index` section. A Note on Security ------------------- +------------------------------------------------------------------------ .. include:: common/security_notes.rst diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index 6a4839e2..834e6eba 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -9,9 +9,10 @@ Upgrade Notes ---------- * Compatibility updates. - - Linux distribution support for Ubuntu 22.04 Jammy and RockyLinux 9 (RHEL9 compatible) has been added. Support for Ubuntu 18.04 Focal and CentOS 7 has been removed. - - Python versions from ``3.8`` to ``3.11`` are supported along with the removal of ``3.6`` support. - - MongoDB compatibility ranges from ``4.x`` to ``v7.x`` for the official MongoDB database. + + * Linux distribution support for Ubuntu 22.04 Jammy and RockyLinux 9 (RHEL9 compatible) has been added. Support for Ubuntu 18.04 Focal and CentOS 7 has been removed. + * Python versions from ``3.8`` to ``3.11`` are supported along with the removal of ``3.6`` support. + * MongoDB compatibility ranges from ``4.x`` to ``v7.x`` for the official MongoDB database. * Configuration updates required in ``st2.conf``. @@ -21,7 +22,7 @@ Upgrade Notes .. code-block:: - cat path/to/ssl_keyfile path/to/ssl_certfile > path/to/tls_certificate_key_file + cat path/to/ssl_keyfile path/to/ssl_certfile > path/to/tls_certificate_key_file Other options that were renamed under ``[database]`` are (more details available in ``st2.conf.sample``): @@ -31,6 +32,45 @@ Upgrade Notes * ``ssl_ca_certs`` -> ``tls_ca_file`` * ``ssl_match_hostnames`` -> ``tls_allow_invalid_hostnames`` (meaning is inverted: the new option is the opposite of the old) +* YAQL `format` fucntion removed. + + Due to security concerns related to potential unauthorised data access the `str().format()` function was removed. Upstream developers + recommend to replace the use of `format` with string concatentation. Users can replace the ``format`` function by the ``+`` operator and the ``str`` YAQL function. + + ``format("{0}-{1}", a b)`` rewirtten as ``str(a) + '-' + str(b)`` + Further details can be seen in the security issue https://bugs.launchpad.net/murano/+bug/2048114 + + In cases where the string is not controlled by the workflow directly, the `replace` function can be used. + + *Workflow Context* + + .. code-block:: yaml + + { + "name": "hostname1", + "status": "Online", + "string_keywords": "Server {name} is {status}.", + "string_positional": "Server {0} is {1}." + } + + *String using keyword* + + .. code-block:: + + <% ctx(string_keywords).replace("{name}", ctx(name)).replace("{status}", ctx(status)) %> + + *String using positional arguments* + + .. code-block:: + + <% ctx(string_positional).replace("{0}", ctx(name)).replace("{1}", ctx(status)) %> + + *Output* + :: + + 'Server hostname1 is Online.' + + Use Jinja in cases where `replace` isn't optimal. .. _ref-upgrade-notes-v3-8: diff --git a/version.txt b/version.txt index 83c5bc50..bd28b9c5 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -3.9dev +3.9