Skip to content

Commit 8407175

Browse files
authored
Merge pull request #669 from StackStorm/upgrade_notes
Clarified upgrade instructions
2 parents ddf63d0 + 4fd9043 commit 8407175

File tree

1 file changed

+14
-22
lines changed

1 file changed

+14
-22
lines changed

docs/source/install/upgrades.rst

+14-22
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,37 @@ Upgrades
44
When new versions of |st2| are released, they are published to our APT and Yum repositories. You
55
can use standard Linux package management tools to install these upgraded packages.
66

7-
Depending on the versions you are upgrading to and from, you may need to run additional data model
8-
:ref:`migration scripts<migration-scripts-to-run>`.
7+
As part of the general upgrade procedure, you will need to run scripts to upgrade the Mistral Database prior
8+
to restarting |st2| services. See below for more details. Depending on the versions you are upgrading to and
9+
from, you may need to run additional :ref:`migration scripts<migration-scripts-to-run>`.
910

1011
If you skipped a version and are upgrading to a newer version, please make sure you also run the
1112
migration scripts for skipped versions.
1213

1314
General Upgrade Procedure
1415
-------------------------
1516

16-
The typical **upgrade** procedure is:
17+
This is the standard upgrade procedure:
1718

1819
1. Stop ``st2*`` services:
1920

2021
.. sourcecode:: bash
2122

2223
sudo st2ctl stop
2324

24-
2. Upgrade |st2| packages (``st2``, ``st2web``, ``st2chatops``, ``st2mistral`` and
25-
``bwc-enterprise`` using distro-specific tools:
25+
2. Upgrade |st2| packages using distro-specific tools:
2626

2727
Ubuntu:
2828

2929
.. sourcecode:: bash
3030

31-
sudo apt-get install --only-upgrade $PKG_NAME
31+
sudo apt-get install --only-upgrade st2 st2web st2chatops st2mistral
3232

33-
RHEL / CentOS:
33+
RHEL/CentOS:
3434

3535
.. sourcecode:: bash
3636

37-
sudo yum update $PKG_NAME
37+
sudo yum update st2 st2web st2chatops st2mistral
3838

3939
3. Upgrade Mistral database:
4040

@@ -49,15 +49,6 @@ The typical **upgrade** procedure is:
4949
restarted before the mistral-db-manage commands are run, then the
5050
``mistral-db-manage upgrade head`` command may fail.
5151

52-
.. note::
53-
54-
When running the ``populate`` command, if there are errors for
55-
``mistral.actions.openstack.action_generator.base``, these can be ignored. These indicate
56-
that the command encountered errors when registering the native OpenStack actions in
57-
Mistral. |st2| does not support these native OpenStack actions. Please use the OpenStack
58-
pack from the StackStorm Exchange.
59-
https://github.com/StackStorm-Exchange/stackstorm-openstack
60-
6152
4. Run the migration scripts (if any). See below for version-specific migration scripts.
6253

6354
5. Start |st2| services:
@@ -71,12 +62,13 @@ The typical **upgrade** procedure is:
7162
Version-specific Migration Scripts
7263
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7364

74-
We document :ref:`upgrade notes<upgrade_notes>` for the various versions. The upgrade notes
75-
section gives an idea of what major changes happened with each release. You may also want to take
76-
a look at the detailed :doc:`/changelog` for each version.
65+
We document :ref:`upgrade notes<upgrade_notes>` for the various versions. The upgrade notes section gives
66+
an idea of what major changes happened with each release. You may also want to take a look at the detailed
67+
:doc:`/changelog` for each version.
7768

78-
The following sections call out the migration scripts that need to be run before upgrading to the
79-
respective version:
69+
The following sections call out the migration scripts that need to be run when upgrading to the
70+
respective version. If you are upgrading across multiple versions, make sure you run the scripts for
71+
any skipped versions:
8072

8173
v2.5
8274
'''''

0 commit comments

Comments
 (0)