From 231d1bce409c3305352ebdb58635c5353362ba63 Mon Sep 17 00:00:00 2001 From: Ngo Quoc Cuong Date: Tue, 9 May 2017 08:43:24 +0700 Subject: [PATCH] Trivial fix typos in documents Change-Id: I6541d0b396bfc47ac8d13bcd24f5b8e3c20708c7 --- doc/source/api/octaviaapi.rst | 2 +- .../design/version0.5/component-design.rst | 4 ++-- doc/source/guides/dev-quick-start.rst | 4 ++-- doc/source/guides/l7-cookbook.rst | 13 +++++++------ doc/source/guides/operator-maintenance.rst | 12 ++++++------ doc/source/main/glossary.rst | 2 +- doc/source/main/gmr.rst | 2 +- specs/template.rst | 2 +- specs/version0.5/amphora-manager-interface.rst | 2 +- specs/version0.5/controller-worker.rst | 2 +- .../housekeeping-manager-interface.rst | 4 ++-- specs/version1/vip-qos-policy-application.rst | 16 ++++++++-------- 12 files changed, 33 insertions(+), 32 deletions(-) diff --git a/doc/source/api/octaviaapi.rst b/doc/source/api/octaviaapi.rst index 395960f148..9aa40a9290 100644 --- a/doc/source/api/octaviaapi.rst +++ b/doc/source/api/octaviaapi.rst @@ -2238,7 +2238,7 @@ Modify a project's quotas. Delete Quota ************ -Delete a project's quota, reseting it to the configured default quotas. +Delete a project's quota, resetting it to the configured default quotas. +----------------+-----------------------------------------------------------+ | Request Type | ``DELETE`` | diff --git a/doc/source/design/version0.5/component-design.rst b/doc/source/design/version0.5/component-design.rst index 27a0883d0b..72a341aa96 100644 --- a/doc/source/design/version0.5/component-design.rst +++ b/doc/source/design/version0.5/component-design.rst @@ -161,7 +161,7 @@ driver. It should be noted that in later releases of Octavia, the controller functions will be split across several components. At this stage we are less concerned -with how this internal communcation will happen, and are most concerned with +with how this internal communication will happen, and are most concerned with ensuring communication with amphorae, the amphora LB driver, and the Network driver are all made as perfect as possible. @@ -404,7 +404,7 @@ Option 2: "True Active / Standby" * In this topology, both amphorae need to be colocated on the same subnet. As such a "spares pool" doesn't make sense for this type of layout, unless - all spares are on the same mamangement network with the active nodes. + all spares are on the same management network with the active nodes. We considered also supporting "Single node" topology, but this turns out to be the same thing as option 1 above with a spares pool size of zero. diff --git a/doc/source/guides/dev-quick-start.rst b/doc/source/guides/dev-quick-start.rst index bdcb10d44c..9f59261812 100644 --- a/doc/source/guides/dev-quick-start.rst +++ b/doc/source/guides/dev-quick-start.rst @@ -138,7 +138,7 @@ Production Deployment Walkthrough Create Octavia User ___________________ By default Octavia will use the 'neutron' user for keystone authentication, and -the admin user for interactions with all other serivces. However, it doesn't +the admin user for interactions with all other services. However, it doesn't actually share neutron's database or otherwise access Neutron outside of Neutron's API, so a dedicated 'octavia' keystone user should generally be created for Octavia to use. @@ -272,7 +272,7 @@ bi-directional certificate-based authentication in order to authenticate and encrypt communication. You must therefore create appropriate TLS certificates which will be used for key signing, authentication, and encryption. There is a helper script to do this in this repository under: -``bin/create_certficiates.sh`` +``bin/create_certificates.sh`` Please note that certificates created with this helper script may not meet your organization's security policies, since they are self-signed certificates with diff --git a/doc/source/guides/l7-cookbook.rst b/doc/source/guides/l7-cookbook.rst index 8e8c8d8ee0..b7045eeee7 100644 --- a/doc/source/guides/l7-cookbook.rst +++ b/doc/source/guides/l7-cookbook.rst @@ -22,12 +22,13 @@ Introduction This document gives several examples of common L7 load balancer usage. For a description of L7 load balancing see: :doc:`l7` -For the puposes of this guide we assume that the neutron command-line interface -is going to be used to configure all features of Neutron LBaaS with an Octavia -back-end. Also, in order to keep these examples short, we assume that many -non-L7 configuration tasks (such as deploying loadbalancers, listeners, pools, -members, healthmonitors, etc.) have already been accomplished. A description -of the starting conditions is given in each example below. +For the purposes of this guide we assume that the neutron command-line +interface is going to be used to configure all features of Neutron LBaaS with +an Octavia back-end. Also, in order to keep these examples short, we assume +that many non-L7 configuration tasks (such as deploying loadbalancers, +listeners, pools, members, healthmonitors, etc.) have already been +accomplished. A description of the starting conditions is given in each example +below. Examples diff --git a/doc/source/guides/operator-maintenance.rst b/doc/source/guides/operator-maintenance.rst index e3eac466e0..c7338b5d21 100644 --- a/doc/source/guides/operator-maintenance.rst +++ b/doc/source/guides/operator-maintenance.rst @@ -14,7 +14,7 @@ under the License. ====================================== -Operator Maintenace Guide +Operator Maintenance Guide ====================================== This document is intended for operators. For a developer guide see the :doc:`dev-quick-start` in this documentation repository. For an end-user @@ -25,7 +25,7 @@ Monitoring ========== -Montioring Load Balancer Amphora +Monitoring Load Balancer Amphora -------------------------------- Octavia will monitor the load balancing amphorae itself and initiate failovers and/or replacements if they malfunction. Therefore, most installations won't @@ -211,11 +211,11 @@ Best Practices/Optimizations ---------------------------- To speed up the failovers, the spare pool can be temporarily increased to -accomodate the rapid failover of the amphora. In this case after the +accommodate the rapid failover of the amphora. In this case after the new image has been loaded into glance, shut down or initiate a failover of the amphora in the spare pool. They can be found, for instance, by looking for the -servers in ``openstack server list --all`` who only have an ip on the mangement -network assigned but not any tenant network. Alternatively, use this +servers in ``openstack server list --all`` who only have an ip on the +management network assigned but not any tenant network. Alternatively, use this database query: @@ -249,7 +249,7 @@ initiated this might crowd out other operations. In Pike a failover command is being added to the API which allows to failover a load balancer's amphora while taking care of the intricacies of different topologies and prioritizes administrative failovers behind other operations. - This function should be used instead of the ones descrived above once it + This function should be used instead of the ones described above once it becomes available. Rotating Cryptographic Certificates diff --git a/doc/source/main/glossary.rst b/doc/source/main/glossary.rst index 3e2ced3d18..a8fc126e2e 100644 --- a/doc/source/main/glossary.rst +++ b/doc/source/main/glossary.rst @@ -77,7 +77,7 @@ description of these terms. Layer 7 Rule Single logical expression used to match a condition present in a given HTTP or terminated HTTPS request. L7 rules typically match against - a specific header or part of the URI and are used in conjuncion with + a specific header or part of the URI and are used in conjunction with L7 policies to accomplish L7 switching. An L7 rule is associated with exactly one L7 policy. diff --git a/doc/source/main/gmr.rst b/doc/source/main/gmr.rst index 8ed67741eb..5a689fbeed 100644 --- a/doc/source/main/gmr.rst +++ b/doc/source/main/gmr.rst @@ -40,7 +40,7 @@ own sections. However, the base *GMR* consists of several sections: Package Shows information about the package to which this process belongs, including - version informations. + version information. Threads Shows stack traces and thread ids for each of the threads within this diff --git a/specs/template.rst b/specs/template.rst index 366e85bb68..2680c9c739 100644 --- a/specs/template.rst +++ b/specs/template.rst @@ -283,7 +283,7 @@ Note that the schema should be defined as restrictively as possible. Parameters which are required should be marked as such and only under exceptional circumstances should additional parameters which are not defined in the schema be permitted (eg -additionaProperties should be False). +additionalProperties should be False). Reuse of existing predefined parameter types such as regexps for passwords and user defined names is highly encouraged. diff --git a/specs/version0.5/amphora-manager-interface.rst b/specs/version0.5/amphora-manager-interface.rst index c2b7bf5cbf..9f21a4e4e4 100755 --- a/specs/version0.5/amphora-manager-interface.rst +++ b/specs/version0.5/amphora-manager-interface.rst @@ -53,7 +53,7 @@ Establish an abstract base class to model the desired functionality: groups :param network_ids: A list of network_ids to attach to the amphora - :config_drive_files: A dict of files to overrwrite on + :config_drive_files: A dict of files to overwrite on the server upon boot. Keys are file names (i.e. /etc/passwd) and values are the file contents (either as a string or as a file-like object). A maximum of five entries is allowed, diff --git a/specs/version0.5/controller-worker.rst b/specs/version0.5/controller-worker.rst index 4484bd5fb8..ab063eb6e3 100644 --- a/specs/version0.5/controller-worker.rst +++ b/specs/version0.5/controller-worker.rst @@ -38,7 +38,7 @@ facilitate the create/update/delete actions. This class will be responsible for managing the number of simultaneous operations being executed by coordinating through the Octavia database. -The Controller Worker will provide a base class that sets up and initilizes +The Controller Worker will provide a base class that sets up and initializes the TaskFlow engines required to complete the action. Users of the library will then call the appropriate method for the action. These methods setup and launch the appropriate flow. Each flow will be contained in a separate diff --git a/specs/version0.5/housekeeping-manager-interface.rst b/specs/version0.5/housekeeping-manager-interface.rst index 97d04588cf..d201857b12 100755 --- a/specs/version0.5/housekeeping-manager-interface.rst +++ b/specs/version0.5/housekeeping-manager-interface.rst @@ -152,7 +152,7 @@ Performance Impact ------------------ The housekeeping_interval and spare_pool_size parameters will be -adjustible by the operator in order to balance resource usage against +adjustable by the operator in order to balance resource usage against performance. @@ -160,7 +160,7 @@ Developer impact ---------------- Developers of other modules need to be aware that amphorae may be -created, deleted, or saved for diagonsis by this daemon. +created, deleted, or saved for diagnosis by this daemon. Implementation diff --git a/specs/version1/vip-qos-policy-application.rst b/specs/version1/vip-qos-policy-application.rst index 634ed26da4..c9fa0465a8 100644 --- a/specs/version1/vip-qos-policy-application.rst +++ b/specs/version1/vip-qos-policy-application.rst @@ -12,14 +12,14 @@ Vip QoS Policy Application Problem description =================== For real cases, the bandwidth of vip should be limited, because the upstream -network resource is provided by the ISP or other orgnizations. That means it is -not free. The openstack provider or users should pay for the limited bandwidth, -for example, users buy the 50M bandwidth from ISP for openstack environment to -access Internet, also it will be used for the connection outside of openstack -to access the servers in openstack. And the servers are behind LoadBalance VIP. -We cannot offer the whole bandwidth to the servers, as maybe there also are the -VMs want to access the external network. So we should take a bandwidth -limitation towards vip port. +network resource is provided by the ISP or other organizations. That means it +is not free. The openstack provider or users should pay for the limited +bandwidth, for example, users buy the 50M bandwidth from ISP for openstack +environment to access Internet, also it will be used for the connection outside +of openstack to access the servers in openstack. And the servers are behind +LoadBalance VIP. We cannot offer the whole bandwidth to the servers, as maybe +there also are the VMs want to access the external network. So we should take a +bandwidth limitation towards vip port. Also, if the upstream network resource had been used up mostly, we still want the backend servers behind loadbalancer are accessible and stable. The min