summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorIan Wienand <iwienand@redhat.com>2020-03-24 15:47:31 +1100
committerIan Wienand <iwienand@redhat.com>2020-03-24 18:41:21 +1100
commit9c5a850f5aad8def78434f4ec4c7ca2f9aa8d25d (patch)
treea59f88ac351d52d17c41bd701ee332bb4a54f18f /doc
parent38a44e7ebeead6c086374d80f25d135618380faa (diff)
downloadpython-cinderclient-9c5a850f5aad8def78434f4ec4c7ca2f9aa8d25d.tar.gz
Remove --bypass-url documentation
This was removed with I3b951cc4eb3adff23f3d2cbe674971816261ef56; cleanup old references. Change-Id: I71e6da99dff04d86b9dd67a754764b1e742d366a
Diffstat (limited to 'doc')
-rw-r--r--doc/source/cli/details.rst9
-rw-r--r--doc/source/user/no_auth.rst4
2 files changed, 4 insertions, 9 deletions
diff --git a/doc/source/cli/details.rst b/doc/source/cli/details.rst
index 9ced4c6..e182fa5 100644
--- a/doc/source/cli/details.rst
+++ b/doc/source/cli/details.rst
@@ -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.
diff --git a/doc/source/user/no_auth.rst b/doc/source/user/no_auth.rst
index 71a65e9..597b69a 100644
--- a/doc/source/user/no_auth.rst
+++ b/doc/source/user/no_auth.rst
@@ -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