Flux Operator

https://fluxoperator.dev/docs
Admin
Flux Operator is a Kubernetes GitOps automation platform that extends Flux CD with self-service...
Tokens:581,283
Snippets:3,971
Trust Score:5.6
Update:1 day ago
Show doc for...
Tokens:
Raw
### FluxInstance spec with exact version

Source: https://fluxoperator.dev/docs/crd/fluxinstance/

Example using an exact version to install a specific Flux version.

```yaml
spec:
  distribution:
    version: "2.8.0"
```

--------------------------------

### Install Flux Operator and instance with CLI

Source: https://fluxoperator.dev/docs/guides/install.md

Uses the flux-operator CLI to install the Flux Operator and a Flux instance from a configuration file.

```shell
flux-operator install -f flux-instance.yaml
```

--------------------------------

### ImageUpdateAutomation get output

Source: https://fluxoperator.dev/docs/crd/imageupdateautomation/

Example output from kubectl get imageupdateautomation showing the podinfo-update resource and its last run time.

```text
NAME             LAST RUN
podinfo-update   2024-03-17T22:22:34Z

```

--------------------------------

### Install Flux Instance Helm Chart from Quay

Source: https://fluxoperator.dev/docs/charts/flux-instance/

Installs the flux-instance chart from the Quay registry (quay.io) and sets the instance.distribution.registry to quay.io/fluxoperatordev to use the Quay distribution registry.

```bash
helm upgrade -i flux \
  oci://quay.io/fluxoperatordev/charts/flux-instance \
  --set instance.distribution.registry=quay.io/fluxoperatordev \
  --namespace flux-system \
  --create-namespace \
  --wait
```

--------------------------------

### Kustomize overlays directory structure

Source: https://fluxoperator.dev/docs/crd/provider/

Example directory structure for kustomize overlays for two applications, app1 and app2, each with production and staging overlays.

```text
apps/
├── app1
│   └── overlays
│       ├── production
│       └── staging
└── app2
    └── overlays
        ├── production
        └── staging

```

--------------------------------

### Distribution information example

Source: https://fluxoperator.dev/docs/crd/fluxreport.md

Example YAML for the .spec.distribution field, showing the entitlement, managedBy, status, and version when Flux was installed using the bootstrap command.

```yaml
spec:
  distribution:
    entitlement: Issued by controlplane
    managedBy: 'flux bootstrap'
    status: Installed
    version: v2.3.0
```

--------------------------------

### Default value with get and default functions

Source: https://fluxoperator.dev/docs/crd/resourceset/

Shows how to assign a default value when an input field is not specified, using get combined with default. The example uses the namespace input as a default for the name field.

```yaml
spec:
  inputs:
    - namespace: team1
  resources:
    - apiVersion: source.toolkit.fluxcd.io/v1
      kind: OCIRepository
      metadata:
        name: << get inputs "name" | default inputs.namespace >>
        namespace: << inputs.namespace >>
```

--------------------------------

### Build Flux MCP Server from Source

Source: https://fluxoperator.dev/docs/mcp/install.md

Clones the repository and builds the binary using make. Requires Go 1.26+.

```shell
git clone https://github.com/controlplaneio-fluxcd/flux-operator.git
cd flux-operator
make mcp-build
```

--------------------------------

### Flux Bootstrap Command Example

Source: https://fluxoperator.dev/docs/guides/migration.md

Example of bootstrapping a cluster with the Flux CLI, including the source-watcher component and a custom repository path. This command is used as a reference for creating the equivalent FluxInstance configuration.

```shell
flux bootstrap github \
  --components-extra=source-watcher \
  --owner=my-org \
  --repository=my-fleet \
  --branch=main \
  --path=clusters/my-cluster
```

--------------------------------

### HelmRelease with CRD CreateReplace policy

Source: https://fluxoperator.dev/docs/crd/helmrelease/

Example HelmRelease manifest that sets .spec.install.crds and .spec.upgrade.crds to CreateReplace, enabling CRD updates during install and upgrade. This is useful when using third-party charts that install CRDs and you need to upgrade them via GitOps.

```yaml
---
apiVersion: helm.toolkit.fluxcd.io/v2
kind: HelmRelease
metadata:
  name: my-operator
  namespace: default
spec:
  interval: 15m
  chart:
    spec:
      chart: my-operator
      version: "1.0.1"
      sourceRef:
        kind: HelmRepository
        name: my-operator-repo
      interval: 5m
  install:
    crds: CreateReplace
  upgrade:
    crds: CreateReplace

```

--------------------------------

### Example Config YAML

Source: https://fluxoperator.dev/docs/web-ui/web-config-api/

Minimal example configuration for the Flux Web UI server, using OAuth2 with OIDC provider. Must be passed with --web-config=<path to file>.

```yaml
# /etc/flux-status-page/config.yaml
apiVersion: web.fluxcd.controlplane.io/v1
kind: Config
spec:
  baseURL: https://flux-web.example.com
  authentication:
    type: OAuth2
    oauth2:
      provider: OIDC
      clientID: <OIDC-CLIENT-ID>
      clientSecret: <OIDC-CLIENT-SECRET>
      issuerURL: https://dex.example.com

```

--------------------------------

### Output of kubectl get helmchart

Source: https://fluxoperator.dev/docs/crd/helmchart.md

Example output showing the HelmChart 'podinfo' with status 'True' and message indicating the chart was pulled.

```console
NAME      CHART     VERSION   SOURCE KIND      SOURCE NAME   AGE   READY   STATUS                                     
podinfo   podinfo   5.*       HelmRepository   podinfo       53s   True    pulled 'podinfo' chart with version '5.2.1'
```

--------------------------------

### Generate kustomization.yaml with kustomize create

Source: https://fluxoperator.dev/docs/crd/kustomization/

Commands to generate a kustomization.yaml file for manifests inside apps/my-app.

```bash
cd apps/my-app

# create kustomization.yaml
kustomize create --autodetect --recursive
```

--------------------------------

### FluxInstance spec with upstream Flux distribution

Source: https://fluxoperator.dev/docs/crd/fluxinstance/

Example using the upstream Flux distribution. The .spec.distribution field is required and specifies the Flux distribution to install.

```yaml
spec:
  distribution:
    version: "2.8.x"
    registry: "ghcr.io/fluxcd"
```

--------------------------------

### ImageUpdateAutomation describe output

Source: https://fluxoperator.dev/docs/crd/imageupdateautomation/

Example output from kubectl describe showing the status conditions, last push commit, observed policies, and events.

```text
Status:
  Conditions:
    Last Transition Time:    2024-03-17T22:22:33Z
    Message:                 repository up-to-date
    Observed Generation:     1
    Reason:                  Succeeded
    Status:                  True
    Type:                    Ready
  Last Automation Run Time:  2024-03-17T22:22:34Z
  Last Push Commit:          3ebb95cc56d2db59bc6ffbe0d9dd0ea445edeb77
  Last Push Time:            2024-03-17T22:22:34Z
  Observed Generation:       1
  Observed Policies:
    Podinfo - Policy:
      Name:  ghcr.io/stefanprodan/podinfo
      Tag:   5.0.3
  Observed Source Revision:  main@sha1:3ebb95cc56d2db59bc6ffbe0d9dd0ea445edeb77
Events:
  Type    Reason     Age              From                         Message
  ----    ------     ----             ----                         -------
  Normal  Succeeded  5s (x2 over 6s)  image-automation-controller  repository up-to-date
  Normal  Succeeded  5s               image-automation-controller  pushed commit '3ebb95c' to branch 'main'
Update from image update automation

```

--------------------------------

### Skip configuration with labels

Source: https://fluxoperator.dev/docs/crd/resourcesetinputprovider/

Configures .spec.skip to skip input updates when a label matches, and to skip when a label starting with '!' is not present. The example also includes a filter for labels.

```yaml
spec:
  filter:
    labels:
      - "deploy:flux-preview"
  skip:
    labels:
      - "deploy/flux-preview-pause"
      - "!test-build-push/passed"
```

--------------------------------

### Sample inputs file for ResourceSet build

Source: https://fluxoperator.dev/docs/resourcesets/gitlab-environments.md

Example content for test-inputs.yaml containing mock MR data. Each entry provides author, branch, id, sha, title, and slug for a merge request.

```yaml
   - author: test
     branch: feat/test
     id: "1"
     sha: bf5d6e01cf802734853f6f3417b237e3ad0ba35d
     title: 'review/testing-env'
     slug: 'review-testing-env'

```

--------------------------------

### OLM Subscription manifest for Flux Operator

Source: https://fluxoperator.dev/docs/guides/install.md

Example Subscription manifest to install the Flux Operator on OpenShift via OperatorHub, including environment variables, node affinity, and tolerations.

```yaml
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: flux-operator
  namespace: flux-system
spec:
  channel: stable
  name: flux-operator
  source: operatorhubio-catalog
  sourceNamespace: olm
  config:
    env:
      - name: DEFAULT_SERVICE_ACCOUNT
        value: "flux-operator"
      - name: REPORTING_INTERVAL
        value: "30s"
    affinity:
      nodeAffinity:
        requiredDuringSchedulingIgnoredDuringExecution:
          nodeSelectorTerms:
            - matchExpressions:
                - key: role
                  operator: In
                  values:
                    - flux
    tolerations:
      - effect: NoSchedule
        key: role
        operator: Equal
        value: flux
```

--------------------------------

### Install Flux Instance Helm Chart from GitHub

Source: https://fluxoperator.dev/docs/charts/flux-instance/

Installs the flux-instance chart from the GitHub Container Registry (ghcr.io) into the flux-system namespace, creating the namespace if needed and waiting for the release to complete.

```bash
helm upgrade -i flux \
  oci://ghcr.io/controlplaneio-fluxcd/charts/flux-instance \
  --namespace flux-system \
  --create-namespace \
  --wait
```

--------------------------------

### Check input provider status with flux-operator get

Source: https://fluxoperator.dev/docs/resourcesets/time-based-delivery.md

Use this command to check the status of input providers, including their next schedule time. The example uses '--all-namespaces' to query across all namespaces.

```sh
flux-operator get rsip --all-namespaces
```

--------------------------------

### Cluster sync status example

Source: https://fluxoperator.dev/docs/crd/fluxreport.md

Example YAML for the .spec.sync field, showing the sync readiness, Kustomization ID, path, source URL, and applied revision.

```yaml
spec:
  sync:
    ready: true
    id: kustomization/flux-system
    path: tests/v2.3/sources
    source: https://github.com/controlplaneio-fluxcd/distribution.git
    status: 'Applied revision: refs/heads/main@sha1:a90cd1ac35de01c175f7199315d3f4cd60195911'
```

--------------------------------

### Get Azure Event Hub SAS Connection String

Source: https://fluxoperator.dev/docs/crd/provider/

Azure CLI command to retrieve the primary connection string for the RootManageSharedAccessKey. The output is shown as an example; the default Root SAS is not for production use.

```bash
az eventhubs namespace authorization-rule keys list --resource-group <rg-name> --namespace-name <namespace-name> --name RootManageSharedAccessKey -o tsv --query primaryConnectionString
# The output should look something like this:
Endpoint=sb://fluxv2.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=yoursaskeygeneatedbyazure;EntityPath=youreventhub

```

--------------------------------

### Get HelmRelease status

Source: https://fluxoperator.dev/docs/crd/helmrelease/

Run this command to see the HelmRelease named podinfo, including its age, readiness, and status. The example output shows a successful Helm test with 3 test hooks completed.

```bash
kubectl get helmrelease
```

```text
NAME      AGE   READY   STATUS
podinfo   15s   True    Helm test succeeded for release default/podinfo.v1 with chart podinfo@6.5.3: 3 test hooks completed successfully
```

--------------------------------

### Kustomize overlays file structure for multi-instance app

Source: https://fluxoperator.dev/docs/resourcesets/app-definition.md

Shows the file tree required when using Kustomize overlays to deploy an app instance per tenant with different Helm values. This is the baseline that the ResourceSet API simplifies.

```text
apps/
└── app1
    ├── base
    │   ├── flux-helm-release.yaml
    │   ├── flux-oci-repository.yaml
    │   └── kustomization.yaml
    ├── overlays
    │   ├── tenant1
    │   │   ├── kustomization.yaml
    │   │   ├── values-patch.yaml
    │   │   └── version-patch.yaml
    │   └── tenant2
    │       ├── kustomization.yaml
    │       ├── values-patch.yaml
    │       └── version-patch.yaml
    └── bundle
        └── kustomization.yaml

```

--------------------------------

### Install Flux Operator CLI as a Flux plugin

Source: https://fluxoperator.dev/docs/guides/cli/

Installs the Flux Operator CLI as a Flux plugin using the flux plugin install command.

```bash
flux plugin install operator
```

--------------------------------

### install_flux_instance

Source: https://fluxoperator.dev/docs/mcp/tools/

Installs Flux Operator and a Flux instance on the cluster from a manifest URL. Supports HTTPS and OCI URLs. Returns a detailed installation log.

```APIDOC
## install_flux_instance

### Description
Installs Flux Operator and a Flux instance on the cluster from a manifest URL.

### Parameters
- `instance_url` (required): The URL pointing to the Flux Instance manifest file (supports HTTPS and OCI URLs)
- `timeout` (optional): The installation timeout duration (default: 5m)

### Output
Returns a detailed installation log including deployed resources with their change status.

### Installation Steps
1. Downloads the Flux instance manifest from the provided URL
2. Downloads the Flux Operator manifests from the distribution artifact
3. Installs or upgrades the Flux Operator in the `flux-system` namespace
4. Installs or upgrades the Flux instance according to the manifest configuration
5. Waits for the Flux instance to become ready
6. Configures automatic updates for the Flux Operator

### Example URLs
- OCI Artifact: `oci://ghcr.io/org/manifests:latest#clusters/dev/flux-system/flux-instance.yaml`
- GitHub Gist: `https://gist.github.com/user/id#file-flux-instance-yaml`
- GitHub Repo: `https://github.com/org/repo/blob/main/clusters/dev/flux-system/flux-instance.yaml`
- GitLab Repo: `https://gitlab.com/org/proj/-/blob/main/clusters/dev/flux-system/flux-instance.yaml`
```

--------------------------------

### ResourceSet resourcesTemplate example with conditional and repeated blocks

Source: https://fluxoperator.dev/docs/crd/resourceset.md

Shows a multi-document YAML template using Go template actions (range, if) to generate OCIRepository and Kustomization resources based on inputs. Generates two OCIRepository resources (one per bundle) and four Kustomization resources (one per component per bundle).

```yaml
spec:
  inputs:
    - bundle: addons
      decryption: false
      components:
        - ingress-nginx
        - cert-manager
    - bundle: apps
      decryption: true
      components:
        - frontend
        - backend
  resourcesTemplate: |
    ---
    apiVersion: source.toolkit.fluxcd.io/v1
    kind: OCIRepository
    metadata:
      name: << inputs.bundle >>
      namespace: flux-system
    spec:
      interval: 10m
      url: oci://registry.example.com/<< inputs.bundle >>
    <<- range $component := inputs.components >>
    ---
    apiVersion: kustomize.toolkit.fluxcd.io/v1
    kind: Kustomization
    metadata:
      name: << $component >>
      namespace: flux-system
    spec:
      interval: 1h
      prune: true
      <<- if inputs.decryption >>
      decryption:
        provider: sops
        secretRef:
          name: << inputs.bundle >>-sops
      <<- end >>
      sourceRef:
        kind: OCIRepository
        name: << inputs.bundle >>
      path: ./<< $component >>
    <<- end >>

```
Tokens:
Raw