Collect and cache metadata, run hooks on changes.
Go to file
Zuul c5d73f5926 Merge "Display coverage report" 2024-02-07 05:43:42 +00:00
os_collect_config Drop direct execution of 2024-01-29 23:56:44 +09:00
releasenotes/notes Stop testing python2.7 2020-05-19 08:05:35 -06:00
zuul.d Update python job template 2023-10-18 15:00:13 +09:00
.coveragerc coveragerc: Remove non-existent path 2023-12-19 21:00:58 +09:00
.gitignore Ignore .eggs directory 2023-12-19 21:02:44 +09:00
.gitreview OpenDev Migration Patch 2019-04-19 19:42:57 +00:00
.stestr.conf Switch to stestr 2018-07-10 18:53:52 +07:00
LICENSE Aligned tests with OpenStack standards. 2013-03-28 03:40:38 +01:00
README.rst Fix config file documentation 2019-09-12 13:09:55 +00: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 Remove workaround for Python 2 2023-11-28 00:23:17 +09:00
setup.cfg Drop direct execution of 2024-01-29 23:56:44 +09:00 Remove workaround for Python 2 2023-11-28 00:23:17 +09:00
test-requirements.txt Bump hacking 2024-01-17 01:40:13 +09:00
tox.ini Display coverage report 2024-02-07 14:18:52 +09: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+

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