Skip to content

Commit

Permalink
Merge pull request #828 from fluxcd/document-v2beta2
Browse files Browse the repository at this point in the history
docs/spec: document `v2beta2` API
  • Loading branch information
hiddeco authored Dec 11, 2023
2 parents 7d0aecf + bb5a03b commit 14a333d
Show file tree
Hide file tree
Showing 4 changed files with 1,625 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ operator.
[notification-controller][])
* Built-in Kustomize compatible Helm post renderer, providing support
for strategic merge, JSON 6902 and images patches
* Supports detecting and correcting in-cluster changes compared to the desired
state of the Helm release

## Guides

Expand All @@ -47,7 +49,7 @@ operator.

## Specifications

* [API](docs/spec/v2beta1/README.md)
* [API](docs/spec/v2beta2/README.md)
* [Controller](docs/spec/README.md)

[source-controller]: https://github.com/fluxcd/source-controller
Expand Down
3 changes: 2 additions & 1 deletion docs/spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ actions that should be (conditionally) executed. Based on this the reconciler:
- performs a Helm install or upgrade action if needed
- performs a Helm test action if enabled
- performs a reconciliation strategy (rollback, uninstall) and retries as configured if any Helm action failed
- performs in cluster drift detection and correction if enabled

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

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

## Backward compatibility

Expand Down
16 changes: 16 additions & 0 deletions docs/spec/v2beta2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# helm.toolkit.fluxcd.io/v2beta2

This is the v2beta2 API specification for declaratively managing Helm chart
releases with Kubernetes manifests.

## Specification

- [HelmRelease CRD](helmreleases.md)
+ [Example](helmreleases.md#example)
+ [Writing a HelmRelease spec](helmreleases.md#writing-a-helmrelease-spec)
+ [Working with HelmReleases](helmreleases.md#working-with-helmreleases)
+ [HelmRelease Status](helmreleases.md#helmrelease-status)

## Implementation

* [helm-controller](https://github.com/fluxcd/helm-controller/)
Loading

0 comments on commit 14a333d

Please sign in to comment.