openstack
/
os-collect-config
Code Issues Proposed changes
Collect and cache metadata, run hooks on changes.
362 Commits 1 Branch 109 Tags 3.1 MiB
Python 100%
Go to file
Wes Hayutin 6dd0e536b9 Stop testing python2.7 
Train was the last release supporting python2. Let's rip the bandaid
off.

Also includes remove tripleo jobs from os-collect-config master

Partial-Bug: #1879361
Co-Authored-By: xuanyandong <xuanyandong@inspur.com>
Co-Authored-By: Alex Schultz <aschultz@redhat.com>
Change-Id: I46c79ce87f474a986f1983fa9164e6e4cbeaf8de
 		2020-05-19 08:05:35 -06:00
os_collect_config Don't ignore SIGPIPE 2018-09-28 16:33:11 +00:00
releasenotes/notes Stop testing python2.7 2020-05-19 08:05:35 -06:00
zuul.d Stop testing python2.7 2020-05-19 08:05:35 -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 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
MANIFEST.in Ensure that README file makes it into the tarball 2013-07-07 11:56:08 -04: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 uncap eventlet 2018-04-11 11:52:27 -04:00
setup.cfg Stop testing python2.7 2020-05-19 08:05:35 -06:00
setup.py Updated from global requirements 2017-03-06 01:16:53 +00:00
test-requirements.txt Sync Sphinx requirement 2019-10-10 14:19:22 +08:00
tox.ini Stop testing python2.7 2020-05-19 08:05:35 -06:00

README.rst

Team and repository tags

image

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

1

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+https://opendev.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.

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