e6fbb4cd98
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: b'https://gist.github.com/e08d834d7d0be70f74da177780f25f4a\n' Change-Id: I5b7c82f942547245a830db0e80c1e12069f21cb9
75 lines
2.2 KiB
ReStructuredText
75 lines
2.2 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/os-collect-config.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
=================
|
|
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.
|
|
|
|
.. image:: os-collect-config-and-friends.svg
|
|
|
|
[#update_svg]_
|
|
|
|
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.
|
|
|
|
.. [#update_svg] 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.
|