# project-koku/cost-management-metrics-operator-fbc architecture

> Architecture diagram of the GitHub repository project-koku/cost-management-metrics-operator-fbc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/project-koku/cost-management-metrics-operator-fbc
- Repository: https://github.com/project-koku/cost-management-metrics-operator-fbc

## Overview

This repository maintains File-Based Catalog (FBC) metadata for the Cost Management Metrics Operator and provides tooling to prepare a catalog image on an OpenShift cluster. The principal workflow updates the catalog template with a new operator bundle version and digest, generates version-appropriate catalog metadata, then gathers built catalog images for QE. Separately, `configure_cluster.py` configures a cluster for testing by disabling default catalogs and creating image mirror and catalog source resources. README documents these workflows; source-level evidence is limited to the cluster configuration script.

Main entry points: [`configure_cluster.py`](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/configure_cluster.py) (Cluster configurator), [`catalog-template/basic-template.yaml`](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog-template/basic-template.yaml) (Basic template), [`catalog/costmanagement-metrics-operator/catalog.yaml`](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog/costmanagement-metrics-operator/catalog.yaml) (OCP 4.17+ catalog), [`catalog-old/costmanagement-metrics-operator/catalog.yaml`](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog-old/costmanagement-metrics-operator/catalog.yaml) (OCP 4.16− catalog)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_catalogs["Catalog metadata"]
  node_template["Basic template"]
  node_modern["OCP 4.17+ catalog<br/>[catalog.yaml]"]
  node_legacy["OCP 4.16− catalog<br/>[catalog.yaml]"]
end

subgraph group_qe["QE image handoff"]
  node_konflux["Konflux releases"]
  node_snapshots[("Build snapshots")]
  node_catalogimage["Catalog images"]
  node_qe(("QE"))
end

subgraph group_cluster["Cluster setup"]
  node_clusteruser(("Cluster tester"))
  node_configure["Cluster configurator"]
  node_operatorhub[("OperatorHub settings")]
  node_mirrors[("Image mirror set")]
  node_catalogsource[("CatalogSource")]
end

node_maintainer(("Catalog maintainer"))
node_bundle[("Operator bundle")]
node_openshift["OpenShift API"]

node_maintainer -->|"updates"| node_template
node_bundle -->|"digest supplied"| node_template
node_template -->|"generates for 4.17+"| node_modern
node_template -->|"generates for 4.16−"| node_legacy
node_konflux -->|"publishes"| node_snapshots
node_snapshots -->|"provides images"| node_catalogimage
node_catalogimage -->|"hands off"| node_qe
node_clusteruser -->|"runs"| node_configure
node_configure -->|"uses API"| node_openshift
node_configure -->|"disables defaults"| node_operatorhub
node_configure -->|"creates"| node_mirrors
node_configure -->|"creates"| node_catalogsource

click node_template "https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog-template/basic-template.yaml"
click node_modern "https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog/costmanagement-metrics-operator/catalog.yaml"
click node_legacy "https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog-old/costmanagement-metrics-operator/catalog.yaml"
click node_configure "https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/configure_cluster.py"

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_template,node_modern,node_legacy toneBlue
class node_konflux,node_snapshots,node_catalogimage,node_qe,node_bundle toneAmber
class node_clusteruser,node_configure,node_operatorhub,node_mirrors,node_catalogsource,node_openshift toneMint
class node_maintainer toneIndigo
```

## Components

### Catalog metadata

- [Basic template](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog-template/basic-template.yaml): `catalog-template/basic-template.yaml`
- [OCP 4.17+ catalog](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog/costmanagement-metrics-operator/catalog.yaml): `catalog/costmanagement-metrics-operator/catalog.yaml`
- [OCP 4.16− catalog](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/catalog-old/costmanagement-metrics-operator/catalog.yaml): `catalog-old/costmanagement-metrics-operator/catalog.yaml`

### QE image handoff

- **Konflux releases**
- **Build snapshots**
- **Catalog images**
- **QE**

### Cluster setup

- **Cluster tester**
- [Cluster configurator](https://github.com/project-koku/cost-management-metrics-operator-fbc/blob/main/configure_cluster.py): `configure_cluster.py`
- **OperatorHub settings**
- **Image mirror set**
- **CatalogSource**

### Other components

- **Catalog maintainer**
- **Operator bundle**
- **OpenShift API**

## Connections

- Catalog maintainer → Basic template: updates (evidence: `README.md`)
- Operator bundle → Basic template: digest supplied (evidence: `README.md`)
- Basic template → OCP 4.17+ catalog: generates for 4.17+ (evidence: `README.md`)
- Basic template → OCP 4.16− catalog: generates for 4.16− (evidence: `README.md`)
- Konflux releases → Build snapshots: publishes (evidence: `README.md`)
- Build snapshots → Catalog images: provides images (evidence: `README.md`)
- Catalog images → QE: hands off (evidence: `README.md`)
- Cluster tester → Cluster configurator: runs (evidence: `README.md`)
- Cluster configurator → OpenShift API: uses API (evidence: `configure_cluster.py`)
- Cluster configurator → OperatorHub settings: disables defaults (evidence: `configure_cluster.py`)
- Cluster configurator → Image mirror set: creates (evidence: `configure_cluster.py`)
- Cluster configurator → CatalogSource: creates (evidence: `configure_cluster.py`)
