From f44d28590b6fd5ee01fe417a57ab44c3dacbdab2 Mon Sep 17 00:00:00 2001 From: jichen Date: Thu, 3 May 2018 17:37:27 +0800 Subject: [PATCH] [doc] enhance admin/configuration/api.rst enhance doc including remove 'nova-api' daemon which is deprecated to use wsgi instead, and added some operations for password response. Change-Id: I4cb7ac55683951aa5900699ba587da03c22fb0a1 --- doc/source/admin/configuration/api.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/source/admin/configuration/api.rst b/doc/source/admin/configuration/api.rst index 21048265259b..979169ee8f8d 100644 --- a/doc/source/admin/configuration/api.rst +++ b/doc/source/admin/configuration/api.rst @@ -2,16 +2,17 @@ Compute API configuration ========================= -The Compute API, run by the ``nova-api`` daemon, 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. +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 or rebuild a server instance. If the user does not specify a -password, a random password is generated and returned in the API response. +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 @@ -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 misleading because it was ignored. -To prevent this confusion, use the ``enable_instance_password`` configuration -option to disable the return of the admin password for installations that do -not support setting instance passwords. +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.