Collect and cache metadata, run hooks on changes.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Zuul 8763b70935 Merge "Switch to stestr" 10 months ago
os_collect_config Add region support 11 months ago
zuul.d Zuul: Remove project name 1 year ago
.coveragerc Change ignore-errors to ignore_errors 3 years ago
.gitignore Switch to stestr 11 months ago
.gitreview Update stackforge references to openstack 5 years ago
.stestr.conf Switch to stestr 11 months ago
LICENSE Aligned tests with OpenStack standards. 6 years ago Ensure that README file makes it into the tarball 6 years ago
README.rst Update links in README 1 year ago
os-collect-config-and-friends.odg Add diagram to os-collect-config README.rst 5 years ago
os-collect-config-and-friends.svg Add diagram to os-collect-config README.rst 5 years ago
requirements.txt uncap eventlet 1 year ago
setup.cfg Revert "Support building wheels (PEP-427)" 5 years ago Updated from global requirements 2 years ago
test-requirements.txt Switch to stestr 11 months ago
tox.ini Switch to stestr 11 months ago


Team and repository tags



Collect configuration from cloud metadata sources

What does it do?

It collects data from defined configuration sources and runs a defined hook whenever the metadata has been changed.




You must define what sources to collect configuration data from in /etc/os-collect-config.conf.

The format of this file is:


access_key_id = ABCDEFGHIJLMNOP01234567890
secret_access_key = 01234567890ABCDEFGHIJKLMNOP
path = MyResource
stack_name = my.stack

These sources will be polled and whenever any of them is changed, default.command will be run. A file will be written to the cache dir, os_config_files.json, which will be a json list of the file paths to the current copy of each metadata source. This list will also be set as a colon separated list in the environment variable OS_CONFIG_FILES for the command that is run. So in the example above, os-refresh-config would be executed with something like this in OS_CONFIG_FILES:


The previous version of the metadata from a source (if available) is present at $FILENAME.last.

When run without a command, the metadata sources are printed as a json document.

Quick Start


sudo pip install -U git+git://

Run it on an OpenStack instance with access to ec2 metadata:


That should print out a json representation of the entire ec2 metadata tree.

  1. Recommend using LibreOffice draw to edit os-collect-config-and-friends.odg and regenerate the svg file. Alternatively edit the svg directly, but remove the .odg file if that is done.