Skip to content

Commit 14a333d

Browse files
authored
Merge pull request #828 from fluxcd/document-v2beta2
docs/spec: document `v2beta2` API
2 parents 7d0aecf + bb5a03b commit 14a333d

File tree

4 files changed

+1625
-2
lines changed

4 files changed

+1625
-2
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ operator.
3838
[notification-controller][])
3939
* Built-in Kustomize compatible Helm post renderer, providing support
4040
for strategic merge, JSON 6902 and images patches
41+
* Supports detecting and correcting in-cluster changes compared to the desired
42+
state of the Helm release
4143

4244
## Guides
4345

@@ -47,7 +49,7 @@ operator.
4749

4850
## Specifications
4951

50-
* [API](docs/spec/v2beta1/README.md)
52+
* [API](docs/spec/v2beta2/README.md)
5153
* [Controller](docs/spec/README.md)
5254

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

docs/spec/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ actions that should be (conditionally) executed. Based on this the reconciler:
3535
- performs a Helm install or upgrade action if needed
3636
- performs a Helm test action if enabled
3737
- performs a reconciliation strategy (rollback, uninstall) and retries as configured if any Helm action failed
38+
- performs in cluster drift detection and correction if enabled
3839

3940
The controller that runs these Helm actions relies on [source-controller](https://github.com/fluxcd/source-controller)
4041
for providing the Helm charts from Helm repositories or any other source that source-controller
@@ -50,7 +51,7 @@ trigger a Helm uninstall.
5051
Alerting can be configured with a Kubernetes custom resource that specifies a webhook address, and a
5152
group of `HelmRelease` resources to be monitored using the [notification-controller](https://github.com/fluxcd/notification-controller).
5253

53-
The API design of the controller can be found at [helm.toolkit.fluxcd.io/v2beta1](./v2beta1/helmreleases.md).
54+
The API design of the controller can be found at [helm.toolkit.fluxcd.io/v2beta2](./v2beta2/helmreleases.md).
5455

5556
## Backward compatibility
5657

docs/spec/v2beta2/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# helm.toolkit.fluxcd.io/v2beta2
2+
3+
This is the v2beta2 API specification for declaratively managing Helm chart
4+
releases with Kubernetes manifests.
5+
6+
## Specification
7+
8+
- [HelmRelease CRD](helmreleases.md)
9+
+ [Example](helmreleases.md#example)
10+
+ [Writing a HelmRelease spec](helmreleases.md#writing-a-helmrelease-spec)
11+
+ [Working with HelmReleases](helmreleases.md#working-with-helmreleases)
12+
+ [HelmRelease Status](helmreleases.md#helmrelease-status)
13+
14+
## Implementation
15+
16+
* [helm-controller](https://github.com/fluxcd/helm-controller/)

0 commit comments

Comments
 (0)