Gudrun Wolfgram 08f0c4aa46 Cloud Admin Guide CLI chapter

Moving (copying) Admin User Guide CLI content to
the Cloud Admin Guide as a part of the reorganization
goal. This patch does not include any new or original
content.

This patch is Part 1 to create a new command-
line client section for Admin Users in the Cloud Admin
Guide, as disucssed in the User Guide Specialty team
meetings.

1) Creating a new CLI section with cli.rst

2) Moving the non common files from user-guide-admin to
admin-guide-cloud, along with their sub files. (Rename
user-guide-admin files to user cli_ prefix in admin-
guide-cloud.)
manage_projects_users_and_roles.rst
nova_cli_manage_projects_security.rst
cli_manage_services.rst
cli_manage_shares.rst
cli_manage_flavors.rst
cli_admin_manage_environment.rst
cli_set_quotas.rst
analyzing-log-files-with-swift-cli.rst
cli_cinder_scheduling.rst

3) Attempt updates to several links.

Change-Id: I97f4ced4f5033c7e0f3bf00c410288a75699d110
Implements: blueprint user-guides-reorganised

2016-03-07 15:51:49 -06:00

12 KiB

Raw Blame History

Manage projects, users, and roles

As a cloud administrator, you manage projects, users, and roles. Projects are organizational units in the cloud to which you can assign users. Projects are also known as tenants or accounts. Users can be members of one or more projects. Roles define which actions users can perform. You assign roles to user-project pairs.

You can define actions for OpenStack service roles in the /etc/PROJECT/policy.json files. For example, define actions for Compute service roles in the /etc/nova/policy.json file.

You can manage projects, users, and roles independently from each other.

During cloud set up, the operator defines at least one project, user, and role.

You can add, update, and delete projects and users, assign users to one or more projects, and change or remove the assignment. To enable or temporarily disable a project or user, update that project or user. You can also change quotas at the project level.

Before you can delete a user account, you must remove the user account from its primary project.

Before you can run client commands, you must download and source an OpenStack RC file. See Download and source the OpenStack RC file.

Projects

A project is a group of zero or more users. In Compute, a project owns virtual machines. In Object Storage, a project owns containers. Users can be associated with more than one project. Each project and user pairing can have a role associated with it.

List projects

List all projects with their ID, name, and whether they are enabled or disabled:

$ openstack project list
+----------------------------------+--------------------+
| id                               | name               |
+----------------------------------+--------------------+
| f7ac731cc11f40efbc03a9f9e1d1d21f | admin              |
| c150ab41f0d9443f8874e32e725a4cc8 | alt_demo           |
| a9debfe41a6d4d09a677da737b907d5e | demo               |
| 9208739195a34c628c58c95d157917d7 | invisible_to_admin |
| 3943a53dc92a49b2827fae94363851e1 | service            |
| 80cab5e1f02045abad92a2864cfd76cb | test_project       |
+----------------------------------+--------------------+

Create a project

Create a project named new-project:

$ openstack project create --description 'my new project' new-project
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description | my new project                   |
| enabled     | True                             |
| id          | 1a4a0618b306462c9830f876b0bd6af2 |
| name        | new-project                      |
+-------------+----------------------------------+

Update a project

Specify the project ID to update a project. You can update the name, description, and enabled status of a project.

To temporarily disable a project:

$ openstack project set PROJECT_ID --disable

To enable a disabled project:

$ openstack project set PROJECT_ID --enable

To update the name of a project:

$ openstack project set PROJECT_ID --name project-new

To verify your changes, show information for the updated project:

$ openstack project show PROJECT_ID
+-------------+----------------------------------+
| Field       | Value                            |
+-------------+----------------------------------+
| description | my new project                   |
| enabled     | True                             |
| id          | 1a4a0618b306462c9830f876b0bd6af2 |
| name        | project-new                      |
+-------------+----------------------------------+

Delete a project

Specify the project ID to delete a project:

$ openstack project delete PROJECT_ID

Users

List users

List all users:

$ openstack user list
+----------------------------------+----------+
| id                               | name     |
+----------------------------------+----------+
| 352b37f5c89144d4ad0534139266d51f | admin    |
| 86c0de739bcb4802b8dc786921355813 | demo     |
| 32ec34aae8ea432e8af560a1cec0e881 | glance   |
| 7047fcb7908e420cb36e13bbd72c972c | nova     |
+----------------------------------+----------+

Create a user

To create a user, you must specify a name. Optionally, you can specify a tenant ID, password, and email address. It is recommended that you include the tenant ID and password because the user cannot log in to the dashboard without this information.

Create the new-user user:

$ openstack user create --project new-project --password PASSWORD new-user
+----------+----------------------------------+
| Field    | Value                            |
+----------+----------------------------------+
| email    |                                  |
| enabled  | True                             |
| id       | 6e5140962b424cb9814fb172889d3be2 |
| name     | new-user                         |
| tenantId | new-project                      |
+----------+----------------------------------+

Update a user

You can update the name, email address, and enabled status for a user.

To temporarily disable a user account:
```
$ 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 can enable the user at any time.
To enable a disabled user account:
```
$ openstack user set USER_NAME --enable
```

To change the name and description for a user account:

$ openstack user set USER_NAME --name user-new --email new-user@example.com
User has been updated.

Delete a user

Delete a specified user account:

$ openstack user delete USER_NAME

Roles and role assignments

List available roles

List the available roles:

$ openstack role list
+----------------------------------+---------------+
| id                               | name          |
+----------------------------------+---------------+
| 71ccc37d41c8491c975ae72676db687f | Member        |
| 149f50a1fe684bfa88dae76a48d26ef7 | ResellerAdmin |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_      |
| 6ecf391421604da985db2f141e46a7c8 | admin         |
| deb4fffd123c4d02a907c2c74559dccf | anotherrole   |
+----------------------------------+---------------+

Create a role

Users can be members of multiple projects. To assign users to multiple projects, define a role and assign that role to a user-project pair.

Create the new-role role:

$ openstack role create new-role
+--------+----------------------------------+
| Field  | Value                            |
+--------+----------------------------------+
| id     | bef1f95537914b1295da6aa038ef4de6 |
| name   | new-role                         |
+--------+----------------------------------+

Assign a 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 IDs.

List users and note the user ID you want to assign to the role:

$ openstack user list
+----------------------------------+----------+---------+----------------------+
| 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     |
+----------------------------------+----------+---------+----------------------+

List role IDs and note the role ID you want to assign:

$ openstack role list
+----------------------------------+---------------+
| id                               | name          |
+----------------------------------+---------------+
| 71ccc37d41c8491c975ae72676db687f | Member        |
| 149f50a1fe684bfa88dae76a48d26ef7 | ResellerAdmin |
| 9fe2ff9ee4384b1894a90878d3e92bab | _member_      |
| 6ecf391421604da985db2f141e46a7c8 | admin         |
| deb4fffd123c4d02a907c2c74559dccf | anotherrole   |
| bef1f95537914b1295da6aa038ef4de6 | new-role      |
+----------------------------------+---------------+

List projects and note the project ID you want to assign to the role:

$ openstack project list
+----------------------------------+--------------------+---------+
| id                               | name               | enabled |
+----------------------------------+--------------------+---------+
| 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  |
+----------------------------------+--------------------+---------+

Assign a role to a user-project pair. In this example, assign the new-role role to the demo and test-project pair:
```
$ openstack role add --user USER_NAME --project TENANT_ID ROLE_NAME
```

Verify the role assignment:

$ openstack role list --user USER_NAME --project TENANT_ID
+--------------+----------+---------------------------+--------------+
| id           | name     | user_id                   | tenant_id    |
+--------------+----------+---------------------------+--------------+
| bef1f9553... | new-role | 86c0de739bcb4802b21355... | 80cab5e1f... |
+--------------+----------+---------------------------+--------------+

View role details

View details for a specified role:

$ openstack role show ROLE_NAME
+----------+----------------------------------+
| Field    | Value                            |
+----------+----------------------------------+
| id       | bef1f95537914b1295da6aa038ef4de6 |
| name     | new-role                         |
+----------+----------------------------------+

Remove a role

Remove a role from a user-project pair:

Run the openstack role remove command:

$ openstack role remove --user USER_NAME --project TENANT_ID ROLE_NAME

Verify the role removal:
```
$ openstack role list --user USER_NAME --project TENANT_ID
```
If the role was removed, the command output omits the removed role.

12 KiB Raw Blame History