openstack
/
os-collect-config
Code Issues Proposed changes
Collect and cache metadata, run hooks on changes.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
373 Commits
2 Branches
106 Tags
3.0 MiB
Python 100%
 
master
stable/train
victoria-eol
victoria-em
ussuri-eol
ussuri-em
13.1.0
stein-eol
queens-eol
11.0.4
train-em
12.0.2
10.6.0
12.0.1
11.0.3
13.0.1
rocky-eol
11.0.2
13.0.0
12.0.0
stein-em
11.0.1
rocky-em
10.5.1
10.3.1
11.0.0
queens-em
10.5.0
pike-eol
ocata-eol
10.4.0
pike-em
7.2.3
10.3.0
ocata-em
8.3.1
9.2.1
10.2.0
10.1.0
10.0.0
9.2.0
newton-eol
9.1.0
9.0.0
8.3.0
7.2.2
6.1.3
8.2.0
8.1.0
7.2.1
5.2.1
6.1.2
8.0.0
7.2.0
6.1.1
7.1.0
7.0.0
6.1.0
5.2.0
7.0.0.0b1
6.0.0
6.0.0.0rc1
5.1.0
6.0.0.0b2
6.0.0.0b1
5.0.0
5.0.0.0rc2
5.0.0.0b3
5.0.0.0b1
0.1.37
0.1.36
0.1.35
0.1.34
0.1.33
0.1.32
0.1.31
0.1.30
0.1.29
0.1.28
0.1.27
0.1.26
0.1.25
0.1.24
0.1.23
0.1.22
0.1.21
0.1.20
0.1.19
0.1.18
0.1.17
0.1.16
0.1.15
0.1.14
0.1.13
0.1.12
0.1.11
0.1.10
0.1.9
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3a7d05a9e8'
${ noResults }
Go to file
Alex Schultz 3a7d05a9e8 Drop six 
With python2 not being supported anymore, let's drop six.

Change-Id: I22f3d28e22ad209806b78ad78f46671a74179157
 		2 years ago
os_collect_config Drop six 2 years ago
releasenotes/notes Stop testing python2.7 3 years ago
zuul.d Stop testing python2.7 3 years ago
.coveragerc Change ignore-errors to ignore_errors 8 years ago
.gitignore Switch to stestr 5 years ago
.gitreview OpenDev Migration Patch 4 years ago
.stestr.conf Switch to stestr 5 years ago
LICENSE Aligned tests with OpenStack standards. 10 years ago
MANIFEST.in Ensure that README file makes it into the tarball 10 years ago
README.rst Fix config file documentation 4 years ago
os-collect-config-and-friends.odg Add diagram to os-collect-config README.rst 9 years ago
os-collect-config-and-friends.svg Add diagram to os-collect-config README.rst 9 years ago
requirements.txt Drop six 2 years ago
setup.cfg setup.cfg: Replace dashes with underscores 2 years ago
setup.py Updated from global requirements 6 years ago
test-requirements.txt Bump hacking 2 years ago
tox.ini Use py3 as the default runtime for tox 2 years ago

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