Skip to content
Back to search

flux-operator

GitOps on Autopilot Mode

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/controlplaneio-fluxcd/flux-operator with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/controlplaneio-fluxcd/flux-operator'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/controlplaneio-fluxcd--flux-operator/badge.svg)](/listings/controlplaneio-fluxcd--flux-operator)

HTML

<a href="/listings/controlplaneio-fluxcd--flux-operator"><img src="/api/listings/controlplaneio-fluxcd--flux-operator/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install the Flux Operator

Install the Flux Operator in the `flux-system` namespace, for example using Helm:

helm install flux-operator oci://ghcr.io/controlplaneio-fluxcd/charts/flux-operator \
  --namespace flux-system

> [!NOTE] > The Flux Operator can be installed using Helm, Terraform, OperatorHub, kubectl and other methods. > For more information, refer to the > [installation guide](https://fluxoperator.dev/docs/guides/install/).

Install the Flux Controllers

Create a [FluxInstance](https://fluxoperator.dev/docs/crd/fluxinstance/) resource named `flux` in the `flux-system` namespace to install the latest Flux stable version:

apiVersion: fluxcd.controlplane.io/v1
kind: FluxInstance
metadata:
  name: flux
  namespace: flux-system
  annotations:
    fluxcd.controlplane.io/reconcileEvery: "1h"
    fluxcd.controlplane.io/reconcileArtifactEvery: "10m"
    fluxcd.controlplane.io/reconcileTimeout: "5m"
spec:
  distribution:
    version: "2.x"
    registry: "ghcr.io/fluxcd"
    artifact: "oci://ghcr.io/controlplaneio-fluxcd/flux-operator-manifests"
  components:
    - source-controller
    - kustomize-controller
    - helm-controller
    - notification-controller
    - image-reflector-controller
    - image-automation-controller
  cluster:
    type: kubernetes
    size: medium
    multitenant: false
    networkPolicy: true
    domain: "cluster.local"
  kustomize:
    patches:
      - target:
          kind: Deployment
        patch: |
          - op: replace
            path: /spec/template/spec/nodeSelector
            value:
              kubernetes.io/os: linux
          - op: add
            path: /spec/template/spec/tolerations
            value:
              - key: "CriticalAddonsOnly"
                operator: "Exists"

> [!NOTE] > The Flux instance can be customized in various ways. > For more information, refer to the > [configuration guide](https://fluxoperator.dev/docs/instance/controllers/).

Sync from a Git Repository

To sync the cluster state from a Git repository, add the following configuration to the `FluxInstance`:

apiVersion: fluxcd.controlplane.io/v1
kind: FluxInstance
metadata:
  name: flux
  namespace: flux-system
spec:
  sync:
    kind: GitRepository
    url: "https://github.com/my-org/my-fleet.git"
    ref: "refs/heads/main"
    path: "clusters/my-cluster"
    pullSecret: "flux-system"
  # distribution omitted for brevity

If the source repository is private, the Kubernetes secret must be created in the `flux-system` namespace and should contain the credentials to clone the repository:

flux create secret git flux-system \
  --url=https://github.com/my-org/my-fleet.git \
  --username=git \
  --password=$GITHUB_TOKEN

> [!NOTE] > For more information on how to configure syncing from Git repositories, > container registries and S3-compatible storage, refer to the > [cluster sync guide](https://fluxoperator.dev/docs/instance/sync/).

Monitor the Flux Installation

To monitor the Flux deployment status, check the [FluxReport](https://fluxoperator.dev/docs/crd/fluxreport/) resource in the `flux-system` namespace:

kubectl get fluxreport/flux -n flux-system -o yaml

The report is updated at regular intervals and contains information about the deployment readiness status, the distribution details, reconcilers statistics, Flux CRDs versions, the cluster sync status and more.

Access the Flux Web UI

To access the [Flux Web UI](https://fluxoperator.dev/web-ui/), you can port-forward the operator service:

kubectl -n flux-system port-forward svc/flux-operator 9080:9080

Note that the Flux Web UI can be configured with [Ingress](https://fluxoperator.dev/docs/web-ui/ingress/) and [Single Sign-On](https://fluxoperator.dev/docs/web-ui/user-management/) for secure external access.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 233 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # flux-operator
  2. [![release](https://img.shields.io/github/release/controlplaneio-fluxcd/flux-operator/all.svg)](https://github.com/controlplaneio-fluxcd/flux-operator/releases)
  3. [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/flux-operator)](https://artifacthub.io/packages/helm/flux-operator/flux-operator)
  4. [![Operator Hub](https://img.shields.io/badge/Operator_Hub-flux--operator-9cf.svg)](https://operatorhub.io/operator/flux-operator)
  5. [![test](https://github.com/controlplaneio-fluxcd/flux-operator/actions/workflows/test.yaml/badge.svg)](https://github.com/controlplaneio-fluxcd/flux-operator/actions/workflows/test.yaml)
  6. [![license](https://img.shields.io/github/license/controlplaneio-fluxcd/flux-operator.svg)](https://github.com/controlplaneio-fluxcd/flux-operator/blob/main/LICENSE)
  7. [![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://fluxcd.control-plane.io/distribution/security/)
  8. The Flux Operator is a Kubernetes CRD controller that manages
  9. the lifecycle of CNCF [Flux CD](https://fluxcd.io) and the [ControlPlane enterprise distribution](https://github.com/controlplaneio-fluxcd/distribution).
  10. The operator extends Flux with self-service capabilities, deployment windows,
  11. and preview environments for GitHub, GitLab, Gitea and Azure DevOps pull requests testing.
  12. ---
  13. <p align="center">
  14. <a href="https://fluxoperator.dev">
  15. <img src="https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/logo/flux-operator-banner.png" width="100%">
  16. </a>
  17. </p>
  18. ---
  19. **Autopilot for Flux CD** - The operator offers an alternative to the Flux Bootstrap procedure, it
  20. removes the operational burden of managing Flux across fleets of clusters by fully automating the
  21. installation, configuration, and upgrade of the Flux controllers based on a declarative API.
  22. **Advanced Configuration** - The operator simplifies the configuration of Flux multi-tenancy lockdown,
  23. sharding, horizontal and vertical scaling, persistent storage, and allows fine-tuning the Flux
  24. controllers with Kustomize patches. The operator streamlines the transition from Git as the delivery
  25. mechanism for the cluster desired state to OCI artifacts and S3-compatible storage.
  26. **Deep Insights** - The operator provides deep insights into the delivery pipelines managed by Flux,
  27. including detailed reports and Prometheus metrics about the Flux controllers
  28. readiness status, reconcilers statistics, and cluster state synchronization.
  29. The [Flux Web UI](https://fluxoperator.dev/web-ui/) offers a real-time view of the GitOps pipelines,
  30. allowing you to monitor deployments, track reconciliation status, and troubleshoot issues.
  31. **Self-Service Environments** - The operator [ResourceSet API](https://fluxoperator.dev/docs/resourcesets/introduction/)
  32. enables platform teams to define their own application standard as a group of Flux and Kubernetes resources
  33. that can be templated, parameterized and deployed as a single unit on self-service environments.
  34. The ResourceSet API integrates with Git pull requests to create ephemeral environments
  35. for testing and validation.
  36. **AI-Assisted GitOps** - The [Flux MCP Server](https://fluxoperator.dev/mcp-server/) connects
  37. AI assistants to Kubernetes clusters running the operator, enabling seamless interaction
  38. through natural language. It serves as a bridge between AI tools and GitOps pipelines,
  39. allowing you to analyze deployment across environments, troubleshoot issues,
  40. and perform operations using conversational prompts.
  41. **Enterprise Support** - The operator is a key component of the ControlPlane
  42. [Enterprise offering](https://fluxcd.control-plane.io/pricing/), and is designed to automate the
  43. rollout of new Flux versions, CVE patches and hotfixes to production environments in a secure and reliable way.
  44. The operator is end-to-end tested along with the ControlPlane Flux distribution on
  45. Red Hat OpenShift, Amazon EKS, Azure AKS and Google GKE.
  46. ## Quickstart Guide
  47. ### Install the Flux Operator
  48. Install the Flux Operator in the `flux-system` namespace, for example using Helm:
  49. ```shell
  50. helm install flux-operator oci://ghcr.io/controlplaneio-fluxcd/charts/flux-operator \
  51. --namespace flux-system
  52. ```
  53. > [!NOTE]
  54. > The Flux Operator can be installed using Helm, Terraform, OperatorHub, kubectl and other methods.
  55. > For more information, refer to the
  56. > [installation guide](https://fluxoperator.dev/docs/guides/install/).
  57. ### Install the Flux Controllers
  58. Create a [FluxInstance](https://fluxoperator.dev/docs/crd/fluxinstance/) resource
  59. named `flux` in the `flux-system` namespace to install the latest Flux stable version:
  60. ```yaml
  61. apiVersion: fluxcd.controlplane.io/v1
  62. kind: FluxInstance
  63. metadata:
  64. name: flux
  65. namespace: flux-system
  66. annotations:
  67. fluxcd.controlplane.io/reconcileEvery: "1h"
  68. fluxcd.controlplane.io/reconcileArtifactEvery: "10m"
  69. fluxcd.controlplane.io/reconcileTimeout: "5m"
  70. spec:
  71. distribution:
  72. version: "2.x"
  73. registry: "ghcr.io/fluxcd"
  74. artifact: "oci://ghcr.io/controlplaneio-fluxcd/flux-operator-manifests"
  75. components:
  76. - source-controller
  77. - kustomize-controller
  78. - helm-controller
  79. - notification-controller
  80. - image-reflector-controller
  81. - image-automation-controller
  82. cluster:
  83. type: kubernetes
  84. size: medium
  85. multitenant: false
  86. networkPolicy: true
  87. domain: "cluster.local"
  88. kustomize:
  89. patches:
  90. - target:
  91. kind: Deployment
  92. patch: |
  93. - op: replace
  94. path: /spec/template/spec/nodeSelector
  95. value:
  96. kubernetes.io/os: linux
  97. - op: add
  98. path: /spec/template/spec/tolerations
  99. value:
  100. - key: "CriticalAddonsOnly"
  101. operator: "Exists"
  102. ```
  103. > [!NOTE]
  104. > The Flux instance can be customized in various ways.
  105. > For more information, refer to the
  106. > [configuration guide](https://fluxoperator.dev/docs/instance/controllers/).
  107. ### Sync from a Git Repository
  108. To sync the cluster state from a Git repository, add the following configuration to the `FluxInstance`:
  109. ```yaml
  110. apiVersion: fluxcd.controlplane.io/v1
  111. kind: FluxInstance
  112. metadata:
  113. name: flux
  114. namespace: flux-system
  115. spec:
  116. sync:
  117. kind: GitRepository
  118. url: "https://github.com/my-org/my-fleet.git"
  119. ref: "refs/heads/main"
  120. path: "clusters/my-cluster"
  121. pullSecret: "flux-system"
  122. # distribution omitted for brevity
  123. ```
  124. If the source repository is private, the Kubernetes secret must be created in the `flux-system` namespace
  125. and should contain the credentials to clone the repository:
  126. ```shell
  127. flux create secret git flux-system \
  128. --url=https://github.com/my-org/my-fleet.git \
  129. --username=git \
  130. --password=$GITHUB_TOKEN
  131. ```
  132. > [!NOTE]
  133. > For more information on how to configure syncing from Git repositories,
  134. > container registries and S3-compatible storage, refer to the
  135. > [cluster sync guide](https://fluxoperator.dev/docs/instance/sync/).
  136. ### Monitor the Flux Installation
  137. To monitor the Flux deployment status, check the
  138. [FluxReport](https://fluxoperator.dev/docs/crd/fluxreport/)
  139. resource in the `flux-system` namespace:
  140. ```shell
  141. kubectl get fluxreport/flux -n flux-system -o yaml
  142. ```
  143. The report is updated at regular intervals and contains information about the deployment
  144. readiness status, the distribution details, reconcilers statistics, Flux CRDs versions,
  145. the cluster sync status and more.
  146. ### Access the Flux Web UI
  147. To access the [Flux Web UI](https://fluxoperator.dev/web-ui/),
  148. you can port-forward the operator service:
  149. ```shell
  150. kubectl -n flux-system port-forward svc/flux-operator 9080:9080
  151. ```
  152. Note that the Flux Web UI can be configured with [Ingress](https://fluxoperator.dev/docs/web-ui/ingress/)
  153. and [Single Sign-On](https://fluxoperator.dev/docs/web-ui/user-management/) for secure external access.
  154. ## ResourceSet APIs
  155. The Flux Operator [ResourceSet APIs](https://fluxoperator.dev/docs/resourcesets/introduction/)
  156. offer a high-level abstraction for defining and managing Flux resources and related Kubernetes
  157. objects as a single unit.
  158. The ResourceSet API is designed to reduce the complexity of GitOps workflows and to
  159. enable self-service for developers and platform teams.
  160. Guides:
  161. - [Using ResourceSets for Application Definitions](https://fluxoperator.dev/docs/resourcesets/app-definition/)
  162. - [Using ResourceSets for Time-Based Delivery](https://fluxoperator.dev/docs/resourcesets/time-based-delivery/)
  163. - [Ephemeral Environments for GitHub Pull Requests](https://fluxoperator.dev/docs/resourcesets/github-pull-requests/)
  164. - [Ephemeral Environments for GitLab Merge Requests](https://fluxoperator.dev/docs/resourcesets/gitlab-merge-requests/)
  165. ## Documentation
  166. - Installation
  167. - [Flux Operator installation](https://fluxoperator.dev/docs/guides/install/)
  168. - [Migration of bootstrapped clusters](https://fluxoperator.dev/docs/guides/migration/)
  169. - [Flux Operator CLI](https://fluxoperator.dev/docs/guides/cli/)
  170. - Flux Configuration
  171. - [Flux controllers configuration](https://fluxoperator.dev/docs/instance/controllers/)
  172. - [Flux instance customization](https://fluxoperator.dev/docs/instance/customization/)
  173. - [Cluster sync configuration](https://fluxoperator.dev/docs/instance/sync/)
  174. - [Flux controllers sharding](https://fluxoperator.dev/docs/instance/sharding/)
  175. - [Flux monitoring and reporting](https://fluxoperator.dev/docs/instance/monitoring/)
  176. - CRD references
  177. - [FluxInstance API reference](https://fluxoperator.dev/docs/crd/fluxinstance/)
  178. - [FluxReport API reference](https://fluxoperator.dev/docs/crd/fluxreport/)
  179. - [ResourceSet API reference](https://fluxoperator.dev/docs/crd/resourceset/)
  180. - [ResourceSetInputProvider API reference](https://fluxoperator.dev/docs/crd/resourcesetinputprovider/)
  181. ## Contributing
  182. We welcome contributions to the Flux Operator project via GitHub pull requests.
  183. Please see the [CONTRIBUTING](https://github.com/controlplaneio-fluxcd/flux-operator/blob/main/CONTRIBUTING.md)
  184. guide for details on how to set up your development environment and start contributing to the project.
  185. ## License
  186. The Flux Operator is an open-source project licensed under the
  187. [AGPL-3.0 license](https://github.com/controlplaneio-fluxcd/flux-operator/blob/main/LICENSE).
  188. The project is developed by CNCF Flux core maintainers part of the [ControlPlane](https://control-plane.io) team.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.