Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Further upgrade info #1077

Merged
merged 3 commits into from
Jun 16, 2021
Merged

Further upgrade info #1077

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
434cdd3
Further upgrade info
amanda11 Jun 15, 2021
b820210
Update docs/source/coordination.rst
amanda11 Jun 16, 2021
61211ce
Update upgrades.rst
amanda11 Jun 16, 2021
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
8 changes: 5 additions & 3 deletions docs/source/coordination.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

amanda11 marked this conversation as resolved.
Show resolved Hide resolved
# Example when using consul backend
Expand Down
19 changes: 16 additions & 3 deletions docs/source/install/upgrades.rst
View file
Open in desktop
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

* |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
Copy link
Member

@arm4b arm4b Jun 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW per https://github.com/StackStorm/st2-packages/blob/master/scripts/st2bootstrap-deb.sh#L633-L634
the original nginx file shipped with the packages (incl. updated 3.5.0) is located at /usr/share/doc/st2/conf/nginx/st2.conf if it would be easier to reference it instead.


* 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
View file
Open in desktop
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