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.
OpenStack Release Bot 385ad808fd Update .gitreview for stable/ussuri 10 months ago
os_collect_config Use unittest.mock instead of mock 1 year ago
releasenotes/notes Stop testing python2.7 2 years ago
zuul.d Stop testing python2.7 2 years ago
.coveragerc Change ignore-errors to ignore_errors 6 years ago
.gitignore Switch to stestr 3 years ago
.gitreview Update .gitreview for stable/ussuri 9 months ago
.stestr.conf Switch to stestr 3 years ago
LICENSE Aligned tests with OpenStack standards. 9 years ago Ensure that README file makes it into the tarball 9 years ago
README.rst Fix config file documentation 2 years ago
os-collect-config-and-friends.odg Add diagram to os-collect-config README.rst 8 years ago
os-collect-config-and-friends.svg Add diagram to os-collect-config README.rst 8 years ago
requirements.txt uncap eventlet 4 years ago
setup.cfg Stop testing python2.7 2 years ago Updated from global requirements 5 years ago
test-requirements.txt Bump hacking 9 months ago
tox.ini Bump hacking 9 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+

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.↩︎