argocd-helm/charts/argo/README.md
chgl 82b655dadc
feat(argo-workflows): added new argo-workflows chart and deprecated argo chart (#668)
* feat: added new argo-workflows chart and deprecated argo chart

Signed-off-by: chgl <chgl@users.noreply.github.com>

* fix: removed maintainers from deprecated argo chart

Signed-off-by: chgl <chgl@users.noreply.github.com>

* docs: rm pullPolicy from snippet since the global images.pullPolicy is actually used

Signed-off-by: chgl <chgl@users.noreply.github.com>

* use Chart.AppVersion as the default image tag

Signed-off-by: chgl <chgl@users.noreply.github.com>

* updated various links

Signed-off-by: chgl <chgl@users.noreply.github.com>

* enabled metrics endpoint and liveness probe by default

Signed-off-by: chgl <chgl@users.noreply.github.com>

* fix: use new-style labels

Signed-off-by: chgl <chgl@users.noreply.github.com>

* fix: set securitycontext for server to something more secure

Signed-off-by: chgl <chgl@users.noreply.github.com>

* Update charts/argo-workflows/templates/_helpers.tpl

Signed-off-by: chgl <chgl@users.noreply.github.com>

Co-authored-by: Brandon Mayfield <563214+bmayfi3ld@users.noreply.github.com>
Signed-off-by: chgl <chgl@users.noreply.github.com>

* bumped argo chart version

Signed-off-by: chgl <chgl@users.noreply.github.com>

* Update charts/argo-workflows/templates/controller/workflow-controller-deployment.yaml

Co-authored-by: Oliver Bähler <oliverbaehler@hotmail.com>
Signed-off-by: chgl <chgl@users.noreply.github.com>

* Update charts/argo-workflows/templates/controller/workflow-controller-deployment.yaml

Co-authored-by: Oliver Bähler <oliverbaehler@hotmail.com>
Signed-off-by: chgl <chgl@users.noreply.github.com>

* Update charts/argo-workflows/templates/controller/workflow-controller-deployment.yaml

Co-authored-by: Oliver Bähler <oliverbaehler@hotmail.com>
Signed-off-by: chgl <chgl@users.noreply.github.com>

* Update charts/argo-workflows/templates/controller/workflow-controller-deployment.yaml

Co-authored-by: Oliver Bähler <oliverbaehler@hotmail.com>
Signed-off-by: chgl <chgl@users.noreply.github.com>

* Update charts/argo-workflows/templates/controller/workflow-controller-service.yaml

Co-authored-by: Oliver Bähler <oliverbaehler@hotmail.com>
Signed-off-by: chgl <chgl@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Brandon Mayfield <563214+bmayfi3ld@users.noreply.github.com>
Co-authored-by: Oliver Bähler <oliverbaehler@hotmail.com>
Signed-off-by: chgl <chgl@users.noreply.github.com>

* used ingress from argo-cd

Signed-off-by: chgl <chgl@users.noreply.github.com>

* Update charts/argo-workflows/templates/server/server-deployment.yaml

Signed-off-by: chgl <chgl@users.noreply.github.com>

Co-authored-by: Brandon Mayfield <mayfield.brandon.a@gmail.com>

* updated argo-wf to v3.0.2

Signed-off-by: chgl <chgl@users.noreply.github.com>

* aligned serviceAccount configuration with argo-cd values

Signed-off-by: chgl <chgl@users.noreply.github.com>

* docs: updated breaking changes in README

Signed-off-by: chgl <chgl@users.noreply.github.com>

* fix: use .Capabilities.APIVersions.Has in Ingress template

Signed-off-by: chgl <chgl@users.noreply.github.com>

Co-authored-by: Brandon Mayfield <563214+bmayfi3ld@users.noreply.github.com>
Co-authored-by: Oliver Bähler <oliverbaehler@hotmail.com>
Co-authored-by: Brandon Mayfield <mayfield.brandon.a@gmail.com>
2021-05-21 14:19:05 +02:00

29 lines
2.8 KiB
Markdown

## Argo Workflows Chart
> ⚠ DEPRECATION WARNING: this chart is for v2 of Argo Workflows. For v3, a new chart is available at <https://github.com/argoproj/argo-helm/tree/master/charts/argo-workflows>
This is a **community maintained** chart. It is used to set up argo and it's needed dependencies through one command. This is used in conjunction with [helm](https://github.com/kubernetes/helm).
If you want your deployment of this helm chart to most closely match the [argo CLI](https://github.com/argoproj/argo-workflows), you should deploy it in the `kube-system` namespace.
## Pre-Requisites
This chart uses an install hook to configure the CRD definition. Installation of CRDs is a somewhat privileged process in itself and in RBAC enabled clusters the `default` service account for namespaces does not typically have the ability to do create these.
A few options are:
- Setup the CRD yourself manually and use `--set installCRD=false` when installing the helm chart. Find the CRDs in the [argo codebase](https://github.com/argoproj/argo-workflows/tree/master/manifests/base/crds/full)
- Manually create a ServiceAccount in the Namespace which your release will be deployed w/ appropriate bindings to perform this action and set the `init.serviceAccount` attribute
- Augment the `default` ServiceAccount permissions in the Namespace in which your Release is deployed to have the appropriate permissions
## Usage Notes:
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 it's configuration options to set the `instanceID` of the workflow controller to be properly scoped for your needs.
## Values
The `values.yaml` contains items used to tweak a deployment of this chart.
Fields to note:
* `controller.instanceID.enabled`: If set to true, the Argo Controller will **ONLY** monitor Workflow submissions with a `--instanceid` attribute
* `controller.instanceID.useReleaseName`: If set to true then chart set controller instance id to release name
* `controller.instanceID.explicitID`: Allows customization of an instance id for the workflow controller to monitor
* `controller.workflowNamespaces`: This is a list of namespaces where workflows will be ran
* `minio.install`: If this is true, we'll install [minio](https://github.com/kubernetes/charts/tree/master/stable/minio) and build out the artifactRepository section in workflow controller config map.
* `artifactRepository.s3.accessKeySecret` and `artifactRepository.s3.secretKeySecret` These by default link to minio default credentials stored in the secret deployed by the minio chart.