Skip to content

Commit

Permalink
Merge pull request #17 from controlplaneio-fluxcd/api-docs
Browse files Browse the repository at this point in the history
Add API docs for the FluxInstance custom resource
  • Loading branch information
stefanprodan authored Jun 4, 2024
2 parents 95a962f + b346da5 commit d61a7a6
Show file tree
Hide file tree
Showing 2 changed files with 470 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ The Flux Operator comes with a Kubernetes CRD called `FluxInstance`. A single cu
can exist in a Kubernetes cluster with the name `flux` that must be created in the same
namespace where the operator is deployed.

> [!NOTE]
> The `FluxInstance` API documentation is available at
> [docs/api/v1](https://github.com/controlplaneio-fluxcd/flux-operator/blob/main/docs/api/v1/fluxinstance.md).
### Upstream Distribution

To install the upstream distribution of Flux, create the following `FluxInstance` resource:
Expand Down
Loading

0 comments on commit d61a7a6

Please sign in to comment.