Upgrade notes for v3.9 (#1176)

Author: nzlosh

docs/source/chatops/chatops.rst

@@ -252,5 +252,4 @@ Logging
 =======
 
 ChatOps logs are written to ``/var/log/st2/st2chatops.log`` on non systemd-based distros. For
-systemd-based distros (Ubuntu 18/20, RHEL/RockyLinux8+), you can access the logs via
-``journalctl --unit=st2chatops``
+systemd-based distros, you can access the logs via ``journalctl --unit=st2chatops``

docs/source/install/uninstall.rst

@@ -40,7 +40,7 @@ below. Only execute the instructions for your distribution.
 1. Stop Services
 ----------------
 
-* Ubuntu 18.04/20.04:
+* Ubuntu:
 
   .. sourcecode:: bash
 
@@ -69,7 +69,7 @@ below. Only execute the instructions for your distribution.
 2. Remove Packages
 ------------------
 
-* Ubuntu 18.04/20.04:
+* Ubuntu:
 
   If you are using StackStorm only:
 

docs/source/roadmap.rst

@@ -16,10 +16,12 @@ contributions. Here's our plans for the next releases.
     the feature. Pull Requests are open to anyone.
 
 
-3.8
+3.10
 ---
 
-* **Output Schema:** Allow action/runner output schemas to cover all output types, not just JSON objects.
+* **SSO:** Support SSO with SAML2 for |ewc| web UI (beta).
+* **Python ChatOps:** Convert ChatOps backend to Python
+
 * More will be added to the roadmap for ``3.8``. So, stay tuned!
 
 Monitor the `master branch <https://github.com/StackStorm/st2/>`_ to see how we're progressing.
@@ -29,12 +31,10 @@ Backlog
 
 Here's some more nice things on our list that we haven't scheduled yet:
 
-* **Python ChatOps:** Convert ChatOps backend to Python
 * **ChatOps:** Support RBAC.
 * **K8s/HA:** Graduate `K8s Helm chart <https://github.com/stackstorm/stackstorm-ha>`_ from beta to stable.
 * **Workflow runtime graph:** Runtime view of workflow execution in st2flow for |ewc|.
 * **Workflow dry run:** Ability to run unit tests on orquesta workflows for |ewc|.
-* **SSO:** Support SSO with SAML2 for |ewc| web UI (beta).
 * **Job Scheduling:** Job scheduling for ad-hoc jobs.
 * **Datastore viewer/editor:** Datastore viewer/editor at web UI.
 * **History and Audit service:** History view with advanced search over years worth of execution
@@ -59,6 +59,17 @@ Submit a PR!
 Release History
 ---------------
 
+.. rubric:: Done in v3.9
+
+* **MongoDB compatibility:** Support for versions greater than v4.x add with v7.x being actively tested.
+* **RHEL/RockyLinux 9:** is now supported which has replaced RHEL7 in the supported OS matrix.
+* **Ubuntu Jammy 22.04:** is now supported and has replaced Ubuntu Bionic 18.04
+* **Python 3.9, 3.10 & 3.11:** st2 is now tested against supported version of Python.  Python 3.6 support has been removed.
+
+.. rubric:: Done in v3.8
+
+* **Output Schema:** Allow action/runner output schemas to cover all output types, not just JSON objects.
+
 .. rubric:: Done in v3.7
 
 * **RHEL/RockyLinux 8:** EL8 support continues, despite the deprecation of CentOS 8. We now use RockyLinux 8 to build for and test on EL8.

docs/source/upgrade_notes.rst

@@ -3,6 +3,35 @@
 Upgrade Notes
 =============
 
+.. _ref-upgrade-notes-v3-9:
+
+|st2| v3.9
+----------
+
+ * 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.
+
+ * Configuration updates required in ``st2.conf``.
+
+    Several ``st2.conf`` database options have been renamed or deprecated. Most of the options will continue to work using their old name.
+    However, if you use `[database].ssl_keyfile` and/or `[database].ssl_certfile`, you MUST migrate to `[database].tls_certificate_key_file`.
+    This new option expects the key and certificate in the same file.  Use something like the following to create that file from your old files:
+
+    .. code-block::
+
+    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``):
+
+    * ``ssl`` -> ``tls``
+    * ``ssl_cert_reqs`` -> ``tls_allow_invalid_certificates`` (opt type change: string -> boolean)
+    * ``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)
+
+
 .. _ref-upgrade-notes-v3-8:
 
 |st2| v3.8
@@ -53,7 +82,7 @@ Upgrade Notes
 * As part of extending RBAC support to include protecting access to datastore operations, if
   you have RBAC enabled and any workflows access the datastore, then any user with execute
   permissions for those workflows will need to be assigned an RBAC role with the appropriate
-  key_value_pair permissions.  
+  key_value_pair permissions.
   Further information can be found in the :doc:`RBAC documentation <rbac>`.
 
 * Additional garbage collection options are available to automatically delete old tokens.
@@ -102,7 +131,7 @@ Upgrade Notes
 
 * As part of extending RBAC support to include protecting access to datastore operations, if
   you have RBAC enabled and any sensors access the datastore, then the ``sensor_service`` user will
-  need to be assigned an RBAC role with the appropriate key_value_pair permissions.  
+  need to be assigned an RBAC role with the appropriate key_value_pair permissions.
   Further information can be found in the :doc:`RBAC documentation <rbac>`.
 
 .. _ref-upgrade-notes-v3-6:
@@ -156,10 +185,10 @@ Upgrade Notes
 
 * ``%`` interpolation in st2 configuration parameters is no longer supported. Update your configuration
   parameters to fix strings if you use ``%`` interpolation to lookup keys as part of your parameter.
-  
+
   Now ``%`` is a valid character in parameter values.
-  
-  This increases security because passwords with a ``%`` in it do no longer result into an error. 
+
+  This increases security because passwords with a ``%`` in it do no longer result into an error.
 
 * The underlying database field type for storing large values such as action execution result has
   changed for various database models (ActionExecutionDB, LiveActionDB, WorkflowExecutionDB,
@@ -288,11 +317,11 @@ Upgrade Notes
   the ``/opt/stackstorm/st2`` virtualenv. This is caused by the fact that the core ``st2``
   package no longer bundles in the ``pyasn1`` module, so it will be absent post-upgrade.
   Running following command will be necessary for ``st2auth`` to function again:
-  
+
   .. code-block:: bash
 
    /opt/stackstorm/st2/bin/pip install pyasn1
-  
+
 
 .. _ref-upgrade-notes-v3-0:
 
@@ -405,7 +434,7 @@ Upgrade Notes
   ``sudo st2ctl reload --register-runners`` command.
 
   Keep in mind that all the runners which are installed inside |st2| virtual environment are now
-  automatically loaded and registered on each |st2| service start up. You only need to run 
+  automatically loaded and registered on each |st2| service start up. You only need to run
   ``sudo st2ctl reload --register-runners`` if you are using runner outside the service context or
   if you didn't restart the services.