Skip to content

Commit

Permalink
Update docs for Flux Operator v0.16.0
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Prodan <[email protected]>
  • Loading branch information
stefanprodan committed Feb 26, 2025
1 parent dd94da8 commit ef9b5ec
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 15 deletions.
11 changes: 2 additions & 9 deletions docs/operator/flux-sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,18 +64,11 @@ spec:
- image-automation-controller
sync:
kind: GitRepository
provider: github
url: "https://github.com/my-org/my-fleet.git"
ref: "refs/heads/main"
path: "clusters/my-cluster"
pullSecret: "flux-system"
kustomize:
patches:
- patch: |
- op: add
path: /spec/provider
value: github
target:
kind: GitRepository
```

The Kubernetes secret must be created in the `flux-system` namespace
Expand All @@ -90,7 +83,7 @@ flux create secret githubapp flux-system \

!!! tip "GitHub App Support"

Note that GitHub App support was added in Flux v2.5.0 and Flux Operator v0.15.0.
Note that GitHub App support was added in Flux v2.5.0 and Flux Operator v0.16.0.
For more information on how to create a GitHub App see the
Flux [GitRepository API reference](https://fluxcd.io/flux/components/source/gitrepositories/#github).

Expand Down
13 changes: 8 additions & 5 deletions docs/operator/fluxinstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ where the flux-operator is deployed.

The following example shows a FluxInstance custom resource that
installs the upstream Flux distribution with all available components,
and configures the flux-operator to automatically upgrade Flux
and configures the flux-operator to automatically upgrade Flux
to the latest stable version:

```yaml
Expand Down Expand Up @@ -135,7 +135,7 @@ kubectl -n flux-system events --for FluxInstance/flux
```

**6.** Run `kubectl delete` to remove the FluxInstance resource and
to uninstall Flux without affecting any Flux-managed workloads:
to uninstall Flux without affecting any Flux-managed workloads:

```shell
kubectl -n flux-system delete FluxInstance/flux
Expand Down Expand Up @@ -472,10 +472,13 @@ Sync fields:
- `ref`: The source reference, can be a Git ref name e.g. `refs/heads/main`, an OCI tag e.g. `latest` or a Bucket name.
- `path`: The path to the source directory containing the kustomize overlay or plain Kubernetes manifests to sync from.
- `pullSecret`: The name of the Kubernetes secret that contains the credentials to pull the source repository. This field is optional.
- `provider`: The provider name used for OIDC-based authentication.
Supported values are `aws`, `azure` and `gcp` for `OCIRepository`/`Bucket`,
and `azure` or `github` for `GitRepository`. This field is optional.
- `interval`: The sync interval. This field is optional, when not set the default is `1m`.
- `name`: The name of the generated Flux source and Kustomization objects.
This field is optional, when not set the default is the FluxInstance namespace name.
Note that this field is considered immutable, and cannot be changed after the FluxInstance is created.
This field is optional, when not set the default is the FluxInstance namespace name.
Note that this field is considered immutable, and cannot be changed after the FluxInstance is created.

#### Sync from Git over HTTP/S

Expand Down Expand Up @@ -752,7 +755,7 @@ Status:
`.status.lastAppliedRevision` is the last revision of the Flux distribution
that was successfully applied to the cluster.

The revision is in the format `<version>@sha256:<digest>`.
The revision is in the format `<version>@sha256:<digest>`.

The version is the Flux distribution exact semver version that was applied to the cluster.

Expand Down
9 changes: 8 additions & 1 deletion docs/operator/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It is recommended to install the operator in a dedicated namespace, such as `flu

The Flux Operator can be installed using the
[Helm chart](https://github.com/controlplaneio-fluxcd/charts/tree/main/charts/flux-operator)
available in the ControlPlane registry:
available in GitHub Container Registry:

```shell
helm install flux-operator oci://ghcr.io/controlplaneio-fluxcd/charts/flux-operator \
Expand Down Expand Up @@ -71,8 +71,15 @@ spec:
name: flux-operator
source: operatorhubio-catalog
sourceNamespace: olm
config:
env:
- name: DEFAULT_SERVICE_ACCOUNT
value: "flux-operator"
```
The Flux Operator is also available in the Openshift and OKD
[production-ready catalog](https://github.com/redhat-openshift-ecosystem/community-operators-prod).
### Kubectl
The Flux Operator can be installed with `kubectl` by
Expand Down

0 comments on commit ef9b5ec

Please sign in to comment.