openstack/openstack-manuals
Code Issues Proposed changes

Added table name and fixed description in User Guide

Browse Source 
This patch added the table name in OpenStack command-line
clients section of User Guide. This patch also revised sentences
in the description column of this table to follow singular forms.

Closes-Bug: #1505543
Change-Id: Ibe62befee20488410794dcb0f87fcd250a292072
This commit is contained in:
Lujin Luo 2015-10-14 17:42:23 +09:00
parent c909e65c5c
commit 348aaae8ea
2 changed files with 43 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/common-rst/cli_overview.rst
View File

@ -28,67 +28,70 @@ 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**
+----------------+----------+-----------------------+------------------------+
|Service |Client |Package |Description |
+================+==========+=======================+========================+
|Application |murano |python-muranoclient |Create and manage |
|Application |murano |python-muranoclient |Creates and manages |
|catalog | | |applications. |
+----------------+----------+-----------------------+------------------------+
|Block Storage |cinder |python-cinderclient |Create and manage |
|Block Storage |cinder |python-cinderclient |Creates and manages |
| | | |volumes. |
+----------------+----------+-----------------------+------------------------+
|Compute |nova |python-novaclient |Create and manage |
|Compute |nova |python-novaclient |Creates and manages |
| | | |images, instances, and |
| | | |flavors. |
+----------------+----------+-----------------------+------------------------+
|Containers |magnum |python-magnumclient |Create and manage |
|Containers |magnum |python-magnumclient |Creates and manages |
|service | | |containers. |
+----------------+----------+-----------------------+------------------------+
|Database service|trove |python-troveclient |Create and manage |
|Database service|trove |python-troveclient |Creates and manages |
| | | |databases. |
+----------------+----------+-----------------------+------------------------+
|Data processing |sahara |python-saharaclient |Create and manage |
|Data processing |sahara |python-saharaclient |Creates and manages |
| | | |Hadoop clusters on |
| | | |OpenStack. |
+----------------+----------+-----------------------+------------------------+
|Deployment |tuskar |python-tuskarclient |Plan Deployments. |
|Deployment |tuskar |python-tuskarclient |Plans Deployments. |
|service | | | |
+----------------+----------+-----------------------+------------------------+
|Identity |keystone |python-keystoneclient |Create and manage |
|Identity |keystone |python-keystoneclient |Creates and manages |
| | | |users, tenants, roles, |
| | | |endpoints, and |
| | | |credentials. |
+----------------+----------+-----------------------+------------------------+
|Image service |glance |python-glanceclient |Create and manage |
|Image service |glance |python-glanceclient |Creates and manages |
| | | |images. |
+----------------+----------+-----------------------+------------------------+
|Key Manager |barbican |python-barbicanclient |Create and manage |
|Key Manager |barbican |python-barbicanclient |Creates and manages |
|service | | |keys. |
+----------------+----------+-----------------------+------------------------+
|Networking |neutron |python-neutronclient |Configure networks for |
|Networking |neutron |python-neutronclient |Configures networks for |
| | | |guest servers. |
+----------------+----------+-----------------------+------------------------+
|Object Storage |swift |python-swiftclient |Gather statistics, list |
| | | |items, update metadata, |
| | | |and upload, download, |
| | | |and delete files stored |
| | | |by the Object Storage |
| | | |service. Gain access to |
|Object Storage |swift |python-swiftclient |Gathers statistics, |
| | | |lists items, updates |
| | | |metedata, 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 |Launch stacks from |
| | | |templates, view details |
|Orchestration |heat |python-heatclient |Launches stacks from |
| | | |templates, views details|
| | | |of running stacks |
| | | |including events and |
| | | |resources, and update |
| | | |and delete stacks. |
| | | |resources, and updates |
| | | |and deletes stacks. |
+----------------+----------+-----------------------+------------------------+
|Shared file |manila |python-manilaclient |Create and manage |
|Shared file |manila |python-manilaclient |Creates and manages |
|systems | | |shared file systems. |
+----------------+----------+-----------------------+------------------------+
|Telemetry |ceilometer|python-ceilometerclient|Create and collect |
|Telemetry |ceilometer|python-ceilometerclient|Creates and collects |
| | | |measurements across |
| | | |OpenStack. |
+----------------+----------+-----------------------+------------------------+

34
doc/common/section_cli_overview.xml
View File

@ -48,31 +48,31 @@
<td>Application catalog</td>
<td><command>murano</command></td>
<td><package>python-muranoclient</package></td>
<td>Create and manage application catalog.</td>
<td>Creates and manages application catalog.</td>
</tr>
<tr>
<td>Block Storage</td>
<td><command>cinder</command></td>
<td><package>python-cinderclient</package></td>
<td>Create and manage volumes.</td>
<td>Creates and manages volumes.</td>
</tr>
<tr>
<td>Compute</td>
<td><command>nova</command></td>
<td><package>python-novaclient</package></td>
<td>Create and manage images, instances, and flavors.</td>
<td>Creates and manages images, instances, and flavors.</td>
</tr>
<tr>
<td>Containers service</td>
<td><command>magnum</command></td>
<td><package>python-magnumclient</package></td>
<td>Create and manage containers.</td>
<td>Creates and manages containers.</td>
</tr>
<tr>
<td>Database service</td>
<td><command>trove</command></td>
<td><package>python-troveclient</package></td>
<td>Create and manage databases.</td>
<td>Creates and manages databases.</td>
</tr>
<tr>
<td>Data processing service</td>
@ -84,59 +84,59 @@
<td>Deployment service</td>
<td><command>tuskar</command></td>
<td><package>python-tuskarclient</package></td>
<td>Plan Deployments.</td>
<td>Plans Deployments.</td>
</tr>
<tr>
<td>Identity</td>
<td><command>openstack</command></td>
<td><package>python-openstackclient</package></td>
<td>Create and manage users, tenants, roles, endpoints, and credentials.</td>
<td>Creates and manages users, tenants, roles, endpoints, and credentials.</td>
</tr>
<tr>
<td>Image service</td>
<td><command>glance</command></td>
<td><package>python-glanceclient</package></td>
<td>Create and manage images.</td>
<td>Creates and manages images.</td>
</tr>
<tr>
<td>Key Manager service</td>
<td><command>barbican</command></td>
<td><package>python-barbicanclient</package></td>
<td>Create and manage keys.</td>
<td>Creates and manages keys.</td>
</tr>
<tr>
<td>Networking</td>
<td><command>neutron</command></td>
<td><package>python-neutronclient</package></td>
<td>Configure networks for guest servers. This client was
<td>Configures networks for guest servers. This client was
previously called <command>quantum</command>.</td>
</tr>
<tr>
<td>Object Storage</td>
<td><command>swift</command></td>
<td><package>python-swiftclient</package></td>
<td>Gather statistics, list items, update metadata, and upload, download, and delete
files stored by the Object Storage service. Gain access to an Object Storage
installation for ad hoc processing.</td>
<td>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.</td>
</tr>
<tr>
<td>Orchestration</td>
<td><command>heat</command></td>
<td><package>python-heatclient</package></td>
<td>Launch stacks from templates, view details of running stacks including events
and resources, and update and delete stacks.</td>
<td>Launches stacks from templates, views details of running stacks including
events and resources, and updates and deletes stacks.</td>
</tr>
<tr>
<td>Shared file systems</td>
<td><command>manila</command></td>
<td><package>python-manilaclient</package></td>
<td>Create and manage shared file systems.</td>
<td>Creates and manages shared file systems.</td>
</tr>
<tr>
<td>Telemetry</td>
<td><command>ceilometer</command></td>
<td><package>python-ceilometerclient</package></td>
<td>Create and collect measurements across OpenStack.</td>
<td>Creates and collects measurements across OpenStack.</td>
</tr>
<tr>
<td>Workflow service</td>