Skip to content

Commit

Permalink
Add API docs for HelmRelease v2
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
  • Loading branch information
stefanprodan committed May 3, 2024
1 parent 00785fb commit c9c0beb
Show file tree
Hide file tree
Showing 3 changed files with 1,706 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ operator.
* Supports `HelmChart` artifacts produced from `HelmRepository`,
`GitRepository` and `Bucket` sources
* Fetches artifacts produced by [source-controller][] from `HelmChart`
objects
and `OCIRepository` objects
* Watches `HelmChart` objects for revision changes (including semver
ranges for charts from `HelmRepository` sources)
* Performs automated Helm actions, including Helm tests, rollbacks and
Expand All @@ -49,7 +49,7 @@ operator.

## Specifications

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

[source-controller]: https://github.com/fluxcd/source-controller
Expand Down
16 changes: 16 additions & 0 deletions docs/spec/v2/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# helm.toolkit.fluxcd.io/v2

This is the v2 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 c9c0beb

Please sign in to comment.