Browse Source

Tidy up README.rst, formatting

Wrap long line, add heading, formatting.

Change-Id: Id6d09c19832385a64134cd0115b909ecc7c6de29
tags/0.1.7
JUN JIE NAN 6 years ago
parent
commit
e6810895dc
1 changed files with 26 additions and 13 deletions
  1. +26
    -13
      README.rst

+ 26
- 13
README.rst View File

@@ -1,16 +1,22 @@
=================
os-collect-config
=================

Collect configuration from cloud metadata sources.

-------------------------------------------------
Collect configuration from cloud metadata sources
-------------------------------------------------

# What does it do?
What does it do?
================

It collects data from defined configuration sources and runs a defined hook whenever the metadata has changed.
It collects data from defined configuration sources and runs a defined
hook whenever the metadata has been changed.

# Usage
Usage
=====

You must define what sources to collect configuration data from in /etc/os-collect-config.conf
You must define what sources to collect configuration data from in
*/etc/os-collect-config.conf*.

The format of this file is::

@@ -24,23 +30,30 @@ The format of this file is::
path = MyResource
stack_name = my.stack


These sources will be polled and whenever any of them changes, 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::
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/run/os-collect-config/ec2.json:/var/run/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
Quick Start
===========

sudo pip install -U git+git://git.openstack.org/openstack/os-collect-config.git
Install::

# run it on an OpenStack instance with access to ec2 metadata::
sudo pip install -U git+git://git.openstack.org/openstack/os-collect-config.git

os-collect-config
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.

Loading…
Cancel
Save