openstack/openstack-manuals
Code Issues Proposed changes

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

Browse Source
This commit is contained in:
Jenkins 2016-06-18 08:00:03 +00:00 committed by Gerrit Code Review
commit 25ea3b4c8b
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 compute-euca2ools.rst
common/nova_show_usage_statistics_for_hosts_instances.rst common/nova_show_usage_statistics_for_hosts_instances.rst
System administrators can use :command:`nova` client and :command:`euca2ools` System administrators can use the :command:`openstack` and
commands to manage their clouds. :command:`euca2ools` commands to manage their clouds.
``nova`` client and ``euca2ools`` can be used by all users, though The ``openstack`` client and ``euca2ools`` can be used by all users, though
specific commands might be restricted by Role Based Access Control in specific commands might be restricted by the Identity service.
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 #. The ``python-openstackclient`` package provides an ``openstack`` shell that
Compute API interactions from the command line. Install the client, and enables Compute API interactions from the command line. Install the client,
provide your user name and password (which can be set as environment and provide your user name and password (which can be set as environment
variables for convenience), for the ability to administer the cloud from variables for convenience), for the ability to administer the cloud from
the command line. the command line.
To install python-novaclient, download the tarball from To install python-openstackclient, follow the instructions in the
`http://pypi.python.org/pypi/python-novaclient/#downloads <http://pypi.python.org/pypi/python-novaclient/#downloads>`__ and then `OpenStack User Guide
install it in your favorite Python environment: <http://docs.openstack.org/user-guide/common/cli_install_openstack_command_line_clients.html>`_.
.. 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
#. Confirm the installation was successful: #. Confirm the installation was successful:
.. code-block:: console .. code-block:: console
$ nova help $ openstack help
usage: nova [--version] [--debug] [--os-cache] [--timings] usage: openstack [--version] [-v | -q] [--log-file LOG_FILE] [-h] [--debug]
[--timeout SECONDS] [--os-username AUTH_USER_NAME] [--os-cloud <cloud-config-name>]
[--os-password AUTH_PASSWORD] [--os-region-name <auth-region-name>]
[--os-tenant-name AUTH_TENANT_NAME] [--os-cacert <ca-bundle-file>] [--verify | --insecure]
[--os-tenant-id AUTH_TENANT_ID] [--os-auth-url AUTH_URL] [--os-default-domain <auth-domain>]
[--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 ...
Running :command:`nova help` returns a list of ``nova`` commands and Running :command:`openstack help` returns a list of ``openstack`` commands
parameters. To get help for a subcommand, run: and parameters. To get help for a subcommand, run:
.. code-block:: console .. 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 `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 #. Set the required parameters as environment variables to make running
commands easier. For example, you can add :option:`--os-username` as a commands easier. For example, you can add :option:`--os-username` as an
``nova`` option, or set it as an environment variable. To set the user ``openstack`` option, or set it as an environment variable. To set the user
name, password, and tenant as environment variables, use: name, password, and tenant as environment variables, use:
.. code-block:: console .. code-block:: console
@ -81,10 +61,9 @@ the Identity service.
$ export OS_PASSWORD=coolword $ export OS_PASSWORD=coolword
$ export OS_TENANT_NAME=coolu $ 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``: which Compute recognizes as ``OS_AUTH_URL``:
.. code-block:: console .. code-block:: console
$ export OS_AUTH_URL=http://hostname:5000/v2.0 $ export OS_AUTH_URL=http://hostname:5000/v2.0
$ export NOVA_VERSION=1.1