openstack
/
nova
Code Issues Proposed changes

Merge "[doc] enhance admin/configuration/api.rst"

This commit is contained in:
Zuul 2018-07-03 18:59:32 +00:00 committed by Gerrit Code Review
parent 7a57c472bc f44d28590b
commit 6a10534526
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/source/admin/configuration/api.rst
View File

@ -2,16 +2,17 @@
Compute API configuration Compute API configuration
========================= =========================
The Compute API, run by the ``nova-api`` daemon, is the component of OpenStack The Compute API, is the component of OpenStack Compute that receives and
Compute that receives and responds to user requests, whether they be direct API responds to user requests, whether they be direct API calls, or via the CLI
calls, or via the CLI tools or dashboard. tools or dashboard.
Configure Compute API password handling Configure Compute API password handling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The OpenStack Compute API enables users to specify an administrative password The OpenStack Compute API enables users to specify an administrative password
when they create or rebuild a server instance. If the user does not specify a when they create, rebuild, rescue or evacuate a server instance.
password, a random password is generated and returned in the API response. If the user does not specify a password, a random password is generated
and returned in the API response.
In practice, how the admin password is handled depends on the hypervisor in use In practice, how the admin password is handled depends on the hypervisor in use
and might require additional configuration of the instance. For example, you and might require additional configuration of the instance. For example, you
@ -20,6 +21,6 @@ hypervisor and instance configuration do not support setting a password at
server create time, the password that is returned by the create API call is server create time, the password that is returned by the create API call is
misleading because it was ignored. misleading because it was ignored.
To prevent this confusion, use the ``enable_instance_password`` configuration To prevent this confusion, set the ``enable_instance_password`` configuration
option to disable the return of the admin password for installations that do to ``False`` to disable the return of the admin password for installations that
not support setting instance passwords. do not support setting instance passwords.