stackforge/libra
Code Issues Proposed changes

[docs] Fix minor typos in some documentation files

Browse Source 
Change-Id: Ice0dbd8f4e098f8be71cf009cf6cb2d503eec0f3
This commit is contained in:
Jamie McCarthy 2013-07-23 18:18:46 -04:00
parent 6c1c2fcc17
commit 01966929dd
4 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/api/api.rst
View File

@ -167,8 +167,8 @@ LBaaS APIs.
4.1 Authentication
~~~~~~~~~~~~~~~~~~
The LBaaS API uses standard defined by OpenStack Keystone project and
used by the for authentication. Please refer to the
The LBaaS API uses standards defined by the OpenStack Keystone project
for authentication. Please refer to the
identity management system for more details on all authentication
methods currently supported.
@ -187,7 +187,7 @@ The LBaaS API currently only supports JSON data serialization formats
for request and response bodies. The request format is specified using
the 'Content-Type' header and is required for operations that have a
request body. The response format should be specified in requests using
the 'Accept'header. If no response format is specified, JSON is the
the 'Accept' header. If no response format is specified, JSON is the
default.
4.4 Persistent Connections
@ -257,8 +257,7 @@ all faults:*
Tenant identifiers with LBaaS API URIs are not required. The tenant
identifier is derived from the Openstack Keystone authentication token
provided with each API call. This simplifies the REST URIs to only
include the base URI and the resource. The tenant identifier is derived
from the authentication token which is provided wi the API call. All
include the base URI and the resource. All
LBaaS calls behave in this manner.
5. LBaaS API Resources and Methods
@ -930,13 +929,13 @@ This operation returns the following attributes for each load balancer:
**id :** Unique identifier for the load balancer
**name :** Creator assigned name for the load balancer
**name :** Creator-assigned name for the load balancer
**algorithm :** Creator specified algoriothm for the load balancer
**algorithm :** Creator-specified algorithm for the load balancer
**protocol :** Creator specified protocol for the load balancer
**protocol :** Creator-specified protocol for the load balancer
**port :** Creator specified port for the load balancer
**port :** Creator-specified port for the load balancer
**status :** Current status, see section on load balancer status within
load balancer create
@ -1219,7 +1218,7 @@ HTTP, port set to 80 (or 443 if protocol is HTTPS), and assign a public
IPV4 address to the loadbalancer. The default algorithm used is set to
ROUND\_ROBIN.
A load balancer name has a max length that can be queried when querying
A load balancer name has a max length that can be determined by querying
limits.
Users may configure all documented features of the load balancer at
@ -1472,7 +1471,7 @@ attributes:
This operation does not return a response body.
Note, The load balancer ID, status, port and protocol are immutable
Note: The load balancer ID, status, port and protocol are immutable
attributes and cannot be modified by the caller. Supplying an
unsupported attribute will result in a 400 (badRequest) fault.
@ -2106,7 +2105,7 @@ None.
20.2 Description
~~~~~~~~~~~~~~~~
Delete node for a load balancer. Note, A load balancer must have at
Delete node for a load balancer. Note: A load balancer must have at
least one node. Attempting to remove the last node of a loadbalancer
will result in a 401 error.

14
doc/config.rst
View File

@ -52,7 +52,7 @@ Global Section
Common Command Line Options
---------------------------
These command line options are common to all libra utilities
These command line options are common to all libra utilities.
.. option:: -c <FILE>, --config <FILE>
@ -74,9 +74,10 @@ Common Command Line Options
.. option:: -l <FILE>, --logfile <FILE>
Name of the log file. When running in daemon mode, the default log
file is */var/log/libra/libra_worker.log*. When not in daemon mode,
logging will go to STDOUT unless a log file is specified.
Name of the log file. When not in daemon mode, the logs go by
default to STDOUT. As a daemon, the default log file is
*/var/run/libra/libra_name.log*, where "name" is the utility's
short name (like "api", "mgm", or "worker").
.. option:: -n, --nodaemon
@ -85,8 +86,9 @@ Common Command Line Options
.. option:: -p <PID>, --pid <PID>
Name of the PID file to use. Default is:
*/var/run/libra/libra_worker.pid*
Name of the PID file to use. The default is
*/var/run/libra/libra_name.pid*, where "name" is the utility's
short name (like "api", "mgm", or "worker").
.. option:: --syslog

4
doc/introduction.rst
View File

@ -20,10 +20,10 @@ Layout
.. image:: libralayout.png
Here you can see that the pool manager spins up the required Nova nodes with
the load balancer image. It then hands the details of this node over the the
the load balancer image. It then hands the details of these nodes over to the
Admin API server.
The client sends an API request to the API server which in-turn sends the
The client sends an API request to the API server, which in turn sends the
configuration information to the worker on the load balancer node. The worker
has a plugin system to speak to multiple load balancer types but is currently
designed to use HAProxy.

2
doc/pool_mgm/about.rst
View File

@ -14,5 +14,5 @@ Design
It is designed to probe the API server every X minutes (5 by default) to find
out how many free nodes there are. If this falls below a certain defined level
the pool manager will spin up new nodes and supply the details of the to the
the pool manager will spin up new nodes and supply their details to the
API server.