docs: incorporate HelmRelease API changes in guide

pull/196/head
Hidde Beydals 5 years ago
parent 969f181f3e
commit 8e03968370

@ -4,7 +4,7 @@ The [helm-controller](../components/helm/controller.md) allows you to
declaratively manage Helm chart releases with Kubernetes manifests. declaratively manage Helm chart releases with Kubernetes manifests.
It makes use of the artifacts produced by the It makes use of the artifacts produced by the
[source-controller](../components/source/controller.md) from [source-controller](../components/source/controller.md) from
`HelmRepository` and `HelmChart` resources. `HelmRepository`, `GitRepository`, and `HelmChart` resources.
The helm-controller is part of the default toolkit installation. The helm-controller is part of the default toolkit installation.
## Prerequisites ## Prerequisites
@ -63,25 +63,26 @@ metadata:
spec: spec:
interval: 5m interval: 5m
chart: chart:
name: podinfo spec:
version: '^4.0.0' chart: podinfo
sourceRef: version: '4.0.x'
kind: HelmRepository sourceRef:
name: podinfo kind: HelmRepository
namespace: gitops-system name: podinfo
interval: 1m namespace: gitops-system
interval: 1m
values: values:
replicaCount: 2 replicaCount: 2
``` ```
The `chart.name` is the name of the chart as made available by the Helm The `chart.spec.chart` is the name of the chart as made available by
repository, and may not include any aliases. the Helm repository, and may not include any aliases.
The `chart.version` can be a fixed semver, or any semver range (i.e. The `chart.spec.version` can be a fixed semver, or any semver range
`>=4.0.0 <4.0.2`). (i.e. `>=4.0.0 <5.0.0`).
The `chart` values are used by the helm-controller as a template to The `chart.spec` values are used by the helm-controller as a template
create a new `HelmChart` resource in the same namespace as the to create a new `HelmChart` resource in the same namespace as the
`sourceRef`. The source-controller will then lookup the chart in the `sourceRef`. The source-controller will then lookup the chart in the
artifact of the referenced `HelmRepository`, fetch the chart, and make artifact of the referenced `HelmRepository`, fetch the chart, and make
it available as a `HelmChart` artifact to be used by the it available as a `HelmChart` artifact to be used by the

@ -136,11 +136,12 @@ metadata:
namespace: gitops-system namespace: gitops-system
spec: spec:
chart: chart:
name: sealed-secrets spec:
sourceRef: chart: sealed-secrets
kind: HelmRepository sourceRef:
name: stable kind: HelmRepository
version: "^1.10.0" name: stable
version: "1.10.x"
interval: 1h0m0s interval: 1h0m0s
releaseName: sealed-secrets releaseName: sealed-secrets
targetNamespace: gitops-system targetNamespace: gitops-system

Loading…
Cancel
Save