Collect and cache metadata, run hooks on changes.

Go to file

huang.zhiping dff8dabab0 fix tox python3 overrides We want to default to running all tox environments under python 3, so set the basepython value in each environment. We do not want to specify a minor version number, because we do not want to have to update the file every time we upgrade python. We do not want to set the override once in testenv, because that breaks the more specific versions used in default environments like py35 and py36. Change-Id: I859649b7f4f9ab70617309947375d4886e14a860		2018-06-09 19:05:46 +08:00
os_collect_config	Lower local collector log level	2018-01-02 08:44:13 -07:00
zuul.d	Zuul: Remove project name	2018-02-05 12:37:49 -08: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
MANIFEST.in	Ensure that README file makes it into the tarball	2013-07-07 11:56:08 -04: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
README.rst	Update links in README	2018-03-02 18:01:13 +08:00
requirements.txt	uncap eventlet	2018-04-11 11:52:27 -04:00
setup.cfg	Revert "Support building wheels (PEP-427)"	2013-11-29 12:56:17 +02:00
setup.py	Updated from global requirements	2017-03-06 01:16:53 +00:00
test-requirements.txt	Updated from global requirements	2018-03-15 07:44:17 +00:00
tox.ini	fix tox python3 overrides	2018-06-09 19:05:46 +08:00

README.rst

Team and repository tags

os-collect-config

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.

Usage

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

The format of this file is:

[default]
command=os-refresh-config

[cfn]
metadata_url=http://192.0.2.99:8000/v1/
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:

/var/lib/os-collect-config/ec2.json:/var/lib/os-collect-config/cfn.json

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

Install:

sudo pip install -U git+git://git.openstack.org/openstack/os-collect-config.git

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

os-collect-config

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

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