From c7c3ccea5228a558f4558232f96d77cafbc595c8 Mon Sep 17 00:00:00 2001 From: amanda Date: Thu, 13 Aug 2020 16:09:30 +0100 Subject: [PATCH 1/2] Initial mistral removal from st2docs --- docs/source/install/__installer_passwords.rst | 5 +- docs/source/install/ansible.rst | 13 --- .../install/common/configure_components.rst | 5 +- docs/source/install/common/security_notes.rst | 17 ++-- .../install/common/setup_mistral_database.rst | 14 ---- docs/source/install/config/config.rst | 57 ------------- docs/source/install/k8s_ha.rst | 4 - docs/source/install/overview.rst | 17 +--- docs/source/install/rhel7.rst | 23 +----- docs/source/install/rhel8.rst | 3 - docs/source/install/system_requirements.rst | 1 - docs/source/install/u16.rst | 10 +-- docs/source/install/u18.rst | 3 - docs/source/install/uninstall.rst | 81 ++++++------------- docs/source/install/upgrades.rst | 29 ++----- docs/source/install/vagrant.rst | 2 +- docs/source/upgrade_notes.rst | 4 + 17 files changed, 51 insertions(+), 237 deletions(-) delete mode 100644 docs/source/install/common/setup_mistral_database.rst diff --git a/docs/source/install/__installer_passwords.rst b/docs/source/install/__installer_passwords.rst index a54cc0355..e3c985239 100644 --- a/docs/source/install/__installer_passwords.rst +++ b/docs/source/install/__installer_passwords.rst @@ -1,8 +1,7 @@ .. note:: For security reasons, the installer script enables authentication and generates random - passwords for dependent services such as MongoDB and PostgreSQL. + passwords for dependent services such as MongoDB. If for some reason (e.g. debugging), you need to access those services directly you can find - passwords in the config files - ``/etc/st2/st2.conf`` for MongoDB and RabbitMQ password and - ``/etc/mistral/mistral.conf`` for PostgreSQL password. + passwords in the config files - ``/etc/st2/st2.conf`` for MongoDB and RabbitMQ password. diff --git a/docs/source/install/ansible.rst b/docs/source/install/ansible.rst index 5cd8b2bb4..9b7e58b41 100644 --- a/docs/source/install/ansible.rst +++ b/docs/source/install/ansible.rst @@ -53,10 +53,8 @@ complete installation: - ``epel`` - Repository with extra packages for ``RHEL/CentOS``. - ``mongodb`` - Main DB storage engine. - ``rabbitmq`` - Message broker. -- ``postgresql`` - DB storage engine for Mistral. - ``st2repos`` - Adds |st2| PackageCloud repositories. - ``st2`` - Install and configure |st2| itself. -- ``st2mistral`` - Install and configure |st2| Mistral workflow engine. - ``nginx`` - Dependency for ``st2web``. - ``st2web`` - Nice & shiny WebUI for |st2|. - ``nodejs`` - Dependency for ``st2chatops``. @@ -77,7 +75,6 @@ Here's a more advanced example showing how to customize your |st2| deployment: roles: - mongodb - rabbitmq - - postgresql - nginx - nodejs @@ -99,16 +96,6 @@ Here's a more advanced example showing how to customize your |st2| deployment: # Dict to edit https://github.com/StackStorm/st2/blob/master/conf/st2.conf.sample st2_config: {} - - name: Install and configure st2mistral - role: st2mistral - vars: - st2mistral_version: latest - st2mistral_db: mistral - st2mistral_db_username: mistral - st2mistral_db_password: StackStorm - # Dict to edit https://github.com/StackStorm/st2-packages/blob/master/packages/st2mistral/conf/mistral.conf - st2mistral_config: {} - - name: Install st2web role: st2web diff --git a/docs/source/install/common/configure_components.rst b/docs/source/install/common/configure_components.rst index 667747447..41218dc12 100644 --- a/docs/source/install/common/configure_components.rst +++ b/docs/source/install/common/configure_components.rst @@ -1,8 +1,7 @@ -If you are not running RabbitMQ, MongoDB or PostgreSQL on the same system, or have changed the +If you are not running RabbitMQ or MongoDBL on the same system, or have changed the defaults, please adjust these settings: -* RabbitMQ connection at ``/etc/st2/st2.conf`` and ``/etc/mistral/mistral.conf`` +* RabbitMQ connection at ``/etc/st2/st2.conf`` * MongoDB at ``/etc/st2/st2.conf`` -* PostgreSQL at ``/etc/mistral/mistral.conf`` See the :doc:`Configuration documentation ` for more information. diff --git a/docs/source/install/common/security_notes.rst b/docs/source/install/common/security_notes.rst index ee2e73da5..e8ae20419 100644 --- a/docs/source/install/common/security_notes.rst +++ b/docs/source/install/common/security_notes.rst @@ -1,4 +1,4 @@ -By default, when MongoDB, RabbitMQ and PostgreSQL are installed, they have authentication disabled +By default, when MongoDB and RabbitMQ are installed, they have authentication disabled or use a default static password. As such, after you install those services you should configure them and enable authentication with strong randomly generated passwords. @@ -9,7 +9,6 @@ documentation. For more information refer to the links below: * MongoDB - https://docs.mongodb.com/manual/tutorial/enable-authentication/, https://docs.mongodb.com/manual/core/authorization/ * RabbitMQ - https://www.rabbitmq.com/authentication.html -* PostgreSQL - https://www.postgresql.org/docs/9.4/static/auth-methods.html After you enable authentication for those components, you will also need to update |st2| services to use the new settings. @@ -22,26 +21,20 @@ This means editing the following configuration options: * ``database.password`` - MongoDB database password. * ``messaging.url`` - RabbitMQ transport url (``amqp://:@:5672``) -2. Mistral - ``/etc/mistral/mistral.conf`` - - * ``database.connection`` - PostgreSQL database connection string (``postgresql+psycopg2://:@/mistral``) - * ``transport_url`` - RabbitMQ transport url (``rabbit://:@:5672``) - In addition, you are strongly encouraged to follow these best practices for running network services: -* Ensure communication between services is encrypted. Enable SSL/TLS for MongoDB, RabbitMQ, - and PostgreSQL. +* Ensure communication between services is encrypted. Enable SSL/TLS for MongoDB and RabbitMQ, * Configure services to only listen on localhost, and where needed, internal IP addresses. There - is usually no need for most services which are used by |st2| (MongoDB, RabbitMQ, PostgreSQL) to + is usually no need for most services which are used by |st2| (MongoDB, RabbitMQ) to be available on a public IP address. * Configure a firewall and set up a whitelist. The firewall should only allow access by those users and systems which need access to those services. API and auth services usually need to be - accessible to your users, but other dependent services such as MongoDB, RabbitMQ and PostgreSQL + accessible to your users, but other dependent services such as MongoDB and RabbitMQ don't. These should not be directly accessible by users, and only |st2| components should be allowed to talk to them. * Where possible, you should also utilize additional network-based isolation and security features such as DMZs. The steps mentioned above are especially important for distributed production deployments where -|st2| components are running on multiple servers. \ No newline at end of file +|st2| components are running on multiple servers. diff --git a/docs/source/install/common/setup_mistral_database.rst b/docs/source/install/common/setup_mistral_database.rst deleted file mode 100644 index be531c897..000000000 --- a/docs/source/install/common/setup_mistral_database.rst +++ /dev/null @@ -1,14 +0,0 @@ -Run these commands to set up the Mistral PostgreSQL database: - -.. code-block:: bash - - # Create Mistral DB in PostgreSQL - cat << EHD | sudo -u postgres psql - CREATE ROLE mistral WITH CREATEDB LOGIN ENCRYPTED PASSWORD 'StackStorm'; - CREATE DATABASE mistral OWNER mistral; - EHD - - # Setup Mistral DB tables, etc. - /opt/stackstorm/mistral/bin/mistral-db-manage --config-file /etc/mistral/mistral.conf upgrade head - # Register mistral actions - /opt/stackstorm/mistral/bin/mistral-db-manage --config-file /etc/mistral/mistral.conf populate | grep -v -e openstack -e keystone -e ironicclient diff --git a/docs/source/install/config/config.rst b/docs/source/install/config/config.rst index 329983787..4d35cf19a 100644 --- a/docs/source/install/config/config.rst +++ b/docs/source/install/config/config.rst @@ -351,63 +351,6 @@ file to pass custom environment variables to the ``st2actionrunner`` service/uni WORKERS=25 -Configure Mistral ------------------ - -There are a number of configurable options available under the mistral section in -``/etc/st2/st2.conf``. If the mistral section is not provided, default values will be used. By -default, all Keystone related options are unset and |st2| will not pass any credentials for -authentication to Mistral. Please refer to OpenStack and Mistral documentation for Keystone setup. - -+-----------------------+--------------------------------------------------------+ -| options | description | -+=======================+========================================================+ -| v2_base_url | Mistral API v2 root endpoint | -+-----------------------+--------------------------------------------------------+ -| retry_exp_msec | Multiplier for the exponential backoff. | -+-----------------------+--------------------------------------------------------+ -| retry_exp_max_msec | Max time for each set of backoff. | -+-----------------------+--------------------------------------------------------+ -| retry_stop_max_msec | Max time to stop retrying. | -+-----------------------+--------------------------------------------------------+ -| keystone_username | Username for authentication with OpenStack Keystone. | -+-----------------------+--------------------------------------------------------+ -| keystone_password | Password for authentication with OpenStack Keystone. | -+-----------------------+--------------------------------------------------------+ -| keystone_project_name | OpenStack project scope. | -+-----------------------+--------------------------------------------------------+ -| keystone_auth_url | v3 Auth URL for OpenStack Keystone. | -+-----------------------+--------------------------------------------------------+ - -.. code-block:: ini - - # Example with basic options. The v2_base_url is set to http://workflow.example.com:8989/v2. - # On connection error, the following configuration sets up the action runner to retry - # connecting to Mistral for up to 10 minutes. The retries is setup to be exponential for - # 5 minutes. So in this case, there will be two sets of exponential retries during - # the 10 minutes. - - [mistral] - v2_base_url = http://workflow.example.com:8989/v2 - retry_exp_msec = 1000 - retry_exp_max_msec = 300000 - retry_stop_max_msec = 600000 - -.. code-block:: ini - - # Example with auth options. - - [mistral] - v2_base_url = http://workflow.example.com:8989/v2 - retry_exp_msec = 1000 - retry_exp_max_msec = 300000 - retry_stop_max_msec = 600000 - keystone_username = mistral - keystone_password = pass123 - keystone_project_name = default - keystone_auth_url = http://identity.example.com:5000/v3 - - Authentication -------------- diff --git a/docs/source/install/k8s_ha.rst b/docs/source/install/k8s_ha.rst index 4d6b42ff3..e81541a2d 100644 --- a/docs/source/install/k8s_ha.rst +++ b/docs/source/install/k8s_ha.rst @@ -313,10 +313,6 @@ st2workflowengine drives the execution of orquesta workflows and actually schedu Multiple st2workflowengine processes can run in active-active mode and so minimum ``2`` K8s Deployment replicas are created by default. All the workflow engine processes will share the load and pick up more work if one or more of the processes become available. -.. note:: - As Mistral is going to be deprecated and removed from StackStorm platform soon, Helm chart relies only on - :doc:`Orquesta st2workflowengine ` as a new native workflow engine. - st2notifier ___________ Multiple st2notifier processes can run in active-active mode, using connections to RabbitMQ and MongoDB and generating triggers based on diff --git a/docs/source/install/overview.rst b/docs/source/install/overview.rst index 5821c3910..b733674b8 100644 --- a/docs/source/install/overview.rst +++ b/docs/source/install/overview.rst @@ -68,18 +68,7 @@ the right API, authentication options, suppress insecure warnings for self-signe other conveniences see the :doc:`/reference/cli`. ``st2client`` is packaged with ``st2``, or can be installed independently. -3. st2mistral --------------- - -:doc:`/mistral` is a workflow service component that |st2| uses for long-running workflows. It -is packaged as ``st2mistral``, installed under ``/opt/stackstorm/mistral``, runs in a dedicated -Python virtualenv, and is configured via ``/etc/mistral/mistral.conf``. ``mistral-server`` runs -workflow logic and calling actions, reaching out to st2api for action execution requests. -``st2mistral`` is a mistral plugin with stackstorm extensions. ``mistral-api`` is an internal -end-point accessed by ``st2actionrunner`` and ``st2notifier``. In a single-box deployment it is -restricted to localhost. - -4. NGINX for WebUI and SSL termination +3. NGINX for WebUI and SSL termination -------------------------------------- * **nginx** provides SSL termination, redirects HTTP to HTTPS, serves WebUI static components, and reverse-proxies REST API endpoints to st2* web services. @@ -90,7 +79,7 @@ restricted to localhost. st2auth and st2api REST API endpoints. NGINX proxies inbound requests to ``/api`` and ``/auth`` to the st2api and st2auth services respectively. -5. st2chatops - ChatOps components +4. st2chatops - ChatOps components ---------------------------------- |st2| Chatops components are `Hubot `_, `|st2|'s Hubot adapter `_, and plugins for connecting to `different Chat @@ -103,7 +92,7 @@ ChatOps can be also enabled by installing `hubot-stackstorm plugin Dependencies ------------ -The required dependencies are RabbitMQ, MongoDB, and PostgreSQL. The optional dependencies are: +The required dependencies are RabbitMQ, and MongoDB. The optional dependencies are: - nginx for SSL termination, reverse-proxying API endpoints and serving static HTML. - Redis or Zookeeper for concurrency policies (see :doc:`/reference/policies`). diff --git a/docs/source/install/rhel7.rst b/docs/source/install/rhel7.rst index a5ff31f5d..e17435f0a 100644 --- a/docs/source/install/rhel7.rst +++ b/docs/source/install/rhel7.rst @@ -50,7 +50,7 @@ Install Dependencies .. include:: __mongodb_note.rst -Install MongoDB, RabbitMQ, and PostgreSQL: +Install MongoDB, and RabbitMQ: .. code-block:: bash @@ -73,20 +73,6 @@ Install MongoDB, RabbitMQ, and PostgreSQL: sudo systemctl start mongod rabbitmq-server sudo systemctl enable mongod rabbitmq-server - # Install and configure postgres - sudo yum -y install postgresql-server postgresql-contrib postgresql-devel - - # Initialize PostgreSQL - sudo postgresql-setup initdb - - # Make localhost connections to use an MD5-encrypted password for authentication - sudo sed -i "s/\(host.*all.*all.*127.0.0.1\/32.*\)ident/\1md5/" /var/lib/pgsql/data/pg_hba.conf - sudo sed -i "s/\(host.*all.*all.*::1\/128.*\)ident/\1md5/" /var/lib/pgsql/data/pg_hba.conf - - # Start PostgreSQL service - sudo systemctl start postgresql - sudo systemctl enable postgresql - Setup Repositories ~~~~~~~~~~~~~~~~~~ @@ -102,7 +88,7 @@ Install |st2| Components .. code-block:: bash - sudo yum install -y st2 st2mistral + sudo yum install -y st2 .. include:: common/configure_components.rst @@ -111,11 +97,6 @@ Setup Datastore Encryption .. include:: common/datastore_crypto_key.rst -Setup Mistral Database -~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: common/setup_mistral_database.rst - Configure SSH and SUDO ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/install/rhel8.rst b/docs/source/install/rhel8.rst index e4472bdfb..442779311 100644 --- a/docs/source/install/rhel8.rst +++ b/docs/source/install/rhel8.rst @@ -17,9 +17,6 @@ Please check the :doc:`supported versions and system requirements `_ - Mistral is not supported on RHEL 8/CentOS 8. All workflows must be written in - :doc:`Orquesta `. - Minimal Installation -------------------- diff --git a/docs/source/install/system_requirements.rst b/docs/source/install/system_requirements.rst index 72f180b0b..069acf64a 100644 --- a/docs/source/install/system_requirements.rst +++ b/docs/source/install/system_requirements.rst @@ -55,7 +55,6 @@ By default, |st2| and related services use these TCP ports: * nginx (80, 443) * mongodb (27017) * rabbitmq (4369, 5672, 25672) -* postgresql (5432) * st2auth (9100) * st2api (9101) * st2stream (9102) diff --git a/docs/source/install/u16.rst b/docs/source/install/u16.rst index 47b54c16b..e58120790 100644 --- a/docs/source/install/u16.rst +++ b/docs/source/install/u16.rst @@ -19,7 +19,7 @@ Install Dependencies .. include:: __mongodb_note.rst -Install MongoDB, RabbitMQ, and PostgreSQL: +Install MongoDB, and RabbitMQ: .. code-block:: bash @@ -37,7 +37,6 @@ Install MongoDB, RabbitMQ, and PostgreSQL: sudo apt-get install -y crudini sudo apt-get install -y mongodb-org sudo apt-get install -y rabbitmq-server - sudo apt-get install -y postgresql For Ubuntu ``Xenial`` you may need to enable and start MongoDB. @@ -61,7 +60,7 @@ Install |st2| Components .. code-block:: bash - sudo apt-get install -y st2 st2mistral + sudo apt-get install -y st2 .. include:: common/configure_components.rst @@ -70,11 +69,6 @@ Setup Datastore Encryption .. include:: common/datastore_crypto_key.rst -Setup Mistral Database -~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: common/setup_mistral_database.rst - .. _ref-config-ssh-sudo-deb: Configure SSH and SUDO diff --git a/docs/source/install/u18.rst b/docs/source/install/u18.rst index b327f8e04..61dda67a5 100644 --- a/docs/source/install/u18.rst +++ b/docs/source/install/u18.rst @@ -11,9 +11,6 @@ Ubuntu Bionic (18.04) |st2| on Ubuntu ``18.04`` runs all services, actions and sensors using Python 3 **only**. It does not support Python2 actions. - Mistral is not supported on Ubuntu ``18.04``. All workflows must be written in - :doc:`Orquesta `. - System Requirements ------------------- diff --git a/docs/source/install/uninstall.rst b/docs/source/install/uninstall.rst index e10f7dbd6..0f833eb7a 100644 --- a/docs/source/install/uninstall.rst +++ b/docs/source/install/uninstall.rst @@ -40,64 +40,34 @@ below. Only execute the instructions for your distribution. 1. Stop Services ---------------- -* Ubuntu 16.04: +* Ubuntu 16.04/18.04: .. sourcecode:: bash sudo st2ctl stop sudo service nginx stop - sudo service postgresql stop sudo service mongod stop sudo service rabbitmq-server stop -* Ubuntu 18.04: - - .. sourcecode:: bash - - sudo st2ctl stop - sudo service nginx stop - sudo service mongod stop - sudo service rabbitmq-server stop - -* RHEL/CentOS 7.x: +* RHEL/CentOS 7.x/8.x: .. sourcecode:: bash sudo st2ctl stop sudo systemctl stop nginx - sudo systemctl stop postgresql sudo systemctl stop mongod sudo systemctl stop rabbitmq-server -* RHEL/CentOS 8.x: +.. note:: - .. sourcecode:: bash + If uninstalling a version earlier than StackStorm 3.3 then add postgresql to list of services if running on your system. - sudo st2ctl stop - sudo systemctl stop nginx - sudo systemctl stop mongod - sudo systemctl stop rabbitmq-server 2. Remove Packages ------------------ -* Ubuntu 16: - - If you are using StackStorm only: - - .. sourcecode:: bash - - sudo apt-get purge st2 st2mistral st2chatops st2web - - If you have |ewc| installed, instead use: - - .. sourcecode:: bash - - sudo apt-get purge st2 st2mistral st2chatops st2web bwc-ui st2flow - - -* Ubuntu 18.04: +* Ubuntu 16.04/18.04: If you are using StackStorm only: @@ -112,22 +82,7 @@ below. Only execute the instructions for your distribution. sudo apt-get purge st2 st2chatops st2web bwc-ui st2flow -* RHEL/CentOS 7.x: - - If you are using StackStorm only: - - .. sourcecode:: bash - - sudo yum erase st2 st2mistral st2chatops st2web - - If you have |ewc| installed, instead use: - - .. sourcecode:: bash - - sudo yum erase st2 st2mistral st2chatops st2web bwc-ui st2flow - - -* RHEL/CentOS 8.x: +* RHEL/CentOS 7.x/8.x: If you are using StackStorm only: @@ -141,6 +96,10 @@ below. Only execute the instructions for your distribution. sudo yum erase st2 st2chatops st2web bwc-ui st2flow +.. note:: + + If uninstalling a version earlier than StackStorm 3.3 then add st2mistral to list of packages if it is installed on your system. + 3. Remove |st2| System User --------------------------- @@ -160,13 +119,18 @@ below. Only execute the instructions for your distribution. .. sourcecode:: bash - sudo apt-get purge mongodb-org* postgresql* rabbitmq-server erlang* nginx nodejs + sudo apt-get purge mongodb-org* rabbitmq-server erlang* nginx nodejs * RHEL/CentOS: .. sourcecode:: bash - sudo yum erase mongodb-org* postgresql* rabbitmq-server erlang* nginx nodejs + sudo yum erase mongodb-org* rabbitmq-server erlang* nginx nodejs + +.. note:: + + If uninstalling a version earlier than StackStorm 3.3 then add postgresql* to list of databases if installed on your system. + 5. Remove Repositories ---------------------- @@ -197,7 +161,7 @@ last pieces. .. sourcecode:: bash sudo rm -rf /etc/st2 /opt/stackstorm - sudo rm -rf /var/log/st2 /var/log/mistral /var/log/mongodb + sudo rm -rf /var/log/st2 /var/log/mongodb sudo rm -rf /var/lib/mongodb /var/run/mongodb.pid * RHEL/CentOS: @@ -205,10 +169,15 @@ last pieces. .. sourcecode:: bash sudo rm -rf /etc/st2 /etc/mongod* /etc/rabbitmq /etc/nginx /opt/stackstorm - sudo rm -rf /var/log/st2 /var/log/mistral /var/log/mongodb /var/log/rabbitmq /var/log/nginx - sudo rm -rf /var/lib/pgsql /var/lib/rabbitmq /var/lib/mongo + sudo rm -rf /var/log/st2 /var/log/mongodb /var/log/rabbitmq /var/log/nginx + sudo rm -rf /var/lib/rabbitmq /var/lib/mongo At this point, your system is no longer running any |st2|-related services, and all the main dependencies have been removed. You can either re-install |st2|, or use this system for other applications. + +.. note:: + + If uninstalling a version earlier than StackStorm 3.3 then add /var/log/mistral and /var/lib/pgsql to the list of directories to remove if present. + diff --git a/docs/source/install/upgrades.rst b/docs/source/install/upgrades.rst index a17152645..0be1ca8fd 100644 --- a/docs/source/install/upgrades.rst +++ b/docs/source/install/upgrades.rst @@ -128,42 +128,23 @@ This is the standard upgrade procedure: .. sourcecode:: bash - sudo apt-get install --only-upgrade st2 st2web st2chatops st2mistral + sudo apt-get install --only-upgrade st2 st2web st2chatops RHEL/CentOS: .. sourcecode:: bash - sudo yum update st2 st2web st2chatops st2mistral + sudo yum update st2 st2web st2chatops - .. note:: +3. Run the migration scripts (if any). See below for version-specific migration scripts. - Omit st2mistral from list of packages if Mistral is not installed in your installation - -3. Upgrade Mistral database: - - This step can be skipped if Mistral is not installed in your installation - - .. sourcecode:: bash - - /opt/stackstorm/mistral/bin/mistral-db-manage --config-file /etc/mistral/mistral.conf upgrade head - /opt/stackstorm/mistral/bin/mistral-db-manage --config-file /etc/mistral/mistral.conf populate | grep -v -e openstack -e keystone -e ironicclient - - .. warning:: - - The mistral and mistral-api services must be stopped at time of upgrade. If the services are - restarted before the mistral-db-manage commands are run, then the - ``mistral-db-manage upgrade head`` command may fail. - -4. Run the migration scripts (if any). See below for version-specific migration scripts. - -5. Ensure all content is registered: +4. Ensure all content is registered: .. sourcecode:: bash sudo st2ctl reload --register-all -6. Start |st2| services: +5. Start |st2| services: .. sourcecode:: bash diff --git a/docs/source/install/vagrant.rst b/docs/source/install/vagrant.rst index 1a9edd0cd..55f559b20 100644 --- a/docs/source/install/vagrant.rst +++ b/docs/source/install/vagrant.rst @@ -31,7 +31,7 @@ Starting a StackStorm Vagrant VM is easy: vagrant up vagrant ssh -This will boot up a fresh StackStorm installation along with the Mistral workflow engine on Ubuntu 16.04 LTS. +This will boot up a fresh StackStorm installation on Ubuntu 16.04 LTS. You can access Web UI at ``https://10.10.10.10/`` or SSH to the box ``vagrant ssh`` if you prefer st2 CLI. Virtual Appliance / OVA diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index f863d861f..e31761523 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -17,6 +17,10 @@ Upgrade Notes trigger: type: "core.st2.action.file_written" +* Support for Mistral workflows was removed. Prior to upgrade to v3.3 all Mistral workflows should be converted to Orquesta. A tool for helping converting Mistral to Orquesta workflows is available at https://github.com/StackStorm/orquestaconvert. + +* After upgrading to v3.3 st2mistral and postgresql services are no-longer required. These services can be stopped, disabled and the corresponding packages uninstalled. + .. _ref-upgrade-notes-v3-2: |st2| v3.2 From 506d26df967e3b0dcf9a6fe65ce5e647d2c667b4 Mon Sep 17 00:00:00 2001 From: Cloud User Date: Thu, 13 Aug 2020 16:05:34 +0000 Subject: [PATCH 2/2] Minor updates --- docs/source/install/common/configure_components.rst | 2 +- docs/source/install/uninstall.rst | 8 ++++---- docs/source/install/upgrades.rst | 6 +++++- docs/source/upgrade_notes.rst | 5 +++-- 4 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/source/install/common/configure_components.rst b/docs/source/install/common/configure_components.rst index 41218dc12..dfd580c97 100644 --- a/docs/source/install/common/configure_components.rst +++ b/docs/source/install/common/configure_components.rst @@ -1,4 +1,4 @@ -If you are not running RabbitMQ or MongoDBL on the same system, or have changed the +If you are not running RabbitMQ or MongoDB on the same system, or have changed the defaults, please adjust these settings: * RabbitMQ connection at ``/etc/st2/st2.conf`` diff --git a/docs/source/install/uninstall.rst b/docs/source/install/uninstall.rst index 0f833eb7a..b272eec9a 100644 --- a/docs/source/install/uninstall.rst +++ b/docs/source/install/uninstall.rst @@ -60,7 +60,7 @@ below. Only execute the instructions for your distribution. .. note:: - If uninstalling a version earlier than StackStorm 3.3 then add postgresql to list of services if running on your system. + If uninstalling a version earlier than StackStorm 3.3, add postgresql to list of services to stop if is running on your system. @@ -98,7 +98,7 @@ below. Only execute the instructions for your distribution. .. note:: - If uninstalling a version earlier than StackStorm 3.3 then add st2mistral to list of packages if it is installed on your system. + If uninstalling a version earlier than StackStorm 3.3, add st2mistral to list of packages to remove if it is installed on your system. 3. Remove |st2| System User @@ -129,7 +129,7 @@ below. Only execute the instructions for your distribution. .. note:: - If uninstalling a version earlier than StackStorm 3.3 then add postgresql* to list of databases if installed on your system. + If uninstalling a version earlier than StackStorm 3.3, add postgresql* to list of databases to remove if it is installed on your system. 5. Remove Repositories @@ -179,5 +179,5 @@ applications. .. note:: - If uninstalling a version earlier than StackStorm 3.3 then add /var/log/mistral and /var/lib/pgsql to the list of directories to remove if present. + If uninstalling a version earlier than StackStorm 3.3, add /var/log/mistral and /var/lib/pgsql to the list of directories to remove if present. diff --git a/docs/source/install/upgrades.rst b/docs/source/install/upgrades.rst index 0be1ca8fd..bdabacdf9 100644 --- a/docs/source/install/upgrades.rst +++ b/docs/source/install/upgrades.rst @@ -4,7 +4,7 @@ Upgrades When new versions of |st2| are released, they are published to our APT and Yum repositories. You can use standard Linux package management tools to install these upgraded packages. -As part of the general upgrade procedure, you will need to run scripts to upgrade the Mistral Database prior +For StackStorm versions prior to 3.3 then the general upgrade procedure included scripts to upgrade the Mistral Database, prior to restarting |st2| services. See below for more details. Depending on the versions you are upgrading to and from, you may need to run additional :ref:`migration scripts`. @@ -136,6 +136,10 @@ This is the standard upgrade procedure: sudo yum update st2 st2web st2chatops +.. note:: + + If upgrading to a version earlier than StackStorm 3.3, add st2mistral to list of packages to update (if it is present on your current system). + 3. Run the migration scripts (if any). See below for version-specific migration scripts. 4. Ensure all content is registered: diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index e31761523..57cd9d1a2 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -17,9 +17,10 @@ Upgrade Notes trigger: type: "core.st2.action.file_written" -* Support for Mistral workflows was removed. Prior to upgrade to v3.3 all Mistral workflows should be converted to Orquesta. A tool for helping converting Mistral to Orquesta workflows is available at https://github.com/StackStorm/orquestaconvert. +* Support for Mistral workflows was removed. Before upgrading to v3.3, ensure all Mistral workflows have been converted to Orquesta workflows. A tool is available for assisting in this conversion, more information can be found in the ``orquestaconvert`` `README.md `_. -* After upgrading to v3.3 st2mistral and postgresql services are no-longer required. These services can be stopped, disabled and the corresponding packages uninstalled. + +* After upgrading to v3.3, st2mistral and postgresql services are no-longer required. These services can be stopped, disabled and the corresponding packages uninstalled. .. _ref-upgrade-notes-v3-2: