Skip to content

Update StackStorm HA installation instructions #1132

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

Merged
arm4b merged 9 commits into from
Jul 13, 2022
Merged

Update StackStorm HA installation instructions #1132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4a81d17
Update StackStorm HA installation instructions
mamercad Jul 9, 2022
bf912ce
Remove unused Helm chart image
mamercad Jul 10, 2022
c0101bc
Condense Helm installation instruction
mamercad Jul 10, 2022
d5e1580
Rework the Helm instructions and comment
mamercad Jul 11, 2022
87b3593
Remove `helm repo update`
mamercad Jul 11, 2022
dcfdff5
Remove `--namespace stackstorm`
mamercad Jul 12, 2022
c5ebbb8
Helm output back to png
mamercad Jul 12, 2022
ba4a042
Update docs/source/install/k8s_ha.rst
arm4b Jul 13, 2022
a9561a8
Merge branch 'master' into issue-1131
rush-skills Jul 13, 2022
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
Binary file modified docs/source/_static/images/helm-chart-notes.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 8 additions & 6 deletions docs/source/install/k8s_ha.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,18 @@ makes installing the complex StackStorm infrastructure as easy as:
# Add Helm StackStorm repository
helm repo add stackstorm https://helm.stackstorm.com/

helm install stackstorm/stackstorm-ha
# Install StackStorm HA with an automatically-generated release name in the "stackstorm" namespace
# Replace "--generate-name" with a release name if you would like to name the deployment
# Omit the "--namespace stackstorm" flag if you would like to deploy to the "default" namespace
# Add "--create-namespace" if the namespace that you are specifying needs to be created
helm install --generate-name stackstorm/stackstorm-ha

Once the deployment is finished, it will show you the first steps to get started working with the new cluster via WebUI
Once the deployment is finished, it will show you the first steps to get started with the new cluster via WebUI
or ``st2`` CLI client:

.. figure :: /_static/images/helm-chart-notes.png
:align: center

.. todo:: Update this screenshot. It is out of date.

The installation uses some unsafe defaults which we recommend you change for production use via Helm ``values.yaml``.

Helm Values
Expand Down Expand Up @@ -88,7 +90,7 @@ If not defined, these values are auto-generated on install and preserved across
- st2 auth secrets (ie: the password for the st2admin user)

.. warning::
It's highly recommended to set your own secrets to replace the unsafe defaults for for the MongoDB and RabbitMQ subhcarts!
It's highly recommended to set your own secrets to replace the unsafe defaults for for the MongoDB and RabbitMQ subcharts!
If you disable the subcharts, make sure to secure the services and add the relevant secrets to st2.conf.

Upgrading
Expand Down Expand Up @@ -254,7 +256,7 @@ ______
This service hosts the REST API endpoints that serve requests from WebUI, CLI, ChatOps and other st2 components.
K8s configuration consists of Pod Deployment with ``2`` default replicas for HA and ClusterIP Service accepting HTTP requests on port ``9101``.
This is one of the most important |st2| services. We recommend increasing the number of replicas to distribute load
if you are planning a high-volume environment.
if you are planning a high-volume environment.

st2stream
_________
Expand Down