Collect and cache metadata, run hooks on changes.
Go to file
OpenStack Proposal Bot 6ee0c59066 Updated from global requirements
Change-Id: I453410624fd05840d0f9dd0b9b461045b1f29c8f
2017-03-13 19:39:27 +00:00
os_collect_config Merge "Use pop for checking messages with websocket" 2017-03-11 02:10:01 +00:00
tools Add Constraints support 2016-12-21 12:07:17 +11:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:41:46 +00:00
.gitignore Modify gitignore to ignore cover 2014-09-12 15:53:50 +09:00
.gitreview Update stackforge references to openstack 2013-08-17 22:59:30 -04:00
.testr.conf Remove env vars we don't use. 2013-03-28 04:05:31 +01:00
LICENSE Aligned tests with OpenStack standards. 2013-03-28 03:40:38 +01:00 Ensure that README file makes it into the tarball 2013-07-07 11:56:08 -04:00
README.rst Show team and repo badges on README 2016-11-25 14:19:52 +01:00
os-collect-config-and-friends.odg Add diagram to os-collect-config README.rst 2014-03-26 09:13:19 -07:00
os-collect-config-and-friends.svg Add diagram to os-collect-config README.rst 2014-03-26 09:13:19 -07:00
requirements.txt Updated from global requirements 2017-03-13 19:39:27 +00:00
setup.cfg Revert "Support building wheels (PEP-427)" 2013-11-29 12:56:17 +02:00 Updated from global requirements 2017-03-06 01:16:53 +00:00
test-requirements.txt Updated from global requirements 2017-03-06 01:16:53 +00:00
tox.ini Merge "Add Constraints support" 2017-03-09 22:25:44 +00:00


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