openstack/openstack-manuals
Code Issues Proposed changes

[admin-guide] Edits the "Manage the cloud" topic

Browse Source 
Changes nova client commands to openstack client.
Points to client install rather than re-documenting
install.

Change-Id: I7946cde6bb9d9dc8a8943f04a543cc95ad524d8a
Closes-bug: 1593858
This commit is contained in:
Anne Gentle 2016-06-17 15:15:31 -05:00 committed by Andreas Jaeger
parent c29e3e8c15
commit 4967251358
1 changed files with 26 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
doc/admin-guide/source/compute-manage-the-cloud.rst
View File

@ -9,70 +9,50 @@ Manage the cloud
compute-euca2ools.rst
common/nova_show_usage_statistics_for_hosts_instances.rst
System administrators can use :command:`nova` client and :command:`euca2ools`
commands to manage their clouds.
System administrators can use the :command:`openstack` and
:command:`euca2ools` commands to manage their clouds.
``nova`` client and ``euca2ools`` can be used by all users, though
specific commands might be restricted by Role Based Access Control in
the Identity service.
The ``openstack`` client and ``euca2ools`` can be used by all users, though
specific commands might be restricted by the Identity service.
**Managing the cloud with nova client**
**Managing the cloud with the openstack client**
#. The ``python-novaclient`` package provides a ``nova`` shell that enables
Compute API interactions from the command line. Install the client, and
provide your user name and password (which can be set as environment
#. The ``python-openstackclient`` package provides an ``openstack`` shell that
enables Compute API interactions from the command line. Install the client,
and provide your user name and password (which can be set as environment
variables for convenience), for the ability to administer the cloud from
the command line.
To install python-novaclient, download the tarball from
`http://pypi.python.org/pypi/python-novaclient/#downloads <http://pypi.python.org/pypi/python-novaclient/#downloads>`__ and then
install it in your favorite Python environment:
.. code-block:: console
$ curl -O http://pypi.python.org/packages/source/p/python-novaclient/python-novaclient-2.6.3.tar.gz
$ tar -zxvf python-novaclient-2.6.3.tar.gz
$ cd python-novaclient-2.6.3
As root, run:
.. code-block:: console
# python setup.py install
To install python-openstackclient, follow the instructions in the
`OpenStack User Guide
<http://docs.openstack.org/user-guide/common/cli_install_openstack_command_line_clients.html>`_.
#. Confirm the installation was successful:
.. code-block:: console
$ nova help
usage: nova [--version] [--debug] [--os-cache] [--timings]
[--timeout SECONDS] [--os-username AUTH_USER_NAME]
[--os-password AUTH_PASSWORD]
[--os-tenant-name AUTH_TENANT_NAME]
[--os-tenant-id AUTH_TENANT_ID] [--os-auth-url AUTH_URL]
[--os-region-name REGION_NAME] [--os-auth-system AUTH_SYSTEM]
[--service-type SERVICE_TYPE] [--service-name SERVICE_NAME]
[--volume-service-name VOLUME_SERVICE_NAME]
[--endpoint-type ENDPOINT_TYPE]
[--os-compute-api-version COMPUTE_API_VERSION]
[--os-cacert CA_CERTIFICATE] [--insecure]
[--bypass-url BYPASS_URL]
SUBCOMMAND ...
$ openstack help
usage: openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--os-cloud <cloud-config-name>]
[--os-region-name <auth-region-name>]
[--os-cacert <ca-bundle-file>] [--verify | --insecure]
[--os-default-domain <auth-domain>]
...
Running :command:`nova help` returns a list of ``nova`` commands and
parameters. To get help for a subcommand, run:
Running :command:`openstack help` returns a list of ``openstack`` commands
and parameters. To get help for a subcommand, run:
.. code-block:: console
$ nova help SUBCOMMAND
$ openstack help SUBCOMMAND
For a complete list of ``nova`` commands and parameters, see the
For a complete list of ``openstack`` commands and parameters, see the
`OpenStack Command-Line Reference
<http://docs.openstack.org/cli-reference/nova.html>`__.
<http://docs.openstack.org/cli-reference/openstack.html>`__.
#. Set the required parameters as environment variables to make running
commands easier. For example, you can add :option:`--os-username` as a
``nova`` option, or set it as an environment variable. To set the user
commands easier. For example, you can add :option:`--os-username` as an
``openstack`` option, or set it as an environment variable. To set the user
name, password, and tenant as environment variables, use:
.. code-block:: console
@ -81,10 +61,9 @@ the Identity service.
$ export OS_PASSWORD=coolword
$ export OS_TENANT_NAME=coolu
#. The Identity service will give you an authentication endpoint,
#. The Identity service gives you an authentication endpoint,
which Compute recognizes as ``OS_AUTH_URL``:
.. code-block:: console
$ export OS_AUTH_URL=http://hostname:5000/v2.0
$ export NOVA_VERSION=1.1