# openshift/installer architecture

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

- Interactive diagram: https://gitdiagram.com/openshift/installer
- Repository: https://github.com/openshift/installer

## Overview

OpenShift Installer is a CLI for creating and destroying OpenShift clusters across multiple infrastructure platforms. The documented workflow is to run `create cluster`, answer prompts or provide an install-config.yaml, wait for installation, then use the printed connection details; `destroy cluster` removes the cluster and associated resources. The tree identifies configuration, validation, infrastructure, cluster API, node-join, state, and diagnostic areas, but their call relationships are not shown in the sampled source. Dashed edges mark those unverified relationships.

Main entry points: [`cmd/openshift-install`](https://github.com/openshift/installer/tree/main/cmd/openshift-install) (Installer CLI), [`pkg/infrastructure`](https://github.com/openshift/installer/tree/main/pkg/infrastructure) (Infrastructure provisioning), [`pkg/types`](https://github.com/openshift/installer/tree/main/pkg/types) (Install configuration), [`pkg/validate`](https://github.com/openshift/installer/tree/main/pkg/validate) (Configuration validation)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and configuration"]
  node_cli["Installer CLI"]
  node_config["Install configuration"]
  node_validation["Configuration validation"]
  node_assets["Installation assets"]
end

subgraph group_provision["Cluster provisioning"]
  node_infra["Infrastructure provisioning"]
  node_capi["Cluster API"]
  node_nodejoin["Node joining"]
end

subgraph group_lifecycle["Lifecycle and operations"]
  node_state["Installer state"]
  node_destroy["Cluster destruction"]
  node_diagnostics["Diagnostics"]
  node_gather["Log gathering"]
  node_connect["Cluster access details"]
end

subgraph group_platforms["Infrastructure platforms"]
  node_platforms{{"Cloud and platform services"}}
end

node_user(("Installer user"))

node_user -->|"runs commands"| node_cli
node_user -->|"provides config"| node_config
node_cli -->|"prompts for"| node_config
node_cli -.->|"validates config"| node_validation
node_cli -.->|"creates assets"| node_assets
node_cli -->|"creates cluster"| node_infra
node_infra -.->|"provisions resources"| node_platforms
node_infra -.->|"uses controllers"| node_capi
node_infra -.->|"joins nodes"| node_nodejoin
node_cli -->|"uses install directory"| node_state
node_cli -->|"prints access details"| node_connect
node_cli -->|"destroys cluster"| node_destroy
node_cli -.->|"supports troubleshooting"| node_diagnostics
node_cli -.->|"gathers logs"| node_gather

click node_cli "https://github.com/openshift/installer/tree/main/cmd/openshift-install"
click node_config "https://github.com/openshift/installer/tree/main/pkg/types"
click node_validation "https://github.com/openshift/installer/tree/main/pkg/validate"
click node_assets "https://github.com/openshift/installer/tree/main/pkg/asset"
click node_infra "https://github.com/openshift/installer/tree/main/pkg/infrastructure"
click node_capi "https://github.com/openshift/installer/tree/main/pkg/clusterapi"
click node_nodejoin "https://github.com/openshift/installer/tree/main/pkg/nodejoiner"
click node_state "https://github.com/openshift/installer/tree/main/pkg/asset"
click node_destroy "https://github.com/openshift/installer/tree/main/pkg/destroy"
click node_diagnostics "https://github.com/openshift/installer/tree/main/pkg/diagnostics"
click node_gather "https://github.com/openshift/installer/tree/main/pkg/gather"
click node_connect "https://github.com/openshift/installer/tree/main/pkg/asset"

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_cli,node_config,node_validation,node_assets,node_user toneBlue
class node_infra,node_capi,node_nodejoin toneAmber
class node_state,node_destroy,node_diagnostics,node_gather,node_connect toneMint
class node_platforms toneRose
```

## Components

### CLI and configuration

- [Installer CLI](https://github.com/openshift/installer/tree/main/cmd/openshift-install): `cmd/openshift-install`
- [Install configuration](https://github.com/openshift/installer/tree/main/pkg/types): `pkg/types`
- [Configuration validation](https://github.com/openshift/installer/tree/main/pkg/validate): `pkg/validate`
- [Installation assets](https://github.com/openshift/installer/tree/main/pkg/asset): `pkg/asset`

### Cluster provisioning

- [Infrastructure provisioning](https://github.com/openshift/installer/tree/main/pkg/infrastructure): `pkg/infrastructure`
- [Cluster API](https://github.com/openshift/installer/tree/main/pkg/clusterapi): `pkg/clusterapi`
- [Node joining](https://github.com/openshift/installer/tree/main/pkg/nodejoiner): `pkg/nodejoiner`

### Lifecycle and operations

- [Installer state](https://github.com/openshift/installer/tree/main/pkg/asset): `pkg/asset`
- [Cluster destruction](https://github.com/openshift/installer/tree/main/pkg/destroy): `pkg/destroy`
- [Diagnostics](https://github.com/openshift/installer/tree/main/pkg/diagnostics): `pkg/diagnostics`
- [Log gathering](https://github.com/openshift/installer/tree/main/pkg/gather): `pkg/gather`
- [Cluster access details](https://github.com/openshift/installer/tree/main/pkg/asset): `pkg/asset`

### Infrastructure platforms

- **Cloud and platform services**

### Other components

- **Installer user**

## Connections

- Installer user → Installer CLI: runs commands (evidence: `README.md`)
- Installer user → Install configuration: provides config (evidence: `README.md`)
- Installer CLI → Install configuration: prompts for (evidence: `README.md`)
- Installer CLI → Configuration validation: validates config
- Installer CLI → Installation assets: creates assets
- Installer CLI → Infrastructure provisioning: creates cluster (evidence: `README.md`)
- Infrastructure provisioning → Cloud and platform services: provisions resources
- Infrastructure provisioning → Cluster API: uses controllers
- Infrastructure provisioning → Node joining: joins nodes
- Installer CLI → Installer state: uses install directory (evidence: `README.md`)
- Installer CLI → Cluster access details: prints access details (evidence: `README.md`)
- Installer CLI → Cluster destruction: destroys cluster (evidence: `README.md`)
- Installer CLI → Diagnostics: supports troubleshooting
- Installer CLI → Log gathering: gathers logs
