From 3f4b3ca9977b3a32d013cf5028db5fdc6d935435 Mon Sep 17 00:00:00 2001 From: amanda Date: Thu, 10 Jun 2021 20:39:36 +0100 Subject: [PATCH 1/5] Xenial removal and roadmap update --- docs/source/_redirects/install/deb.html | 4 +- docs/source/install/index.rst | 3 +- docs/source/install/system_requirements.rst | 6 +- docs/source/install/u16.rst | 241 -------------------- docs/source/install/uninstall.rst | 4 +- docs/source/roadmap.rst | 19 +- docs/source/upgrade_notes.rst | 1 + 7 files changed, 19 insertions(+), 259 deletions(-) delete mode 100644 docs/source/install/u16.rst diff --git a/docs/source/_redirects/install/deb.html b/docs/source/_redirects/install/deb.html index 2ccae9d56..440fc2b21 100644 --- a/docs/source/_redirects/install/deb.html +++ b/docs/source/_redirects/install/deb.html @@ -1,8 +1,8 @@ - + -

This page has moved to here.

+

This page has moved to here.

diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst index 5e7ca5836..d88b542b9 100644 --- a/docs/source/install/index.rst +++ b/docs/source/install/index.rst @@ -14,7 +14,7 @@ Here's an overview of the options: ` section below for details. * **Manual Installation:** Have custom needs? Maybe no Internet access from your servers? Or just don't like using scripted installs? Read the manual installation instructions for your OS - (:doc:`Ubuntu 16 `, :doc:`Ubuntu 18 `, + (:doc:`Ubuntu 18 `, :doc:`Ubuntu 20 `, :doc:`RHEL/CentOS 7 `, :doc:`RHEL/CentOS 8 `) and adapt them to your needs. Here's some `additional guidance `_ for setting up an @@ -91,7 +91,6 @@ For more details on reference deployments, or OS-specific installation instructi Reference Deployment Overview system_requirements - Ubuntu 16.04 Ubuntu 18.04 Ubuntu 20.04 RHEL 7 / CentOS 7 diff --git a/docs/source/install/system_requirements.rst b/docs/source/install/system_requirements.rst index e5e77fa12..320de4a5c 100644 --- a/docs/source/install/system_requirements.rst +++ b/docs/source/install/system_requirements.rst @@ -18,8 +18,6 @@ be automatically added when you install |st2|. +-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Linux (64-bit) | Vagrant Box | Amazon AWS AMI | +=======================================================================================================+==============================================================================+===================================================================================================================================================================+ -| `Ubuntu 16.04 `_ | `bento/ubuntu-16.04 `_ | `Ubuntu 16.04 LTS - Xenial (HVM) `_ | -+-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | `Ubuntu 18.04 `_ | `bento/ubuntu-18.04 `_ | `Ubuntu Server 18.04 LTS Bionic `_ | +-------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | `Ubuntu 20.04 `_ | `bento/ubuntu-20.04 `_ | `Ubuntu Server 20.04 LTS Focal `_ | @@ -71,9 +69,11 @@ Linux Distribution Support Policy StackStorm only support Ubuntu and RHEL/CentOS Linux distributions. In general, it is supported on the two most recent major supported releases for those distributions. Specifically: -* **Ubuntu**: Current LTS releases are supported. Today this is ``16.04``, ``18.04`` and ``20.04``. +* **Ubuntu**: Current LTS releases are supported. Today this is ``18.04`` and ``20.04``. * **RHEL/CentOS**: We currently support RHEL/CentOS ``7.x`` and ``8.x``. In general, we recommend using the most recent version in that series, but any version may be used. Support for RHEL/CentOS ``6.x`` has been removed. |st2| 3.2 is the last release that supported RHEL/CentOS ``6.x``. + + Support for Ubuntu ``16.04`` has been removed. |st2| 3.4 is the last release that supported RHEL/CentOS ``16.04``. diff --git a/docs/source/install/u16.rst b/docs/source/install/u16.rst deleted file mode 100644 index b72ab7645..000000000 --- a/docs/source/install/u16.rst +++ /dev/null @@ -1,241 +0,0 @@ -Ubuntu Xenial (16.04) -===================== - -.. include:: common/intro.rst - -.. contents:: Contents - :local: - -System Requirements -------------------- - -Please check the :doc:`supported versions and system requirements `. - -Minimal Installation --------------------- - -Install Dependencies -~~~~~~~~~~~~~~~~~~~~ - -.. include:: __mongodb_note.rst - -Install MongoDB, and RabbitMQ: - -.. code-block:: bash - - sudo apt-get update - sudo apt-get install -y gnupg-curl - sudo apt-get install -y curl - - # Add key and repo for the latest stable MongoDB (4.0) - wget -qO - https://www.mongodb.org/static/pgp/server-4.0.asc | sudo apt-key add - - sudo sh -c "cat < /etc/apt/sources.list.d/mongodb-org-4.0.list - deb http://repo.mongodb.org/apt/ubuntu $(lsb_release -c | awk '{print $2}')/mongodb-org/4.0 multiverse - EOT" - sudo apt-get update - - sudo apt-get install -y crudini - sudo apt-get install -y mongodb-org - sudo apt-get install -y rabbitmq-server - -For Ubuntu ``Xenial`` you may need to enable and start MongoDB. - -.. code-block:: bash - - sudo systemctl enable mongod - sudo systemctl start mongod - -Setup Repositories -~~~~~~~~~~~~~~~~~~ - -The following script will detect your platform and architecture and setup the appropriate |st2| -repository. It will also add the the GPG key used for package signing. - -.. code-block:: bash - - curl -s https://packagecloud.io/install/repositories/StackStorm/stable/script.deb.sh | sudo bash - -Python 3.6 is not available in the base Ubuntu Xenial distro, but the following instructions can add unofficial 3rd party `Python PPA repository `_ that provides it. - -.. warning:: - - Please be aware of the support and security risks associated with using unofficial 3rd party PPA repository. - StackStorm does NOT provide ANY support or security update for python3.6 packages on Ubuntu 16.04. - If security is a priority for you, we recommend starting migrating to Ubuntu 18.04 LTS (Bionic) or 20.04 LTS (Focal) as a base OS which has official python 3.6 packages. - -.. code-block:: bash - - sudo apt-get install -y software-properties-common - # add unofficial 3rd party python3 PPA repository - sudo add-apt-repository -y ppa:deadsnakes/ppa - sudo apt-get update - -Install |st2| Components -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: bash - - sudo apt-get install -y st2 - -.. include:: common/configure_components.rst - -Setup Datastore Encryption -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: common/datastore_crypto_key.rst - -.. _ref-config-ssh-sudo-deb: - -Configure SSH and SUDO -~~~~~~~~~~~~~~~~~~~~~~ - -.. include:: common/configure_ssh_and_sudo.rst - -Start Services -~~~~~~~~~~~~~~ - -.. include:: common/start_services.rst - -Verify -~~~~~~ - -.. include:: common/verify.rst - -.. _ref-config-auth-deb: - -Configure Authentication ------------------------- - -The reference deployment uses a file-based authentication provider for simplicity. Refer to -:doc:`/authentication` to configure and use PAM or LDAP authentication backends. - -To set up authentication with file-based provider: - -* Create a user with a password: - - .. code-block:: bash - - # Install htpasswd utility if you don't have it - sudo apt-get install -y apache2-utils - # Create a user record in a password file. - echo 'Ch@ngeMe' | sudo htpasswd -i /etc/st2/htpasswd st2admin - -.. include:: common/configure_authentication.rst - -.. _ref-install-webui-ssl-deb: - -Install WebUI and Setup SSL Termination ---------------------------------------- - -`NGINX `_ is used to serve WebUI static files, redirect HTTP to HTTPS, provide -SSL termination, and reverse-proxy st2auth and st2api API endpoints. To set it up: install the -``st2web`` and ``nginx`` packages, generate certificates or place your existing certificates under -``/etc/ssl/st2``, and configure nginx with |st2|'s supplied :github_st2:`site config file st2.conf -`. - -|st2| depends on Nginx version >=1.7.5. Ubuntu has an older version in the package repositories, so -you will need to add the official Nginx repository: - - -.. code-block:: bash - - # Add key and repo for the latest stable nginx - sudo apt-key adv --fetch-keys http://nginx.org/keys/nginx_signing.key - sudo sh -c "cat < /etc/apt/sources.list.d/nginx.list - deb http://nginx.org/packages/ubuntu/ $(lsb_release -c | awk '{print $2}') nginx - EOT" - sudo apt-get update - - # Install st2web and nginx - # note nginx should be > 1.4.6 - sudo apt-get install -y st2web nginx - - # Generate self-signed certificate or place your existing certificate under /etc/ssl/st2 - sudo mkdir -p /etc/ssl/st2 - sudo openssl req -x509 -newkey rsa:2048 -keyout /etc/ssl/st2/st2.key -out /etc/ssl/st2/st2.crt \ - -days XXX -nodes -subj "/C=US/ST=California/L=Palo Alto/O=StackStorm/OU=Information \ - Technology/CN=$(hostname)" - - # Remove default site, if present - sudo rm /etc/nginx/conf.d/default.conf - # Copy and enable the supplied nginx config file - sudo cp /usr/share/doc/st2/conf/nginx/st2.conf /etc/nginx/conf.d/ - - sudo service nginx restart - -If you modify ports, or url paths in the nginx configuration, make the corresponding changes in -the st2web configuration at ``/opt/stackstorm/static/webui/config.js``. - -Use your browser to connect to ``https://${ST2_HOSTNAME}`` and login to the WebUI. - -.. include:: common/api_access.rst - -.. _ref-setup-chatops-deb: - -Setup ChatOps -------------- - -If you already run a Hubot instance, you can install the `hubot-stackstorm plugin -`_ and configure |st2| environment variables, as -described below. Otherwise, the easiest way to enable :doc:`StackStorm ChatOps ` -is to use the `st2chatops `_ package. - -* Validate that the ``chatops`` pack is installed, and a notification rule is enabled: - - .. code-block:: bash - - # Ensure chatops pack is in place - ls /opt/stackstorm/packs/chatops - # Create notification rule if not yet enabled - st2 rule get chatops.notify || st2 rule create /opt/stackstorm/packs/chatops/rules/notify_hubot.yaml - -* Add `NodeJS v10 repository `_: - - .. code-block:: bash - - curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash - - -* Install the ``st2chatops`` package: - - .. code-block:: bash - - sudo apt-get install -y st2chatops - -.. include:: common/configure_chatops.rst - -* Start the service: - - .. code-block:: bash - - sudo service st2chatops start - -* Reload st2 packs to make sure ``chatops.notify`` rule is registered: - - .. code-block:: bash - - sudo st2ctl reload --register-all - -* That's it! Go to your Chat room and begin ChatOps-ing. Read more in the :doc:`/chatops/index` section. - -A Note on Security ------------------- - -.. include:: common/security_notes.rst - -Upgrade to |ewc| ----------------- - -.. include:: common/ewc_intro.rst - -.. rubric:: What's Next? - -* Check out the :doc:`/start` Guide to build a simple automation. -* Get more actions, triggers, rules: - - - * Install integration packs from `StackStorm Exchange `__ - follow the :doc:`/packs` guide. - * :ref:`Convert your scripts into StackStorm actions. ` - * Learn how to :ref:`write custom actions `. - -* Use workflows to stitch actions into higher level automations - :doc:`/workflows`. -* Check out `tutorials on stackstorm.com `__ diff --git a/docs/source/install/uninstall.rst b/docs/source/install/uninstall.rst index 7f12c5ec2..dc8f06eaf 100644 --- a/docs/source/install/uninstall.rst +++ b/docs/source/install/uninstall.rst @@ -40,7 +40,7 @@ below. Only execute the instructions for your distribution. 1. Stop Services ---------------- -* Ubuntu 16.04/18.04/20.04: +* Ubuntu 18.04/20.04: .. sourcecode:: bash @@ -67,7 +67,7 @@ below. Only execute the instructions for your distribution. 2. Remove Packages ------------------ -* Ubuntu 16.04/18.04/20.04: +* Ubuntu 18.04/20.04: If you are using StackStorm only: diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst index ac84b7255..6c1302a9d 100644 --- a/docs/source/roadmap.rst +++ b/docs/source/roadmap.rst @@ -2,7 +2,7 @@ Roadmap ======= |st2| is still under active development. We welcome community feedback, and encourage -contributions. Here's our plans for the next two releases. +contributions. Here's our plans for the next releases. .. note:: @@ -16,16 +16,10 @@ contributions. Here's our plans for the next two releases. the feature. Pull Requests are open to anyone. -3.5 +3.6 --- -* The roadmap for ``3.5`` is in the works, stay tuned! - - Current plans include: - - * Add support for Ubuntu 20.04, with Python 3.8 - * Performance improvements - * Add Redis as a coordination backend +* The roadmap for ``3.6`` is in the works, stay tuned! Monitor the `master branch `_ to see how we're progressing. @@ -64,6 +58,13 @@ Submit a PR! Release History --------------- +.. rubric:: Done in v3.5 + +* **Ubuntu Focal:** Add support for Ubuntu 20.04, with Python 3.8 +* **Ubuntu Xenial:** Remove support for Ubuntu 16.04 +* **Performance improvements:** Performance improvements on JSON serialization/deserialization +* **Redis:** Add Redis as a coordination backend + .. rubric:: Done in v3.4 * **Python 2 deprecation:** Updated RHEL/CentOS 7.x and Ubuntu 16.04 to use Python 3.6, and update packs in StackStorm-Exchange diff --git a/docs/source/upgrade_notes.rst b/docs/source/upgrade_notes.rst index b2813aa5f..795ab8d6c 100644 --- a/docs/source/upgrade_notes.rst +++ b/docs/source/upgrade_notes.rst @@ -10,6 +10,7 @@ Upgrade Notes * Node was upgraded from v10 to v14. Node 14 repository will be required to be setup, prior to upgrade of st2chatops. +* Support for Ubuntu 16.04 (Xenial) was removed. .. _ref-upgrade-notes-v3-4: From d4e12c22685a619ed5b9f8c6a56f14d2ee32fc68 Mon Sep 17 00:00:00 2001 From: amanda Date: Thu, 10 Jun 2021 20:47:47 +0100 Subject: [PATCH 2/5] Need to move reference from u16 to u18 --- docs/source/install/u18.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/install/u18.rst b/docs/source/install/u18.rst index 88e3642b5..eab37ea0e 100644 --- a/docs/source/install/u18.rst +++ b/docs/source/install/u18.rst @@ -105,6 +105,8 @@ To set up authentication with file-based provider: .. include:: common/configure_authentication.rst +.. _ref-install-webui-ssl-deb + Install WebUI and Setup SSL Termination --------------------------------------- From 2e704229b522077fab1b831f03a1083a289eb2b3 Mon Sep 17 00:00:00 2001 From: amanda Date: Thu, 10 Jun 2021 20:51:13 +0100 Subject: [PATCH 3/5] Fix typo --- docs/source/install/u18.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/install/u18.rst b/docs/source/install/u18.rst index eab37ea0e..ae809865d 100644 --- a/docs/source/install/u18.rst +++ b/docs/source/install/u18.rst @@ -105,7 +105,7 @@ To set up authentication with file-based provider: .. include:: common/configure_authentication.rst -.. _ref-install-webui-ssl-deb +.. _ref-install-webui-ssl-deb: Install WebUI and Setup SSL Termination --------------------------------------- From 35a4ec17ae6bd7afe754341e1fe9a53903374451 Mon Sep 17 00:00:00 2001 From: amanda Date: Thu, 10 Jun 2021 21:06:30 +0100 Subject: [PATCH 4/5] Move all ref from u16 to u20 --- docs/source/install/u18.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/install/u18.rst b/docs/source/install/u18.rst index ae809865d..3f146f02a 100644 --- a/docs/source/install/u18.rst +++ b/docs/source/install/u18.rst @@ -71,6 +71,8 @@ Setup Datastore Encryption .. include:: common/datastore_crypto_key.rst +.. _ref-config-ssh-sudo-deb: + Configure SSH and SUDO ~~~~~~~~~~~~~~~~~~~~~~ @@ -86,6 +88,8 @@ Verify .. include:: common/verify.rst +.. _ref-config-auth-deb: + Configure Authentication ------------------------ @@ -143,6 +147,8 @@ Use your browser to connect to ``https://${ST2_HOSTNAME}`` and login to the WebU .. include:: common/api_access.rst +.. _ref-setup-chatops-deb: + Setup ChatOps ------------- From e3c182df99a0fc60e21aa794120cc32aa39f48b1 Mon Sep 17 00:00:00 2001 From: Amanda McGuinness Date: Sat, 12 Jun 2021 21:50:08 +0100 Subject: [PATCH 5/5] Update roadmap.rst --- docs/source/roadmap.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst index 6c1302a9d..8847e60f9 100644 --- a/docs/source/roadmap.rst +++ b/docs/source/roadmap.rst @@ -60,7 +60,7 @@ Release History .. rubric:: Done in v3.5 -* **Ubuntu Focal:** Add support for Ubuntu 20.04, with Python 3.8 +* **Ubuntu Focal:** Add support for Ubuntu 20.04, with Python 3.8 and Mongo 4.4 * **Ubuntu Xenial:** Remove support for Ubuntu 16.04 * **Performance improvements:** Performance improvements on JSON serialization/deserialization * **Redis:** Add Redis as a coordination backend