feat(argo-rollouts): Use helm-docs to generate README.md (#1100)
Signed-off-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>
This commit is contained in:
parent
752e1c0580
commit
bee32880a8
5 changed files with 241 additions and 85 deletions
|
@ -1 +0,0 @@
|
||||||
charts/argo-rollouts
|
|
|
@ -2,7 +2,7 @@ apiVersion: v2
|
||||||
appVersion: "v1.1.1"
|
appVersion: "v1.1.1"
|
||||||
description: A Helm chart for Argo Rollouts
|
description: A Helm chart for Argo Rollouts
|
||||||
name: argo-rollouts
|
name: argo-rollouts
|
||||||
version: 2.9.2
|
version: 2.9.3
|
||||||
icon: https://argoproj.github.io/argo-rollouts/assets/logo.png
|
icon: https://argoproj.github.io/argo-rollouts/assets/logo.png
|
||||||
home: https://github.com/argoproj/argo-helm
|
home: https://github.com/argoproj/argo-helm
|
||||||
maintainers:
|
maintainers:
|
||||||
|
@ -11,4 +11,4 @@ maintainers:
|
||||||
- name: jessesuen
|
- name: jessesuen
|
||||||
annotations:
|
annotations:
|
||||||
artifacthub.io/changes: |
|
artifacthub.io/changes: |
|
||||||
- "[Changed]: Consistent .helmignore"
|
- "[Changed]: Use helm-docs to generate README.md"
|
||||||
|
|
|
@ -15,7 +15,6 @@ The default installation is intended to be similar to the provided Argo Rollouts
|
||||||
- Kubernetes 1.7+
|
- Kubernetes 1.7+
|
||||||
- Helm v3.0.0+
|
- Helm v3.0.0+
|
||||||
|
|
||||||
|
|
||||||
## Installing the Chart
|
## Installing the Chart
|
||||||
|
|
||||||
To install the chart with the release name `my-release`:
|
To install the chart with the release name `my-release`:
|
||||||
|
@ -24,6 +23,7 @@ To install the chart with the release name `my-release`:
|
||||||
$ helm repo add argo https://argoproj.github.io/argo-helm
|
$ helm repo add argo https://argoproj.github.io/argo-helm
|
||||||
$ helm install my-release argo/argo-rollouts
|
$ helm install my-release argo/argo-rollouts
|
||||||
```
|
```
|
||||||
|
|
||||||
### UI Dashboard
|
### UI Dashboard
|
||||||
|
|
||||||
If dashboard is installed by `--set dashboard.enabled=true`, checkout the argo-rollouts dashboard by
|
If dashboard is installed by `--set dashboard.enabled=true`, checkout the argo-rollouts dashboard by
|
||||||
|
@ -35,71 +35,89 @@ If dashboard is installed by `--set dashboard.enabled=true`, checkout the argo-r
|
||||||
|
|
||||||
## Chart Values
|
## Chart Values
|
||||||
|
|
||||||
|
### General parameters
|
||||||
|
|
||||||
| Key | Type | Default | Description |
|
| Key | Type | Default | Description |
|
||||||
|-----|------|---------|-------------|
|
|-----|------|---------|-------------|
|
||||||
| apiVersionOverrides.ingress | string | `""` | String to override apiVersion of ingresses rendered by this helm chart |
|
| apiVersionOverrides.ingress | string | `""` | String to override apiVersion of ingresses rendered by this helm chart |
|
||||||
| clusterInstall | bool | `true` | `false` runs controller in namespaced mode (does not require cluster RBAC) |
|
| clusterInstall | bool | `true` | `false` runs controller in namespaced mode (does not require cluster RBAC) |
|
||||||
| controller.component | string | `"rollouts-controller"` | Value of label `app.kubernetes.io/component` |
|
| crdAnnotations | object | `{}` | Annotations to be added to all CRDs |
|
||||||
| controller.image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
|
| fullnameOverride | string | `nil` | String to fully override "argo-rollouts.fullname" template |
|
||||||
| controller.image.registry | string | `quay.io` | Registry to use |
|
| imagePullSecrets | list | `[]` | Secrets with credentials to pull images from a private registry. Registry secret names as an array. |
|
||||||
| controller.image.repository | string | `"argoproj/argo-rollouts"` | Repository to use |
|
|
||||||
| controller.image.tag | string | `""` | Overrides the image tag (default is the chart appVersion) |
|
|
||||||
| controller.extraArgs | list | `[]` | Additional arguments for the controller. A list of flags. |
|
|
||||||
| controller.extraContainers | list | `[]` | Literal yaml for extra containers to be added to controller deployment. |
|
|
||||||
| controller.resources | object | `{}` | Resource limits and requests for the controller pods. |
|
|
||||||
| controller.tolerations | list | `[]` | [Tolerations for use with node taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/) |
|
|
||||||
| controller.affinity | object | `{}` | [Assign custom affinity rules to the deployment](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) |
|
|
||||||
| controller.nodeSelector | object | `{}` | [Node selector](https://kubernetes.io/docs/user-guide/node-selection/) |
|
|
||||||
| controller.metrics.enabled | bool | `false` | Deploy metrics service |
|
|
||||||
| controller.metrics.serviceMonitor.enabled | bool | `false` | Enable a prometheus ServiceMonitor |
|
|
||||||
| controller.metrics.serviceMonitor.additionalAnnotations | object | `{}` | Annotations to be added to the ServiceMonitor |
|
|
||||||
| controller.metrics.serviceMonitor.additionalLabels | object | `{}` | Labels to be added to the ServiceMonitor |
|
|
||||||
| imagePullSecrets | list | `[]` | Registry secret names as an array |
|
|
||||||
| installCRDs | bool | `true` | Install and upgrade CRDs |
|
| installCRDs | bool | `true` | Install and upgrade CRDs |
|
||||||
| keepCRDs | bool | `true` | Keep CRD's on helm uninstall |
|
| keepCRDs | bool | `true` | Keep CRD's on helm uninstall |
|
||||||
| kubeVersionOverride | string | `""` | Override the Kubernetes version, which is used to evaluate certain manifests |
|
| kubeVersionOverride | string | `""` | Override the Kubernetes version, which is used to evaluate certain manifests |
|
||||||
| crdAnnotations | object | `{}` | Annotations to be added to all CRDs |
|
| nameOverride | string | `nil` | String to partially override "argo-rollouts.fullname" template |
|
||||||
|
|
||||||
|
### Controller
|
||||||
|
|
||||||
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| containerSecurityContext | object | `{}` | Security Context to set on container level |
|
||||||
|
| controller.affinity | object | `{}` | Assign custom [affinity] rules to the deployment |
|
||||||
|
| controller.component | string | `"rollouts-controller"` | Value of label `app.kubernetes.io/component` |
|
||||||
|
| controller.extraArgs | list | `[]` | Additional command line arguments to pass to rollouts-controller. A list of flags. |
|
||||||
|
| controller.extraContainers | list | `[]` | Literal yaml for extra containers to be added to controller deployment. |
|
||||||
|
| controller.image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
|
||||||
|
| controller.image.registry | string | `"quay.io"` | Registry to use |
|
||||||
|
| controller.image.repository | string | `"argoproj/argo-rollouts"` | Repository to use |
|
||||||
|
| controller.image.tag | string | `""` | Overrides the image tag (default is the chart appVersion) |
|
||||||
|
| controller.livenessProbe | object | See [values.yaml] | Configure liveness [probe] for the controller |
|
||||||
|
| controller.metrics.enabled | bool | `false` | Deploy metrics service |
|
||||||
|
| controller.metrics.serviceMonitor.additionalAnnotations | object | `{}` | Annotations to be added to the ServiceMonitor |
|
||||||
|
| controller.metrics.serviceMonitor.additionalLabels | object | `{}` | Labels to be added to the ServiceMonitor |
|
||||||
|
| controller.metrics.serviceMonitor.enabled | bool | `false` | Enable a prometheus ServiceMonitor |
|
||||||
|
| controller.nodeSelector | object | `{}` | [Node selector] |
|
||||||
|
| controller.readinessProbe | object | See [values.yaml] | Configure readiness [probe] for the controller |
|
||||||
|
| controller.replicas | int | `1` | The number of controller pods to run |
|
||||||
|
| controller.resources | object | `{}` | Resource limits and requests for the controller pods. |
|
||||||
|
| controller.tolerations | list | `[]` | [Tolerations] for use with node taints |
|
||||||
| podAnnotations | object | `{}` | Annotations to be added to the Rollout pods |
|
| podAnnotations | object | `{}` | Annotations to be added to the Rollout pods |
|
||||||
| podLabels | object | `{}` | Labels to be added to the Rollout pods |
|
| podLabels | object | `{}` | Labels to be added to the Rollout pods |
|
||||||
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
|
|
||||||
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
|
|
||||||
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
|
|
||||||
| podSecurityContext | object | `{"runAsNonRoot":true}` | Security Context to set on pod level |
|
| podSecurityContext | object | `{"runAsNonRoot":true}` | Security Context to set on pod level |
|
||||||
| containerSecurityContext | object | `{}` | Security Context to set on container level |
|
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
|
||||||
| dashboard.enabled | bool | `false` | Deploy dashboard server |
|
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
|
||||||
|
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
|
||||||
|
| serviceAnnotations | object | `{}` | Annotations to be added to the Rollout service |
|
||||||
|
|
||||||
|
### Dashboard
|
||||||
|
|
||||||
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
| dashboard.affinity | object | `{}` | Assign custom [affinity] rules to the deployment |
|
||||||
| dashboard.component | string | `"rollouts-dashboard"` | Value of label `app.kubernetes.io/component` |
|
| dashboard.component | string | `"rollouts-dashboard"` | Value of label `app.kubernetes.io/component` |
|
||||||
|
| dashboard.containerSecurityContext | object | `{}` | Security Context to set on container level |
|
||||||
|
| dashboard.enabled | bool | `false` | Deploy dashboard server |
|
||||||
|
| dashboard.extraArgs | list | `[]` | Additional command line arguments to pass to rollouts-dashboard. A list of flags. |
|
||||||
| dashboard.image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
|
| dashboard.image.pullPolicy | string | `"IfNotPresent"` | Image pull policy |
|
||||||
| dashboard.image.registry | string | `quay.io` | Registry to use |
|
| dashboard.image.registry | string | `"quay.io"` | Registry to use |
|
||||||
| dashboard.image.repository | string | `"argoproj/kubectl-argo-rollouts"` | Repository to use |
|
| dashboard.image.repository | string | `"argoproj/kubectl-argo-rollouts"` | Repository to use |
|
||||||
| dashboard.image.tag | string | `""` | Overrides the image tag (default is the chart appVersion) |
|
| dashboard.image.tag | string | `""` | Overrides the image tag (default is the chart appVersion) |
|
||||||
| dashboard.extraArgs | list | `[]` | Additional arguments for the dashboard. A list of flags. |
|
| dashboard.ingress.annotations | object | `{}` | Dashboard ingress annotations |
|
||||||
|
| dashboard.ingress.enabled | bool | `false` | Enable dashboard ingress support |
|
||||||
|
| dashboard.ingress.extraPaths | list | `[]` | Dashboard ingress extra paths |
|
||||||
|
| dashboard.ingress.hosts | list | `[]` | Dashboard ingress hosts |
|
||||||
|
| dashboard.ingress.ingressClassName | string | `""` | Dashboard ingress class name |
|
||||||
|
| dashboard.ingress.labels | object | `{}` | Dashboard ingress labels |
|
||||||
|
| dashboard.ingress.pathType | string | `"Prefix"` | Dashboard ingress path type |
|
||||||
|
| dashboard.ingress.paths | list | `["/"]` | Dashboard ingress paths |
|
||||||
|
| dashboard.ingress.tls | list | `[]` | Dashboard ingress tls |
|
||||||
|
| dashboard.nodeSelector | object | `{}` | [Node selector] |
|
||||||
|
| dashboard.podSecurityContext | object | `{"runAsNonRoot":true}` | Security Context to set on pod level |
|
||||||
| dashboard.resources | object | `{}` | Resource limits and requests for the dashboard pods. |
|
| dashboard.resources | object | `{}` | Resource limits and requests for the dashboard pods. |
|
||||||
|
| dashboard.service.annotations | object | `{}` | Service annotations |
|
||||||
| dashboard.service.externalIPs | list | `[]` | Dashboard service external IPs |
|
| dashboard.service.externalIPs | list | `[]` | Dashboard service external IPs |
|
||||||
|
| dashboard.service.labels | object | `{}` | Service labels |
|
||||||
| dashboard.service.loadBalancerIP | string | `""` | LoadBalancer will get created with the IP specified in this field |
|
| dashboard.service.loadBalancerIP | string | `""` | LoadBalancer will get created with the IP specified in this field |
|
||||||
| dashboard.service.loadBalancerSourceRanges | list | `[]` | Source IP ranges to allow access to service from |
|
| dashboard.service.loadBalancerSourceRanges | list | `[]` | Source IP ranges to allow access to service from |
|
||||||
| dashboard.service.type | string | `ClusterIP` | Sets the type of the Service |
|
| dashboard.service.port | int | `3100` | Service port |
|
||||||
| dashboard.tolerations | list | `[]` | [Tolerations for use with node taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/) |
|
| dashboard.service.portName | string | `"dashboard"` | Service port name |
|
||||||
| dashboard.affinity | object | `{}` | [Assign custom affinity rules to the deployment](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) |
|
| dashboard.service.targetPort | int | `3100` | Service target port |
|
||||||
| dashboard.nodeSelector | object | `{}` | [Node selector](https://kubernetes.io/docs/user-guide/node-selection/) |
|
| dashboard.service.type | string | `"ClusterIP"` | Sets the type of the Service |
|
||||||
| dashboard.podSecurityContext | object | `{"runAsNonRoot": true}` | Security Context to set on pod level |
|
|
||||||
| dashboard.containerSecurityContext | object | `{}` | Security Context to set on container level |
|
|
||||||
| dashboard.serviceAccount.create | bool | `true` | Specifies whether a dashboard service account should be created |
|
|
||||||
| dashboard.serviceAccount.annotations | object | `{}` | Annotations to add to the dashboard service account |
|
| dashboard.serviceAccount.annotations | object | `{}` | Annotations to add to the dashboard service account |
|
||||||
| dashboard.serviceAccount.name | string | `""` | The name of the dashboard service account to use. If not set and create is true, a name is generated using the fullname template |
|
| dashboard.serviceAccount.create | bool | `true` | Specifies whether a dashboard service account should be created |
|
||||||
| dashboard.service.annotations | object | `{}` | Dashboard service annotations |
|
| dashboard.serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
|
||||||
| dashboard.service.labels | object | `{}` | Dashboard service labels |
|
| dashboard.tolerations | list | `[]` | [Tolerations] for use with node taints |
|
||||||
| dashboard.service.portName | string | `dashboard` | Dashboard service port name |
|
|
||||||
| dashboard.service.port | int | `3100` | Dashboard service port |
|
|
||||||
| dashboard.service.targetPort | int | `3100` | Dashboard service target port |
|
|
||||||
| dashboard.ingress.enabled | bool | `false` | Enable dashboard ingress support |
|
|
||||||
| dashboard.ingress.annotations | object | `{}` | Dashboard ingress annotations |
|
|
||||||
| dashboard.ingress.labels | object | `{}` | Dashboard ingress labels |
|
|
||||||
| dashboard.ingress.ingressClassName | string | `""` | Dashboard ingress class name |
|
|
||||||
| dashboard.ingress.hosts | list | `[]` | Dashboard ingress hosts |
|
|
||||||
| dashboard.ingress.paths | list | `["/"]` | Dashboard ingress paths |
|
|
||||||
| dashboard.ingress.pathType | string | `Prefix` | Dashboard ingress path type |
|
|
||||||
| dashboard.ingress.extraPaths | list | `[]` | Dashboard ingress extra paths |
|
|
||||||
| dashboard.ingress.tls | list | `[]` | Dashboard ingress tls |
|
|
||||||
|
|
||||||
## Upgrading
|
## Upgrading
|
||||||
|
|
||||||
|
@ -121,3 +139,12 @@ If dashboard is installed by `--set dashboard.enabled=true`, checkout the argo-r
|
||||||
* Breaking parameters update
|
* Breaking parameters update
|
||||||
* `securityContext` was renamed to `containerSecurityContext`
|
* `securityContext` was renamed to `containerSecurityContext`
|
||||||
* Added `controller.image.registry`. Prior to this chart version you had to override the registry via `controller.image.repository`
|
* Added `controller.image.registry`. Prior to this chart version you had to override the registry via `controller.image.repository`
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
|
||||||
|
|
||||||
|
[affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
|
||||||
|
[Node selector]: https://kubernetes.io/docs/user-guide/node-selection/
|
||||||
|
[probe]: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
|
||||||
|
[Tolerations]: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
|
||||||
|
[values.yaml]: https://github.com/argoproj/argo-helm/blob/argo-rollouts-2.9.3/charts/argo-rollouts/values.yaml
|
||||||
|
|
99
charts/argo-rollouts/README.md.gotmpl
Normal file
99
charts/argo-rollouts/README.md.gotmpl
Normal file
|
@ -0,0 +1,99 @@
|
||||||
|
# Argo Rollouts Chart
|
||||||
|
|
||||||
|
A Helm chart for Argo Rollouts, progressive delivery for Kubernetes.
|
||||||
|
|
||||||
|
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+
|
||||||
|
- Helm v3.0.0+
|
||||||
|
|
||||||
|
## 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 my-release argo/argo-rollouts
|
||||||
|
```
|
||||||
|
|
||||||
|
### UI Dashboard
|
||||||
|
|
||||||
|
If dashboard is installed by `--set dashboard.enabled=true`, checkout the argo-rollouts dashboard by
|
||||||
|
`kubectl port-forward service/argo-rollouts-dashboard 31000:3100` and pointing the browser to `localhost:31000`
|
||||||
|
|
||||||
|
| :warning: WARNING when the Service type is set to LoadBalancer or NodePort |
|
||||||
|
|:---------------------------------------------------------------------------|
|
||||||
|
| The chart provides an option to change the service type (`dashboard.service.type`). Also it provides the ability to expose the dashboard via Ingress. Dashboard was never intended to be exposed as an administrative console -- it started out as a local view available via CLI. It should be protected by something (e.g. network access or even better an oauth proxy). |
|
||||||
|
|
||||||
|
## Chart Values
|
||||||
|
|
||||||
|
### General parameters
|
||||||
|
|
||||||
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
{{- range .Values }}
|
||||||
|
{{- if not (or (hasPrefix "controller" .Key) (hasPrefix "dashboard" .Key) (hasPrefix "container" .Key) (hasPrefix "pod" .Key) (hasPrefix "service" .Key) ) }}
|
||||||
|
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||||||
|
{{- end }}
|
||||||
|
{{- if hasPrefix "server.additional" .Key }}
|
||||||
|
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
### Controller
|
||||||
|
|
||||||
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
{{- range .Values }}
|
||||||
|
{{- if or (hasPrefix "controller" .Key) (hasPrefix "container" .Key) (hasPrefix "pod" .Key) (hasPrefix "service" .Key) }}
|
||||||
|
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
### Dashboard
|
||||||
|
|
||||||
|
| Key | Type | Default | Description |
|
||||||
|
|-----|------|---------|-------------|
|
||||||
|
{{- range .Values }}
|
||||||
|
{{- if hasPrefix "dashboard" .Key }}
|
||||||
|
| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
|
||||||
|
{{- end }}
|
||||||
|
{{- end }}
|
||||||
|
|
||||||
|
## Upgrading
|
||||||
|
|
||||||
|
### To 2.0.0
|
||||||
|
|
||||||
|
* The argo-rollouts dashboard is added to the template and can be enabled by setting `dashboard.enabled=true`.
|
||||||
|
* There is a breaking change where the selector label `app.kubernetes.io/component: {{ `{{ .Values.controller.component }}` }}` is added to rollout's deployment and service in order to distinguish between the controller and the dashboard component.
|
||||||
|
To upgrade an existing installation, please **add the `--force` parameter** to the `helm upgrade` command or **delete the Deployment and Service resource** before you upgrade. This is necessary because Deployment's label selector is immutable.
|
||||||
|
|
||||||
|
### To 1.0.0
|
||||||
|
|
||||||
|
* This is a breaking change which only supports Helm v3.0.0+ now. If you still use Helm v2, please consider upgrading because v2 is EOL since November 2020.
|
||||||
|
To migrate to Helm v3 please have a look at the [Helm 2to3 Plugin](https://github.com/helm/helm-2to3). This tool will convert the existing ConfigMap used for Tiller to a Secret of type `helm.sh/release.v1`.
|
||||||
|
* `quay.io` is the default registry now
|
||||||
|
* We introduce a template function for the labels here to reduce code duplication. This also affects the Deployment `matchLabels` selector.
|
||||||
|
To upgrade an existing installation, please **add the `--force` parameter** to the `helm upgrade` command or **delete the Deployment resource** before you upgrade. This is necessary because Deployment's label selector is immutable.
|
||||||
|
* All resources are now prefixed with the template `"argo-rollouts.fullname"`.
|
||||||
|
This enables the users to override resource names via the `nameOverride` and `fullnameOverride` parameters.
|
||||||
|
* Breaking parameters update
|
||||||
|
* `securityContext` was renamed to `containerSecurityContext`
|
||||||
|
* Added `controller.image.registry`. Prior to this chart version you had to override the registry via `controller.image.repository`
|
||||||
|
|
||||||
|
----------------------------------------------
|
||||||
|
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
|
||||||
|
|
||||||
|
[affinity]: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
|
||||||
|
[Node selector]: https://kubernetes.io/docs/user-guide/node-selection/
|
||||||
|
[probe]: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes
|
||||||
|
[Tolerations]: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
|
||||||
|
[values.yaml]: https://github.com/argoproj/argo-helm/blob/argo-rollouts-{{ .Version }}/charts/argo-rollouts/values.yaml
|
|
@ -1,50 +1,57 @@
|
||||||
|
# -- Install and upgrade CRDs
|
||||||
installCRDs: true
|
installCRDs: true
|
||||||
|
# -- Keep CRD's on helm uninstall
|
||||||
keepCRDs: true
|
keepCRDs: true
|
||||||
|
|
||||||
|
# -- `false` runs controller in namespaced mode (does not require cluster RBAC)
|
||||||
clusterInstall: true
|
clusterInstall: true
|
||||||
|
|
||||||
## String to partially override "argo-rollouts.fullname" template
|
# -- String to partially override "argo-rollouts.fullname" template
|
||||||
##
|
|
||||||
nameOverride:
|
nameOverride:
|
||||||
|
|
||||||
## String to fully override "argo-rollouts.fullname" template
|
# -- String to fully override "argo-rollouts.fullname" template
|
||||||
##
|
|
||||||
fullnameOverride:
|
fullnameOverride:
|
||||||
|
|
||||||
## Override APIVersions
|
## Override APIVersions
|
||||||
## If you want to template helm charts but cannot access k8s API server
|
## If you want to template helm charts but cannot access k8s API server
|
||||||
## you can set api versions here
|
## you can set api versions here
|
||||||
apiVersionOverrides:
|
apiVersionOverrides:
|
||||||
# String to override apiVersion of ingresses rendered by this helm chart
|
# -- String to override apiVersion of ingresses rendered by this helm chart
|
||||||
ingress: "" # networking.k8s.io/v1beta1
|
ingress: "" # networking.k8s.io/v1beta1
|
||||||
|
|
||||||
## Override the Kubernetes version, which is used to evaluate certain manifests
|
# -- Override the Kubernetes version, which is used to evaluate certain manifests
|
||||||
##
|
|
||||||
kubeVersionOverride: ""
|
kubeVersionOverride: ""
|
||||||
|
|
||||||
controller:
|
controller:
|
||||||
|
# -- Value of label `app.kubernetes.io/component`
|
||||||
component: rollouts-controller
|
component: rollouts-controller
|
||||||
## Node selectors and tolerations for server scheduling to nodes with taints
|
# -- [Node selector]
|
||||||
## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
|
|
||||||
##
|
|
||||||
nodeSelector: {}
|
nodeSelector: {}
|
||||||
|
# -- [Tolerations] for use with node taints
|
||||||
tolerations: []
|
tolerations: []
|
||||||
|
# -- Assign custom [affinity] rules to the deployment
|
||||||
affinity: {}
|
affinity: {}
|
||||||
|
# -- The number of controller pods to run
|
||||||
replicas: 1
|
replicas: 1
|
||||||
image:
|
image:
|
||||||
|
# -- Registry to use
|
||||||
registry: quay.io
|
registry: quay.io
|
||||||
|
# -- Repository to use
|
||||||
repository: argoproj/argo-rollouts
|
repository: argoproj/argo-rollouts
|
||||||
|
# -- Overrides the image tag (default is the chart appVersion)
|
||||||
tag: ""
|
tag: ""
|
||||||
|
# -- Image pull policy
|
||||||
pullPolicy: IfNotPresent
|
pullPolicy: IfNotPresent
|
||||||
|
|
||||||
## Additional command line arguments to pass to rollouts-controller
|
# -- Additional command line arguments to pass to rollouts-controller. A list of flags.
|
||||||
##
|
|
||||||
extraArgs: []
|
extraArgs: []
|
||||||
|
|
||||||
|
# -- Literal yaml for extra containers to be added to controller deployment.
|
||||||
## Additional containers to add to the rollouts controller deployment
|
## Additional containers to add to the rollouts controller deployment
|
||||||
## This will be rendered as the literal yaml
|
## This will be rendered as the literal yaml
|
||||||
extraContainers: []
|
extraContainers: []
|
||||||
|
|
||||||
|
# -- Resource limits and requests for the controller pods.
|
||||||
resources: {}
|
resources: {}
|
||||||
# limits:
|
# limits:
|
||||||
# cpu: 100m
|
# cpu: 100m
|
||||||
|
@ -54,13 +61,18 @@ controller:
|
||||||
# memory: 64Mi
|
# memory: 64Mi
|
||||||
|
|
||||||
metrics:
|
metrics:
|
||||||
|
# -- Deploy metrics service
|
||||||
enabled: false
|
enabled: false
|
||||||
serviceMonitor:
|
serviceMonitor:
|
||||||
|
# -- Enable a prometheus ServiceMonitor
|
||||||
enabled: false
|
enabled: false
|
||||||
|
# -- Labels to be added to the ServiceMonitor
|
||||||
additionalLabels: {}
|
additionalLabels: {}
|
||||||
|
# -- Annotations to be added to the ServiceMonitor
|
||||||
additionalAnnotations: {}
|
additionalAnnotations: {}
|
||||||
|
|
||||||
## Readiness and liveness probes for rollouts controller
|
# -- Configure liveness [probe] for the controller
|
||||||
|
# @default -- See [values.yaml]
|
||||||
livenessProbe:
|
livenessProbe:
|
||||||
httpGet:
|
httpGet:
|
||||||
path: /metrics
|
path: /metrics
|
||||||
|
@ -70,6 +82,9 @@ controller:
|
||||||
failureThreshold: 3
|
failureThreshold: 3
|
||||||
successThreshold: 1
|
successThreshold: 1
|
||||||
timeoutSeconds: 10
|
timeoutSeconds: 10
|
||||||
|
|
||||||
|
# -- Configure readiness [probe] for the controller
|
||||||
|
# @default -- See [values.yaml]
|
||||||
readinessProbe:
|
readinessProbe:
|
||||||
httpGet:
|
httpGet:
|
||||||
path: /metrics
|
path: /metrics
|
||||||
|
@ -81,29 +96,25 @@ controller:
|
||||||
timeoutSeconds: 4
|
timeoutSeconds: 4
|
||||||
|
|
||||||
serviceAccount:
|
serviceAccount:
|
||||||
# Specifies whether a service account should be created
|
# -- Specifies whether a service account should be created
|
||||||
create: true
|
create: true
|
||||||
# Annotations to add to the service account
|
# -- Annotations to add to the service account
|
||||||
annotations: {}
|
annotations: {}
|
||||||
# The name of the service account to use.
|
# -- The name of the service account to use.
|
||||||
# If not set and create is true, a name is generated using the fullname template
|
# If not set and create is true, a name is generated using the fullname template
|
||||||
name: ""
|
name: ""
|
||||||
|
|
||||||
## Annotations to be added to all CRDs
|
# -- Annotations to be added to all CRDs
|
||||||
##
|
|
||||||
crdAnnotations: {}
|
crdAnnotations: {}
|
||||||
|
|
||||||
## Annotations to be added to the Rollout pods
|
# -- Annotations to be added to the Rollout pods
|
||||||
##
|
|
||||||
podAnnotations: {}
|
podAnnotations: {}
|
||||||
|
|
||||||
## Security Context to set on pod level
|
# -- Security Context to set on pod level
|
||||||
##
|
|
||||||
podSecurityContext:
|
podSecurityContext:
|
||||||
runAsNonRoot: true
|
runAsNonRoot: true
|
||||||
|
|
||||||
## Security Context to set on container level
|
# -- Security Context to set on container level
|
||||||
##
|
|
||||||
containerSecurityContext: {}
|
containerSecurityContext: {}
|
||||||
# capabilities:
|
# capabilities:
|
||||||
# drop:
|
# drop:
|
||||||
|
@ -112,40 +123,47 @@ containerSecurityContext: {}
|
||||||
# runAsNonRoot: true
|
# runAsNonRoot: true
|
||||||
# runAsUser: 1000
|
# runAsUser: 1000
|
||||||
|
|
||||||
## Annotations to be added to the Rollout service
|
# -- Annotations to be added to the Rollout service
|
||||||
##
|
|
||||||
serviceAnnotations: {}
|
serviceAnnotations: {}
|
||||||
|
|
||||||
## Labels to be added to the Rollout pods
|
# -- Labels to be added to the Rollout pods
|
||||||
##
|
|
||||||
podLabels: {}
|
podLabels: {}
|
||||||
|
|
||||||
# Secrets with credentials to pull images from a private registry
|
# -- Secrets with credentials to pull images from a private registry. Registry secret names as an array.
|
||||||
imagePullSecrets: []
|
imagePullSecrets: []
|
||||||
# - name: argo-pull-secret
|
# - name: argo-pull-secret
|
||||||
|
|
||||||
dashboard:
|
dashboard:
|
||||||
|
# -- Deploy dashboard server
|
||||||
enabled: false
|
enabled: false
|
||||||
|
# -- Value of label `app.kubernetes.io/component`
|
||||||
component: rollouts-dashboard
|
component: rollouts-dashboard
|
||||||
## Node selectors and tolerations for server scheduling to nodes with taints
|
# -- [Node selector]
|
||||||
## Ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
|
|
||||||
##
|
|
||||||
nodeSelector: {}
|
nodeSelector: {}
|
||||||
|
# -- [Tolerations] for use with node taints
|
||||||
tolerations: []
|
tolerations: []
|
||||||
|
# -- Assign custom [affinity] rules to the deployment
|
||||||
affinity: {}
|
affinity: {}
|
||||||
image:
|
image:
|
||||||
|
# -- Registry to use
|
||||||
registry: quay.io
|
registry: quay.io
|
||||||
|
# -- Repository to use
|
||||||
repository: argoproj/kubectl-argo-rollouts
|
repository: argoproj/kubectl-argo-rollouts
|
||||||
|
# -- Overrides the image tag (default is the chart appVersion)
|
||||||
tag: ""
|
tag: ""
|
||||||
|
# -- Image pull policy
|
||||||
pullPolicy: IfNotPresent
|
pullPolicy: IfNotPresent
|
||||||
## Additional command line arguments to pass to rollouts-dashboard
|
# -- Additional command line arguments to pass to rollouts-dashboard. A list of flags.
|
||||||
##
|
|
||||||
extraArgs: []
|
extraArgs: []
|
||||||
|
# -- Resource limits and requests for the dashboard pods.
|
||||||
resources: {}
|
resources: {}
|
||||||
|
# -- Security Context to set on pod level
|
||||||
podSecurityContext:
|
podSecurityContext:
|
||||||
runAsNonRoot: true
|
runAsNonRoot: true
|
||||||
|
# -- Security Context to set on container level
|
||||||
containerSecurityContext: {}
|
containerSecurityContext: {}
|
||||||
service:
|
service:
|
||||||
|
# -- Sets the type of the Service
|
||||||
type: ClusterIP
|
type: ClusterIP
|
||||||
# -- LoadBalancer will get created with the IP specified in this field
|
# -- LoadBalancer will get created with the IP specified in this field
|
||||||
loadBalancerIP: ""
|
loadBalancerIP: ""
|
||||||
|
@ -164,29 +182,40 @@ dashboard:
|
||||||
# -- Service target port
|
# -- Service target port
|
||||||
targetPort: 3100
|
targetPort: 3100
|
||||||
serviceAccount:
|
serviceAccount:
|
||||||
|
# -- Specifies whether a dashboard service account should be created
|
||||||
create: true
|
create: true
|
||||||
|
# -- Annotations to add to the dashboard service account
|
||||||
annotations: {}
|
annotations: {}
|
||||||
# The name of the service account to use.
|
# -- The name of the service account to use.
|
||||||
# If not set and create is true, a name is generated using the fullname template
|
# If not set and create is true, a name is generated using the fullname template
|
||||||
name: ""
|
name: ""
|
||||||
|
|
||||||
## Ingress configuration.
|
## Ingress configuration.
|
||||||
## ref: https://kubernetes.io/docs/user-guide/ingress/
|
## ref: https://kubernetes.io/docs/user-guide/ingress/
|
||||||
##
|
##
|
||||||
ingress:
|
ingress:
|
||||||
|
# -- Enable dashboard ingress support
|
||||||
enabled: false
|
enabled: false
|
||||||
|
# -- Dashboard ingress annotations
|
||||||
annotations: {}
|
annotations: {}
|
||||||
|
# -- Dashboard ingress labels
|
||||||
labels: {}
|
labels: {}
|
||||||
|
# -- Dashboard ingress class name
|
||||||
ingressClassName: ""
|
ingressClassName: ""
|
||||||
|
|
||||||
|
# -- Dashboard ingress hosts
|
||||||
## Argo Rollouts Dashboard Ingress.
|
## Argo Rollouts Dashboard Ingress.
|
||||||
## Hostnames must be provided if Ingress is enabled.
|
## Hostnames must be provided if Ingress is enabled.
|
||||||
## Secrets must be manually created in the namespace
|
## Secrets must be manually created in the namespace
|
||||||
##
|
|
||||||
hosts: []
|
hosts: []
|
||||||
# - argorollouts.example.com
|
# - argorollouts.example.com
|
||||||
|
|
||||||
|
# -- Dashboard ingress paths
|
||||||
paths:
|
paths:
|
||||||
- /
|
- /
|
||||||
|
# -- Dashboard ingress path type
|
||||||
pathType: Prefix
|
pathType: Prefix
|
||||||
|
# -- Dashboard ingress extra paths
|
||||||
extraPaths: []
|
extraPaths: []
|
||||||
# - path: /*
|
# - path: /*
|
||||||
# backend:
|
# backend:
|
||||||
|
@ -200,6 +229,8 @@ dashboard:
|
||||||
# name: ssl-redirect
|
# name: ssl-redirect
|
||||||
# port:
|
# port:
|
||||||
# name: use-annotation
|
# name: use-annotation
|
||||||
|
|
||||||
|
# -- Dashboard ingress tls
|
||||||
tls: []
|
tls: []
|
||||||
# - secretName: argorollouts-example-tls
|
# - secretName: argorollouts-example-tls
|
||||||
# hosts:
|
# hosts:
|
||||||
|
|
Loading…
Reference in a new issue