Reference

Reference materials are information-oriented technical descriptions that provide detailed, accurate information about Garden Linux. They describe how things work and what options are available.

Available Reference documentation

Glossary

Supporting ToolsDocumentation of several Garden Linux related Tools

builder

reference

tutorials

python-gardenlinux-lib

how-to

Python Gardenlinux Lib - Overview

Architecture Decision Records (ADR)

ADR 0001: Adopting Architecture Decision Records (ADR) for Garden Linux

ADR 0002: Distributions Can Never Change Retroactively

ADR 0003: Update the Builder using Dependabot

ADR 0004: Vendoring dependencies in Go Applications

ADR 0005: How to handle Secure Boot Keys in glci

ADR 0006: New Test Framework to enable In-Place, Self-Contained Test Execution

ADR 0007: Non-Invasive, Read-Only Testing

ADR 0008: Unified and Declarative Test Logic

ADR 0009: Flexible Distribution and Reporting

ADR 0010: Incremental Migration and Coexistence of Tests

ADR 0011: Garden Linux versioning

ADR 0012: Remove the Firecracker Feature from Garden Linux

ADR 0013: Discontinue `packages_musthave` tests

ADR 0014: Enforce Pull Request References in git Commit History

ADR 0015: No Backports from Debian Stable in Garden Linux

ADR 0016: Avoid Host Dependency on `retry` Command in Makefile for tests-ng

ADR 0017: Retain Shell-Based CIS Implementation for tests-ng (No Custom Python Rewrite)

ADR 0018: Revert ADR 3 Update the Builder using Dependabot

ADR 0019: Standardize on systemd Timers

ADR 0020: Enforce Single Platform by Default in Garden Linux Builder

ADR 0021: Use of tiger tool in tests-ng

ADR 0022: System State Diffing in tests-ng

ADR 0023: Providing Garden Linux Images for Lima-VM via Containerized YAML Generator

ADR 0024: Promote Lima Image to Official Garden Linux Product

ADR 0025: Disable Debsums Tests entirely

ADR 0026: Use Parser Plugins for Files and Command Output in Test Framework

ADR 0027: Do not use systemd release candidates

ADR 0028: Pinning All GitHub Actions in Garden Linux Workflows

ADR 0029: Build features/cis with SELINUX=permissive Instead of SELINUX=enforcing

ADR 0030: Defining python-gardenlinux-lib as an internal tool

ADR 0031: S3 Artifact and Metadata Publishing Contract Between Builder and GLCI

ADR 0032: Static Feature/Test Coverage Analysis for Test Framework

Installation

documentation

Documentation Aggregation Configuration ReferenceComplete reference for repos-config.json and repos-config.local.json configuration options

Documentation Aggregation Technical ReferenceSource code documentation for the documentation aggregation system - modules, APIs, and implementation details

Documentation Aggregation Testing GuideTest suite for documentation - unit tests, integration tests, and testing best practices

Flavor Matrix

Image Formats

Kernels And Modules

Platform Compatibility

Releases

Maintained Releases

Release Notes

---

About Reference: Following the Diátaxis framework, reference documentation serves as a reliable source of truth. It provides precise technical information, API documentation, configuration options, and specifications. Reference materials are designed to be consulted when you need specific facts or details.