Skip to content
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

docs(argo-workflows): add an HA section #2183

Merged
merged 4 commits into from
Sep 10, 2023
Merged

docs(argo-workflows): add an HA section #2183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
26200b7
feat(argo-workflows): add a sample HA config
agilgur5 Jul 23, 2023
eb5c7c2
docs(argo-workflows): add an HA section
agilgur5 Aug 8, 2023
8c38064
Merge branch 'main' into feat-values-ha
yu-croco Aug 9, 2023
fb16cbf
Merge branch 'main' into feat-values-ha
agilgur5 Sep 9, 2023
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
6 changes: 3 additions & 3 deletions charts/argo-workflows/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ appVersion: v3.4.11
name: argo-workflows
description: A Helm chart for Argo Workflows
type: application
version: 0.33.2
version: 0.33.3
icon: https://argoproj.github.io/argo-workflows/assets/logo.png
home: https://github.com/argoproj/argo-helm
sources:
Expand All @@ -16,5 +16,5 @@ annotations:
fingerprint: 2B8F22F57260EFA67BE1C5824B11F800CD9D2252
url: https://argoproj.github.io/argo-helm/pgp_keys.asc
artifacthub.io/changes: |
- kind: changed
description: Upgrade Argo Workflows to v3.4.11
- kind: fixed
description: Add HA docs and example
Comment on lines +19 to +20
Copy link
Author

@agilgur5 agilgur5 Aug 8, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is now a docs and tests only change, so actually not sure if this necessary to bump anymore?

I used "fixed" because ArtifactHub doesn't support "docs":

valid supported kinds are added, changed, deprecated, removed, fixed and security.

5 changes: 5 additions & 0 deletions charts/argo-workflows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 5 additions & 0 deletions charts/argo-workflows/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
23 changes: 23 additions & 0 deletions charts/argo-workflows/ci/ha-values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Sample values for High Availability configuration, following https://argoproj.github.io/argo-workflows/high-availability/

controller:
# in v3.0+, a second controller can be ran as a hot-standby: https://argoproj.github.io/argo-workflows/high-availability/#workflow-controller
replicas: 2 # should be strictly greater than PDB minAvailable
# enable PDB with at least one Pod
pdb:
# -- Configure [Pod Disruption Budget] for the controller pods
enabled: true
minAvailable: 1

server:
# enable HPA with at least two Pods
autoscaling:
# -- Enable Horizontal Pod Autoscaler ([HPA]) for the Argo Server
enabled: true
# -- Minimum number of replicas for the Argo Server [HPA]
minReplicas: 2 # should be strictly greater than PDB minAvailable
# enable PDB with at least one Pod
pdb:
# -- Configure [Pod Disruption Budget] for the controller pods
enabled: true
minAvailable: 1