Skip to content

Commit 9c5a850

Browse files
committed
Remove --bypass-url documentation
This was removed with I3b951cc4eb3adff23f3d2cbe674971816261ef56; cleanup old references. Change-Id: I71e6da99dff04d86b9dd67a754764b1e742d366a
1 parent 38a44e7 commit 9c5a850

4 files changed

Lines changed: 10 additions & 16 deletions

File tree

README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ You'll find complete documentation on the shell by running
9090
[--os-endpoint-type <os-endpoint-type>]
9191
[--endpoint-type <endpoint-type>]
9292
[--os-volume-api-version <volume-api-ver>]
93-
[--bypass-url <bypass-url>] [--retries <retries>]
93+
[--retries <retries>]
9494
[--profile HMAC_KEY] [--os-auth-strategy <auth-strategy>]
9595
[--os-username <auth-user-name>] [--os-password <auth-password>]
9696
[--os-tenant-name <auth-tenant-name>]
@@ -254,6 +254,9 @@ You'll find complete documentation on the shell by running
254254
--volume-service-name <volume-service-name>
255255
Volume service name.
256256
Default=env[CINDER_VOLUME_SERVICE_NAME].
257+
--os-endpoint
258+
Use this API endpoint instead of the Service Catalog.
259+
Default=env[CINDER_ENDPOINT]
257260
--os-endpoint-type <os-endpoint-type>
258261
Endpoint type, which is publicURL or internalURL.
259262
Default=env[OS_ENDPOINT_TYPE] or nova
@@ -264,9 +267,6 @@ You'll find complete documentation on the shell by running
264267
Block Storage API version. Accepts X, X.Y (where X is
265268
major and Y is minor
266269
part).Default=env[OS_VOLUME_API_VERSION].
267-
--bypass-url <bypass-url>
268-
Use this API endpoint instead of the Service Catalog.
269-
Defaults to env[CINDERCLIENT_BYPASS_URL].
270270
--retries <retries> Number of retries.
271271
--profile HMAC_KEY HMAC key to use for encrypting context data for
272272
performance profiling of operation. This key needs to

cinderclient/client.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -485,9 +485,8 @@ def get_volume_api_version_from_endpoint(self):
485485
version = get_volume_api_from_url(self.management_url)
486486
except exceptions.UnsupportedVersion as e:
487487
if self.management_url == self.bypass_url:
488-
msg = (_("Invalid url was specified in --os-endpoint or "
489-
"environment variable CINDERCLIENT_BYPASS_URL.\n"
490-
"%s") % six.text_type(e))
488+
msg = (_("Invalid url was specified in --os-endpoint %s")
489+
% six.text_type(e))
491490
else:
492491
msg = (_("Service catalog returned invalid url.\n"
493492
"%s") % six.text_type(e))

doc/source/cli/details.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ cinder usage
4343
[--os-endpoint-type <os-endpoint-type>]
4444
[--endpoint-type <endpoint-type>]
4545
[--os-volume-api-version <volume-api-ver>]
46-
[--bypass-url <bypass-url>] [--os-endpoint <os-endpoint>]
46+
[--os-endpoint <os-endpoint>]
4747
[--retries <retries>] [--profile HMAC_KEY]
4848
[--os-auth-strategy <auth-strategy>]
4949
[--os-username <auth-user-name>] [--os-password <auth-password>]
@@ -877,14 +877,9 @@ cinder optional arguments
877877
major and Y is minor
878878
part).Default= ``env[OS_VOLUME_API_VERSION]``.
879879

880-
``--bypass-url <bypass-url>``
881-
**DEPRECATED!** Use os_endpoint. Use this API endpoint
882-
instead of the Service Catalog. Defaults to
883-
``env[CINDERCLIENT_BYPASS_URL]``.
884-
885880
``--os-endpoint <os-endpoint>``
886881
Use this API endpoint instead of the Service Catalog.
887-
Defaults to ``env[CINDER_ENDPOINT]``.
882+
Default=``env[CINDER_ENDPOINT]``
888883

889884
``--retries <retries>``
890885
Number of retries.

doc/source/user/no_auth.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Using cinderclient
1616
To use the cinderclient you'll need to set the following env variables::
1717

1818
OS_AUTH_TYPE=noauth
19-
CINDERCLIENT_BYPASS_URL=http://<cinder-api-url>:8776/v3
19+
CINDER_ENDPOINT=http://<cinder-api-url>:8776/v3
2020
OS_PROJECT_ID=foo
2121
OS_VOLUME_API_VERSION=3.10
2222

@@ -27,6 +27,6 @@ point, it's noauth.
2727
Each of these options can also be specified on the cmd line::
2828

2929
cinder --os-auth-type=noauth \
30-
--bypass-url=http://<cinder-api-url>:8776/v3 \
30+
--os-endpoint=http://<cinder-api-url>:8776/v3 \
3131
--os-project-id=admin \
3232
--os-volume-api-version=3.10 list

0 commit comments

Comments
 (0)