From 701dd67d6c303bd9199b3185ecbb3c9b3f55c79b Mon Sep 17 00:00:00 2001 From: Snow Kim Date: Sun, 31 Jul 2022 19:10:10 +0900 Subject: [PATCH] Fix documents for replaced configuration name Since 4.0, '--os-url' global option is no longer supported. And this option had been replaced to '--os-endpoint' - Refer Change-Id: I1b9fbb96e447889a41b705324725a2ffc8ecfd9f - Refer Docs: doc/source/cli/backwards-incompatible.rs I fixed in documents as below - OPTIONS: '--os-url' to '--os-endpoint' - ENVIRONMENT VARIABLES: 'OS_URL' to 'OS_ENDPOINT' - and relevant sentence Change-Id: Ibb0cddf34375df941678ee07a005d81399ec7195 --- doc/source/cli/authentication.rst | 2 +- doc/source/cli/man/openstack.rst | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/cli/authentication.rst b/doc/source/cli/authentication.rst index 2e9148c356..2b3ad5dafc 100644 --- a/doc/source/cli/authentication.rst +++ b/doc/source/cli/authentication.rst @@ -36,7 +36,7 @@ There are at least three authentication types that are always available: URL for the Identity service is also required. [Required: ``--os-auth-url``, ``--os-project-name``, ``--os-username``; Optional: ``--os-password``] * **Token**: This is slightly different from the usual token authentication - (described below as token/endpoint) in that a token and an authentication + in that a token and an authentication URL are supplied and the plugin retrieves a new token. [Required: ``--os-auth-url``, ``--os-token``] * **Others**: Other authentication plugins such as SAML, Kerberos, and OAuth1.0 diff --git a/doc/source/cli/man/openstack.rst b/doc/source/cli/man/openstack.rst index dc327a66e8..29db064199 100644 --- a/doc/source/cli/man/openstack.rst +++ b/doc/source/cli/man/openstack.rst @@ -49,7 +49,7 @@ command line. The primary difference is the use of 'project' in the name of the Refer to the keystoneclient library documentation for more details about these plugins and their options, and for a complete list of available plugins. Please bear in mind that some plugins might not support all of the functionalities of :program:`openstack`; for example the v3unscopedsaml plugin can deliver only unscoped tokens, some commands might not be available through this authentication method. -Additionally, it is possible to use Keystone's service token to authenticate, by setting the options :option:`--os-token` and :option:`--os-url` (or the environment variables :envvar:`OS_TOKEN` and :envvar:`OS_URL` respectively). This method takes precedence over authentication plugins. +Additionally, it is possible to use Keystone's service token to authenticate, by setting the options :option:`--os-token` and :option:`--os-endpoint` (or the environment variables :envvar:`OS_TOKEN` and :envvar:`OS_ENDPOINT` respectively). This method takes precedence over authentication plugins. .. NOTE:: To use the ``v3unscopedsaml`` method, the lxml package will need to be installed. @@ -106,9 +106,9 @@ OPTIONS Authentication URL -.. option:: --os-url +.. option:: --os-endpoint - Service URL, when using a service token for authentication + Service ENDPOINT, when using a service token for authentication .. option:: --os-domain-name @@ -349,7 +349,7 @@ file, but if those are incomplete it may be impossible to know which auth type is intended. The :option:`--os-auth-type` option can always be used to force a specific type. -When :option:`--os-token` and :option:`--os-url` are both present the +When :option:`--os-token` and :option:`--os-endpoint` are both present the ``token_endpoint`` auth type is selected automatically. If :option:`--os-auth-url` and :option:`--os-username` are present ``password`` auth type is selected. @@ -466,9 +466,9 @@ The following environment variables can be set to alter the behaviour of :progra - ``v3applicationcredential`` - ``v3multifactor`` -.. envvar:: OS_URL +.. envvar:: OS_ENDPOINT - Service URL (when using the service token) + Service ENDPOINT (when using the service token) .. envvar:: OS_DOMAIN_NAME