docs(argo-workflows): add an HA section

- plus add a test for HA, which the docs link to as an example
- link back to [upstream docs](https://argoproj.github.io/argo-workflows/high-availability/) as well

- follow the same basic structure as the [Argo CD chart for HA](3e35b0c7f7/charts/argo-cd/README.md (L17))
  - as asked in review

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
This commit is contained in:
Anton Gilgur 2023-08-08 19:23:21 -04:00
parent 26200b7e8a
commit eb5c7c26a7
4 changed files with 13 additions and 3 deletions

View file

@ -3,7 +3,7 @@ appVersion: v3.4.9
name: argo-workflows
description: A Helm chart for Argo Workflows
type: application
version: 0.33.0
version: 0.32.2
icon: https://argoproj.github.io/argo-workflows/assets/logo.png
home: https://github.com/argoproj/argo-helm
sources:
@ -16,5 +16,5 @@ annotations:
fingerprint: 2B8F22F57260EFA67BE1C5824B11F800CD9D2252
url: https://argoproj.github.io/argo-helm/pgp_keys.asc
artifacthub.io/changes: |
- kind: added
description: Add a sample HA config
- kind: fixed
description: Add HA docs and example

View file

@ -75,6 +75,11 @@ For full list of changes, please check ArtifactHub [changelog].
## Usage Notes
### High Availability
This chart installs the non-HA version of Argo Workflows by default. If you want to run in HA mode, you can use [these example values](ci/ha-values.yaml) as a starting point.
Please see the upstream [Operator Manual's High Availability page](https://argoproj.github.io/argo-workflows/high-availability/) to understand how to scale Argo Workflows in depth.
### Workflow controller
This chart defaults to setting the `controller.instanceID.enabled` to `false` now, which means the deployed controller will act upon any workflow deployed to the cluster. If you would like to limit the behavior and deploy multiple workflow controllers, please use the `controller.instanceID.enabled` attribute along with one of its configuration options to set the `instanceID` of the workflow controller to be properly scoped for your needs.

View file

@ -75,6 +75,11 @@ For full list of changes, please check ArtifactHub [changelog].
## Usage Notes
### High Availability
This chart installs the non-HA version of Argo Workflows by default. If you want to run in HA mode, you can use [these example values](ci/ha-values.yaml) as a starting point.
Please see the upstream [Operator Manual's High Availability page](https://argoproj.github.io/argo-workflows/high-availability/) to understand how to scale Argo Workflows in depth.
### Workflow controller
This chart defaults to setting the `controller.instanceID.enabled` to `false` now, which means the deployed controller will act upon any workflow deployed to the cluster. If you would like to limit the behavior and deploy multiple workflow controllers, please use the `controller.instanceID.enabled` attribute along with one of its configuration options to set the `instanceID` of the workflow controller to be properly scoped for your needs.