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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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