openstack/nova
Code Issues Proposed changes
bfeea18358
nova/doc/source/admin/manage-the-cloud.rst
Stephen Finucane dd1a416bc9 doc: Start using openstackdoctheme's extlink extension 
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.

[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper

Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
2018-05-03 14:34:47 +01:00

2.2 KiB
Raw Blame History

Manage the cloud

common/nova-show-usage-statistics-for-hosts-instances.rst

System administrators can use the 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

  1. 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 documentation <>.

  2. Confirm the installation was successful:

    $ 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 openstack help returns a list of openstack commands and parameters. To get help for a subcommand, run:

    $ openstack help SUBCOMMAND

    For a complete list of openstack commands and parameters, refer to the OpenStack Command-Line Reference <cli/index.html>.

  3. 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:

    $ export OS_USERNAME=joecool
$ export OS_PASSWORD=coolword
$ export OS_TENANT_NAME=coolu

  4. The Identity service gives you an authentication endpoint, which Compute recognizes as OS_AUTH_URL:

    $ export OS_AUTH_URL=http://hostname:5000/v2.0