Properly format markdown code blocks

The YAML configuration examples were being parsed as markdown, which
resulted in poorly formatted documents.

Also convert tempest element README file to markdown for consistency.

Change-Id: Id6def1c8bcb86e37f10a74bf85361a9da0d151b6
Closes-Bug: 1328304
This commit is contained in:
Martin André 2014-10-24 17:05:20 +09:00
parent 00944b8c36
commit 91c4996685
20 changed files with 331 additions and 322 deletions

View File

@ -2,6 +2,7 @@ Install and configure Glance.
Configuration
-------------
glance:
db: mysql://glance:unset@localhost/glance
- SQLAlchemy database connection string

View File

@ -6,17 +6,18 @@ Sets default install type to local-only so we dont spam anyone. This can be
overwritten with the DIB_POSTFIX_INSTALL_TYPE environmental variable.
Valid options for DIB_POSTFIX_INSTALL_TYPE are:
Local only
Internet Site
Internet with smarthost
Satellite system
* Local only
* Internet Site
* Internet with smarthost
* Satellite system
Set postfix hostname and domain via heat:
postfix:
mailhostname: mail
maildomain: example.com
delay_warning_time: 4h
relayhost: smtp.example.com
*NOTE: mailhostname and maildomain must match the system hostname in order to
**NOTE**: mailhostname and maildomain must match the system hostname in order to
ensure local mail delivery will work.

View File

@ -23,6 +23,7 @@ to be updated. Substitute "rabbit" with "qpid".
sed -i "s/rabbit/qpid/" $TRIPLEO_ROOT/tripleo-image-elements/elements/seed-stack-config/config.json
After including the username, the qpid section should look like
"qpid": {
"host": "127.0.0.1",
"username": "guest",
@ -36,6 +37,7 @@ with "qpid:".
sed -i "s/rabbit:/qpid:/" $TRIPLEO_ROOT/tripleo-heat-templates/undercloud-vm.yaml
After including the username, the qpid section should look like
qpid:
host: 127.0.0.1
username: guest
@ -48,6 +50,7 @@ with "qpid:".
sed -i "s/rabbit:/qpid:/" $TRIPLEO_ROOT/tripleo-heat-templates/overcloud.yaml
After including the username, the qpid section(s) should look like
qpid:
host:
Fn::GetAtt:

View File

@ -16,6 +16,7 @@ Grants snmp user password-less sudo access to lsof, so that the per process
check works correctly.
Options should be provided via heat. For example:
snmpd:
export_MIB: UCD-SNMP-MIB
readonly_user_name: RoUser

View File

@ -2,6 +2,7 @@ Swift element for installing a swift proxy server
Configuration
-------------
swift:
service-password: PASSWORD
- The service password for the swift user

View File

@ -2,6 +2,7 @@ Common element for swift elements
Configuration
-------------
swift:
devices: r1z<zone number>-192.0.2.6:%PORT%/d1
- A comma separated list of swift storage devices to place in the ring

View File

@ -26,6 +26,7 @@ will take care of applying these settings during configuration time.
Configuration example
---------------------
sysctl:
net.ipv4.conf.all.arp_filter: 1
net.ipv4.conf.all.arp_ignore: 2

View File

@ -1,16 +0,0 @@
Add the tempest cloud test suite to an image.
The purpose of this element is to run tempest as a gate for tripleo based ci.
To successfully run tempest your overcloud should have
o Nodes with at least 4G of memory and 20G of diskspace
o the following services should be running
cinder, glance, heat, keystone, neutron, nova and swift
To use you should simply run the command run-tempest with the
OS_* environment variables for admin defined.
TODO:
o Remove as many of the filters in tests2skip.txt as possible
o Investigate setting allow_tenant_isolation to true
o Investigate setting run_ssh to true

View File

@ -0,0 +1,16 @@
Add the tempest cloud test suite to an image.
The purpose of this element is to run tempest as a gate for tripleo based ci.
To successfully run tempest your overcloud should have
* Nodes with at least 4G of memory and 20G of diskspace
* the following services should be running
cinder, glance, heat, keystone, neutron, nova and swift
To use you should simply run the command run-tempest with the
OS_* environment variables for admin defined.
TODO:
* Remove as many of the filters in tests2skip.txt as possible
* Investigate setting allow_tenant_isolation to true
* Investigate setting run_ssh to true