# ciscolearning/cml-docker-containers architecture

> Architecture diagram of the GitHub repository ciscolearning/cml-docker-containers, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ciscolearning/cml-docker-containers
- Repository: https://github.com/ciscolearning/cml-docker-containers

## Overview

This repository automates building CML container images and their node/image definitions, then packages those artifacts as Debian packages or split ISO images. The documented flow starts with a developer invoking Make; container directories are discovered and can be opted out, then build recipes produce images and definitions for CML’s expected layout. ISO staging and packaging are additional output paths. Relationships are based on the README only; source excerpts were not provided, so implementation details beyond those documented are omitted.

Main entry points: [`scripts/build-split-isos.sh`](https://github.com/ciscolearning/cml-docker-containers/blob/main/scripts/build-split-isos.sh) (ISO builder), [`templates/definitions.mk`](https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/definitions.mk) (Definition generation), [`containers`](https://github.com/ciscolearning/cml-docker-containers/tree/main/containers) (Container specs), [`Makefile`](https://github.com/ciscolearning/cml-docker-containers/blob/main/Makefile) (Build entry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_discovery["Discovery and inputs"]
  node_make["Build entry"]
  node_container_specs["Container specs"]
  node_selection["Build selection"]
end

subgraph group_build["Image and definitions"]
  node_build_recipes["Build recipes<br/>[build.mk]"]
  node_image_build["Image preparation<br/>[build.mk]"]
  node_definitions["Definition generation<br/>[definitions.mk]"]
  node_definition_template["Definition template"]
end

subgraph group_outputs["Artifacts and packaging"]
  node_image_tarballs["Image tarballs"]
  node_cml_definitions["CML definitions"]
  node_package_config["Package configuration<br/>[pkg.mk]"]
  node_debian_package["Debian package"]
end

subgraph group_iso["ISO outputs"]
  node_iso_grouping["ISO grouping"]
  node_iso_builder["ISO builder"]
  node_iso_images["ISO images"]
end

node_developer(("Developer"))

node_developer -->|"invokes"| node_make
node_make -->|"discovers"| node_container_specs
node_make -->|"honors opt-outs"| node_selection
node_container_specs -->|"provides specs"| node_selection
node_selection -->|"builds selected"| node_build_recipes
node_build_recipes -->|"prepares images"| node_image_build
node_image_build -->|"exports tarballs"| node_image_tarballs
node_build_recipes -->|"generates definitions"| node_definitions
node_definitions -->|"uses template"| node_definition_template
node_definitions -->|"uses node definition"| node_container_specs
node_definitions -->|"writes YAML"| node_cml_definitions
node_package_config -->|"configures package"| node_debian_package
node_image_tarballs -.->|"packages artifacts"| node_debian_package
node_cml_definitions -.->|"packages artifacts"| node_debian_package
node_developer -->|"invokes ISO build"| node_iso_builder
node_container_specs -->|"supplies suffix"| node_iso_grouping
node_iso_grouping -->|"groups modules"| node_iso_builder
node_iso_builder -->|"stages artifacts"| node_image_tarballs
node_iso_builder -->|"stages artifacts"| node_cml_definitions
node_iso_builder -->|"creates ISOs"| node_iso_images

click node_make "https://github.com/ciscolearning/cml-docker-containers/blob/main/Makefile"
click node_container_specs "https://github.com/ciscolearning/cml-docker-containers/tree/main/containers"
click node_selection "https://github.com/ciscolearning/cml-docker-containers/tree/main/containers"
click node_build_recipes "https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/build.mk"
click node_image_build "https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/build.mk"
click node_definitions "https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/definitions.mk"
click node_definition_template "https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/image-definition.tmpl"
click node_image_tarballs "https://github.com/ciscolearning/cml-docker-containers/tree/main/BUILD"
click node_cml_definitions "https://github.com/ciscolearning/cml-docker-containers/tree/main/BUILD"
click node_package_config "https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/pkg.mk"
click node_debian_package "https://github.com/ciscolearning/cml-docker-containers/tree/main/BUILD/debian"
click node_iso_grouping "https://github.com/ciscolearning/cml-docker-containers/tree/main/containers"
click node_iso_builder "https://github.com/ciscolearning/cml-docker-containers/blob/main/scripts/build-split-isos.sh"

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_make,node_container_specs,node_selection toneBlue
class node_build_recipes,node_image_build,node_definitions,node_definition_template toneAmber
class node_image_tarballs,node_cml_definitions,node_package_config,node_debian_package toneMint
class node_iso_grouping,node_iso_builder,node_iso_images toneRose
class node_developer toneIndigo
```

## Components

### Discovery and inputs

- [Build entry](https://github.com/ciscolearning/cml-docker-containers/blob/main/Makefile): `Makefile`
- [Container specs](https://github.com/ciscolearning/cml-docker-containers/tree/main/containers): `containers`
- [Build selection](https://github.com/ciscolearning/cml-docker-containers/tree/main/containers): `containers`

### Image and definitions

- [Build recipes](https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/build.mk): `templates/build.mk`
- [Image preparation](https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/build.mk): `templates/build.mk`
- [Definition generation](https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/definitions.mk): `templates/definitions.mk`
- [Definition template](https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/image-definition.tmpl): `templates/image-definition.tmpl`

### Artifacts and packaging

- [Image tarballs](https://github.com/ciscolearning/cml-docker-containers/tree/main/BUILD): `BUILD`
- [CML definitions](https://github.com/ciscolearning/cml-docker-containers/tree/main/BUILD): `BUILD`
- [Package configuration](https://github.com/ciscolearning/cml-docker-containers/blob/main/templates/pkg.mk): `templates/pkg.mk`
- [Debian package](https://github.com/ciscolearning/cml-docker-containers/tree/main/BUILD/debian): `BUILD/debian`

### ISO outputs

- [ISO grouping](https://github.com/ciscolearning/cml-docker-containers/tree/main/containers): `containers`
- [ISO builder](https://github.com/ciscolearning/cml-docker-containers/blob/main/scripts/build-split-isos.sh): `scripts/build-split-isos.sh`
- **ISO images**

### Other components

- **Developer**

## Connections

- Developer → Build entry: invokes (evidence: `README.md`)
- Build entry → Container specs: discovers (evidence: `README.md`)
- Build entry → Build selection: honors opt-outs (evidence: `README.md`)
- Container specs → Build selection: provides specs (evidence: `README.md`)
- Build selection → Build recipes: builds selected (evidence: `README.md`)
- Build recipes → Image preparation: prepares images (evidence: `README.md`)
- Image preparation → Image tarballs: exports tarballs (evidence: `README.md`)
- Build recipes → Definition generation: generates definitions (evidence: `README.md`)
- Definition generation → Definition template: uses template (evidence: `README.md`)
- Definition generation → Container specs: uses node definition (evidence: `README.md`)
- Definition generation → CML definitions: writes YAML (evidence: `README.md`)
- Package configuration → Debian package: configures package (evidence: `README.md`)
- Image tarballs → Debian package: packages artifacts
- CML definitions → Debian package: packages artifacts
- Developer → ISO builder: invokes ISO build (evidence: `README.md`)
- Container specs → ISO grouping: supplies suffix (evidence: `README.md`)
- ISO grouping → ISO builder: groups modules (evidence: `README.md`)
- ISO builder → Image tarballs: stages artifacts (evidence: `README.md`)
- ISO builder → CML definitions: stages artifacts (evidence: `README.md`)
- ISO builder → ISO images: creates ISOs (evidence: `README.md`)
