openstack
/
os-collect-config
Code Issues Proposed changes

Fix the formatting in the README 

the backlinks don't seem to work on github use "::" instead.

Change-Id: I33acfc82df70344577dac7d775a061829c8038d8
This commit is contained in:
Angus Salkeld 2013-10-15 14:28:30 +11:00
parent e82a98f127
commit 1e43bdf2b6
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README.rst
View File

@ -12,24 +12,23 @@ It collects data from defined configuration sources and runs a defined hook when
You must define what sources to collect configuration data from in /etc/os-collect-config/sources.ini
The format of this file is
```ini
[default]
command=os-refresh-config
The format of this file is::
[cfn]
metadata_url=http://192.0.2.99:8000/v1/
access_key_id = ABCDEFGHIJLMNOP01234567890
secret_access_key = 01234567890ABCDEFGHIJKLMNOP
path = MyResource
stack_name = my.stack
```
[default]
command=os-refresh-config
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:
[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 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::
/var/run/os-collect-config/ec2.json:/var/run/os-collect-config/cfn.json
```
/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.
@ -39,8 +38,9 @@ When run without a command, the metadata sources are printed as a json document.
sudo pip install -U git+git://git.openstack.org/openstack/os-collect-config.git
# run it on an OpenStack instance with access to ec2 metadata:
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.