Collect and cache metadata, run hooks on changes.

Go to file

Doug Hellmann 4a41f0b3e5 Drop use of 'oslo' namespace package The Oslo libraries have moved all of their code out of the 'oslo' namespace package into per-library packages. The namespace package was retained during kilo for backwards compatibility, but will be removed by the liberty-2 milestone. This change removes the use of the namespace package, replacing it with the new package names. The patches in the libraries will be put on hold until application patches have landed, or L2, whichever comes first. At that point, new versions of the libraries without namespace packages will be released as a major version update. Please merge this patch, or an equivalent, before L2 to avoid problems with those library releases. Blueprint: remove-namespace-packages https://blueprints.launchpad.net/oslo-incubator/+spec/remove-namespace-packages Change-Id: If51059c31c82d5235e2ae21143911b5561783ca6		2015-05-06 18:45:17 +00:00
os_collect_config	Drop use of 'oslo' namespace package	2015-05-06 18:45:17 +00:00
.coveragerc	Fix coverage report generation with tox	2014-06-03 11:00:07 -07: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
README.rst	Add diagram to os-collect-config README.rst	2014-03-26 09:13:19 -07:00
openstack-common.conf	Importing openstack-common using update.py and openstack-common.conf	2013-06-26 17:49:26 -07: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	2015-04-24 13:03:37 +00:00
setup.cfg	Revert "Support building wheels (PEP-427)"	2013-11-29 12:56:17 +02:00
setup.py	Updated from global requirements	2014-05-01 13:49:33 +00:00
test-requirements.txt	Updated from global requirements	2014-11-20 14:11:12 +00:00
tox.ini	Bump hacking to 0.9.x series	2014-11-13 13:11:00 +00:00

README.rst

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