openstack/openstack-manuals
Code Issues Proposed changes

Edited Installation Guide Client Overview

Browse Source 
Clarified the sentences with minor content additions. Added punctuation,
and reduced repetition to add clarity. Changed Case.

Change-Id: I30dbfef463dc51f2b12ed63a0420b5365cfe9494
backport: none
Implements: blueprint installation-guide-improvements
This commit is contained in:
Joseph Robinson
2014-05-30 12:55:32 +10:00
parent a0911eef57
commit e356395605
1 changed files with 24 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
doc/common/section_cli_overview.xml
View File

@@ -5,23 +5,30 @@
version="5.0"
xml:id="section_cli_overview">
<title>Overview</title>
<para>You can use the OpenStack command-line clients to run simple commands
that make API calls. You can run these commands from the command line or
in scripts to automate tasks. If you provide OpenStack credentials, you
can run these commands on any computer.</para>
<para>Internally, each client command runs cURL commands that
embed API requests. The OpenStack APIs are RESTful APIs that
use the HTTP protocol, including methods, URIs, media types,
and response codes.</para>
<para>These open-source Python clients run on Linux or Mac OS X
systems and are easy to learn and use. Each OpenStack service
has its own command-line client. On some client commands, you
can specify a <command>debug</command>
parameter to show the underlying API request for the command.
This is a good way to become familiar with the OpenStack API
calls.</para>
<para>The following table lists the command-line client for each OpenStack
service with its package name and description.</para>
<para>
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.</para>
<para>
You can run the commands from the command line, or include the
commands within scripts to automate tasks. If you provide
OpenStack credentials, such as your user name and password, you
can run these commands on any computer.
</para>
<para>
Internally, each command uses cURL command-line tools, which embed
API requests. OpenStack APIs are RESTful APIs, and use the HTTP
protocol. They include methods, URIs, media types, and response
codes.</para>
<para>
OpenStack APIs are open-source Python clients, and can run on
Linux or Mac OS X systems. On some client commands, you can
specify a <command>debug</command> parameter to show the
underlying API request for the command. This is a good way to
become familiar with the OpenStack API calls.</para>
<para>The following table lists the command-line client for each
OpenStack service with its package name and description.</para>
<table rules="all">
<caption>OpenStack services and clients</caption>
<col width="15%"/>