# Konflux Operator

> The Konflux Operator is a Kubernetes-native operator that installs, configures, and manages the Konflux CI/CD platform from a single declarative Custom Resource. It deploys and wires together build controllers, release pipelines, policy engines, identity providers, ingress, and more. It works on any Kubernetes cluster: local Kind environments, OpenShift, EKS, GKE, or any conformant distribution.

- Source code: https://github.com/konflux-ci/konflux-ci
- Konflux project docs: https://konflux-ci.dev/docs/
- Operator docs site: https://konflux-ci.dev/konflux-ci/docs/

## Docs

- [Overview](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/overview.md): What the Konflux Operator is, how it works, and what it manages.
- [Troubleshooting](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/troubleshooting.md): Solutions to common issues encountered when installing and running Konflux locally.

## Installation

- [Local Deployment (Kind)](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/installation/install-local.md): Deploying Konflux locally on macOS or Linux using Kind.
- [Installing on OpenShift](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/installation/install-openshift.md): Deploying Konflux on an existing OpenShift cluster using the automated deployment script.
- [Building and Installing from Source](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/installation/install-from-source.md): Building and running the Konflux Operator from source for development or custom deployments.
- [Installing from Release](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/installation/install-release.md): Step-by-step guide for installing Konflux from a pre-built release bundle.
- [Installing from OLM](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/installation/install-olm.md): Installing the Konflux Operator through the Operator Lifecycle Manager (OLM).

## Guides

- [Applying the Konflux Custom Resource](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/apply-konflux-cr.md): How to create a Konflux Custom Resource and verify the installation is ready.
- [GitHub Application Secrets](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/github-secrets.md): Creating a GitHub App and deploying its credentials as secrets in the cluster.
- [Registry Configuration](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/registry-configuration.md): Configuring container registries for build and release pipelines.
- [Authentication and OIDC Configuration](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/oidc-configuration.md): Configuring login providers for Konflux using Dex connectors - GitHub, OpenShift, OIDC, LDAP, and static passwords.
- [Tenant and Managed Namespace Management](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/namespace-management.md): How to create and configure tenant namespaces and managed namespaces in Konflux.
- [Resource Management](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/resource-management.md): Tuning CPU and memory for Konflux core services and Tekton workloads in resource-constrained environments.
- [Conforma Policy Configuration](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/conforma-policy-configuration.md): How to use and customize Conforma policies for integration tests and release.
- [Custom URL without Operator-Managed Ingress](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/custom-url.md): How to configure a custom URL for Konflux UI when managing your own ingress or external routing.
- [Webhook URL Configuration](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/webhook-url-configuration.md): How to configure custom webhook URLs for git providers when using Smee proxies or self-hosted instances.
- [CLI Tools](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/cli-tools.md): How to download and use the CLI scripts shipped with the operator for tenant and release setup.
- [LLM-Friendly Documentation (llms.txt)](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/guides/llms-txt.md): How to use the Konflux Operator llms.txt file with MCP servers so AI coding assistants can access the documentation.

## Onboarding Tutorial

- [Onboard a new Application](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/onboard/onboarding.md): Onboard a sample application to Konflux using the UI or Kubernetes manifests, observe a build, and pull the resulting image.
- [Integration Tests](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/onboard/integration.md): Configure and run integration tests for your application after each build pipeline completes.
- [Configure Releases](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/onboard/release.md): Configure ReleasePlan and ReleasePlanAdmission resources to release your application to a container registry.

## API Reference

- [Konflux v1alpha1 API](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/reference/konflux.v1alpha1.md): Generated API reference documentation for Konflux Operator.

## Optional

- [Examples](https://raw.githubusercontent.com/konflux-ci/konflux-ci/main/operator/docs/content/docs/examples.md): Example configurations for Konflux Operator Custom Resources