Commit 8eddb0fd authored by ZhaoBo's avatar ZhaoBo

Fix multi-typo error in Octavia

This patch fix some typo in Octavia.

Change-Id: I2699f85f07e3207a0438b8127e9992c553fa40fc
parent 4edcf3a8
...@@ -37,7 +37,7 @@ way around. ...@@ -37,7 +37,7 @@ way around.
Octavia is a load balancer for large operators Octavia is a load balancer for large operators
---------------------------------------------- ----------------------------------------------
That's not to say that small operators can't use it. (In fact, we expect it to That's not to say that small operators can't use it. (In fact, we expect it to
work well for small deployements, too.) But what we mean here is that if in work well for small deployments, too.) But what we mean here is that if in
creating, improving or maintaining Octavia we somehow make it unable to meet creating, improving or maintaining Octavia we somehow make it unable to meet
the needs of a typical large operator (or that operator's users), then we have the needs of a typical large operator (or that operator's users), then we have
failed. failed.
......
...@@ -12,7 +12,7 @@ To enable the octavia plugin, add a line of the form: ...@@ -12,7 +12,7 @@ To enable the octavia plugin, add a line of the form:
where where
<GITURL> is the URL of a octavia repository <GITURL> is the URL of an octavia repository
[GITREF] is an optional git ref (branch/ref/tag). The default is [GITREF] is an optional git ref (branch/ref/tag). The default is
master. master.
......
...@@ -808,7 +808,7 @@ Delete a listener. ...@@ -808,7 +808,7 @@ Delete a listener.
| | Error | 401, 404, 409, 500 | | | Error | 401, 404, 409, 500 |
+----------------+---------+------------------------------------------------+ +----------------+---------+------------------------------------------------+
**No request/reponse body** **No request/response body**
Pools Pools
----- -----
...@@ -1081,7 +1081,7 @@ Delete a pool. ...@@ -1081,7 +1081,7 @@ Delete a pool.
| | Error | 401, 404, 409, 500 | | | Error | 401, 404, 409, 500 |
+----------------+---------+-------------------------------------------------+ +----------------+---------+-------------------------------------------------+
**No request/reponse body** **No request/response body**
Health Monitors Health Monitors
--------------- ---------------
......
...@@ -253,7 +253,7 @@ epub_copyright = u'2014, OpenStack Octavia Team' ...@@ -253,7 +253,7 @@ epub_copyright = u'2014, OpenStack Octavia Team'
# The scheme of the identifier. Typical schemes are ISBN or URL. # The scheme of the identifier. Typical schemes are ISBN or URL.
#epub_scheme = '' #epub_scheme = ''
# The unique identifier of the text. This can be a ISBN number # The unique identifier of the text. This can be an ISBN number
# or the project homepage. # or the project homepage.
#epub_identifier = '' #epub_identifier = ''
......
...@@ -149,7 +149,7 @@ for Octavia to have its own operator API / interface. ...@@ -149,7 +149,7 @@ for Octavia to have its own operator API / interface.
**Notes:** **Notes:**
* This interface is stateless. State should be managd by the controller, and * This interface is stateless. State should be managed by the controller, and
stored in a highly available database. stored in a highly available database.
...@@ -264,7 +264,7 @@ LB NETWORK ...@@ -264,7 +264,7 @@ LB NETWORK
---------- ----------
This is the subnet that controllers will use to communicate with amphorae. This is the subnet that controllers will use to communicate with amphorae.
This means that controllers must have connectivity (either layer 2 or routed) This means that controllers must have connectivity (either layer 2 or routed)
to this subnet in order to function, and visa versa. Since amphorae will be to this subnet in order to function, and vice versa. Since amphorae will be
communicating on it, this means the network is not part of the "undercloud." communicating on it, this means the network is not part of the "undercloud."
**Notes:** **Notes:**
...@@ -443,7 +443,7 @@ Note that this is somewhat problematic for active / standby virtual appliance ...@@ -443,7 +443,7 @@ Note that this is somewhat problematic for active / standby virtual appliance
topologies because the vip_address for a given load balancer effectively topologies because the vip_address for a given load balancer effectively
becomes a highly-available IP address (a true floating VIP), which means on becomes a highly-available IP address (a true floating VIP), which means on
service failover from active to standby, the active amphora needs to service failover from active to standby, the active amphora needs to
relenquish all the vip_addresses it has, and the standby needs to take them relinquish all the vip_addresses it has, and the standby needs to take them
over *and* start up haproxy services. This is OK if a given amphora over *and* start up haproxy services. This is OK if a given amphora
only has a few load balancers, but can lead to several minutes' down-time only has a few load balancers, but can lead to several minutes' down-time
during a graceful failover if there are a dozen or more load balancers on the during a graceful failover if there are a dozen or more load balancers on the
......
...@@ -523,8 +523,8 @@ HTTP just get redirected to the HTTPS listener), then please see `the example ...@@ -523,8 +523,8 @@ HTTP just get redirected to the HTTPS listener), then please see `the example
.. _heath-monitor-best-practices: .. _heath-monitor-best-practices:
Heath Monitor Best Pratices Heath Monitor Best Practices
=========================== ============================
While it is possible to set up a listener without a health monitor, if a While it is possible to set up a listener without a health monitor, if a
back-end pool member goes down, Octavia will not remove the failed server from back-end pool member goes down, Octavia will not remove the failed server from
the pool until a considerable time has passed. This can lead to service the pool until a considerable time has passed. This can lead to service
......
...@@ -222,7 +222,7 @@ network. Octavia uses the standard python setuptools, so installation of the ...@@ -222,7 +222,7 @@ network. Octavia uses the standard python setuptools, so installation of the
software itself should be straightforward. software itself should be straightforward.
Running multiple instances of the individual Octavia controller components on Running multiple instances of the individual Octavia controller components on
seperate physical hosts is recommended in order to provide scalability and separate physical hosts is recommended in order to provide scalability and
availability of the controller software. availability of the controller software.
One important security note: In 0.9 of Octavia, the Octavia API is designed to One important security note: In 0.9 of Octavia, the Octavia API is designed to
......
...@@ -45,7 +45,7 @@ case $1 in ...@@ -45,7 +45,7 @@ case $1 in
stop) stop)
# Stop the daemon. # Stop the daemon.
if [ -e $PIDFILE ]; then if [ -e $PIDFILE ]; then
status_of_proc -p $PIDFILE $DAEMON "Stoppping the $NAME process" && status="0" || status="$?" status_of_proc -p $PIDFILE $DAEMON "Stopping the $NAME process" && status="0" || status="$?"
if [ "$status" = 0 ]; then if [ "$status" = 0 ]; then
start-stop-daemon --stop --quiet --oknodo --pidfile $PIDFILE start-stop-daemon --stop --quiet --oknodo --pidfile $PIDFILE
/bin/rm -rf $PIDFILE /bin/rm -rf $PIDFILE
......
...@@ -55,7 +55,7 @@ crl = $dir/crl.pem # The current CRL ...@@ -55,7 +55,7 @@ crl = $dir/crl.pem # The current CRL
private_key = $dir/private/cakey.pem# The private key private_key = $dir/private/cakey.pem# The private key
RANDFILE = $dir/private/.rand # private random number file RANDFILE = $dir/private/.rand # private random number file
x509_extensions = usr_cert # The extentions to add to the cert x509_extensions = usr_cert # The extensions to add to the cert
# Comment out the following two lines for the "traditional" # Comment out the following two lines for the "traditional"
# (and highly broken) format. # (and highly broken) format.
...@@ -107,7 +107,7 @@ default_bits = 2048 ...@@ -107,7 +107,7 @@ default_bits = 2048
default_keyfile = privkey.pem default_keyfile = privkey.pem
distinguished_name = req_distinguished_name distinguished_name = req_distinguished_name
attributes = req_attributes attributes = req_attributes
x509_extensions = v3_ca # The extentions to add to the self signed cert x509_extensions = v3_ca # The extensions to add to the self signed cert
# Passwords for private keys if not present they will be prompted for # Passwords for private keys if not present they will be prompted for
# input_password = secret # input_password = secret
......
...@@ -40,7 +40,7 @@ class BaseController(rest.RestController): ...@@ -40,7 +40,7 @@ class BaseController(rest.RestController):
@staticmethod @staticmethod
def _convert_db_to_type(db_entity, to_type, children=False): def _convert_db_to_type(db_entity, to_type, children=False):
"""Converts a data model into a Octavia WSME type """Converts a data model into an Octavia WSME type
:param db_entity: data model to convert :param db_entity: data model to convert
:param to_type: converts db_entity to this time :param to_type: converts db_entity to this time
......
...@@ -40,7 +40,7 @@ class BaseController(rest.RestController): ...@@ -40,7 +40,7 @@ class BaseController(rest.RestController):
@staticmethod @staticmethod
def _convert_db_to_type(db_entity, to_type, children=False): def _convert_db_to_type(db_entity, to_type, children=False):
"""Converts a data model into a Octavia WSME type """Converts a data model into an Octavia WSME type
:param db_entity: data model to convert :param db_entity: data model to convert
:param to_type: converts db_entity to this time :param to_type: converts db_entity to this time
......
...@@ -181,7 +181,7 @@ def _read_pem_blocks(data, *markers): ...@@ -181,7 +181,7 @@ def _read_pem_blocks(data, *markers):
:param data: A long text string containing one or more PEM-encoded blocks :param data: A long text string containing one or more PEM-encoded blocks
:param markers: A tuple containing the test strings that indicate the :param markers: A tuple containing the test strings that indicate the
start and end of the the PEM-encoded blocks start and end of the PEM-encoded blocks
:returns: An ASN1 substrate suitable for DER decoding. :returns: An ASN1 substrate suitable for DER decoding.
""" """
......
...@@ -67,7 +67,7 @@ class DatabaseCleanup(object): ...@@ -67,7 +67,7 @@ class DatabaseCleanup(object):
self.lb_repo = repo.LoadBalancerRepository() self.lb_repo = repo.LoadBalancerRepository()
def delete_old_amphorae(self): def delete_old_amphorae(self):
"""Checks the DB for old amphora and deletes them based on it's age.""" """Checks the DB for old amphora and deletes them based on its age."""
exp_age = datetime.timedelta( exp_age = datetime.timedelta(
seconds=CONF.house_keeping.amphora_expiry_age) seconds=CONF.house_keeping.amphora_expiry_age)
......
...@@ -42,8 +42,8 @@ class EventStreamerBase(object): ...@@ -42,8 +42,8 @@ class EventStreamerBase(object):
class EventStreamerNoop(EventStreamerBase): class EventStreamerNoop(EventStreamerBase):
"""Nop class implementation of EventStreamer """Nop class implementation of EventStreamer
Usefull if your running in standalone mode and don't need to send Useful if you're running in standalone mode and don't need to send
updates to Neutron Lbaas updates to Neutron LBaaS
""" """
def emit(self, cnt): def emit(self, cnt):
......
...@@ -113,7 +113,7 @@ class BaseRepository(object): ...@@ -113,7 +113,7 @@ class BaseRepository(object):
"""Determines whether an entity exists in the database by its id. """Determines whether an entity exists in the database by its id.
:param session: A Sql Alchemy database session. :param session: A Sql Alchemy database session.
:param id: id of entity to check for existance. :param id: id of entity to check for existence.
:returns: octavia.common.data_model :returns: octavia.common.data_model
""" """
return bool(session.query(self.model_class).filter_by(id=id).first()) return bool(session.query(self.model_class).filter_by(id=id).first())
......
...@@ -84,7 +84,7 @@ Establish an abstract base class to model the desired functionality: ...@@ -84,7 +84,7 @@ Establish an abstract base class to model the desired functionality:
raise NotImplementedError raise NotImplementedError
def get_amphora(self, amphora_name = None, amphora_id = None): def get_amphora(self, amphora_name = None, amphora_id = None):
""" Try to find a amphora given its name or id """ Try to find an amphora given its name or id
:param amphora_name: the name of the desired amphora :param amphora_name: the name of the desired amphora
:param amphora_id: the id of the desired amphora :param amphora_id: the id of the desired amphora
......
...@@ -20,7 +20,7 @@ Problem description ...@@ -20,7 +20,7 @@ Problem description
=================== ===================
There is a need to define a generic interface for a networking service. An There is a need to define a generic interface for a networking service. An
Octavia controller should not know what networking infrastucture is being used Octavia controller should not know what networking infrastructure is being used
underneath. It should only know an interface. This interface is needed to underneath. It should only know an interface. This interface is needed to
support differing networking infrastructures. support differing networking infrastructures.
......
...@@ -23,7 +23,7 @@ Queue Consumer. ...@@ -23,7 +23,7 @@ Queue Consumer.
Proposed change Proposed change
=============== ===============
The major component of the Queue Consumer will be be a class that acts as a The major component of the Queue Consumer will be a class that acts as a
consumer to Oslo messages. It will be responsible for configuring and starting consumer to Oslo messages. It will be responsible for configuring and starting
a server that is then able to receive messages. There will be a one-to-one a server that is then able to receive messages. There will be a one-to-one
mapping between API methods and consumer methods (see code snippet below). mapping between API methods and consumer methods (see code snippet below).
......
...@@ -272,7 +272,7 @@ Amphora related changes ...@@ -272,7 +272,7 @@ Amphora related changes
* Extend data model to support active-active Amphora. This is somewhat * Extend data model to support active-active Amphora. This is somewhat
similar to active-passive (VRRP) support. Each Amphora needs to store its similar to active-passive (VRRP) support. Each Amphora needs to store its
IP and port on it's front-end network (similar to ha_ip and ha_port_id IP and port on its front-end network (similar to ha_ip and ha_port_id
in the current model) and its role should indicate it is in a cluster. in the current model) and its role should indicate it is in a cluster.
The provisioning status should be interpreted as referring to an Amphora The provisioning status should be interpreted as referring to an Amphora
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment