summaryrefslogtreecommitdiff
path: root/doc/source/cli/osc_plugin_cli.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/cli/osc_plugin_cli.rst')
-rw-r--r--doc/source/cli/osc_plugin_cli.rst16
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/source/cli/osc_plugin_cli.rst b/doc/source/cli/osc_plugin_cli.rst
index e3e9805..76815fd 100644
--- a/doc/source/cli/osc_plugin_cli.rst
+++ b/doc/source/cli/osc_plugin_cli.rst
@@ -30,6 +30,16 @@ package must be installed. There are two ways to do this:
$ pip install python-openstackclient
+This CLI is provided by python-openstackclient and osc-lib projects:
+
+* https://opendev.org/openstack/python-openstackclient
+* https://opendev.org/openstack/osc-lib
+
+.. _osc-auth:
+
+Authentication
+--------------
+
To use the CLI, you must provide your OpenStack username, password,
project, and auth endpoint. You can use configuration options
``--os-username``, ``--os-password``, ``--os-project-id``
@@ -44,11 +54,6 @@ or set the corresponding environment variables::
$ export OS_IDENTITY_API_VERSION=3
$ export OS_AUTH_URL=http://auth.example.com:5000/identity
-This CLI is provided by python-openstackclient and osc-lib projects:
-
-* https://opendev.org/openstack/python-openstackclient
-* https://opendev.org/openstack/osc-lib
-
Getting help
============
@@ -91,6 +96,7 @@ The baremetal API version can be specified via:
$ openstack baremetal port group list --os-baremetal-api-version 1.25
+
Command Reference
=================
.. toctree::