Skip to content

Commit 9afd20c

Browse files
committed
docs: various doc nits
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
1 parent d8966cd commit 9afd20c

File tree

2 files changed

+15
-10
lines changed

2 files changed

+15
-10
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ operator.
4949

5050
## Specifications
5151

52-
* [API](docs/spec/v2beta1/README.md)
52+
* [API](docs/spec/v2beta2/README.md)
5353
* [Controller](docs/spec/README.md)
5454

5555
[source-controller]: https://github.com/fluxcd/source-controller

docs/spec/v2beta2/helmreleases.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Helm Releases
22

3+
<!-- menuweight:10 -->
4+
35
The `HelmRelease` API allows for controller-driven reconciliation of Helm
46
releases via Helm actions such as install, upgrade, test, uninstall, and
57
rollback. In addition to this, it detects and corrects cluster state drift
@@ -62,16 +64,15 @@ In the above example:
6264
named `podinfo` is created, pointing to the Helm repository from which the
6365
podinfo chart can be installed.
6466
- A HelmRelease named `podinfo` is created, that will create a [HelmChart](https://fluxcd.io/flux/components/source/helmcharts/) object
65-
object from [the `.spec.chart`](#chart-template) and watch it for Artifact
66-
changes.
67+
from [the `.spec.chart`](#chart-template) and watch it for Artifact changes.
6768
- The controller will fetch the chart from the HelmChart's Artifact and use it
6869
together with the `.spec.releaseName` and `.spec.values` to confirm if the
6970
Helm release exists and is up-to-date.
7071
- If the Helm release does not exist, is not up-to-date, or has not observed to
71-
be made by the controller, then the controller will install or upgrade the
72-
release. If this fails, it is allowed to retry the operation a number of
73-
times while requeueing between attempts, as defined by the respective
74-
[remediation configurations](#configuring-failure-handling).
72+
be made by the controller based on [the HelmRelease's history](#history), then
73+
the controller will install or upgrade the release. If this fails, it is
74+
allowed to retry the operation a number of times while requeueing between
75+
attempts, as defined by the respective [remediation configurations](#configuring-failure-handling).
7576
- If the [Helm tests](#test-configuration) for the release have not been run
7677
before for this release, the HelmRelease will run them.
7778
- When the Helm release in storage is up-to-date, the controller will check if
@@ -214,7 +215,7 @@ uninstalled before installing a new release with the new name.
214215
**Note:** When the composition exceeds the maximum length of 53 characters, the
215216
name is shortened by hashing the release name with SHA-256. The resulting name
216217
is then composed of the first 40 characters of the release name, followed by a
217-
dash (`-`), followed by the 12 characters of the hash. For example,
218+
dash (`-`), followed by the first 12 characters of the hash. For example,
218219
`a-very-lengthy-target-namespace-with-a-nice-object-name` becomes
219220
`a-very-lengthy-target-namespace-with-a-nic-97af5d7f41f3`.
220221

@@ -481,7 +482,8 @@ The field offers the following subfields:
481482

482483
To make the controller run the [Helm tests available for the chart](https://helm.sh/docs/topics/chart_tests/)
483484
after a successful Helm install or upgrade, `.spec.test.enable` can be set to
484-
`true`.
485+
`true`. When enabled, the test results will be available in the
486+
[`.status.history`](#history) field and emitted as a Kubernetes Event.
485487

486488
By default, when tests are enabled, failures in tests are considered release
487489
failures, and thus are subject to the triggering Helm action's remediation
@@ -586,7 +588,7 @@ to the controller logs (with `--log-level=debug`).
586588

587589
Furthermore, when `.spec.driftDetection.mode` is set to `enabled`, the
588590
controller will attempt to correct the drift by creating and patching the
589-
resources based on the server-side apply dry-run result.
591+
resources based on the server-side dry-run apply result.
590592

591593
At the end of the correction attempt, it will emit a Kubernetes Event with a
592594
summary of the changes it made and any failures it encountered. In case of a
@@ -977,6 +979,9 @@ When the flag is set, HelmReleases which do not have a `.spec.serviceAccountName
977979
specified will use the Service Account name provided by
978980
`--default-service-account=<name>` in the namespace of the HelmRelease object.
979981

982+
For further best practices on securing helm-controller, see our
983+
[best practices guide](https://fluxcd.io/flux/security/best-practices).
984+
980985
### Remote clusters / Cluster-API
981986

982987
Using a [`.spec.kubeConfig` reference](#kubeconfig-reference), it is possible

0 commit comments

Comments
 (0)