summaryrefslogtreecommitdiff
path: root/doc/source/usage
diff options
context:
space:
mode:
authorAkihiro Motoki <amotoki@gmail.com>2015-11-28 06:18:50 +0900
committerAkihiro Motoki <motoki@da.jp.nec.com>2015-12-04 20:14:07 +0900
commita2f2908c1648d332ad3d8cc2a94eb592a60a88e7 (patch)
tree3b7280fad848d4be120cee00a6f026ab05e9376c /doc/source/usage
parentf5b4a27fb7931c7f1ff827bb3413effba5da6327 (diff)
downloadpython-neutronclient-a2f2908c1648d332ad3d8cc2a94eb592a60a88e7.tar.gz
Add os-client-config to CLI usage
Change-Id: I5d4a3d7206c8f90f479047e8ee810496c06022d9
Diffstat (limited to 'doc/source/usage')
-rw-r--r--doc/source/usage/cli.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/source/usage/cli.rst b/doc/source/usage/cli.rst
index a87e9d1..801ebae 100644
--- a/doc/source/usage/cli.rst
+++ b/doc/source/usage/cli.rst
@@ -30,6 +30,50 @@ commands. All commands take the form of:
Run **neutron help** to get a full list of all possible commands, and run
**neutron help <command>** to get detailed help for that command.
+Using with os-client-config
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+`os-client-config <http://docs.openstack.org/developer/os-client-config/>`_
+provides more convenient way to manage a collection of client configurations
+and you can easily switch multiple OpenStack-based configurations.
+
+To use os-client-config, you first need to prepare
+``~/.config/openstack/clouds.yaml`` like the following.
+
+.. code-block:: yaml
+
+ clouds:
+ devstack:
+ auth:
+ auth_url: http://auth.example.com:5000
+ password: your-secret
+ project_domain_id: default
+ project_name: demo
+ user_domain_id: default
+ username: demo
+ identity_api_version: '3'
+ region_name: RegionOne
+ devstack-admin:
+ auth:
+ auth_url: http://auth.example.com:35357
+ password: another-secret
+ project_domain_id: default
+ project_name: admin
+ user_domain_id: default
+ username: admin
+ identity_api_version: '3'
+ region_name: RegionOne
+
+Then, you need to specify a configuration name defined in the above clouds.yaml.
+
+.. code-block:: shell
+
+ export OS_CLOUD=devstack
+
+For more detail information, see the
+`os-client-config <http://docs.openstack.org/developer/os-client-config/>`_
+documentation.
+
Using with keystone token
~~~~~~~~~~~~~~~~~~~~~~~~~