From c0305a1e180cc2a101c94b50b423adea37c5578d Mon Sep 17 00:00:00 2001 From: Takashi NATSUME Date: Mon, 16 Oct 2017 17:53:34 +0900 Subject: [PATCH] Update "The nova Shell Utility" in the user guide Change-Id: I02025f364a11b7f41935fe835407852fc37b4d87 Closes-Bug: #1723895 --- doc/source/user/shell.rst | 49 ++++++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 14 deletions(-) diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst index b2d7d9ef8..bd1fb7e93 100644 --- a/doc/source/user/shell.rst +++ b/doc/source/user/shell.rst @@ -8,33 +8,52 @@ The :program:`nova` shell utility interacts with OpenStack Nova API from the command line. It supports the entirety of the OpenStack Nova API. -First, you'll need an OpenStack Nova account and an API key. You get this by -using the `nova-manage` command in OpenStack Nova. - -You'll need to provide :program:`nova` with your OpenStack username and API -key. You can do this with the `--os-username`, `--os-password` and -`--os-tenant-id` options, but it's easier to just set them as environment -variables by setting some environment variables: +You'll need to provide :program:`nova` with your OpenStack Keystone user +information. You can do this with the `--os-username`, `--os-password`, +`--os-project-name` (`--os-project-id`), `--os-project-domain-name` +(`--os-project-domain-id`) and `--os-user-domain-name` (`--os-user-domain-id`) +options, but it's easier to just set them as environment variables by setting +some environment variables: .. envvar:: OS_USERNAME - Your OpenStack Nova username. + Your OpenStack Keystone user name. .. envvar:: OS_PASSWORD Your password. -.. envvar:: OS_TENANT_NAME +.. envvar:: OS_PROJECT_NAME - Project for work. + The name of project for work. + +.. envvar:: OS_PROJECT_ID + + The ID of project for work. + +.. envvar:: OS_PROJECT_DOMAIN_NAME + + The name of domain containing the project. + +.. envvar:: OS_PROJECT_DOMAIN_ID + + The ID of domain containing the project. + +.. envvar:: OS_USER_DOMAIN_NAME + + The user's domain name. + +.. envvar:: OS_USER_DOMAIN_ID + + The user's domain ID. .. envvar:: OS_AUTH_URL - The OpenStack API server URL. + The OpenStack Keystone endpoint URL. .. envvar:: OS_COMPUTE_API_VERSION - The OpenStack API version. + The OpenStack Nova API version (microversion). .. envvar:: OS_REGION_NAME @@ -45,8 +64,10 @@ For example, in Bash you'd use:: export OS_USERNAME=yourname export OS_PASSWORD=yadayadayada - export OS_TENANT_NAME=myproject - export OS_AUTH_URL=http://:5000/v3/ + export OS_PROJECT_NAME=myproject + export OS_PROJECT_DOMAIN_NAME=default + export OS_USER_DOMAIN_NAME=default + export OS_AUTH_URL=http:///identity export OS_COMPUTE_API_VERSION=2.1 From there, all shell commands take the form::