Browse Source

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>
tags/5.0.0
Sean McGinnis 5 months ago
parent
commit
61fec71adb
3 changed files with 7 additions and 7 deletions
  1. 3
    3
      doc/source/cli/index.rst
  2. 2
    2
      doc/source/index.rst
  3. 2
    2
      doc/source/user/shell.rst

+ 3
- 3
doc/source/cli/index.rst View File

@@ -24,13 +24,13 @@ Storage Service (Cinder).
24 24
 
25 25
 In order to use the CLI, you must provide your OpenStack username, password,
26 26
 project (historically called tenant), and auth endpoint. You can use
27
-configuration options `--os-username`, `--os-password`, `--os-tenant-name` or
28
-`--os-tenant-id`, and `--os-auth-url` or set corresponding environment
27
+configuration options `--os-username`, `--os-password`, `--os-project-name` or
28
+`--os-project-id`, and `--os-auth-url` or set corresponding environment
29 29
 variables::
30 30
 
31 31
     export OS_USERNAME=user
32 32
     export OS_PASSWORD=pass
33
-    export OS_TENANT_NAME=myproject
33
+    export OS_PROJECT_NAME=myproject
34 34
     export OS_AUTH_URL=http://auth.example.com:5000/v3
35 35
 
36 36
 You can select an API version to use by `--os-volume-api-version` option or by

+ 2
- 2
doc/source/index.rst View File

@@ -6,7 +6,7 @@ and identify which endpoint you wish to speak to. Once you have done so, you
6 6
 can use the API like so::
7 7
 
8 8
     >>> from cinderclient import client
9
-    >>> cinder = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_TENANT_NAME, $OS_AUTH_URL)
9
+    >>> cinder = client.Client('1', $OS_USER_NAME, $OS_PASSWORD, $OS_PROJECT_NAME, $OS_AUTH_URL)
10 10
     >>> cinder.volumes.list()
11 11
     []
12 12
     >>> myvol = cinder.volumes.create(display_name="test-vol", size=1)
@@ -91,7 +91,7 @@ The following are kept for historical purposes.
91 91
 
92 92
 * Fixed usage of the --debug option.
93 93
 * Documentation and API example improvements.
94
-* Set max volume size limit for the tenant.
94
+* Set max volume size limit for the project.
95 95
 * Added encryption-type-update to cinderclient.
96 96
 * Added volume multi attach support.
97 97
 * Support host-attach of volumes.

+ 2
- 2
doc/source/user/shell.rst View File

@@ -20,7 +20,7 @@ variables by setting two environment variables:
20 20
 
21 21
     Your password.
22 22
 
23
-.. envvar:: OS_TENANT_NAME or CINDER_PROJECT_ID
23
+.. envvar:: OS_PROJECT_NAME or CINDER_PROJECT_ID
24 24
 
25 25
     Project for work.
26 26
 
@@ -36,7 +36,7 @@ For example, in Bash you'd use::
36 36
 
37 37
     export OS_USERNAME=yourname
38 38
     export OS_PASSWORD=yadayadayada
39
-    export OS_TENANT_NAME=myproject
39
+    export OS_PROJECT_NAME=myproject
40 40
     export OS_AUTH_URL=http://auth.example.com:5000/v3
41 41
     export OS_VOLUME_API_VERSION=3
42 42
 

Loading…
Cancel
Save