From d6a1ccaccdfa18a25de68617cbf9ad7379bb66f6 Mon Sep 17 00:00:00 2001 From: KATO Tomoyuki Date: Sat, 1 Oct 2016 17:34:20 +0900 Subject: [PATCH] [common] update CLI overview to emphasis OSC * python-keystoneclient does not provide CLI any more in favor of python-openstackclient. Change-Id: I24bbb4cd1d6b83a38a16fa01d9be6ff1ac0be5b9 --- ...install-openstack-command-line-clients.rst | 5 --- doc/common/cli-overview.rst | 36 +++++++++++-------- 2 files changed, 21 insertions(+), 20 deletions(-) diff --git a/doc/common/cli-install-openstack-command-line-clients.rst b/doc/common/cli-install-openstack-command-line-clients.rst index c133609bb0..a88b2ef8c6 100644 --- a/doc/common/cli-install-openstack-command-line-clients.rst +++ b/doc/common/cli-install-openstack-command-line-clients.rst @@ -156,7 +156,6 @@ list below. * ``glance`` - Image service API * ``gnocchi`` - Telemetry API v3 * ``heat`` - Orchestration API -* ``keystone`` - Identity service API and extensions * ``magnum`` - Container Infrastructure Management service API * ``manila`` - Shared file systems API * ``mistral`` - Workflow service API @@ -169,10 +168,6 @@ list below. * ``swift`` - Object Storage API * ``trove`` - Database service API -While you can install the ``keystone`` client for interacting with version 2.0 -of the service's API, you should use the ``openstack`` client for all Identity -interactions. Identity API v2 is deprecated in the Mitaka release. - Installing with pip ------------------- diff --git a/doc/common/cli-overview.rst b/doc/common/cli-overview.rst index 4033068c8f..6d9e908752 100644 --- a/doc/common/cli-overview.rst +++ b/doc/common/cli-overview.rst @@ -1,10 +1,11 @@ -======== -Overview -======== +============================ +Command-line client overview +============================ -Each OpenStack project provides a command-line client, which enables -you to access the project API through easy-to-use commands. For -example, the Compute service provides a ``nova`` command-line client. +OpenStackClient project provides a unified command-line client, which +enables you to access the project API through easy-to-use commands. +Also, most OpenStack project provides a command-line client for each service. +For example, the Compute service provides a ``nova`` command-line client. You can run the commands from the command line, or include the commands within scripts to automate tasks. If you provide OpenStack @@ -25,7 +26,20 @@ your own resources within the limits set by administrators. You can modify the examples provided in this section to create other types and sizes of server instances. -The following table lists the command-line client for each OpenStack +Unified command-line client +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can use the unified ``openstack`` command (**python-openstackclient**) +for the most of OpenStack services. +For more information, see `OpenStackClient document +`_. + + +Individual command-line clients +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Unless the unified OpenStack Client (**python-openstackclient**) is used, +the following table lists the command-line client for each OpenStack service with its package name and description. .. list-table:: OpenStack services and clients @@ -36,10 +50,6 @@ service with its package name and description. - Client - Package - Description - * - **Command-line client** - - **openstack** - - **python-openstackclient** - - **Common client for the OpenStack project.** * - Application Catalog service - murano - python-muranoclient @@ -80,10 +90,6 @@ service with its package name and description. - designate - python-designateclient - Creates and manages self service authoritative DNS. - * - Identity service - - keystone - - python-keystoneclient - - Creates and manages users, tenants, roles, endpoints, and credentials. * - Image service - glance - python-glanceclient