Merge pull request #5706 from xcat2/master

Merge master to 2.14 for 2.14.4 release(1)

docs/source/advanced/goconserver/index.rst

@@ -5,7 +5,6 @@ Go Conserver
 programming language. For more information, see https://github.com/xcat2/goconserver/
 
 .. toctree::
-
   :maxdepth: 2
 
   quickstart.rst

docs/source/advanced/gpu/nvidia/repo/index.rst

@@ -10,5 +10,4 @@ Download the toolkit and prepare the software repository on the xCAT Management
 
    rhels.rst
    ubuntu.rst
-   nvml.rst
 

docs/source/advanced/hierarchy/provision/diskless_sn.rst

@@ -291,8 +291,7 @@ The following section explains how to accomplish this.
     packimage rhels7.3-ppc64le-netboot-service
 
 
-Note: ``enablepart=yes`` in partition file will make partition on the locak disk at every boot time. If you want to keep the contents
-on local disk at next boot, remmber changing to ``enablepart=no`` after the first time provisioning.
+.. note:: ``enablepart=yes`` in partition file will partition the local disk at every boot. If you want to preserve the contents on local disk at next boot, change to ``enablepart=no`` after the initial provision.
 
 For more information on ``localdisk`` option, refer to :ref:`setup_localdisk_label`
 
@@ -312,9 +311,9 @@ To update the xCAT software in the image at a later time:
     packimage "<osimagename>"
     rinstall service osimage="<osimagename>"
 
-Note: The Service Nodes are set up as NFS-root servers for the compute nodes.
-Any time changes are made to any compute image on the mgmt node it will be
-necessary to sync all changes to all Service Nodes. In our case the
-``/install`` directory is mounted on the servicenodes, so the update to the
-compute node image is automatically available.
+.. note:: The Service Nodes are set up as NFS-root servers for the compute nodes.
+ Any time changes are made to any compute image on the mgmt node it will be
+ necessary to sync all changes to all Service Nodes. In our case the
+ ``/install`` directory is mounted on the servicenodes, so the update to the
+ compute node image is automatically available.
 

docs/source/advanced/networks/infiniband/switch_configuration.rst

@@ -23,12 +23,12 @@ The switches table will look like this: ::
 
 If there is only one admin and one password for all the switches then put the entry in the xCAT passwd table for the admin id and password to use to login. ::
 
-	tabch key=mswitch  passwd.username=admin passwd.password=admin
+	tabch key=switch  passwd.username=admin passwd.password=admin
 
 The passwd table will look like this: ::
 
 	#key,username,password,cryptmethod,comments,disable
-	"mswitch","admin","admin",,,
+	"switch","admin","admin",,,
 
 Setup ssh connection to the Mellanox Switch
 -------------------------------------------

docs/source/advanced/restapi/restapi_setup/restapi_setup.rst

@@ -1,5 +1,5 @@
 Enable the HTTPS protocol for REST API
-=====================================
+======================================
 
 To improve the security between the REST API clients and server, enabling the secure transfer protocol (https) is the default configuration.
 

docs/source/conf.py

@@ -59,7 +59,7 @@
 # The short X.Y version.
 version = '2'
 # The full version, including alpha/beta/rc tags.
-release = '2.14.3'
+release = '2.14.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/guides/admin-guides/basic_concepts/xcat_db/regexp_db.rst

@@ -120,13 +120,15 @@ xCAT provides several functions that can simplify regular expressions.
   +-----------+-----------+-----------+-----------+
   | row2-col1 | row2-col2 | row2-col3 | row2-col4 |
   +-----------+-----------+-----------+-----------+
+
   To obtain the rack index, use ``|row(\d+)-col(\d+)|(dim2idx($1, 4, $2))|``.  This maps the racks to:
 
   +---+---+---+---+
   | 1 | 2 | 3 | 4 |
   +---+---+---+---+
   | 5 | 6 | 7 | 8 |
   +---+---+---+---+
+
   Note that the size of the highest dimension (2 rows) is not needed, and all values are one-indexed.
 
   If each rack contains 20 nodes, use ``|row(\d+)-col(\d+)-node(\d+)|(dim2idx($1, 4, $2, 20, $3)`` to determine a node index (useful for determining IP addresses).

docs/source/guides/admin-guides/manage_clusters/common/deployment/enable_localdisk.rst

@@ -1,25 +1,23 @@
 .. _setup_localdisk_label:
 
-Enabling the localdisk Option
+Enabling the localdisk option
 -----------------------------
 
-``Note``: You can skip this section if not using the ``localdisk`` option in your litefile table.
-
-Several things need to be done to enable the 'localdisk' support:
+.. note:: You can skip this section if not using the ``localdisk`` option in your ``litefile`` table.
 
 Define how to partition the local disk
 ``````````````````````````````````````
 
-When a node is deployed, the local hard disk needs to be partitioned and formatted before it can be used. This section explains how provide a configuration file that tells xCAT to partition a local disk and make it ready to use for the directories listed in the litefile table with the ``localdisk`` option.
+When a node is deployed, the local hard disk needs to be partitioned and formatted before it can be used. This section explains how provide a configuration file that tells xCAT to partition a local disk and make it ready to use for the directories listed in the litefile table.
 
-The configuration file needs to be specified in the ``partitionfile`` attribute of the osimage definition. The configuration file includes several parts:
+The configuration file needs to be specified in the ``partitionfile`` attribute of the osimage definition. The configuration file includes several sections:
 
     * Global parameters to control enabling or disabling the function
-    * [disk] part to control the partitioning of the disk
-    * [localspace] part to control which partition will be used to store the localdisk directories listed in the litefile table
-    * [swapspace] part to control the enablement of the swap space for the node.
+    * ``[disk]`` section to control the partitioning of the disk
+    * ``[localspace]`` section to control which partition will be used to store the ``localdisk`` directories listed in the ``litefile`` table
+    * ``[swapspace]`` section to control the enablement of the swap space for the node.
 
-An example localdisk configuration file: ::
+An example ``localdisk`` configuration file: ::
 
     enable=yes
     enablepart=no
@@ -48,15 +46,15 @@ An example localdisk configuration file: ::
 
 The two global parameters ``enable`` and ``enablepart`` can be used to control the enabling/disabling of the functions:
 
-    * enable: The localdisk feature only works when ``enable`` is set to *yes*. If it is set to *no*, the localdisk configuration will not be run.
+    * enable: The ``localdisk`` feature only works when ``enable`` is set to ``yes``. If it is set to ``no``, the ``localdisk`` configuration will not be run.
     * enablepart: The partition action (refer to the ``[disk]`` section) will be run only when ``enablepart=yes``.
 
 The ``[disk]`` section is used to configure how to partition a hard disk:
 
     * dev: The path of the device file.
     * clear: If set to ``yes`` it will clear all the existing partitions on this disk.
-    * fstype: The file system type for the new created partitions. ``ext3`` is the default value if not set.
-    * parts: A comma separated list of space ranges, one for each partition that will be created on the device. The valid format for each space range is ``<startpoint>-<endpoint>`` or ``<percentage of the disk>``. For example, you could set it to ``100M-10G`` or ``50``. If you set it to ``50``, that means 50% of the disk space will be assigned to that partition.
+    * fstype: The file system type for the new created partitions. ``ext3`` is the default.
+    * parts: A comma separated list of space ranges, one for each partition that will be created on the device. The valid format for each space range is ``<startpoint>-<endpoint>`` or ``<percentage of the disk>``. For example, you could set it to ``100M-10G`` or ``50``. If set to ``50``, 50% of the disk space will be assigned to that partition.
 
 The ``[localspace]`` section is used to specify which partition will be used as local storage for the node.
 
@@ -67,21 +65,23 @@ the ``[swapspace]`` section is used to configure the swap space for the statelit
 
     * dev: The path of the partition file which will be used as the swap space.
 
-To enable the local disk capability, create the configuration file (for example in ``/install/custom``) and set the path in the partitionfile attribute for the osimage: ::
+To enable the local disk capability, create the configuration file (for example in ``/install/custom``) and set the path in the ``partitionfile`` attribute for the osimage: ::
 
-    chdef -t osimage partitionfile=/install/custom/cfglocaldisk
+    chdef -t osimage <osimage> partitionfile=/install/custom/cfglocaldisk
 
-Now all nodes that use this osimage (i.e. have their provmethod attribute set to this osimage definition name), will have its local disk configured.
+Now all nodes that use this osimage (i.e. have their ``provmethod`` attribute set to this osimage definition name), will have its local disk configured.
 
 Configure the files in the litefile table
 `````````````````````````````````````````
 
-For the files/directories that you would like xCAT to store on the local disk, add an entry in the litefile table like this: ::
+For the files/directories to store on the local disk, add an entry in the ``litefile`` table: ::
 
     "ALL","/tmp/","localdisk",,
 
-``Note``: you do not need to specify the swap space in the litefile table. Just putting it in the partitionfile config file is enough.
+.. note:: you do not need to specify the swap space in the litefile table. Just putting it in the ``partitionfile`` config file is enough.
 
 Add an entry in policy table to permit the running of the ``getpartition`` command from the node ::
 
     chtab priority=7.1 policy.commands=getpartition policy.rule=allow
+
+Run ``genimage`` and ``packimage`` for the osimage

docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst

@@ -15,11 +15,11 @@ The basic entry format looks like following: ::
        path_of_src_file1 -> path_of_dst_directory
        path_of_src_file1 path_of_src_file2 ... -> path_of_dst_directory
 
-The path_of_src_file* should be the full path of the source file on the Management Node.
+The ``path_of_src_file*`` should be the full path of the source file on the Management Node.
 
-The path_of_dst_file* should be the full path of the destination file on target node. Please make sure path_of_dst_file* is not a existing directory on target node, otherwise, the file sync with ``updatenode -r /usr/bin/scp`` or ``xdcp -r /usr/bin/scp`` will fail.
+The ``path_of_dst_file*`` should be the full path of the destination file on target node. Make sure ``path_of_dst_file*`` is not a existing directory on target node, otherwise, the file sync with ``updatenode -r /usr/bin/scp`` or ``xdcp -r /usr/bin/scp`` will fail.
 
-The path_of_dst_directory should be the full path of the destination directory. Please make sure *eth_of_dst_directory is not a existing file on target node, otherwise, the file sync with ``updatenode -r /usr/bin/scp`` or ``xdcp -r /usr/bin/scp`` will fail.
+The ``path_of_dst_directory`` should be the full path of the destination directory. Make ``sure path_of_dst_directory`` is not a existing file on target node, otherwise, the file sync with ``updatenode -r /usr/bin/scp`` or ``xdcp -r /usr/bin/scp`` will fail.
 
 Since the synclist file is for common purpose, the target node need not be configured in it.
 
@@ -37,7 +37,7 @@ sync file **/etc/file4** to the file **/etc/tmp/file5** on the node( different f
 
       /etc/file4 -> /etc/tmp/file5
 
-sync the multiple files **/etc/file1**, **/etc/file2**, **/etc/file3**, ... to the directory **/tmp/etc** (**/tmp/etc** must be a directory when multiple files are synced at one time). If the directory does not exist,**xdcp** will create it. ::
+sync the multiple files **/etc/file1**, **/etc/file2**, **/etc/file3**, ... to the directory **/tmp/etc** (**/tmp/etc** must be a directory when multiple files are synced at one time). If the directory does not exist, **xdcp** will create it. ::
 
       /etc/file1 /etc/file2 /etc/file3 -> /tmp/etc
 
@@ -116,7 +116,8 @@ Advanced synclist file features
 
 After you define the files to rsync in the syncfile, you can add an **EXECUTEALWAYS** clause in the syncfile. The **EXECUTEALWAYS** clause will list all the postscripts you would always like to run after the files are sync'd, whether or not any file is actually updated. The files in this list must be added to the list of files to rsync, if hierarchical.
 
-For example, your rsyncfile may look like this. **Note: the path to the file to EXECUTE, is the location of the *.post file on the MN**. ::
+For example, your rsyncfile may look like this. 
+.. note:: the path to the file to EXECUTE, is the location of the *.post file on the MN**. ::
 
 
        /tmp/share/file2  -> /tmp/file2
@@ -160,7 +161,7 @@ When you use the **APPEND** clause, the file (left) of the arrow is appended to
 
 The script creates a backup of the original file on the node in the directory defined by the site table nodesyncfiledir attribute, which is **/var/xcat/node/syncfiles** by default. To update the original file when using the function, you need to rsync a new original file to the node, removed the old original from the **/var/xcat/node/syncfiles/org** directory. If you want to cleanup all the files for the append function on the node, you can use the ``xdsh -c`` flag. See man page for ``xdsh``.
 
-Note:no order of execution may be assumed by the order that the **EXECUTE,EXECUTEALWAYS and APPEND** clause fall in the synclist file.
+.. note:: no order of execution may be assumed by the order that the **EXECUTE,EXECUTEALWAYS and APPEND** clause fall in the synclist file.
 
 You can add an **MERGE** clause to your syncfile. This is only supported on Linux.
 
@@ -184,9 +185,9 @@ For example, your synclist file may look like this ::
        /etc/mydir/mergeshadow -> /etc/shadow
        /etc/mydir/mergegroup -> /etc/group
 
-When you use the **MERGE** clause, the file (left) of the arrow is merged into the file right of the arrow. It will replace any common userid's found in those files and add new userids. The /opt/xcat/share/xcat/scripts/xdcpmerge.sh is used to accomplish this.
+When you use the **MERGE** clause, the file (left) of the arrow is merged into the file right of the arrow. It will replace any common userid's found in those files and add new userids. The **/opt/xcat/share/xcat/scripts/xdcpmerge.sh** is used to accomplish this.
 
-Note: no order of execution may be assumed by the order that the **EXECUTE,EXECUTEALWAYS,APPEND and MERGE** clause fall in the synclist file.
+.. note:: no order of execution may be assumed by the order that the **EXECUTE,EXECUTEALWAYS,APPEND and MERGE** clause fall in the synclist file.
 
 .. _the_localtion_of_synclist_file_for_updatenode_label:
 

docs/source/guides/admin-guides/manage_clusters/common/deployment/use_kernel_patch.rst

@@ -21,4 +21,4 @@ The RPM names below are only examples, substitute your specific level and archit
         genitrd rhels7.3-ppc64le-install-compute --ignorekernelchk
         nodeset <CN> osimage=rhels7.3-ppc64le-install-compute --noupdateinitrd
 
-#. Boot CN from net normallly.
+#. Boot CN from net normally.

docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/localdisk.rst

@@ -1,4 +1,3 @@
 .. include:: ../../../common/deployment/enable_localdisk.rst
 
-``Note``:
-    * To keep the contents on local disk after you using ``enablepart=yes`` to do the disk partitioning, make sure to set ``enablepart=no`` in partition configuration file after the node is booted.
+.. note:: ``enablepart=yes`` in partition file will partition the local disk at every boot. If you want to preserve the contents on local disk at next boot, change to ``enablepart=no`` after the initial provision. A log file ``/.sllocal/log/localdisk.log`` on the target node can be used for debugging.