Skip to content

Commit 26d4145

Browse files
committed
docs/spec/v2beta2: address review comments
Signed-off-by: Hidde Beydals <hidde@hhh.computer>
1 parent e833972 commit 26d4145

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

docs/spec/v2beta2/helmreleases.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
The `HelmRelease` API allows for controller-driven reconciliation of Helm
44
releases via Helm actions such as install, upgrade, test, uninstall, and
5-
rollback. In addition to this, it allows detecting and correcting cluster state
6-
drift from the desired release state.
5+
rollback. In addition to this, it detects and corrects cluster state drift
6+
from the desired release state.
77

88
## Example
99

@@ -68,9 +68,9 @@ In the above example:
6868
Helm release exists and is up-to-date.
6969
- If the Helm release does not exist, is not up-to-date, or has not observed to
7070
be made by the controller, then the controller will install or upgrade the
71-
release, respectively. If this fails, it is allowed to retry the operation
72-
a number of times while requeueing between attempts, as defined by the
73-
respective [remediation configurations](#configuring-failure-handling).
71+
release. If this fails, it is allowed to retry the operation a number of
72+
times while requeueing between attempts, as defined by the respective
73+
[remediation configurations](#configuring-failure-handling).
7474
- If the [Helm tests](#test-configuration) for the release have not been run
7575
before for this release, the HelmRelease will run them.
7676
- When the Helm release in storage is up-to-date, the controller will check if
@@ -451,7 +451,7 @@ The field offers the following subfields:
451451
Defaults to `false`.
452452
- `.preserveValues` (Optional): Instructs Helm to re-use the values from the
453453
last release while merging in overrides from [values](#values). Setting
454-
this flag makes the HelmRelease non-declarative.
454+
this flag makes the HelmRelease non-declarative. Defaults to `false`.
455455

456456
#### Upgrade remediation
457457

@@ -552,8 +552,10 @@ The field offers the following subfields:
552552
- `.timeout` (Optional): The time to wait for any individual Kubernetes
553553
operation (like Jobs for hooks) during the uninstalltion of the release.
554554
Defaults to the [global timeout value](#timeout).
555-
- `.deletionPropagation` (Optional):
556-
`.disableHooks` (Optional): Prevents [chart hooks](https://helm.sh/docs/topics/charts_hooks/)
555+
- `.deletionPropagation` (Optional): The [deletion propagation policy](https://kubernetes.io/docs/tasks/administer-cluster/use-cascading-deletion/)
556+
when a Helm uninstall is performed. Valid values are `background`,
557+
`foreground` and `orphan`. Defaults to `background`.
558+
- `.disableHooks` (Optional): Prevents [chart hooks](https://helm.sh/docs/topics/charts_hooks/)
557559
from running during the uninstallation of the release. Defaults to `false`.
558560
- `.disableWait` (Optional): Disables waiting for resources to be deleted after
559561
uninstalling the release. Defaults to `false`.
@@ -569,7 +571,7 @@ storage.
569571

570572
When `.spec.driftDetection.mode` is set to `warn` or `enabled`, and the
571573
desired state of the HelmRelease is in-sync with the Helm release object in
572-
the storage. The controller will compare the manifest from the Helm storage
574+
the storage, the controller will compare the manifest from the Helm storage
573575
with the current state of the cluster using a
574576
[server-side dry-run apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/).
575577

@@ -581,9 +583,9 @@ to the controller logs (with `--log-level=debug`).
581583

582584
#### Drift correction
583585

584-
When `.spec.driftDetection.mode` is set to `enabled`, the controller will
585-
attempt to correct the drift by creating and patching the resources based on
586-
the server-side dry-run result.
586+
Furthermore, when `.spec.driftDetection.mode` is set to `enabled`, the
587+
controller will attempt to correct the drift by creating and patching the
588+
resources based on the server-side dry-run result.
587589

588590
At the end of the correction attempt, it will emit a Kubernetes Event with a
589591
summary of the changes it made and any failures it encountered. In case of a

0 commit comments

Comments
 (0)