[cloudstack-documentation] 04/21: wording and header corrections

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rohit pushed a commit to branch security-tls-config
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git

commit 4d004f83c91fadd8cf1598d0da4013d235f16672
Author: ernjvr <er...@gmail.com>
AuthorDate: Tue Aug 28 15:39:10 2018 +0200

    wording and header corrections
---
 .../networking/additional_networking_features.rst  | 91 ++++++++++++----------
 1 file changed, 49 insertions(+), 42 deletions(-)

diff --git a/source/adminguide/networking/additional_networking_features.rst b/source/adminguide/networking/additional_networking_features.rst
index c15aa46..41d9690 100644
--- a/source/adminguide/networking/additional_networking_features.rst
+++ b/source/adminguide/networking/additional_networking_features.rst
@@ -13,97 +13,104 @@
    specific language governing permissions and limitations
    under the License.
 
-
+##############################
 Additional Networking Features
------------------------------------
-
+##############################
 
+*******************************
 KVM Libvirt Hook Script Include
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+*******************************
 
-**Feature Overview**:
+Feature Overview:
+=================
 
 -  This feature applies to KVM hosts.
 -  KVM utilised under CloudStack uses the standard Libvirt hook script behaviour outlined in https://libvirt.org/hooks.html.
--  During the install of the KVM CloudStack agent, the script "/etc/libvirt/hooks/qemu" is populated based on the CloudStack-provided file "libvirtqemuhook.in". 
--  This is a python script that carries out network management tasks every time a VM is started, stopped or migrated, as per the qemu script specification.
--  User-specific network configuration tasks can be done at the same time as the "/etc/libvirt/hooks/qemu" is called.
--  Since the tasks in question are user-specific, they cannot be included in the CloudStack-provided script.
+-  During the install of the KVM CloudStack agent, the Libvirt hook script "/etc/libvirt/hooks/qemu", referred to as the qemu script hereafter is installed. 
+-  This is a python script that carries out network management tasks every time a VM is started, stopped or migrated, as per the Libvirt hooks specification.
+-  Custom network configuration tasks can be done at the same time as the qemu script is called.
+-  Since the tasks in question are user-specific, they cannot be included in the CloudStack-provided qemu script.
 
--  The Libvirt documentation page https://libvirt.org/hooks.html#qemu describes the parameters that can be passed to the "qemu" script, based on what actions KVM and Libvirt are carrying out on each VM: 'prepare', 'start', 'started', 'stopped', 'release', 'migrate', 'restore', 'reconnect' and 'attach'.
+-  The Libvirt documentation page https://libvirt.org/hooks.html#qemu describes the parameters that can be passed to the qemu script, based on what actions KVM and Libvirt are carrying out on each VM: 'prepare', 'start', 'started', 'stopped', 'release', 'migrate', 'restore', 'reconnect' and 'attach'.
 
-**The KVM Libvirt Hook script allows for**:
+The KVM Libvirt Hook script allows for:
+=======================================
 
-#. The inclusion and execution of user-specific scripts to perform additional networking configuration tasks.
-#. The included user-specific scripts can be bash scripts and/or python scripts.
-#. Each script's start-up and return commands are captured and logged.
-#. There are no limits to the number of user-specific scripts that can be included or called.
+#. The inclusion and execution of custom scripts to perform additional networking configuration tasks.
+#. The included custom scripts can be bash scripts and/or python scripts.
+#. Each custom script's start-up and return commands are captured and logged.
+#. There are no limits to the number of custom scripts that can be included or called.
 
-**Usage**:
+Usage:
+======
 
-
--  The cloudstack-agent package will install the libvirtqemuhook.in script in the /etc/libvirt/hooks directory of Libvirt and rename the script to "qemu".
--  The documentation page: https://libvirt.org/hooks.html#arguments describes the arguments that can be passed to the "qemu" script. 
+-  The cloudstack-agent package will install the qemu script in the /etc/libvirt/hooks directory of Libvirt.
+-  The documentation page: https://libvirt.org/hooks.html#arguments describes the arguments that can be passed to the qemu script. 
 -  The input arguments are: 
 
     #. Name of the object involved in the operation, or '-' if there is none. For example, the name of a guest being started.
-    #. Name of the operation being performed. For example, "start" if a guest is being started.
+    #. Name of the operation being performed. For example, 'start' if a guest is being started.
     #. Sub-operation indication, or '-' if there is none.
     #. An extra argument string, or '-' if there is none.
 
 -  The operation argument is based on what actions KVM and Libvirt are carrying out on each VM: 'prepare', 'start', 'started', 'stopped', 'release', 'migrate', 'restore', 'reconnect', 'attach'.
 
--  If an invalid operation argument is received, the hook script will log the fact, not execute any custom scripts and exit.
+-  If an invalid operation argument is received, the qemu script will log the fact, not execute any custom scripts and exit.
 
--  All input arguments that are passed to the Libvirt hook script are also be passed to each user-specific custom script. 
+-  All input arguments that are passed to the qemu script will also be passed to each custom script. 
 
--  For each of the above actions, the "qemu" hook script will find and run scripts by the name "<action>_<custom script name" in a custom include path /etc/libvirt/hooks/custom/. Custom scripts that do not follow this naming convention will be ignored and not be executed.
+-  For each of the above actions, the qemu script will find and run scripts by the name "<action>_<custom script name>" in a custom include path /etc/libvirt/hooks/custom/. Custom scripts that do not follow this naming convention will be ignored and not be executed.
 
--  In addition to the Libvirt standard actions, the hook script will also find and run user-specific scripts with an "all" prefixed to the script name. For example: "all_<custom script name>". These user-specific scripts will run every time the hook script is called with a valid Libvirt action.
--  In the case of multiple scripts, they will be executed in sorted (alphabetical) order. The alphabetical ordering will use the file name part after the prefix and underscore have been removed from the file name. For example, if there are two files in the directory: all_cde.sh, migrate_abc.py; they will be sorted and executed in this order: migrate_abc.py, all_cde.sh.
+-  In addition to the Libvirt standard actions, the qemu script will also find and run custom scripts with an "all" prefixed to the script name. For example: "all_<custom script name>". These custom scripts will run every time the qemu script is called with a valid Libvirt action.
+-  In the case of multiple custom scripts, they will be executed in sorted (alphabetical) order. The alphabetical ordering will use the file name part after the prefix and underscore have been removed from the file name. For example, if there are two custom script files in the directory: all_cde.sh, migrate_abc.py; they will be sorted and executed in this order: migrate_abc.py, all_cde.sh.
 -  Custom scripts can either be bash scripts and/or python scripts.
 -  Custom scripts must be executable by the underlying host operating system. Non-executable scripts will be logged and ignored.
 -  Each custom script's start-up and return commands will be captured and logged.
 -  During execution of a custom script, the standard out (stdout) and standard error (stderr) outputs of the custom script will be logged (appended) to /var/log/libvirt/qemu-hook.log. If the custom script needs to log anything, it can also use this file for logging purposes.
--  There is a timeout setting in the libvirtqemuhook.in script that counts down at the start of every execution of a custom script. If the custom script is still executing after the timeout time has elapsed, the custom script will be gracefully terminated.
+-  There is a timeout setting in the qemu script that counts down at the start of every execution of a custom script. If the custom script is still executing after the timeout time has elapsed, the custom script will be gracefully terminated.
 
-**Timeout Configuration**:
+Timeout Configuration:
+======================
 
--  The timeout setting called "timeoutSeconds", at the top of the “qemu” script, has a default timeout setting of 10 minutes, expressed as 10 * 60 seconds, and can be modified manually if a different timeout is required.
+-  The timeout setting called "timeoutSeconds", at the top of the qemu script, has a default timeout setting of 10 minutes, expressed as 10 * 60 seconds, and can be manually modified if a different timeout is required.
 -  To configure a different timeout, do the following:
 
-    #. Navigate to the /etc/libvirt/hooks/qemu folder.
-    #. Open the libvirtqemuhook.in script in an editor.
+    #. Navigate to the /etc/libvirt/hooks/ folder.
+    #. Open the qemu script in an editor.
     #. Find the "timeoutSeconds" timeout setting.
     #. Change the 10 * 60 value to a preferred timeout value. For example 20 * 60, for a 20-minute timeout.
 
-**Custom Script Naming for a Specific VM Action**:
+Custom Script Naming for a Specific VM Action:
+==============================================
 
 -  For a custom script that needs to be executed at the end of a specific VM action, do the following: 
+
     #. Navigate to the custom script that needs to be executed for a specific action.
-    #. Rename the file by prefixing to the filename the specific action name followed by an underscore. For example, if a custom script is named abc.sh then prefix 'migrate' and an underscore to the name to become migrate_abc.sh.
+    #. Rename the file by prefixing to the filename the specific action name followed by an underscore. For example, if a custom script is named abc.sh, then prefix 'migrate' and an underscore to the name to become migrate_abc.sh.
 
 
-**Custom Script Naming for All VM Actions**:
+Custom Script Naming for All VM Actions:
+==============================================
 
 -  For a custom script that needs to be executed at the end of all VM actions, do the following:
 
     #. Navigate to the custom script that needs to be executed for all actions.
-    #. Rename the file by prefixing 'all' to the filename, followed by an underscore.  For example, if a custom script is named def.py then prefix 'all' and an underscore to the name to become all_def.py.
+    #. Rename the file by prefixing 'all' to the filename, followed by an underscore.  For example, if a custom script is named def.py, then prefix 'all' and an underscore to the name to become all_def.py.
 
-**Custom Script Execution Configuration**:
+Custom Script Execution Configuration:
+==============================================
 
--  Grant each script with executable permissions so that the underlying host operating system can execute them:
+-  Grant each custom script execute permissions so that the underlying host operating system can execute them:
 
-    #. Navigate to the custom script that needs to be executed.
-    #. Grant the file with executable permissions.
+    #. Navigate to the custom script that needs to be executable.
+    #. Grant the custom script execute permissions.
 
--  Place the custom scripts in the custom include folder /etc/libvirt/hooks/custom/ so that the “qemu” script will be able to find and execute them:
+-  Place the custom scripts in the custom include folder /etc/libvirt/hooks/custom/ so that the qemu script will be able to find and execute them:
 
-    #. Make sure that the /etc/libvirt/hooks/custom/ folder is created and that it has the correct permissions.
+    #. Make sure that the /etc/libvirt/hooks/custom/ folder is created and that it has the correct access permissions.
     #. Navigate to the custom scripts that need to be copied.
     #. Copy the scripts to the /etc/libvirt/hooks/custom/ folder.
 
 
--  In shell custom scripts include #!/bin/bash in the first line of the file.
--  In Python custom scripts include #!/usr/bin/python in the first line of the file.
+-  In shell custom scripts include #!/bin/bash in the first line of the file so that the script will be executed with bash.
+-  In Python custom scripts include #!/usr/bin/python in the first line of the file so that the script will be executed with python.