Sean M. Collins 09e550c370 Convert all HTML doc to RST

The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.

Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.

The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.

Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd

2014-10-22 12:27:00 -04:00

2.6 KiB

Raw Blame History

DevStack

openrc User authentication settings

openrc configures login credentials suitable for use with the OpenStack command-line tools. openrc sources stackrc at the beginning (which in turn sources the localrc setion of local.conf) in order to pick up HOST_IP and/or SERVICE_HOST to use in the endpoints. The values shown below are the default values.

OS_TENANT_NAME

The introduction of Keystone to the OpenStack ecosystem has standardized the term tenant as the entity that owns resources. In some places references still exist to the original Nova term project for this use. Also, tenant_name is preferred to tenant_id.

OS_TENANT_NAME=demo

OS_USERNAME

In addition to the owning entity (tenant), Nova stores the entity performing the action as the user.

OS_USERNAME=demo

OS_PASSWORD

With Keystone you pass the keystone password instead of an api key. Recent versions of novaclient use OS_PASSWORD instead of NOVA_API_KEYs or NOVA_PASSWORD.

OS_PASSWORD=secrete

HOST_IP, SERVICE_HOST

Set API endpoint host using HOST_IP. SERVICE_HOST may also be used to specify the endpoint, which is convenient for some localrc configurations. Typically, HOST_IP is set in the localrc section.

HOST_IP=127.0.0.1
SERVICE_HOST=$HOST_IP

OS_AUTH_URL

Authenticating against an OpenStack cloud using Keystone returns a Token and Service Catalog. The catalog contains the endpoints for all services the user/tenant has access to - including Nova, Glance, Keystone and Swift.

OS_AUTH_URL=http://$SERVICE_HOST:5000/v2.0

GLANCE_HOST

Some exercises call Glance directly. On a single-node installation, Glance should be listening on HOST_IP. If its running elsewhere it can be set here.

GLANCE_HOST=$HOST_IP

KEYSTONECLIENT_DEBUG, NOVACLIENT_DEBUG

Set command-line client log level to DEBUG. These are commented out by default.

# export KEYSTONECLIENT_DEBUG=1
# export NOVACLIENT_DEBUG=1

2.6 KiB Raw Blame History

openrc User authentication settings

2.6 KiB

Raw Blame History