openstack/os-collect-config
Code Issues Proposed changes
Collect and cache metadata, run hooks on changes.
368 Commits 1 Branch 109 Tags 3.2 MiB
Python 100%
13.0.1
Go to file
Alex Schultz 224af052af Bump hacking 
This change bumps hacking to 4.x and adds W503, W504, and W605 to the
ignore list for now.

Change-Id: I2b5c7c671b1cd7c0f378992895434f86b02ed95e
2021-03-09 09:23:32 -07:00
os_collect_config Use unittest.mock instead of mock 2020-06-09 19:28:11 +02: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
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 Fix config file documentation 2019-09-12 13:09:55 +00: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 Bump hacking 2021-03-09 09:23:32 -07:00
tox.ini Bump hacking 2021-03-09 09:23:32 -07: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.↩︎