openstack/python-cinderclient
Code Issues Proposed changes

Remove --bypass-url documentation

Browse Source 
This was removed with I3b951cc4eb3adff23f3d2cbe674971816261ef56;
cleanup old references.

Change-Id: I71e6da99dff04d86b9dd67a754764b1e742d366a
This commit is contained in:
Ian Wienand 2020-03-24 15:47:31 +11:00
parent 38a44e7ebe
commit 9c5a850f5a
4 changed files with 10 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.rst
View File

@ -90,7 +90,7 @@ You'll find complete documentation on the shell by running
[--os-endpoint-type <os-endpoint-type>]
[--endpoint-type <endpoint-type>]
[--os-volume-api-version <volume-api-ver>]
[--bypass-url <bypass-url>] [--retries <retries>]
[--retries <retries>]
[--profile HMAC_KEY] [--os-auth-strategy <auth-strategy>]
[--os-username <auth-user-name>] [--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>]
@ -254,6 +254,9 @@ You'll find complete documentation on the shell by running
--volume-service-name <volume-service-name>
Volume service name.
Default=env[CINDER_VOLUME_SERVICE_NAME].
--os-endpoint
Use this API endpoint instead of the Service Catalog.
Default=env[CINDER_ENDPOINT]
--os-endpoint-type <os-endpoint-type>
Endpoint type, which is publicURL or internalURL.
Default=env[OS_ENDPOINT_TYPE] or nova
@ -264,9 +267,6 @@ You'll find complete documentation on the shell by running
Block Storage API version. Accepts X, X.Y (where X is
major and Y is minor
part).Default=env[OS_VOLUME_API_VERSION].
--bypass-url <bypass-url>
Use this API endpoint instead of the Service Catalog.
Defaults to env[CINDERCLIENT_BYPASS_URL].
--retries <retries> Number of retries.
--profile HMAC_KEY HMAC key to use for encrypting context data for
performance profiling of operation. This key needs to

5
cinderclient/client.py
View File

@ -485,9 +485,8 @@ class HTTPClient(object):
version = get_volume_api_from_url(self.management_url)
except exceptions.UnsupportedVersion as e:
if self.management_url == self.bypass_url:
msg = (_("Invalid url was specified in --os-endpoint or "
"environment variable CINDERCLIENT_BYPASS_URL.\n"
"%s") % six.text_type(e))
msg = (_("Invalid url was specified in --os-endpoint %s")
% six.text_type(e))
else:
msg = (_("Service catalog returned invalid url.\n"
"%s") % six.text_type(e))

9
doc/source/cli/details.rst
View File

@ -43,7 +43,7 @@ cinder usage
[--os-endpoint-type <os-endpoint-type>]
[--endpoint-type <endpoint-type>]
[--os-volume-api-version <volume-api-ver>]
[--bypass-url <bypass-url>] [--os-endpoint <os-endpoint>]
[--os-endpoint <os-endpoint>]
[--retries <retries>] [--profile HMAC_KEY]
[--os-auth-strategy <auth-strategy>]
[--os-username <auth-user-name>] [--os-password <auth-password>]
@ -877,14 +877,9 @@ cinder optional arguments
major and Y is minor
part).Default= ``env[OS_VOLUME_API_VERSION]``.
``--bypass-url <bypass-url>``
**DEPRECATED!** Use os_endpoint. Use this API endpoint
instead of the Service Catalog. Defaults to
``env[CINDERCLIENT_BYPASS_URL]``.
``--os-endpoint <os-endpoint>``
Use this API endpoint instead of the Service Catalog.
Defaults to ``env[CINDER_ENDPOINT]``.
Default=``env[CINDER_ENDPOINT]``
``--retries <retries>``
Number of retries.

4
doc/source/user/no_auth.rst
View File

@ -16,7 +16,7 @@ Using cinderclient
To use the cinderclient you'll need to set the following env variables::
OS_AUTH_TYPE=noauth
CINDERCLIENT_BYPASS_URL=http://<cinder-api-url>:8776/v3
CINDER_ENDPOINT=http://<cinder-api-url>:8776/v3
OS_PROJECT_ID=foo
OS_VOLUME_API_VERSION=3.10
@ -27,6 +27,6 @@ point, it's noauth.
Each of these options can also be specified on the cmd line::
cinder --os-auth-type=noauth \
--bypass-url=http://<cinder-api-url>:8776/v3 \
--os-endpoint=http://<cinder-api-url>:8776/v3 \
--os-project-id=admin \
--os-volume-api-version=3.10 list