nova/doc/source/admin/configuration/api.rst
Stephen Finucane 76549775fe docs: Change formatting of hypervisor config guides
Use the formatting established in the style guide. There's a lot of
out-of-date information in here, but that's a battle for another day.

Change-Id: Ieec2c8f450c05a2451179e3bdba77514f2cc956e
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:16:42 +00:00

28 lines
1.2 KiB
ReStructuredText

=========================
Compute API configuration
=========================
The Compute API, is the component of OpenStack Compute that receives and
responds to user requests, whether they be direct API calls, or via the CLI
tools or dashboard.
Configure Compute API password handling
---------------------------------------
The OpenStack Compute API enables users to specify an administrative password
when they create, rebuild, rescue or evacuate a server instance.
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
and might require additional configuration of the instance. For example, you
might have to install an agent to handle the password setting. If the
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
misleading because it was ignored.
To prevent this confusion, set the ``enable_instance_password`` configuration
to ``False`` to disable the return of the admin password for installations that
do not support setting instance passwords.