# openshift/cluster-authentication-operator architecture

> Architecture diagram of the GitHub repository openshift/cluster-authentication-operator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openshift/cluster-authentication-operator
- Repository: https://github.com/openshift/cluster-authentication-operator

## Overview

The cluster-authentication-operator reconciles OpenShift authentication configuration and maintains the OAuth server and OAuth API server operands. An administrator configures cluster authentication; the operator observes configuration, reconciles operand resources and supporting auth features, then evaluates health and reports status. The graph preserves documented capability areas and central controllers. Some controller wiring is supported by the starter's SOURCE INDEX references; unsampled implementation details and relationships are not inferred.

Main entry points: [`pkg/operator/starter.go`](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/starter.go) (Operator startup), [`pkg/controllers/readiness/wellknown_ready_controller.go`](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/readiness/wellknown_ready_controller.go) (Well-known readiness), [`pkg/operator/configobservation/configobservercontroller/config_observer_controller.go`](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/configobservation/configobservercontroller/config_observer_controller.go) (Config observation), [`pkg/controllers/deployment/deployment_controller.go`](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/deployment/deployment_controller.go) (OAuth server workload)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_control["Operator control"]
  node_starter["Operator startup<br/>[starter.go]"]
  node_observation["Config observation"]
  node_payload["Payload configuration"]
end

subgraph group_oauth["OAuth operand"]
  node_oauthserver["OAuth server workload"]
  node_oauthapi["OAuth API workload"]
  node_customroute["Custom route"]
  node_ingress["Ingress state"]
  node_proxy["Proxy configuration"]
  node_routercerts["Router certificates<br/>[controller.go]"]
end

subgraph group_auth["Authentication features"]
  node_externaloidc["External OIDC"]
  node_webhook["Webhook authenticator"]
  node_oauthclients["OAuth clients"]
  node_legacyapi["Legacy OAuth APIs"]
end

subgraph group_health["Health and status"]
  node_endpoints["OAuth endpoints"]
  node_readiness["Well-known readiness"]
  node_metadata["Operator metadata"]
end

node_admin(("Cluster administrator"))

node_admin -->|"configures cluster"| node_starter
node_starter -->|"starts"| node_observation
node_starter -->|"starts"| node_payload
node_starter -->|"starts"| node_oauthserver
node_starter -->|"starts"| node_oauthapi
node_starter -->|"starts"| node_customroute
node_starter -->|"starts"| node_ingress
node_starter -->|"starts"| node_proxy
node_starter -->|"starts"| node_routercerts
node_starter -->|"starts"| node_externaloidc
node_starter -->|"starts"| node_webhook
node_starter -->|"starts"| node_oauthclients
node_starter -->|"initializes"| node_legacyapi
node_starter -->|"starts"| node_endpoints
node_starter -->|"starts"| node_readiness
node_starter -->|"starts"| node_metadata
node_observation -->|"observes configuration"| node_payload
node_oauthserver -.->|"serves login"| node_admin
node_oauthapi -.->|"serves OAuth API"| node_admin
node_customroute -->|"updates status"| node_ingress
node_endpoints -.->|"checks service health"| node_readiness
node_readiness -.->|"reports readiness"| node_metadata

click node_starter "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/starter.go"
click node_observation "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/configobservation/configobservercontroller/config_observer_controller.go"
click node_payload "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/payload/payload_config_controller.go"
click node_oauthserver "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/deployment/deployment_controller.go"
click node_oauthapi "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/workload/sync_openshift_oauth_apiserver.go"
click node_customroute "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/customroute/custom_route_controller.go"
click node_ingress "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/ingressstate/ingress_state_controller.go"
click node_proxy "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/proxyconfig/proxyconfig_controller.go"
click node_routercerts "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/routercerts/controller.go"
click node_externaloidc "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/externaloidc/externaloidc_controller.go"
click node_webhook "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/webhookauthenticator/webhookauthenticator_controller.go"
click node_oauthclients "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/oauthclientscontroller/oauthclientscontroller.go"
click node_legacyapi "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/legacy_oauth_apis.go"
click node_endpoints "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/oauthendpoints/oauth_endpoints_controller.go"
click node_readiness "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/readiness/wellknown_ready_controller.go"
click node_metadata "https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/metadata/metadata_controller.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_starter,node_observation,node_payload toneBlue
class node_oauthserver,node_oauthapi,node_customroute,node_ingress,node_proxy,node_routercerts toneAmber
class node_externaloidc,node_webhook,node_oauthclients,node_legacyapi toneMint
class node_endpoints,node_readiness,node_metadata toneRose
class node_admin toneIndigo
```

## Components

### Operator control

- [Operator startup](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/starter.go): `pkg/operator/starter.go`
- [Config observation](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/configobservation/configobservercontroller/config_observer_controller.go): `pkg/operator/configobservation/configobservercontroller/config_observer_controller.go`
- [Payload configuration](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/payload/payload_config_controller.go): `pkg/controllers/payload/payload_config_controller.go`

### OAuth operand

- [OAuth server workload](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/deployment/deployment_controller.go): `pkg/controllers/deployment/deployment_controller.go`
- [OAuth API workload](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/workload/sync_openshift_oauth_apiserver.go): `pkg/operator/workload/sync_openshift_oauth_apiserver.go`
- [Custom route](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/customroute/custom_route_controller.go): `pkg/controllers/customroute/custom_route_controller.go`
- [Ingress state](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/ingressstate/ingress_state_controller.go): `pkg/controllers/ingressstate/ingress_state_controller.go`
- [Proxy configuration](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/proxyconfig/proxyconfig_controller.go): `pkg/controllers/proxyconfig/proxyconfig_controller.go`
- [Router certificates](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/routercerts/controller.go): `pkg/controllers/routercerts/controller.go`

### Authentication features

- [External OIDC](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/externaloidc/externaloidc_controller.go): `pkg/controllers/externaloidc/externaloidc_controller.go`
- [Webhook authenticator](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/webhookauthenticator/webhookauthenticator_controller.go): `pkg/controllers/webhookauthenticator/webhookauthenticator_controller.go`
- [OAuth clients](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/oauthclientscontroller/oauthclientscontroller.go): `pkg/controllers/oauthclientscontroller/oauthclientscontroller.go`
- [Legacy OAuth APIs](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/operator/legacy_oauth_apis.go): `pkg/operator/legacy_oauth_apis.go`

### Health and status

- [OAuth endpoints](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/oauthendpoints/oauth_endpoints_controller.go): `pkg/controllers/oauthendpoints/oauth_endpoints_controller.go`
- [Well-known readiness](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/readiness/wellknown_ready_controller.go): `pkg/controllers/readiness/wellknown_ready_controller.go`
- [Operator metadata](https://github.com/openshift/cluster-authentication-operator/blob/master/pkg/controllers/metadata/metadata_controller.go): `pkg/controllers/metadata/metadata_controller.go`

### Other components

- **Cluster administrator**

## Connections

- Cluster administrator → Operator startup: configures cluster
- Operator startup → Config observation: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Payload configuration: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → OAuth server workload: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → OAuth API workload: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Custom route: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Ingress state: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Proxy configuration: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Router certificates: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → External OIDC: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Webhook authenticator: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → OAuth clients: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Legacy OAuth APIs: initializes (evidence: `pkg/operator/starter.go`)
- Operator startup → OAuth endpoints: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Well-known readiness: starts (evidence: `pkg/operator/starter.go`)
- Operator startup → Operator metadata: starts (evidence: `pkg/operator/starter.go`)
- Config observation → Payload configuration: observes configuration (evidence: `pkg/controllers/payload/payload_config_controller.go`)
- OAuth server workload → Cluster administrator: serves login
- OAuth API workload → Cluster administrator: serves OAuth API
- Custom route → Ingress state: updates status (evidence: `pkg/controllers/customroute/custom_route_controller.go`)
- OAuth endpoints → Well-known readiness: checks service health
- Well-known readiness → Operator metadata: reports readiness
