# truenas/core-build architecture

> Architecture diagram of the GitHub repository truenas/core-build, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/truenas/core-build
- Repository: https://github.com/truenas/core-build

## Overview

##### Main Components (Top Level)

a) Build System Core
- Represented by a large container showing the main build process

b) Input Sources
- On the left side
- Include:
- Git repositories
- Configuration templates
- Build profiles

c) Output Artifacts
- On the right side
- Include:
- ISO files
- Update files
- Log files

##### Build System Components (Detail Level)

a) Build Tools Layer
- Tools from build/tools/
- Include:
- build-os.py
- build-packages.py
- create-iso.py
- create-upgrade-distribution.py

b) Profile Management
- Profiles system (build/profiles/)
- FreeNAS profile structure

c) Customization Layer
- Build/customize/ scripts
- Connection to main build process

##### Testing Framework
- At the bottom
- Connection to:
- FreeBSD tests
- TrueOS tests
- Validation flow

##### Key Relationships

a) Build Flow:
- Git checkout → Source preparation
- Profile selection → Build configuration
- Package building → OS assembly
- OS assembly → ISO creation

b) Dependencies:
- Connection to FreeBSD base
- Package dependencies
- Build tool relationships

##### Important Elements

a) Environment Requirements:
- FreeBSD 13.x requirement
- Hardware requirements

b) Build Artifacts Storage:
- _BE directory structure
- Release artifacts organization

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        Git[Git Repositories]:::input
        Config[Configuration Templates]:::input
        Profiles[Build Profiles]:::input
    end

    subgraph "Build System Core"
        BuildCore[Build System Core]:::core
        click BuildCore "https://github.com/truenas/core-build/tree/master/build/"
        
        subgraph "Build Tools"
            BuildOS[OS Builder]:::tool
            click BuildOS "https://github.com/truenas/core-build/blob/master/build/tools/build-os.py"
            BuildPkg[Package Builder]:::tool
            click BuildPkg "https://github.com/truenas/core-build/blob/master/build/tools/build-packages.py"
            ISOCreator[ISO Creator]:::tool
            click ISOCreator "https://github.com/truenas/core-build/blob/master/build/tools/create-iso.py"
            UpgradeDist[Upgrade Distribution]:::tool
            click UpgradeDist "https://github.com/truenas/core-build/blob/master/build/tools/create-upgrade-distribution.py"
        end

        subgraph "Profile Management"
            ProfilesDir[Profiles Directory]:::profile
            click ProfilesDir "https://github.com/truenas/core-build/tree/master/build/profiles/"
            FreeNASProfile[FreeNAS Profile]:::profile
            click FreeNASProfile "https://github.com/truenas/core-build/tree/master/build/profiles/freenas/"
            KernelConfig[Kernel Configs]:::profile
            click KernelConfig "https://github.com/truenas/core-build/tree/master/build/profiles/freenas/kernel/"
        end

        subgraph "Customization"
            CustomScripts[Customization Scripts]:::custom
            click CustomScripts "https://github.com/truenas/core-build/tree/master/build/customize/"
            BaseConfig[Base Configuration]:::custom
            click BaseConfig "https://github.com/truenas/core-build/blob/master/build/customize/conf-base.py"
            VersionWriter[Version Writer]:::custom
            click VersionWriter "https://github.com/truenas/core-build/blob/master/build/customize/write-version.py"
        end
    end

    subgraph "Configuration Management"
        ConfigTemplates[Config Templates]:::config
        click ConfigTemplates "https://github.com/truenas/core-build/tree/master/build/config/templates/"
        PkgRepos[Package Repositories]:::config
        click PkgRepos "https://github.com/truenas/core-build/tree/master/build/config/templates/pkg-repos/"
        SysConfigs[System Configs]:::config
        click SysConfigs "https://github.com/truenas/core-build/tree/master/build/config/templates/cdrom/"
    end

    subgraph "CI/CD"
        Jenkins[Jenkins Config]:::ci
        click Jenkins "https://github.com/truenas/core-build/tree/master/Jenkins/"
        NightlyBuilds[Nightly Builds]:::ci
        click NightlyBuilds "https://github.com/truenas/core-build/tree/master/Jenkins/freenas-nightlies"
        Pipeline[Build Pipeline]:::ci
        click Pipeline "https://github.com/truenas/core-build/tree/master/Jenkinsfile"
    end

    subgraph "Testing Framework"
        TestDir[Test Directory]:::test
        click TestDir "https://github.com/truenas/core-build/tree/master/tests/"
        FreeNASTests[FreeNAS Tests]:::test
        click FreeNASTests "https://github.com/truenas/core-build/tree/master/tests/freenas/"
        TrueOSTests[TrueOS Tests]:::test
        click TrueOSTests "https://github.com/truenas/core-build/tree/master/tests/trueos/"
    end

    subgraph "Output Artifacts"
        ISO[ISO Files]:::output
        Updates[Update Files]:::output
        Logs[Log Files]:::output
    end

    Git --> BuildCore
    Config --> BuildCore
    Profiles --> BuildCore

    BuildCore --> BuildOS
    BuildCore --> BuildPkg
    BuildCore --> ISOCreator
    BuildCore --> UpgradeDist

    BuildOS --> ProfilesDir
    ProfilesDir --> FreeNASProfile
    FreeNASProfile --> KernelConfig

    BuildCore --> CustomScripts
    CustomScripts --> BaseConfig
    CustomScripts --> VersionWriter

    ConfigTemplates --> BuildCore
    PkgRepos --> BuildCore
    SysConfigs --> BuildCore

    Jenkins --> Pipeline
    Pipeline --> NightlyBuilds
    NightlyBuilds --> BuildCore

    BuildCore --> TestDir
    TestDir --> FreeNASTests
    TestDir --> TrueOSTests

    BuildCore --> ISO
    BuildCore --> Updates
    BuildCore --> Logs

    classDef input fill:#90EE90,stroke:#333,stroke-width:2px
    classDef core fill:#4169E1,stroke:#333,stroke-width:2px
    classDef tool fill:#87CEEB,stroke:#333,stroke-width:2px
    classDef profile fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef custom fill:#F0E68C,stroke:#333,stroke-width:2px
    classDef config fill:#FFB6C1,stroke:#333,stroke-width:2px
    classDef ci fill:#98FB98,stroke:#333,stroke-width:2px
    classDef test fill:#FFA07A,stroke:#333,stroke-width:2px
    classDef output fill:#FFA500,stroke:#333,stroke-width:2px
```
