From 434cdd3d6ba66580e2a737283f5b039a333367dc Mon Sep 17 00:00:00 2001 From: amanda Date: Tue, 15 Jun 2021 17:34:46 +0100 Subject: [PATCH 1/3] Further upgrade info --- docs/source/coordination.rst | 8 +++++--- docs/source/install/upgrades.rst | 19 ++++++++++++++++--- docs/source/upgrade_notes.rst | 3 +++ 3 files changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/source/coordination.rst b/docs/source/coordination.rst index dec0e455..77be6d8c 100644 --- a/docs/source/coordination.rst +++ b/docs/source/coordination.rst @@ -37,14 +37,16 @@ ZooKeeper: url = kazoo://username:password@host:port Some of these coordination backends also require corresponding client libraries to be installed -in |st2| virtualenv. We do not ship these libraries by default. As an example, to install the client -library in |st2| virtualenv, run: +in |st2| virtualenv. +Since |st2| v3.5 the redis client libraries are included with the st2 package, but for +all other versions or coordination backends, we do not ship these libraries by default. +As an example, to install the client library in |st2| virtualenv, run: .. sourcecode:: bash sudo su - # Example when using redis backend + # Example when using redis backend (not required for ST2 >= 3.5) /opt/stackstorm/st2/bin/pip install redis # Example when using consul backend diff --git a/docs/source/install/upgrades.rst b/docs/source/install/upgrades.rst index ab4950de..29889ba1 100644 --- a/docs/source/install/upgrades.rst +++ b/docs/source/install/upgrades.rst @@ -193,11 +193,24 @@ v3.5 sudo rpm -e --nodeps nodejs sudo yum upgrade st2chatops +* |st2| has been updated to configure only TLSv1.2 and v1.3 on nginx. The default nginx ST2 configuration will need to be updated manually, and nginx restarted: + + .. sourcecode:: bash + + sudo sed -i.bak 's|ssl_protocols.*|ssl_protocols TLSv1.2 TLSv1.3;|g' /etc/nginx/conf.d/st2.conf + sudo systemctl restart nginx + +* The packaged st2.conf has been altered in this release to use redis for the coordination url, see point below. + Depending on your distribution, when the st2 package is upgraded it will either ask you which version to use, + or will save a copy of the new st2.conf. + You are advised to review the differences between your current st2.conf and the packaged st2.conf + to create a merged st2.conf for your particular installation. + * Redis server is installed and configured as backend for the coordination service by default in the single node installation script to support workflows with multiple - branches and tasks with items. Upgrade requires coordination service to be setup - manually, For workflows to be executed properly, setup the coordination service - accordingly. See :doc:`../coordination` for setup instruction. + branches and tasks with items. Upgrade requires coordination server and service to be setup + manually. For workflows to be executed properly, setup the coordination service + accordingly. See :doc:`../coordination` for setup instructions. v3.4 '''' diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index 11f76920..025ec0c9 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -16,6 +16,9 @@ Upgrade Notes Upgrade requires coordination service to be setup manually. For workflows to be executed properly, setup the coordination service accordingly. +* Validation of action definitions are stricter. If an action definition has duplicate parameters, |st2| + will complain when ``st2ctl reload`` is performed at upgrade. Action/workflow definitions should be checked + for duplicate parameters before upgrade. * The underlying database field type for storing large values such as action execution result has changed for various database models (ActionExecutionDB, LiveActionDB, WorkflowExecutionDB, From b8202105cf4d8792ac169218c1fbb89d522c34c8 Mon Sep 17 00:00:00 2001 From: Amanda McGuinness Date: Wed, 16 Jun 2021 21:21:29 +0100 Subject: [PATCH 2/3] Update docs/source/coordination.rst Updated with review comment Co-authored-by: Eugen Cusmaunsa --- docs/source/coordination.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/source/coordination.rst b/docs/source/coordination.rst index 77be6d8c..4c055ad9 100644 --- a/docs/source/coordination.rst +++ b/docs/source/coordination.rst @@ -46,8 +46,5 @@ As an example, to install the client library in |st2| virtualenv, run: sudo su - # Example when using redis backend (not required for ST2 >= 3.5) - /opt/stackstorm/st2/bin/pip install redis - # Example when using consul backend /opt/stackstorm/st2/bin/pip install consul From 61211ce6a6401c7fbc1b2b2d1275b31454dfca48 Mon Sep 17 00:00:00 2001 From: Amanda McGuinness Date: Wed, 16 Jun 2021 21:30:12 +0100 Subject: [PATCH 3/3] Update upgrades.rst --- docs/source/install/upgrades.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/install/upgrades.rst b/docs/source/install/upgrades.rst index 29889ba1..f73168d6 100644 --- a/docs/source/install/upgrades.rst +++ b/docs/source/install/upgrades.rst @@ -193,7 +193,7 @@ v3.5 sudo rpm -e --nodeps nodejs sudo yum upgrade st2chatops -* |st2| has been updated to configure only TLSv1.2 and v1.3 on nginx. The default nginx ST2 configuration will need to be updated manually, and nginx restarted: +* The default st2 nginx configuration has been updated to support only TLSv1.2 and v1.3 on nginx. The package upgrade does not update the deployed nginx configuration with the packaged version (/usr/share/doc/st2/conf/nginx/st2.conf), therefore the nginx ST2 configuration will need to be updated manually and nginx restarted: .. sourcecode:: bash