Simple-CDD-YAML

Preprocessor for Simple-CDD using YAML input files (so-called recipes), as inspired by debos.

Simple-CDD is a tool for creating customized debian-installer CDs.

Introduction

Simple-CDD-YAML uses YAML recipes to generate the profile files required by Simple-CDD. A recipe consists of actions, that generate or append files in the Simple-CDD profile. Simple-CDD-YAML features the following actions (for an exemplary profile called <profile>):

• recipe action: embed another recipe
• conf action: compose a <profile>.conf file by supplying (environment) variables
• preseed action: define a preseed file
• apt action: add packages
• run action: add a command or script (to <profile>.postinst)
• overlay action: add an overlay (an overlay is a file structure that is compressed into one single file and automatically added to the file <profile>.extra. A corresponding command to decompress the overlay is added to <profile>.postinst)
• extra action: add extra file
• downloads action: add extra packages
• debos action: [only in debos mode] add pre- and post-action to debos recipe output

Some of the actions support substitutions using jinja notation, making it easier to reuse scripts, preseeds and recipes. By defining variables with default values at the top of a recipe it becomes easy to reuse and nest recipes.

A few actions also support different roles: by default scripts are executed and overlays are deployed as root, but you can also specify to have this done by a given user.

Please refer to the documentation on actions for detailed documentation for each action.

Installation

Simple-CDD-YAML can be directly installed from PyPi using pip:

pip install simple-cdd-yaml

Detailed instructions are found in the documentation's installation section.

Usage

After installation use the command simple-cdd-yaml to create Simple-CDD profiles from YAML files. Issue simple-cdd-yaml --help to get help.

Detailed usage instructions are found in the getting started guide.

Examples

Refer to the documentation's examples page for a detailed recipe explanation. The repository simple-cdd-yaml-recipes contains more example recipes.

Documentation

Check out the documentation to get started, find more background information and query the code reference.

Pre-commit hooks

This repository comes with pre-commit hooks, which are stored in .hooks. To enable the hooks issue:

git config --local core.hooksPath .hooks/

License

An MIT style license applies for Simple-CDD-YAML, see the LICENSE file for more details.