From 214086a3cab35c615ef347d35f335494fe6c3bdf Mon Sep 17 00:00:00 2001 From: Louis Murray Date: Thu, 31 May 2018 18:46:29 -0400 Subject: [PATCH] added README to explain chart a bit --- charts/argo/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 charts/argo/README.md diff --git a/charts/argo/README.md b/charts/argo/README.md new file mode 100644 index 00000000..8bd449b6 --- /dev/null +++ b/charts/argo/README.md @@ -0,0 +1,17 @@ +## Argo Chart +This chart 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), you should deploy it in the `kube-system` namespace. + +## Values + +The `values.yaml` contains items used to tweak a deployment of this chart. +Fields to note: +* `controller.useReleaseAsInstanceID`: If set to true then chart set controller instance id to release name + - __Note:__ If this is set to false then `controller.instanceId` must be set +* `controller.workflowNamespaces`: This is a list of namespaces where workflows will be ran +* `ui.enableWebConsole`: Enables ability to SSH into pod using web UI +* `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 have the minio default credentials in them. + +