Merge "changed heat dev docs to comply with conventions"
This commit is contained in:
commit
d7cadf02c9
|
@ -15,7 +15,7 @@ DESCRIPTION
|
||||||
===========
|
===========
|
||||||
heat-db-setup is a tool which configures the local MySQL database for
|
heat-db-setup is a tool which configures the local MySQL database for
|
||||||
heat. Typically distro-specific tools would provide this functionality
|
heat. Typically distro-specific tools would provide this functionality
|
||||||
so please read the distro-specific documentation for configuring Heat.
|
so please read the distro-specific documentation for configuring heat.
|
||||||
|
|
||||||
|
|
||||||
COMMANDS
|
COMMANDS
|
||||||
|
|
|
@ -14,21 +14,21 @@ SYNOPSIS
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
===========
|
===========
|
||||||
|
|
||||||
The `heat-keystone-setup-domain` tool configures Keystone by creating
|
The `heat-keystone-setup-domain` tool configures keystone by creating
|
||||||
a 'stack user domain' and the user credential used to manage this domain.
|
a 'stack user domain' and the user credential used to manage this domain.
|
||||||
A 'stack user domain' can be treated as a namespace for projects,
|
A 'stack user domain' can be treated as a namespace for projects,
|
||||||
groups and users created by Heat. The domain will have an admin user
|
groups and users created by heat. The domain will have an admin user
|
||||||
that manages other users, groups and projects in the domain.
|
that manages other users, groups and projects in the domain.
|
||||||
|
|
||||||
This script requires admin keystone credentials to be available in the
|
This script requires admin keystone credentials to be available in the
|
||||||
shell environment by setting `OS_USERNAME` and `OS_PASSWORD`.
|
shell environment by setting `OS_USERNAME` and `OS_PASSWORD`.
|
||||||
|
|
||||||
After running this script, a user needs to take actions to check or
|
After running this script, a user needs to take actions to check or
|
||||||
modify Heat configuration file (e.g. /etc/heat/heat.conf). The tool
|
modify the heat configuration file (e.g. /etc/heat/heat.conf). The tool
|
||||||
is NOT performing these updates on behalf of the user.
|
is NOT performing these updates on behalf of the user.
|
||||||
|
|
||||||
Distributions may provide other tools to setup 'stack user domain' for
|
Distributions may provide other tools to setup 'stack user domain' for
|
||||||
use with Heat, so check the distro documentation first. Other tools
|
use with heat, so check the distro documentation first. Other tools
|
||||||
are available to set up the 'stack user domain', for example
|
are available to set up the 'stack user domain', for example
|
||||||
`python-openstackclient`, which is preferred to this tool where it is
|
`python-openstackclient`, which is preferred to this tool where it is
|
||||||
available.
|
available.
|
||||||
|
|
|
@ -13,7 +13,7 @@ SYNOPSIS
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
===========
|
===========
|
||||||
The heat-keystone-setup tool configures keystone for use with Heat. This script requires admin keystone credentials to be available in the shell environment and write access to /etc/keystone.
|
The heat-keystone-setup tool configures keystone for use with heat. This script requires admin keystone credentials to be available in the shell environment and write access to /etc/keystone.
|
||||||
|
|
||||||
Distributions may provide other tools to setup keystone for use with Heat, so check the distro documentation first.
|
Distributions may provide other tools to setup keystone for use with Heat, so check the distro documentation first.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue