Skip to main content

Collect and cache metadata, run hooks on changes.

Project description

Team and repository tags

https://governance.openstack.org/tc/badges/os-collect-config.svg

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.

os-collect-config-and-friends.svg

[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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

os-collect-config-14.0.0.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

os_collect_config-14.0.0-py3-none-any.whl (55.7 kB view details)

Uploaded Python 3

File details

Details for the file os-collect-config-14.0.0.tar.gz.

File metadata

  • Download URL: os-collect-config-14.0.0.tar.gz
  • Upload date:
  • Size: 59.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.7

File hashes

Hashes for os-collect-config-14.0.0.tar.gz
Algorithm Hash digest
SHA256 9c626a6cacb8eb5ce7da1ebeba0c1c17372cc3ce5e609f9169d752c744990a03
MD5 e8a3e03581c33718d4ea05a624f08de2
BLAKE2b-256 35d92309ebd1751bdaca5ac93f2976ead82083aa062572f265d6ae53afd79484

See more details on using hashes here.

File details

Details for the file os_collect_config-14.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for os_collect_config-14.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2c0f5c7f5325706ba229243f514cd1cb9496b1735e166c5d274a687bd2bdf62
MD5 44100b84408d661b639c0b3132c2128c
BLAKE2b-256 5b0d9bb3ed445793b17a5dc9a8515f5c80de27504f8b374659a2608f20100a62

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page