# flatcar/scripts architecture

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

- Interactive diagram: https://gitdiagram.com/flatcar/scripts
- Repository: https://github.com/flatcar/scripts

## Overview

Flatcar’s scripts repository is the entry point for developing and building Flatcar Container Linux: engineers modify packages and kernel content, use the SDK, and produce images for cloud, VM, and bare-metal targets. The README documents the build entry point and package-overlay locations; sampled files show several supporting utilities and Azure Marketplace publishing. Most build-script implementations were not sampled, so their internal call relationships are not asserted.

Main entry points: [`ci-automation/release/azure_marketplace_publish.py`](https://github.com/flatcar/scripts/blob/main/ci-automation/release/azure_marketplace_publish.py) (Azure image publisher), [`build_image`](https://github.com/flatcar/scripts/blob/main/build_image) (Image build entry), [`sdk_container/src`](https://github.com/flatcar/scripts/tree/main/sdk_container/src) (SDK scripts), [`sdk_container/src/third_party`](https://github.com/flatcar/scripts/tree/main/sdk_container/src/third_party) (Package overlays)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_sdk["SDK and packages"]
  node_sdk_scripts["SDK scripts"]
  node_package_overlays["Package overlays"]
  node_package_list_sorter["Package list sorter"]
  node_package_build["Package builds"]
  node_toolchain_build["Toolchain builds"]
  node_kernel_config["Kernel configuration"]
  node_sysext_build["System extensions"]
end

subgraph group_build["OS build"]
  node_image_entry["Image build entry"]
  node_image_utilities["Image utilities"]
  node_tmpfiles_generator["Tempfiles generator<br/>[gen_tmpfiles.py]"]
  node_au_zip_generator["Update zip generator<br/>[generate_au_zip.py]"]
  node_image_hashes["Boot integrity hashes"]
  node_kernel_hash["Kernel hash"]
end

subgraph group_artifacts["Image artifacts"]
  node_platform_images["Platform images"]
end

subgraph group_release["Release publishing"]
  node_azure_publish["Azure image publisher"]
end

node_engineer(("Flatcar engineer"))
node_azure_storage[("Azure Blob Storage")]
node_partner_api["Microsoft Partner API"]
node_channel_info["Channel metadata"]

node_engineer -->|"uses SDK"| node_sdk_scripts
node_engineer -->|"builds images"| node_image_entry
node_sdk_scripts -->|"works with"| node_package_overlays
node_engineer -->|"modifies packages"| node_package_overlays
node_engineer -->|"modifies kernel"| node_kernel_config
node_image_entry -.->|"uses utilities"| node_image_utilities
node_image_entry -.->|"builds targets"| node_platform_images
node_azure_publish -->|"reads metadata"| node_channel_info
node_azure_publish -->|"creates SAS URLs"| node_azure_storage
node_azure_publish -->|"publishes versions"| node_partner_api

click node_sdk_scripts "https://github.com/flatcar/scripts/tree/main/sdk_container/src"
click node_package_overlays "https://github.com/flatcar/scripts/tree/main/sdk_container/src/third_party"
click node_package_list_sorter "https://github.com/flatcar/scripts/blob/main/pkg_auto/impl/sort_packages_list.py"
click node_package_build "https://github.com/flatcar/scripts/blob/main/build_packages"
click node_toolchain_build "https://github.com/flatcar/scripts/blob/main/build_toolchains"
click node_kernel_config "https://github.com/flatcar/scripts/tree/main/sdk_container/src"
click node_sysext_build "https://github.com/flatcar/scripts/blob/main/build_sysext"
click node_image_entry "https://github.com/flatcar/scripts/blob/main/build_image"
click node_image_utilities "https://github.com/flatcar/scripts/tree/main/build_library"
click node_tmpfiles_generator "https://github.com/flatcar/scripts/blob/main/build_library/gen_tmpfiles.py"
click node_au_zip_generator "https://github.com/flatcar/scripts/blob/main/build_library/generate_au_zip.py"
click node_image_hashes "https://github.com/flatcar/scripts/blob/main/build_library/generate_grub_hashes.py"
click node_kernel_hash "https://github.com/flatcar/scripts/blob/main/build_library/generate_kernel_hash.py"
click node_platform_images "https://github.com/flatcar/scripts/tree/main/build_library/oem"
click node_azure_publish "https://github.com/flatcar/scripts/blob/main/ci-automation/release/azure_marketplace_publish.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_sdk_scripts,node_package_overlays,node_package_list_sorter,node_package_build,node_toolchain_build,node_kernel_config,node_sysext_build toneBlue
class node_image_entry,node_image_utilities,node_tmpfiles_generator,node_au_zip_generator,node_image_hashes,node_kernel_hash,node_azure_storage toneAmber
class node_platform_images,node_partner_api toneMint
class node_azure_publish toneRose
class node_engineer,node_channel_info toneIndigo
```

## Components

### SDK and packages

- [SDK scripts](https://github.com/flatcar/scripts/tree/main/sdk_container/src): `sdk_container/src`
- [Package overlays](https://github.com/flatcar/scripts/tree/main/sdk_container/src/third_party): `sdk_container/src/third_party`
- [Package list sorter](https://github.com/flatcar/scripts/blob/main/pkg_auto/impl/sort_packages_list.py): `pkg_auto/impl/sort_packages_list.py`
- [Package builds](https://github.com/flatcar/scripts/blob/main/build_packages): `build_packages`
- [Toolchain builds](https://github.com/flatcar/scripts/blob/main/build_toolchains): `build_toolchains`
- [Kernel configuration](https://github.com/flatcar/scripts/tree/main/sdk_container/src): `sdk_container/src`
- [System extensions](https://github.com/flatcar/scripts/blob/main/build_sysext): `build_sysext`

### OS build

- [Image build entry](https://github.com/flatcar/scripts/blob/main/build_image): `build_image`
- [Image utilities](https://github.com/flatcar/scripts/tree/main/build_library): `build_library`
- [Tempfiles generator](https://github.com/flatcar/scripts/blob/main/build_library/gen_tmpfiles.py): `build_library/gen_tmpfiles.py`
- [Update zip generator](https://github.com/flatcar/scripts/blob/main/build_library/generate_au_zip.py): `build_library/generate_au_zip.py`
- [Boot integrity hashes](https://github.com/flatcar/scripts/blob/main/build_library/generate_grub_hashes.py): `build_library/generate_grub_hashes.py`
- [Kernel hash](https://github.com/flatcar/scripts/blob/main/build_library/generate_kernel_hash.py): `build_library/generate_kernel_hash.py`

### Image artifacts

- [Platform images](https://github.com/flatcar/scripts/tree/main/build_library/oem): `build_library/oem`

### Release publishing

- [Azure image publisher](https://github.com/flatcar/scripts/blob/main/ci-automation/release/azure_marketplace_publish.py): `ci-automation/release/azure_marketplace_publish.py`

### Other components

- **Flatcar engineer**
- **Azure Blob Storage**
- **Microsoft Partner API**
- **Channel metadata**

## Connections

- Flatcar engineer → SDK scripts: uses SDK (evidence: `README.md`)
- Flatcar engineer → Image build entry: builds images (evidence: `README.md`)
- SDK scripts → Package overlays: works with (evidence: `README.md`)
- Flatcar engineer → Package overlays: modifies packages (evidence: `README.md`)
- Flatcar engineer → Kernel configuration: modifies kernel (evidence: `README.md`)
- Image build entry → Image utilities: uses utilities
- Image build entry → Platform images: builds targets
- Azure image publisher → Channel metadata: reads metadata (evidence: `ci-automation/release/azure_marketplace_publish.py`)
- Azure image publisher → Azure Blob Storage: creates SAS URLs (evidence: `ci-automation/release/azure_marketplace_publish.py`)
- Azure image publisher → Microsoft Partner API: publishes versions (evidence: `ci-automation/release/azure_marketplace_publish.py`)
