Skip to main content

os-collect-config

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

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.

Metadata

Release files for os-collect-config 14.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for os-collect-config 14.1.0
File Size Uploaded
os_collect_config-14.1.0.tar.gz 60.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for os-collect-config 14.1.0
File Interpreter ABI Platform
os_collect_config-14.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 116.0 kB

Release files / os_collect_config-14.1.0.tar.gz

Download URL os_collect_config-14.1.0.tar.gz
Size 60.4 kB
Tags Source
SHA-256 checksum
How to use checksums
fa9fd62346831284c7967868addbe2db461fb4636ad63436ef222988a62e02b5
BLAKE2b-256 checksum
How to use checksums
5395484425e6e036366b425af85a604654113c2a8a1283bf4ef8082419d57291
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / os_collect_config-14.1.0-py3-none-any.whl

Download URL os_collect_config-14.1.0-py3-none-any.whl
Size 55.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
69e04cca65043f11f742b48828e886d23c84327d8316932c6e32131452bc9aed
BLAKE2b-256 checksum
How to use checksums
2ea6fe21546efd53ad84adce60b1d3105c46746a22e42fd8eaa0668a61bd950f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

This release

14.1.0 This release

2 release files

14.0.1

2 release files

14.0.0

2 release files

13.2.0

2 release files

13.1.0

2 release files

13.0.1

2 release files

13.0.0

2 release files

12.0.1

2 release files

12.0.0

2 release files

11.0.4

2 release files

11.0.3

2 release files

11.0.0

2 release files

10.5.0

2 release files

10.4.0

2 release files

10.3.1

2 release files

10.3.0

2 release files

10.2.0

2 release files

10.1.0

2 release files

9.2.1

2 release files

9.2.0

2 release files

9.1.0

2 release files

9.0.0

2 release files

8.3.1

2 release files

8.3.0

2 release files

8.2.0

2 release files

8.1.0

2 release files

8.0.0

2 release files

7.2.3

2 release files

7.2.2

2 release files

7.2.1

2 release files

7.2.0

2 release files

7.1.0

2 release files

7.0.0

2 release files

6.1.3

2 release files

6.1.2

2 release files

6.1.1

2 release files

6.1.0

2 release files

6.0.0

2 release files

5.2.1

2 release files

5.2.0

2 release files

5.1.0

2 release files

5.0.0

2 release files

0.1.37

2 release files

0.1.36

2 release files

0.1.34

2 release files

0.1.32

2 release files

0.1.30

2 release files

0.1.29

2 release files

0.1.27

2 release files

0.1.25

2 release files

0.1.24

2 release files

0.1.22

2 release files

0.1.21

2 release files

0.1.19

1 release file

0.1.18

1 release file

0.1.17

1 release file

0.1.16

1 release file

0.1.15

1 release file

0.1.14

1 release file

0.1.13

1 release file

0.1.12

1 release file

0.1.11

1 release file

0.1.10

1 release file

0.1.9

1 release file

0.1.8

1 release file

0.1.7

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

0.0.1

1 release file

5b8fd36

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page