Merge "Update the CLI examples to also use openstackclient"

2 files changed, 295 insertions, 9 deletions

diff --git a/doc/source/cli_examples.rst b/doc/source/cli_examples.rst
index b76f575c8..46f8a97af 100644
--- a/doc/source/cli_examples.rst
+++ b/doc/source/cli_examples.rst
@@ -18,16 +18,300 @@
 Command Line Interface Examples
 ===============================
 
+The Keystone command line interface packaged in `python-keystoneclient`_ only
+supports the Identity v2.0 API. The OpenStack common command line interface
+packaged in `python-openstackclient`_  supports both v2.0 and v3 APIs.
+
+.. NOTE::
+
+    As of the Juno release, it is recommended to use ``python-openstackclient``,
+    as it suports both v2.0 and v3 APIs. For the purpose of backwards compatibility,
+    the CLI packaged in ``python-keystoneclient`` is not being removed.
+
+.. _`python-openstackclient`: http://docs.openstack.org/developer/python-openstackclient/
+.. _`python-keystoneclient`: http://docs.openstack.org/developer/python-keystoneclient/
+
+Using python-openstackclient
+============================
+
+--------
+Projects
+--------
+
+``project create``
+------------------
+
+positional arguments::
+
+  <project-name>                        New project name
+
+optional arguments::
+
+  --description <project-description>   New project description
+  --enable                              Enable project (default)
+  --disable                             Disable project
+
+example:
+
+.. code-block:: bash
+
+    $ openstack project create demo
+
+
+``project delete``
+------------------
+
+positional arguments::
+
+  <project>   Project to delete (name or ID)
+
+example:
+
+.. code-block:: bash
+
+    $ openstack project delete demo
+
+-----
+Users
+-----
+
+``user create``
+---------------
+
+positional arguments::
+
+  <user-name>                  New user name
+
+optional arguments::
+
+  --password <user-password>   New user password
+  --password-prompt            Prompt interactively for password
+  --email <user-email>         New user email address
+  --project <project>          Set default project (name or ID)
+  --enable                     Enable user (default)
+  --disable                    Disable user
+
+
+example:
+
+.. code-block:: bash
+
+    $ openstack user create heat-user \
+    --password secrete \
+    --project demo \
+    --email admin@example.com
+
+``user delete``
+---------------
+
+positional arguments::
+
+  <user>   User to delete (name or ID)
+
+example:
+
+.. code-block:: bash
+
+    $ openstack user delete heat-user
+
+``user list``
+-------------
+
+optional arguments::
+
+  --project <project>   Filter users by project (name or ID)
+  --long                List additional fields in output
+
+example:
+
+.. code-block:: bash
+
+    $ openstack user list
+
+``user set``
+------------
+
+positional arguments::
+
+  <user>                       User to change (name or ID)
+
+optional arguments::
+
+  --name <new-user-name>       New user name
+  --password <user-password>   New user password
+  --password-prompt            Prompt interactively for password
+  --email <user-email>         New user email address
+  --project <project>          New default project (name or ID)
+  --enable                     Enable user (default)
+  --disable                    Disable user
+
+
+example:
+
+.. code-block:: bash
+
+    $ openstack user set heat-user --email newemail@example.com
+
+-----
+Roles
+-----
+
+``role create``
+---------------
+
+positional arguments::
+
+  <role-name>           New role name
+
+example:
+
+.. code-block:: bash
+
+    $ openstack role create demo
+
+``role delete``
+---------------
+
+positional arguments::
+
+  <role>      Name or ID of role to delete
+
+example:
+
+.. code-block:: bash
+
+    $ openstack role delete demo
+
+``role list``
+-------------
+
+example:
+
+.. code-block:: bash
+
+    $ openstack role list
+
+``role show``
+-------------
+
+positional arguments::
+
+  <role>                Name or ID of role to display
+
+example:
+
+.. code-block:: bash
+
+    $ openstack role show demo
+
+
+``role add``
+------------
+
+positional arguments::
+
+  <role>                Role name or ID to add to user
+
+optional arguments::
+
+  --project <project>   Include project (name or ID)
+  --user <user>         Name or ID of user to include
+
+
+example:
+
+.. code-block:: bash
+
+    $ openstack user role add  demo --user heat-user --project heat
+
+``role remove``
+---------------
+
+positional arguments::
+
+  <role>               Role name or ID to remove from user
+
+optional arguments::
+
+  --project <project>  Project to include (name or ID)
+  --user <user>        Name or ID of user
+
+
+example:
+
+.. code-block:: bash
+
+    $ openstack user role remove  demo --user heat-user --project heat
+
+--------
+Services
+--------
+
+``service create``
+------------------
+
+positional arguments::
+
+  <service-name>   New service name
+
+optional arguments::
+
+  --type <service-type>   New service type (compute, image, identity, volume, etc)
+  --description <service-description>   New service description
+
+example:
+
+.. code-block:: bash
+
+  $ openstack service create nova --type compute --description "Nova Compute Service"
+
+``service list``
+----------------
+
+optional arguments::
+
+  --long   List additional fields in output
+
+example:
+
+.. code-block:: bash
+
+  $ openstack service list
+
+``service show``
+----------------
+
+positional arguments::
+
+  <service>   Service to display (type, name or ID)
+
+example:
+
+.. code-block:: bash
+
+  $ openstack service show nova
+
+``service delete``
+------------------
+
+positional arguments::
+
+  <service>   Service to delete (name or ID)
+
+example:
+
+.. code-block:: bash
+
+  $ openstack service delete nova
+
+
+Using python-keystoneclient
+===========================
+
 -------
 Tenants
 -------
 
-Tenants are the high level grouping within Keystone that represent groups of
-users. A tenant is the grouping that owns virtual machines within Nova, or
-containers within Swift. A tenant can have zero or more users, Users can be
-associated with more than one tenant, and each tenant - user pairing can have
-a role associated with it.
-
 ``tenant-create``
 -----------------
 
@@ -112,7 +396,7 @@ example:
     $ keystone user-list
 
 ``user-update``
----------------
+---------------------
 
 arguments
 
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index 398065645..b4f6e55df 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -1194,9 +1194,11 @@ as follows:
     $ openstack --os-username=admin --os-password=secrete --os-project-name=admin --os-auth-url=http://localhost:35357/v2.0 user list
     $ openstack --os-username=admin --os-password=secrete --os-project-name=admin --os-auth-url=http://localhost:35357/v2.0 project create demo
 
-For additional examples using ``python-keystoneclient`` refer to `CLI Examples`_.
+For additional examples using ``python-keystoneclient`` refer to `python-keystoneclient examples`_,
+likewise, for additional examples using ``python-openstackclient``, refer to `python-openstackclient examples`_.
 
-.. _`CLI Examples`: cli_examples.html
+.. _`python-keystoneclient examples`: cli_examples.html#using-python-keystoneclient
+.. _`python-openstackclient examples`: cli_examples.html#using-python-openstackclient
 
 
 Removing Expired Tokens