nova/doc/source/admin/manage-the-cloud.rst
Stephen Finucane a0380894d0 docs: Strip '.rst' suffix
These are unnecessary noise. Drop them.

Change-Id: I6ce4c78bd53975ae83c10b2e5c3910f23b42dba0
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-15 16:37:26 +00:00

67 lines
2.2 KiB
ReStructuredText

.. _section_manage-the-cloud:
================
Manage the cloud
================
.. toctree::
common/nova-show-usage-statistics-for-hosts-instances
System administrators can use the :command:`openstack` to manage their clouds.
The ``openstack`` client can be used by all users, though specific commands
might be restricted by the Identity service.
**Managing the cloud with the openstack client**
#. 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.
For more information on ``python-openstackclient``, refer to the
:python-openstackclient-doc:`documentation <>`.
#. Confirm the installation was successful:
.. code-block:: console
$ 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:`openstack help` returns a list of ``openstack`` commands
and parameters. To get help for a subcommand, run:
.. code-block:: console
$ openstack help SUBCOMMAND
For a complete list of ``openstack`` commands and parameters, refer to the
:python-openstackclient-doc:`OpenStack Command-Line Reference
<cli/index.html>`.
#. Set the required parameters as environment variables to make running
commands easier. For example, you can add ``--os-username`` as an
``openstack`` option, or set it as an environment variable. To set the user
name, password, and project as environment variables, use:
.. code-block:: console
$ export OS_USERNAME=joecool
$ export OS_PASSWORD=coolword
$ export OS_TENANT_NAME=coolu
#. 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