diff options
| author | Sean McGinnis <sean.mcginnis@gmail.com> | 2019-04-18 16:01:39 -0500 |
|---|---|---|
| committer | Sean McGinnis <sean.mcginnis@gmail.com> | 2019-09-10 15:56:27 -0500 |
| commit | 61fec71adbcff8b62312d2e814c8af4879d169be (patch) | |
| tree | 85aa127ca08a4fddbdfec4ceedbbb72d94d09209 | |
| parent | dce8a8ed106f2581df27c172a2a002ea8cbeb20e (diff) | |
| download | python-cinderclient-61fec71adbcff8b62312d2e814c8af4879d169be.tar.gz | |
Update docs to refer to PROJECT instead of TENANT
Updates several references for things like OS_TENANT_NAME and
--os-tenant-name.
Change-Id: If71710740b4d4573a1b3f515a5762a4f82bc727d
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
| -rw-r--r-- | doc/source/cli/index.rst | 6 | ||||
| -rw-r--r-- | doc/source/index.rst | 4 | ||||
| -rw-r--r-- | doc/source/user/shell.rst | 4 |
3 files changed, 7 insertions, 7 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index cdb39af..1c877dd 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -24,13 +24,13 @@ Storage Service (Cinder). In order to use the CLI, you must provide your OpenStack username, password, project (historically called tenant), and auth endpoint. You can use -configuration options `--os-username`, `--os-password`, `--os-tenant-name` or -`--os-tenant-id`, and `--os-auth-url` or set corresponding environment +configuration options `--os-username`, `--os-password`, `--os-project-name` or +`--os-project-id`, and `--os-auth-url` or set corresponding environment variables:: export OS_USERNAME=user export OS_PASSWORD=pass - export OS_TENANT_NAME=myproject + export OS_PROJECT_NAME=myproject export OS_AUTH_URL=http://auth.example.com:5000/v3 You can select an API version to use by `--os-volume-api-version` option or by diff --git a/doc/source/index.rst b/doc/source/index.rst index edf0695..0859574 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,7 +6,7 @@ and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so:: >>> from cinderclient import client - >>> cinder = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_TENANT_NAME, $OS_AUTH_URL) + >>> cinder = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_PROJECT_NAME, $OS_AUTH_URL) >>> cinder.volumes.list() [] >>> myvol = cinder.volumes.create(display_name="test-vol", size=1) @@ -91,7 +91,7 @@ The following are kept for historical purposes. * Fixed usage of the --debug option. * Documentation and API example improvements. -* Set max volume size limit for the tenant. +* Set max volume size limit for the project. * Added encryption-type-update to cinderclient. * Added volume multi attach support. * Support host-attach of volumes. diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst index 50d8feb..a06fbff 100644 --- a/doc/source/user/shell.rst +++ b/doc/source/user/shell.rst @@ -20,7 +20,7 @@ variables by setting two environment variables: Your password. -.. envvar:: OS_TENANT_NAME or CINDER_PROJECT_ID +.. envvar:: OS_PROJECT_NAME or CINDER_PROJECT_ID Project for work. @@ -36,7 +36,7 @@ For example, in Bash you'd use:: export OS_USERNAME=yourname export OS_PASSWORD=yadayadayada - export OS_TENANT_NAME=myproject + export OS_PROJECT_NAME=myproject export OS_AUTH_URL=http://auth.example.com:5000/v3 export OS_VOLUME_API_VERSION=3 |