Collect and cache metadata, run hooks on changes.
Go to file
Monty Taylor 49c060a313 Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
os_config_applier Render complex sub-objects using json.dumps 2013-03-20 09:12:22 -07:00
tests Render complex sub-objects using json.dumps 2013-03-20 09:12:22 -07:00
.gitignore Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
.testr.conf Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
.travis.yml Pass all flake8 tests - run in CI too 2013-03-15 10:47:02 -07:00
README.md Update README.md 2013-01-31 15:15:31 -08:00
requirements.txt Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
run_tests.sh Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
setup.cfg Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
setup.py Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
test-requirements.txt Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00
tox.ini Migrate to pbr and testr. 2013-03-28 02:37:45 +01:00

README.md

os-config-applier

Apply configuration from cloud metadata.

What does it do?

it turns a cloud-metadata file like this:

{"keystone": {"database": {"host": "127.0.0.1", "user": "keystone", "password": "foobar"}}}

into service config files like this:

[sql]
connection = mysql://keystone:foobar@127.0.0.1/keystone
...other settings...

Usage

Just pass it the path to a directory tree of templates:

os-config-applier -t /home/me/my_templates

Templates

The template directory structure should mimic a root filesystem, and contain templates for only those files you want configured.

e.g.

~/my_templates$ tree
.
└── etc
    ├── keystone
    │   └── keystone.conf
    └── mysql
        └── mysql.conf

An example tree can be found here.

If a template is executable it will be treated as an executable template. Otherwise, it will be treated as a mustache template.

Mustache Templates

If you don't need any logic, just some string substitution, use a mustache template.

Metadata settings are accessed with dot ('.') notation:

[sql]
connection = mysql://{{keystone.database.user}}:{{keystone.database.password}@{{keystone.database.host}}/keystone

Executable Templates

Configuration requiring logic is expressed in executable templates.

An executable template is a script which accepts configuration as a json string on standard in, and writes a config file to standard out.

The script should exit non-zero if it encounters a problem, so that os-config-applier knows what's up.

The output of the script will be written to the path corresponding to the executable template's path in the template tree.

#!/usr/bin/env ruby
require 'json'
params = JSON.parse STDIN.read
puts "connection = mysql://#{c['keystone']['database']['user']}:#{c['keystone']['database']['password']}@#{c['keystone']['database']['host']}/keystone"

You could even embed mustache in a heredoc, and use that:

#!/usr/bin/env ruby
require 'json'
require 'mustache'
params = JSON.parse STDIN.read

template = <<-eos
[sql]
connection = mysql://{{keystone.database.user}}:{{keystone.database.password}}@{{keystone.database.host}}/keystone

[log]
...
eos

# tweak params here...

puts Mustache.render(template, params)

Quick Start

# install it
sudo pip install -U git+git://github.com/tripleo/os-config-applier.git

# grab example templates
git clone git://github.com/tripleo/openstack-config-templates /tmp/config

# run it
os-config-applier -t /tmp/config/templates/ -m /tmp/config/cfn-init-data.example -o /tmp/config_output