Collect and cache metadata, run hooks on changes.
Go to file
Wes Hayutin 45ce891299 remove tripleo jobs from os-collect-config stein
Partail-Bug: #1879361
Change-Id: Ided16a8965732da84d1a3fc4ebcdca1c5a97af96
2020-05-18 10:23:10 -06:00
os_collect_config Don't ignore SIGPIPE 2018-09-28 16:33:11 +00:00
zuul.d remove tripleo jobs from os-collect-config stein 2020-05-18 10:23:10 -06:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:41:46 +00:00
.gitignore Switch to stestr 2018-07-10 18:53:52 +07:00
.gitreview Update .gitreview for stable/stein 2019-04-23 06:30:30 +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 Ensure that README file makes it into the tarball 2013-07-07 11:56:08 -04:00
README.rst Replace git:// URLs with https:// 2019-03-24 20:35:18 +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 uncap eventlet 2018-04-11 11:52:27 -04:00
setup.cfg Change openstack-dev to openstack-discuss 2018-12-05 00:06:06 +08:00 Updated from global requirements 2017-03-06 01:16:53 +00:00
test-requirements.txt Switch to stestr 2018-07-10 18:53:52 +07:00
tox.ini Update UPPER_CONSTRAINTS_FILE for stable/stein 2019-04-23 12:30:54 +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+

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