Added OpenStackClient commands in manage projects, users and roles section

Removed deprecated keystone CLI commands, and replaced with OpenStackClient commands

Change-Id: Id5216dc23f07e51913feeaf34a0422c880b1f437
backport: kilo
Closes-Bug: #1446236
This commit is contained in:
darrenchan
2015-05-08 13:36:40 +10:00
committed by Gauvain Pocentek
parent 31f5cf546c
commit 1ee2e0afec

View File

@@ -33,62 +33,64 @@ file
Services
~~~~~~~~
To look at your service catalog, use these keystone client commands.
To look at your service catalog, use the OpenStack common client commands.
``service-create``
``service create``
^^^^^^^^^^^^^^^^^^
Keyword arguments:
- Name
- Type
- Description
Positional argument:
- Type, name or ID
Example:
.. code::
$ keystone service-create \
$ openstack service create \
--name nova \
--type compute \
--description "Nova Compute Service"
--description "Nova Compute Service" \
compute
``service-list``
``service list``
^^^^^^^^^^^^^^^^
Example:
.. code::
$ keystone service-list
$ openstack service list
``service-get``
^^^^^^^^^^^^^^^
``service show``
^^^^^^^^^^^^^^^^
Arguments
Positional argument:
- service\_id
- Type, name or ID
Example:
.. code::
$ keystone service-get 08741d8ed88242ca88d1f61484a0fe3b
$ openstack service show 08741d8ed88242ca88d1f61484a0fe3b
``service-delete``
``service delete``
^^^^^^^^^^^^^^^^^^
Arguments
Positional argument:
- service\_id
- Type, name or ID
Example:
.. code::
$ keystone service-delete 08741d8ed88242ca88d1f61484a0fe3b
$ openstack service delete 08741d8ed88242ca88d1f61484a0fe3b
Create a tenant (project)
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -104,38 +106,38 @@ with it.
.. code::
$ keystone tenant-list
$ openstack project list
.. code::
+----------------------------------+--------------------+---------+
| id | name | enabled |
+----------------------------------+--------------------+---------+
| f7ac731cc11f40efbc03a9f9e1d1d21f | admin | True |
| c150ab41f0d9443f8874e32e725a4cc8 | alt_demo | True |
| a9debfe41a6d4d09a677da737b907d5e | demo | True |
| 9208739195a34c628c58c95d157917d7 | invisible_to_admin | True |
| 3943a53dc92a49b2827fae94363851e1 | service | True |
| 80cab5e1f02045abad92a2864cfd76cb | test_project | True |
+----------------------------------+--------------------+---------+
+----------------------------------+--------------------+
| id | name |
+----------------------------------+--------------------+
| f7ac731cc11f40efbc03a9f9e1d1d21f | admin |
| c150ab41f0d9443f8874e32e725a4cc8 | alt_demo |
| a9debfe41a6d4d09a677da737b907d5e | demo |
| 9208739195a34c628c58c95d157917d7 | invisible_to_admin |
| 3943a53dc92a49b2827fae94363851e1 | service |
| 80cab5e1f02045abad92a2864cfd76cb | test_project |
+----------------------------------+--------------------+
#. Create a project named ``new-project``:
.. code::
$ keystone tenant-create --name new-project --description 'my new project'
$ openstack project create --description 'my new project' new-project
By default, the project is enabled.
.. code::
+-------------+----------------------------------+
| Property | Value |
| Field | Value |
+-------------+----------------------------------+
| description | my new project |
| enabled | True |
| id | 1a4a0618b306462c9830f876b0bd6af2 |
| name | new-project |
| description | my new project |
| enabled | True |
| id | 1a4a0618b306462c9830f876b0bd6af2 |
| name | new-project |
+-------------+----------------------------------+
Note the ID for the project so you can update it in the next
@@ -151,35 +153,35 @@ description, and enabled status of a project.
.. code::
$ keystone tenant-update PROJECT_ID --enabled false
$ openstack project set PROJECT_ID --disable
#. To enable a disabled project:
.. code::
$ keystone tenant-update PROJECT_ID --enabled true
$ openstack project set PROJECT_ID --enable
#. To update the name of a project:
.. code::
$ keystone tenant-update PROJECT_ID --name project-new
$ openstack project set PROJECT_ID --name project-new
#. To verify your changes, show information for the updated project:
.. code::
$ keystone tenant-get PROJECT_ID
$ openstack project show PROJECT_ID
.. code::
+-------------+----------------------------------+
| Property | Value |
| Field | Value |
+-------------+----------------------------------+
| description | my new project |
| enabled | True |
| id | 1a4a0618b306462c9830f876b0bd6af2 |
| name | project-new |
| description | my new project |
| enabled | True |
| id | 1a4a0618b306462c9830f876b0bd6af2 |
| name | project-new |
+-------------+----------------------------------+
Delete a project
@@ -189,7 +191,7 @@ Delete a project
.. code::
$ keystone tenant-delete PROJECT_ID
$ openstack project delete PROJECT_ID
Create a user
^^^^^^^^^^^^^
@@ -198,21 +200,20 @@ Create a user
.. code::
$ keystone user-list
$ openstack user list
The output shows the ID, name, enabled status, and e-mail address for
each user:
The output shows the ID and name for each user:
.. code::
+----------------------------------+----------+---------+----------------------+
| id | name | enabled | email |
+----------------------------------+----------+---------+----------------------+
| 352b37f5c89144d4ad0534139266d51f | admin | True | admin@example.com |
| 86c0de739bcb4802b8dc786921355813 | demo | True | demo@example.com |
| 32ec34aae8ea432e8af560a1cec0e881 | glance | True | glance@example.com |
| 7047fcb7908e420cb36e13bbd72c972c | nova | True | nova@example.com |
+----------------------------------+----------+---------+----------------------+
+----------------------------------+----------+
| id | name |
+----------------------------------+----------+
| 352b37f5c89144d4ad0534139266d51f | admin |
| 86c0de739bcb4802b8dc786921355813 | demo |
| 32ec34aae8ea432e8af560a1cec0e881 | glance |
| 7047fcb7908e420cb36e13bbd72c972c | nova |
+----------------------------------+----------+
#. To create a user, you must specify a name. Optionally, you can
specify a tenant ID, password, and email address. It is recommended
@@ -223,18 +224,18 @@ Create a user
.. code::
$ keystone user-create --name new-user --tenant_id 1a4a0618b306462c9830f876b0bd6af2 --pass PASSWORD
$ openstack user create --project new-project --password PASSWORD new-user
.. code::
+----------+----------------------------------+
| Property | Value |
| Field | Value |
+----------+----------------------------------+
| email | |
| enabled | True |
| id | 6e5140962b424cb9814fb172889d3be2 |
| name | new-user |
| tenantId | 1a4a0618b306462c9830f876b0bd6af2 |
| email | |
| enabled | True |
| id | 6e5140962b424cb9814fb172889d3be2 |
| name | new-user |
| tenantId | new-project |
+----------+----------------------------------+
Update a user
@@ -246,7 +247,7 @@ You can update the name, email address, and enabled status for a user.
.. code::
$ keystone user-update USER_ID --enabled false
$ openstack user set USER_NAME --disable
If you disable a user account, the user cannot log in to the
dashboard. However, data for the user account is maintained, so you
@@ -256,13 +257,13 @@ You can update the name, email address, and enabled status for a user.
.. code::
$ keystone user-update USER_ID --enabled true
$ openstack user set USER_NAME --enable
#. To change the name and description for a user account:
.. code::
$ keystone user-update USER_ID --name user-new --email new-user@example.com
$ openstack user set USER_NAME --name user-new --email new-user@example.com
.. code::
@@ -275,7 +276,7 @@ Delete a user
.. code::
$ keystone user-delete USER_ID
$ openstack user delete USER_NAME
Create and assign a role
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -287,34 +288,34 @@ projects, define a role and assign that role to a user-project pair.
.. code::
$ keystone role-list
$ openstack user list
.. code::
+----------------------------------+---------------+
| id | name |
| id | name |
+----------------------------------+---------------+
| 71ccc37d41c8491c975ae72676db687f | Member |
| 71ccc37d41c8491c975ae72676db687f | Member |
| 149f50a1fe684bfa88dae76a48d26ef7 | ResellerAdmin |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_ |
| 6ecf391421604da985db2f141e46a7c8 | admin |
| deb4fffd123c4d02a907c2c74559dccf | anotherrole |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_ |
| 6ecf391421604da985db2f141e46a7c8 | admin |
| deb4fffd123c4d02a907c2c74559dccf | anotherrole |
+----------------------------------+---------------+
#. To create the ``new-role`` role:
.. code::
$ keystone role-create --name new-role
$ openstack role create new-role
.. code::
+----------+----------------------------------+
| Property | Value |
+----------+----------------------------------+
| id | bef1f95537914b1295da6aa038ef4de6 |
| name | new-role |
+----------+----------------------------------+
+--------+----------------------------------+
| Field | Value |
+--------+----------------------------------+
| id | bef1f95537914b1295da6aa038ef4de6 |
| name | new-role |
+--------+----------------------------------+
#. To assign a user to a project, you must assign the role to a
user-project pair. To do this, you need the user, role, and project
@@ -324,114 +325,114 @@ projects, define a role and assign that role to a user-project pair.
.. code::
$ keystone user-list
$ openstack user list
.. code::
+----------------------------------+----------+---------+----------------------+
| id | name | enabled | email |
| id | name | enabled | email |
+----------------------------------+----------+---------+----------------------+
| 352b37f5c89144d4ad0534139266d51f | admin | True | admin@example.com |
| 981422ec906d4842b2fc2a8658a5b534 | alt_demo | True | alt_demo@example.com |
| 036e22a764ae497992f5fb8e9fd79896 | cinder | True | cinder@example.com |
| 86c0de739bcb4802b8dc786921355813 | demo | True | demo@example.com |
| 32ec34aae8ea432e8af560a1cec0e881 | glance | True | glance@example.com |
| 7047fcb7908e420cb36e13bbd72c972c | nova | True | nova@example.com |
| 352b37f5c89144d4ad0534139266d51f | admin | True | admin@example.com |
| 981422ec906d4842b2fc2a8658a5b534 | alt_demo | True | alt_demo@example.com |
| 036e22a764ae497992f5fb8e9fd79896 | cinder | True | cinder@example.com |
| 86c0de739bcb4802b8dc786921355813 | demo | True | demo@example.com |
| 32ec34aae8ea432e8af560a1cec0e881 | glance | True | glance@example.com |
| 7047fcb7908e420cb36e13bbd72c972c | nova | True | nova@example.com |
+----------------------------------+----------+---------+----------------------+
Note the ID of the user to which you want to assign the role.
Note the user ID to be assigned to the role.
#. To list role IDs:
.. code::
$ keystone role-list
$ openstack role list
.. code::
+----------------------------------+---------------+
| id | name |
| id | name |
+----------------------------------+---------------+
| 71ccc37d41c8491c975ae72676db687f | Member |
| 71ccc37d41c8491c975ae72676db687f | Member |
| 149f50a1fe684bfa88dae76a48d26ef7 | ResellerAdmin |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_ |
| 6ecf391421604da985db2f141e46a7c8 | admin |
| deb4fffd123c4d02a907c2c74559dccf | anotherrole |
| bef1f95537914b1295da6aa038ef4de6 | new-role |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_ |
| 6ecf391421604da985db2f141e46a7c8 | admin |
| deb4fffd123c4d02a907c2c74559dccf | anotherrole |
| bef1f95537914b1295da6aa038ef4de6 | new-role |
+----------------------------------+---------------+
Note the ID of the role that you want to assign.
Note the role ID to be assigned.
#. To list projects:
.. code::
$ keystone tenant-list
$ openstack project list
.. code::
+----------------------------------+--------------------+---------+
| id | name | enabled |
| id | name | enabled |
+----------------------------------+--------------------+---------+
| f7ac731cc11f40efbc03a9f9e1d1d21f | admin | True |
| c150ab41f0d9443f8874e32e725a4cc8 | alt_demo | True |
| a9debfe41a6d4d09a677da737b907d5e | demo | True |
| f7ac731cc11f40efbc03a9f9e1d1d21f | admin | True |
| c150ab41f0d9443f8874e32e725a4cc8 | alt_demo | True |
| a9debfe41a6d4d09a677da737b907d5e | demo | True |
| 9208739195a34c628c58c95d157917d7 | invisible_to_admin | True |
| caa9b4ce7d5c4225aa25d6ff8b35c31f | new-user | True |
| 1a4a0618b306462c9830f876b0bd6af2 | project-new | True |
| 3943a53dc92a49b2827fae94363851e1 | service | True |
| 80cab5e1f02045abad92a2864cfd76cb | test_project | True |
| caa9b4ce7d5c4225aa25d6ff8b35c31f | new-user | True |
| 1a4a0618b306462c9830f876b0bd6af2 | project-new | True |
| 3943a53dc92a49b2827fae94363851e1 | service | True |
| 80cab5e1f02045abad92a2864cfd76cb | test_project | True |
+----------------------------------+--------------------+---------+
Note the ID of the project to which you want to assign the role.
Note the project ID to be assigned to the role.
#. Assign a role to a user-project pair. In this example, you assign the
#. Assign a role to a user-project pair. In this example, assign the
``new-role`` role to the ``demo`` and ``test-project`` pair:
.. code::
$ keystone user-role-add --user USER_ID --role ROLE_ID --tenant TENANT_ID
$ openstack role add --user USER_NAME --project TENANT_ID ROLE_NAME
#. To verify the role assignment:
.. code::
$ keystone user-role-list --user USER_ID --tenant TENANT_ID
$ openstack role list --user USER_NAME --project TENANT_ID
.. code::
+----------------------------------+----------+----------------------------------+----------------------------------+
| id | name | user_id | tenant_id |
+----------------------------------+----------+----------------------------------+----------------------------------+
| bef1f95537914b1295da6aa038ef4de6 | new-role | 86c0de739bcb4802b8dc786921355813 | 80cab5e1f02045abad92a2864cfd76cb |
+----------------------------------+----------+----------------------------------+----------------------------------+
+--------------+----------+----------------------------------+--------------+
| id | name | user_id | tenant_id |
+--------------+----------+----------------------------------+--------------+
| bef1f9553... | new-role | 86c0de739bcb4802b8dc786921355813 | 80cab5e1f... |
+--------------+----------+----------------------------------+--------------+
#. To get details for a specified role:
.. code::
$ keystone role-get ROLE_ID
$ openstack role show ROLE_NAME
.. code::
+----------+----------------------------------+
| Property | Value |
| Field | Value |
+----------+----------------------------------+
| id | bef1f95537914b1295da6aa038ef4de6 |
| name | new-role |
| id | bef1f95537914b1295da6aa038ef4de6 |
| name | new-role |
+----------+----------------------------------+
#. To remove a role from a user-project pair:
.. code::
$ keystone user-role-remove --user USER_ID --role ROLE_ID --tenant TENANT_ID
$ openstack role remove --user USER_NAME --project TENANT_ID ROLE_NAME
#. To verify the role removal, run the following command:
.. code::
$ keystone user-role-list --user USER_ID --tenant TENANT_ID
$ openstack role list --user USER_NAME --project TENANT_ID
If the role was removed, the command output omits the removed role.