From 060fa584b4b72c2cc5cf0ca8d87ffc41aa6cd17e Mon Sep 17 00:00:00 2001 From: Scott Cabrinha Date: Fri, 14 Feb 2020 13:55:18 -0800 Subject: [PATCH] feat: adding readme (#241) --- charts/argo-rollouts/Chart.yaml | 2 +- charts/argo-rollouts/README.md | 39 +++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 charts/argo-rollouts/README.md diff --git a/charts/argo-rollouts/Chart.yaml b/charts/argo-rollouts/Chart.yaml index fa8038dd..175d2c86 100644 --- a/charts/argo-rollouts/Chart.yaml +++ b/charts/argo-rollouts/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v1 appVersion: "0.7" description: A Helm chart for Argo Rollouts name: argo-rollouts -version: 0.1.0 +version: 0.1.1 icon: https://raw.githubusercontent.com/argoproj/argo/master/argo.png home: https://github.com/argoproj/argo-helm maintainers: diff --git a/charts/argo-rollouts/README.md b/charts/argo-rollouts/README.md new file mode 100644 index 00000000..f4f0f3a6 --- /dev/null +++ b/charts/argo-rollouts/README.md @@ -0,0 +1,39 @@ +Argo Rollouts Chart +============= +A Helm chart for Argo Rollouts, progressive delivery for Kubernetes. + +Current chart version is `0.1.0` + +Source code can be found [here](https://github.com/argoproj/argo-rollouts) + +## Additional Information +This is a **community maintained** chart. This chart installs [argo-rollouts](https://argoproj.github.io/argo-rollouts/), progressive delivery for Kubernetes. + +The default installation is intended to be similar to the provided Argo Rollouts [releases](https://github.com/argoproj/argo-rollouts/releases). + +## Prerequisites + +- Kubernetes 1.7+ + + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +$ helm repo add argo https://argoproj.github.io/argo-helm +$ helm install --name my-release argo/argo-rollouts +``` + +## Chart Values + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| clusterInstall | bool | `true` | | +| controller.component | string | `"rollouts-controller"` | | +| controller.image.pullPolicy | string | `"IfNotPresent"` | | +| controller.image.repository | string | `"argoproj/argo-rollouts"` | | +| controller.image.tag | string | `"v0.7.0"` | | +| controller.name | string | `"argo-rollouts"` | | +| installCRDs | bool | `true` | | +| serviceAccount.name | string | `"argo-rollouts"` | |