openstack/openstack-manuals
Code Issues Proposed changes

[common] Update CLIs description

Browse Source 
* emphasize OpenStack Client
* deprecate Individual CLIs
* use list-table to improve maintenanceability

Change-Id: I4d34ff82dc4af6df9214044bbcfa58b185fcdecf
This commit is contained in:
KATO Tomoyuki 2016-03-24 23:53:52 +09:00
parent d45e590bb1
commit 31df04074c
3 changed files with 121 additions and 129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/common/cli_discover_version_number_for_a_client.rst
View File

@ -8,10 +8,10 @@ Run the following command to discover the version number for a client:
$ PROJECT --version
For example, to see the version number for the ``nova`` client, run the
following command:
For example, to see the version number for the ``openstack`` client,
run the following command:
.. code-block:: console
$ nova --version
2.31.0
$ openstack --version
2.2.0

55
doc/common/cli_install_openstack_command_line_clients.rst
View File

@ -74,7 +74,7 @@ command-line clients, and provides installation instructions as needed.
| | installer provided by Christoph Gohlke |
| | (http://www.lfd.uci.edu/~gohlke/pythonlibs/#pip). |
| | |
| | **Ubuntu and Debian** |
| | **Ubuntu or Debian** |
| | |
| | .. code-block:: console |
| | |
@ -150,8 +150,8 @@ with ``pip``, which supports multiple services.
# pip install python-openstackclient
The following clients, while valid, are de-emphasized in favor of a common
client. Instead of installing and learning all these clients, we recommend
The following individual clients are deprecated in favor of a common client.
Instead of installing and learning all these clients, we recommend
installing and using the OpenStack client. You may need to install an
individual project's client because coverage is not yet sufficient in the
OpenStack client. If you need to install an individual client's project,
@ -163,55 +163,30 @@ list below.
# pip install python-<project>client
* ``barbican`` - Key Manager Service API
* ``ceilometer`` - Telemetry API
* ``cinder`` - Block Storage API and extensions
* ``cloudkitty`` - Rating service API
* ``designate`` - DNS service API
* ``fuel`` - Deployment service API
* ``glance`` - Image service API
* ``gnocchi`` - Telemetry API v3
* ``heat`` - Orchestration API
* ``magnum`` - Containers service API
* ``manila`` - Shared file systems API
* ``mistral`` - Workflow service API
* ``monasca`` - Monitoring API
* ``murano`` - Application catalog API
* ``neutron`` - Networking API
* ``nova`` - Compute API and extensions
* ``sahara`` - Data Processing API
* ``senlin`` - Clustering service API
* ``swift`` - Object Storage API
* ``trove`` - Database service API
* ``openstack`` - Common OpenStack client supporting multiple services
The following CLIs are deprecated in favor of ``openstack``, the
Common OpenStack client supporting multiple services:
* ``keystone`` - Identity service API and extensions
* ``magnum`` - Containers service API
* ``manila`` - Shared file systems API
* ``mistral`` - Workflow service API
* ``monasca`` - Monitoring API
* ``murano`` - Application catalog API
* ``neutron`` - Networking API
* ``nova`` - Compute API and extensions
* ``sahara`` - Data Processing API
* ``senlin`` - Clustering service API
* ``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.
interactions. Identity API v2 is deprecated in the Mitaka release.
Installing with pip
-------------------

187
doc/common/cli_overview.rst
View File

@ -28,89 +28,106 @@ sizes of server instances.
The following table lists the command-line client for each OpenStack
service with its package name and description.
**OpenStack services and clients**
.. list-table:: OpenStack services and clients
:widths: 20 20 20 40
:header-rows: 1
+----------------+----------+-----------------------+------------------------+
|Service |Client |Package |Description |
+================+==========+=======================+========================+
|Application |murano |python-muranoclient |Creates and manages |
|catalog | | |applications. |
+----------------+----------+-----------------------+------------------------+
|Block Storage |cinder |python-cinderclient |Creates and manages |
| | | |volumes. |
+----------------+----------+-----------------------+------------------------+
|Clustering |senlin |python-senlinclient |Creates and manages |
|service | | |clustering services. |
+----------------+----------+-----------------------+------------------------+
|Compute |nova |python-novaclient |Creates and manages |
| | | |images, instances, and |
| | | |flavors. |
+----------------+----------+-----------------------+------------------------+
|Containers |magnum |python-magnumclient |Creates and manages |
|service | | |containers. |
+----------------+----------+-----------------------+------------------------+
|Database service|trove |python-troveclient |Creates and manages |
| | | |databases. |
+----------------+----------+-----------------------+------------------------+
|Data processing |sahara |python-saharaclient |Creates and manages |
| | | |Hadoop clusters on |
| | | |OpenStack. |
+----------------+----------+-----------------------+------------------------+
|Deployment |fuel |python-fuelclient |Plans deployments. |
|service | | | |
+----------------+----------+-----------------------+------------------------+
|Identity |keystone |python-keystoneclient |Creates and manages |
| | | |users, tenants, roles, |
| | | |endpoints, and |
| | | |credentials. |
+----------------+----------+-----------------------+------------------------+
|Image service |glance |python-glanceclient |Creates and manages |
| | | |images. |
+----------------+----------+-----------------------+------------------------+
|Key Manager |barbican |python-barbicanclient |Creates and manages |
|service | | |keys. |
+----------------+----------+-----------------------+------------------------+
|Monitoring |monasca |python-monascaclient |Monitoring solution. |
| | | | |
+----------------+----------+-----------------------+------------------------+
|Networking |neutron |python-neutronclient |Configures networks for |
| | | |guest servers. |
+----------------+----------+-----------------------+------------------------+
|Object Storage |swift |python-swiftclient |Gathers statistics, |
| | | |lists items, updates |
| | | |metadata, and uploads, |
| | | |downloads, and deletes |
| | | |files stored by the |
| | | |Object Storage service. |
| | | |Gains access to |
| | | |an Object Storage |
| | | |installation for ad hoc |
| | | |processing. |
+----------------+----------+-----------------------+------------------------+
|Orchestration |heat |python-heatclient |Launches stacks from |
| | | |templates, views details|
| | | |of running stacks |
| | | |including events and |
| | | |resources, and updates |
| | | |and deletes stacks. |
+----------------+----------+-----------------------+------------------------+
|Rating |cloudkitty|python-cloudkittyclient|Rating service. |
|service | | | |
+----------------+----------+-----------------------+------------------------+
|Shared file |manila |python-manilaclient |Creates and manages |
|systems | | |shared file systems. |
+----------------+----------+-----------------------+------------------------+
|Telemetry |ceilometer|python-ceilometerclient|Creates and collects |
| | | |measurements across |
| | | |OpenStack. |
+----------------+----------+-----------------------+------------------------+
|Telemetry v3 |gnocchi |python-gnocchiclient |Creates and collects |
| | | |measurements across |
| | | |OpenStack. |
+----------------+----------+-----------------------+------------------------+
|Workflow |mistral |python-mistralclient |Workflow service |
|service | | |for OpenStack cloud. |
+----------------+----------+-----------------------+------------------------+
|Common client |openstack |python-openstackclient |Common client for the |
| | | |OpenStack project. |
+----------------+----------+-----------------------+------------------------+
* - Service
- Client
- Package
- Description
* - **Command-line client**
- **openstack**
- **python-openstackclient**
- **Common client for the OpenStack project.**
* - Application Catalog service
- murano
- python-muranoclient
- Creates and manages applications.
* - Bare Metal service
- ironic
- python-ironicclient
- manages and provisions physical machines.
* - Block Storage service
- cinder
- python-cinderclient
- Creates and manages volumes.
* - Clustering service
- senlin
- python-senlinclient
- Creates and manages clustering services.
* - Compute service
- nova
- python-novaclient
- Creates and manages images, instances, and flavors.
* - Containers service
- magnum
- python-magnumclient
- Creates and manages containers.
* - Data Processing service
- sahara
- python-saharaclient
- Creates and manages Hadoop clusters on OpenStack.
* - Database service
- trove
- python-troveclient
- Creates and manages databases.
* - Deployment service
- fuel
- python-fuelclient
- Plans deployments.
* - DNS service
- 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
- Creates and manages images.
* - Key Manager service
- barbican
- python-barbicanclient
- Creates and manages keys.
* - Monitoring
- monasca
- python-monascaclient
- Monitoring solution.
* - Networking service
- neutron
- python-neutronclient
- Configures networks for guest servers.
* - Object Storage service
- swift
- python-swiftclient
- Gathers statistics, lists items, updates metadata, and uploads,
downloads, and deletes files stored by the Object Storage service.
Gains access to an Object Storage installation for ad hoc processing.
* - Orchestration service
- heat
- python-heatclient
- Launches stacks from templates, views details of running stacks
including events and resources, and updates and deletes stacks.
* - Rating service
- cloudkitty
- python-cloudkittyclient
- Rating service.
* - Shared File Systems service
- manila
- python-manilaclient
- Creates and manages shared file systems.
* - Telemetry service
- ceilometer
- python-ceilometerclient
- Creates and collects measurements across OpenStack.
* - Telemetry v3
- gnocchi
- python-gnocchiclient
- Creates and collects measurements across OpenStack.
* - Workflow service
- mistral
- python-mistralclient
- Workflow service for OpenStack cloud.