openstack/python-cinderclient
Code Issues Proposed changes

Update docs to refer to PROJECT instead of TENANT

Browse Source 
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>
This commit is contained in:
Sean McGinnis 2019-04-18 16:01:39 -05:00
parent dce8a8ed10
commit 61fec71adb
3 changed files with 7 additions and 7 deletions

6
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

4
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.

4
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