summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorTerryHowe <terrylhowe@gmail.com>2015-07-19 12:15:04 -0600
committerTerryHowe <terrylhowe@gmail.com>2015-07-23 13:00:59 -0600
commit43942871a9d1515b6ed261e5093001850c2232be (patch)
tree731c37a612a068fb5a7f7855d8247cae6c86c62a /doc/source
parent64334c0dc95ed5cdb10fefe5100d5a1e486132f1 (diff)
downloadpython-openstackclient-43942871a9d1515b6ed261e5093001850c2232be.tar.gz
Add configuration show command
Create a `configuration show` command that displays the current configuration of the CLI. Different configurations can be displayed using options such as --os-cloud. Passwords and tokens are redacted by default unless the --unmask option is specified. Closes-Bug: #1476729 Change-Id: I0792365d0c5fa526cd09c0ed88c6bb1e2cb813a7
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/command-objects/configuration.rst18
-rw-r--r--doc/source/configuration.rst6
2 files changed, 24 insertions, 0 deletions
diff --git a/doc/source/command-objects/configuration.rst b/doc/source/command-objects/configuration.rst
new file mode 100644
index 00000000..0ee8bd63
--- /dev/null
+++ b/doc/source/command-objects/configuration.rst
@@ -0,0 +1,18 @@
+=============
+configuration
+=============
+
+Available for all services
+
+configuration show
+------------------
+
+Show the current openstack client configuration. This command is a little
+different from other show commands because it does not take a resource name
+or id to show. The command line options, such as --os-cloud, can be used to
+show different configurations.
+
+.. program:: configuration show
+.. code:: bash
+
+ os configuration show
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index de3f84ee..563a7193 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -137,3 +137,9 @@ that appears in :file:`clouds.yaml`
rackspace:
auth:
auth_url: 'https://identity.api.rackspacecloud.com/v2.0/'
+
+Debugging
+~~~~~~~~~
+You may find the :doc:`config show <command-objects/config>`
+helpful to debug configuration issues. It will display your current
+configuration.