# Flux Operator

Flux Operator offers a production-ready solution for managing the delivery of application and infrastructure workloads on multi-tenant Kubernetes clusters using GitOps principles.
The operator is designed to automate the installation, configuration, and upgrade of the Flux controllers as well as to provide advanced features such as preview environments for testing pull requests, deployment windows, and self-service capabilities for developers.
The operator comes with a built-in Web UI called Flux Status Page for real-time monitoring of the GitOps pipelines and cluster state.
The Flux Operator is an open-source project licensed under AGPL-3.0 and is developed by the CNCF Flux core maintainers part of the ControlPlane.io team.

## Flux Operator Documentation

- Installation
    - [Flux operator installation](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/install.md)
    - [Migration of bootstrapped clusters](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/flux-bootstrap-migration.md)
- Flux Instance Configuration
    - [Flux controllers configuration](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/flux-config.md)
    - [Flux instance customization](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/flux-kustomize.md)
    - [Cluster sync configuration](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/flux-sync.md)
    - [Flux controllers sharding](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/flux-sharding.md)
    - [Flux monitoring and reporting](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/monitoring.md)
- Application Definitions and Self-Service Environments
    - [Using ResourceSets for Application Definitions](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/resourcesets/app-definition.md)
    - [Using ResourceSets for Time-Based Delivery and Deployment Windows](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/resourcesets/time-based-delivery.md)
    - [Using ResourceSets for Image Update Automation](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/resourcesets/image-automation.md)
    - [Ephemeral Environments for GitHub Pull Requests](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/resourcesets/github-pull-requests.md)
    - [Ephemeral Environments for GitLab Merge Requests](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/resourcesets/gitlab-merge-requests.md)
- API References
    - [FluxInstance CRD](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/fluxinstance.md)
    - [FluxReport CRD](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/fluxreport.md)
    - [ResourceSet CRD](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/resourceset.md)
    - [ResourceSetInputProvider CRD](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/operator/resourcesetinputprovider.md)

## Flux Web UI

The Flux Web UI (also known as Flux Status Page) provides a real-time dashboard for monitoring GitOps pipelines and cluster state.
It offers visibility into Flux resources, their reconciliation status, and events, helping teams quickly identify and troubleshoot deployment issues.
The Web UI supports Single Sign-On (SSO) with various identity providers and role-based access control for secure multi-user access.
The Flux Web UI is a subproject of the Flux Operator licensed under AGPL-3.0.

### Flux Web UI Documentation

- [Standalone installation](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-standalone.md)
- [Ingress configuration](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-ingress.md)
- [User management](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-user-management.md)
- [SSO with Dex](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-sso-dex.md)
- [SSO with Keycloak](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-sso-keycloak.md)
- [SSO with OpenShift](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-sso-openshift.md)
- [SSO with Microsoft Entra](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-sso-microsoft.md)
- [Config API reference](https://raw.githubusercontent.com/controlplaneio-fluxcd/flux-operator/refs/heads/main/docs/web/web-config-api.md)

## Flux MCP Server

The Flux Model Context Protocol (MCP) Server connects AI assistants directly to your Kubernetes clusters running Flux Operator, enabling seamless interaction through natural language.
It serves as a bridge between AI tools and your GitOps pipelines, allowing you to analyze the cluster state, troubleshoot deployment issues, and perform operations using conversational prompts.
The MCP Server is a subproject of the Flux Operator licensed under AGPL-3.0.

### Flux MCP Server Documentation

- [Flux MCP Server Installation](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/mcp/install.md)
- [Flux MCP Server Prompting Guide](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/mcp/prompt-engineering.md)
- [Flux MCP Server Tools](https://raw.githubusercontent.com/controlplaneio-fluxcd/distribution/refs/heads/main/docs/mcp/tools.md)

## CNCF Flux CD

Flux is a leading GitOps Continuous Delivery tool used to streamline and automate application deployments on Kubernetes.
Flux enables teams to achieve a reliable and auditable delivery process while promoting collaboration and traceability across different environments.
Flux is powered by the GitOps Toolkit, a set of composable APIs and specialized tools that enable a wide range of continuous delivery use-cases, from simple Kubernetes deployment pipelines to multi-tenant and multi-cluster progressive delivery rollouts.
Flux is a Cloud Native Computing Foundation (CNCF) graduated project, licensed under the Apache License 2.0.

### Flux API Documentation

- [GitRepository CRD](https://raw.githubusercontent.com/fluxcd/source-controller/refs/heads/main/docs/spec/v1/gitrepositories.md)
- [OCIRepository CRD](https://raw.githubusercontent.com/fluxcd/source-controller/refs/heads/main/docs/spec/v1/ocirepositories.md)
- [Bucket CRD](https://raw.githubusercontent.com/fluxcd/source-controller/refs/heads/main/docs/spec/v1/buckets.md)
- [Kustomization CRD](https://raw.githubusercontent.com/fluxcd/kustomize-controller/refs/heads/main/docs/spec/v1/kustomizations.md)
- [HelmRelease CRD](https://raw.githubusercontent.com/fluxcd/helm-controller/refs/heads/main/docs/spec/v2/helmreleases.md)
- [Webhook Receiver CRD](https://raw.githubusercontent.com/fluxcd/notification-controller/refs/heads/main/docs/spec/v1/receivers.md)
- [Alert Provider CRD](https://raw.githubusercontent.com/fluxcd/notification-controller/refs/heads/main/docs/spec/v1beta3/providers.md)
- [Alert CRD](https://raw.githubusercontent.com/fluxcd/notification-controller/refs/heads/main/docs/spec/v1beta3/alerts.md)
- [ImageRepository CRD](https://raw.githubusercontent.com/fluxcd/image-reflector-controller/refs/heads/main/docs/spec/v1/imagerpositories.md)
- [ImagePolicy CRD](https://raw.githubusercontent.com/fluxcd/image-reflector-controller/refs/heads/main/docs/spec/v1/imagepolicies.md)
- [ImageUpdateAutomation CRD](https://raw.githubusercontent.com/fluxcd/image-automation-controller/refs/heads/main/docs/spec/v1/imageupdateautomations.md)
- [ArtifactGenerator CRD](https://raw.githubusercontent.com/fluxcd/source-watcher/refs/heads/main/docs/spec/v1beta1/artifactgenerators.md)