# ibmstorage/qe-ceph-manifest architecture

> Architecture diagram of the GitHub repository ibmstorage/qe-ceph-manifest, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ibmstorage/qe-ceph-manifest
- Repository: https://github.com/ibmstorage/qe-ceph-manifest

## Overview

##### Project type and purpose
- This is an open-source manifest repository (‘qe-ceph-manifest’) that holds YAML definitions of Ceph component versions, RPM repos, and container images.
- It is consumed by IBM Storage Ceph QE and CI systems (via the `cephci` tool) to deploy test environments matching specific product, release, build-type, and platform parameters.

##### File structure
- Top-level files:
- LICENSE, README.md
- Top-level directories by product:
- ceph/…
- ibm/…
- redhat/…
- Each directory contains multiple `<version>.yaml` files.
- No code, just structured data used at runtime by an external tool.

##### README for additional insights
- Describes the YAML schema: top-level keys (`nightly`, `stable`, `released`, `zN`) mapping to cephci `--build-type`.
- Documents second-level keys (`version`, `repositories`, `images`, optional `repo_ids`).
- Explains how `cephci` selects the correct manifest: flags `--product`, `--release`, `--build-type`, `--platform`.

##### Components & interactions
a. Main components
- Manifest Git Repository (this project)
- CI Orchestrator (e.g., Jenkins or IBM QE CI)
- cephci client tool
- RPM Repositories (external)
- Container Registry (external)
- Test Environment (KVM or bare-metal cluster)
b. Relationships & data flow
1. CI Orchestrator triggers a job for a test scenario.
2. The job invokes `cephci` with flags (`--product`, `--release`, etc.).
3. cephci clones or pulls the Manifest Repo.
4. cephci parses the selected `<product>/<release>.yaml` manifest.
5. cephci uses `repositories` entries to configure yum/baseurl on test nodes.
6. cephci pulls container images from the `images` registry namespace.
7. cephci orchestrates deployment of Ceph cluster in the Test Environment.
c. Architectural patterns/design principles
- Separation of configuration (YAML manifests) from execution logic (cephci).
- Declarative configuration for easy version-targeted deployments.
- Plugin-like extensibility: add a new product or release by dropping a YAML.
d. Relevant technologies
- Git (source control for manifests)
- YAML (manifest format)
- Python (cephci implementation)
- Jenkins or IBM QE CI (pipeline orchestrator)
- RPM repos (yum) and Docker/Podman registries

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Subgraph for Manifest Repository
    subgraph "Manifest Repository (Git)" 
        direction TB
        RepoRoot["/"]:::dataStore
        Readme["README.md"]:::dataStore
        License["LICENSE"]:::dataStore
        subgraph "Ceph Manifests"
            direction TB
            CephMain["main.yaml"]:::dataStore
            CephSquid["squid.yaml"]:::dataStore
            CephTentacle["tentacle.yaml"]:::dataStore
        end
        subgraph "IBM Manifests"
            direction TB
            IBM53["5.3.yaml"]:::dataStore
            IBM61["6.1.yaml"]:::dataStore
            IBM71["7.1.yaml"]:::dataStore
            IBM80["8.0.yaml"]:::dataStore
            IBM81["8.1.yaml"]:::dataStore
        end
        subgraph "RedHat Manifests"
            direction TB
            RH61["6.1.yaml"]:::dataStore
            RH70["7.0.yaml"]:::dataStore
            RH71["7.1.yaml"]:::dataStore
            RH80["8.0.yaml"]:::dataStore
            RH81["8.1.yaml"]:::dataStore
        end
    end

    %% CI Orchestrator
    subgraph "CI Orchestrator" 
        direction TB
        BuildJob["Build Job"]:::compute
        TestJob["Test Job"]:::compute
        ResultsCollector["Results Collector"]:::compute
    end

    %% cephci client
    CephCI["cephci Client Tool"]:::compute

    %% External Repositories
    RPMRepo["RPM Repositories"]:::dataStore
    ContainerReg["Container Registry"]:::dataStore

    %% Test Environment
    subgraph "Test Environment" 
        direction TB
        Monitors["Monitors"]:::infra
        OSDs["OSDs"]:::infra
        Clients["Clients"]:::infra
    end

    %% Connections
    BuildJob -->|"triggers"| TestJob
    TestJob -->|"invokes"| CephCI
    CephCI -->|"git clone"| RepoRoot
    CephCI -->|"parse YAML"| CephMain
    CephCI -->|"configures yum"| RPMRepo
    CephCI -->|"docker pull"| ContainerReg
    CephCI -->|"deploy via SSH/Ansible"| TestEnvironment
    TestEnvironment --> Monitors
    TestEnvironment --> OSDs
    TestEnvironment --> Clients
    TestJob -->|"collects results"| ResultsCollector

    %% Click Events
    click RepoRoot "https://github.com/ibmstorage/qe-ceph-manifest/tree/main//"
    click Readme "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//README.md"
    click License "https://github.com/ibmstorage/qe-ceph-manifest/tree/main//LICENSE"
    click CephMain "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ceph/main.yaml"
    click CephSquid "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ceph/squid.yaml"
    click CephTentacle "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ceph/tentacle.yaml"
    click IBM53 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ibm/5.3.yaml"
    click IBM61 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ibm/6.1.yaml"
    click IBM71 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ibm/7.1.yaml"
    click IBM80 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ibm/8.0.yaml"
    click IBM81 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//ibm/8.1.yaml"
    click RH61 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//redhat/6.1.yaml"
    click RH70 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//redhat/7.0.yaml"
    click RH71 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//redhat/7.1.yaml"
    click RH80 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//redhat/8.0.yaml"
    click RH81 "https://github.com/ibmstorage/qe-ceph-manifest/blob/main//redhat/8.1.yaml"

    %% Styles
    classDef dataStore fill:#B3E5FC,stroke:#0288D1,color:#000
    classDef compute fill:#C8E6C9,stroke:#2E7D32,color:#000
    classDef infra fill:#FFF9C4,stroke:#F9A825,color:#000
```
