Skip to content
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
9 changes: 4 additions & 5 deletions docs/source/coordination.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,14 @@ 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
/opt/stackstorm/st2/bin/pip install redis

# Example when using consul backend
/opt/stackstorm/st2/bin/pip install consul
19 changes: 16 additions & 3 deletions docs/source/install/upgrades.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,24 @@ v3.5
sudo rpm -e --nodeps nodejs
sudo yum upgrade st2chatops

* 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

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
''''
Expand Down
3 changes: 3 additions & 0 deletions docs/source/upgrade_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down