Skip to main content

YAML recipe interpreter for Simple-CDD

Project description

Simple-CDD-YAML

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

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:

  • recipe action: embed another recipe
  • conf action: compose a *.conf file by supplying (environment) variables
  • preseed action: define a preseed file
  • apt action: add packages
  • run action: add a command or script (to *.postinst)
  • overlay action: add an overlay. An overlay is a file structure that is compressed into one single file and automatically added to *.extra.
    A corresponding command to decompress the overly is added *.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 a script is run or an overlay is deployed as root, but you can also specify to have this done by a certain user.

Please refer to the documentation for more information.

Installation

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

pip install simple-cdd-yaml

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.

Examples

Refer to simple-cdd-yaml-recipes for example recipes.

Documentation

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

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simple_cdd_yaml-0.1.0.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

simple_cdd_yaml-0.1.0-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file simple_cdd_yaml-0.1.0.tar.gz.

File metadata

  • Download URL: simple_cdd_yaml-0.1.0.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for simple_cdd_yaml-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cdf3a9c1ebce9e9198b33d05e91dba7dc05ebe443b0f88b8b720ae6e3640fcbc
MD5 f90b3d3cdca45222359df53456db4f8f
BLAKE2b-256 c87062049680001f00cd6e069c6081f3ce587fc4c6aee26d3bebe8479f0efb42

See more details on using hashes here.

File details

Details for the file simple_cdd_yaml-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_cdd_yaml-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36c83810523a13a19b8959679fa97e455e94fff45cdc0589f0bddb0b5a5ec0ab
MD5 2a749e6258047f50f1aea7ff3b5db12c
BLAKE2b-256 cf7bb1faf525b02afab540566552131058b810054bc120018e80592754c81a02

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page