From 6df7914e2663202e906ff27c531d81e2a17a106f Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Wed, 9 Feb 2022 11:41:28 -0500 Subject: [PATCH 01/17] Spelling fixes in advanced/chain docs --- docs/source/advanced/chain/create_image_for_runimage.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/advanced/chain/create_image_for_runimage.rst b/docs/source/advanced/chain/create_image_for_runimage.rst index a8d68339b..7dc14dca7 100644 --- a/docs/source/advanced/chain/create_image_for_runimage.rst +++ b/docs/source/advanced/chain/create_image_for_runimage.rst @@ -20,7 +20,7 @@ How to prepare a image for ``runimage`` in ``chain`` mkdir -p /install/my_image - * Go to the direcotry and copy the rpm file into it: :: + * Go to the directory and copy the rpm file into it: :: cd /install/my_image cp /tmp/a.rpm /install/my_image From 2818a11b9148aa7ffbbe3a7122f4a12d2ab9b0f5 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Wed, 9 Feb 2022 12:04:54 -0500 Subject: [PATCH 02/17] Spelling fixes in advanced/docker docs --- .../advanced/docker/dockerized_xcat/run_xcat_in_docker_host.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/advanced/docker/dockerized_xcat/run_xcat_in_docker_host.rst b/docs/source/advanced/docker/dockerized_xcat/run_xcat_in_docker_host.rst index 726d9f333..4bb7b6c5d 100644 --- a/docs/source/advanced/docker/dockerized_xcat/run_xcat_in_docker_host.rst +++ b/docs/source/advanced/docker/dockerized_xcat/run_xcat_in_docker_host.rst @@ -1,7 +1,7 @@ Quick Start to Use xCAT Docker Image ==================================== -A new Docker image will be published for each new release of xCAT. Use ``docker search xcat2`` to list all Docker images xCAT has released. xCAT Docker image offical organization is ``xcat``, repository is ``xcat2``. :: +A new Docker image will be published for each new release of xCAT. Use ``docker search xcat2`` to list all Docker images xCAT has released. xCAT Docker image official organization is ``xcat``, repository is ``xcat2``. :: [dockerhost]# sudo docker search xcat2 NAME DESCRIPTION STARS OFFICIAL AUTOMATED From 8d4795374f24809149e54af69d57054cbea013ac Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Wed, 9 Feb 2022 12:30:39 -0500 Subject: [PATCH 03/17] Spelling fixes in advanced/hamn docs --- .../advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst b/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst index 9c6ff0d2a..dba5fb5a0 100644 --- a/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst +++ b/docs/source/advanced/hamn/setup_ha_mgmt_node_with_shared_data.rst @@ -214,7 +214,7 @@ Setup xCAT on the Standby Management Node File Synchronization ==================== -For the files that are changed constantly such as xcat database, ``/etc/xcat/*``, we have to put the files on the shared data; but for the files that are not changed frequently or unlikely to be changed at all, we can simply copy the the files from the primary management node to the standby management node or use crontab and rsync to keep the files synchronized between primary management node and standby management node. Here are some files we recommend to keep synchronization between the primary management node and standby management node: +For the files that are changed constantly such as xcat database, ``/etc/xcat/*``, we have to put the files on the shared data; but for the files that are not changed frequently or unlikely to be changed at all, we can simply copy the files from the primary management node to the standby management node or use crontab and rsync to keep the files synchronized between primary management node and standby management node. Here are some files we recommend to keep synchronization between the primary management node and standby management node: SSL Credentials and SSH Keys -------------------------------- From 362b4bd7a77deab78d68c5fa586ceaba3fcc0c65 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Wed, 9 Feb 2022 12:43:36 -0500 Subject: [PATCH 04/17] Spelling fixes in advanced/kit docs --- docs/source/advanced/kit/custom/build/createkit.rst | 2 +- docs/source/advanced/kit/custom/build/kitrepo.rst | 2 +- docs/source/advanced/kit/custom/introduction.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/advanced/kit/custom/build/createkit.rst b/docs/source/advanced/kit/custom/build/createkit.rst index 2c712c8ff..1afecc046 100644 --- a/docs/source/advanced/kit/custom/build/createkit.rst +++ b/docs/source/advanced/kit/custom/build/createkit.rst @@ -9,7 +9,7 @@ Use the :doc:`buildkit ` comman Kit Directory ------------- -The Kit directory location will be automatically populated with additional subdirecotries and samples: +The Kit directory location will be automatically populated with additional subdirectories and samples: **buildkit.conf** - The sample Kit build configuration file. diff --git a/docs/source/advanced/kit/custom/build/kitrepo.rst b/docs/source/advanced/kit/custom/build/kitrepo.rst index a2f757ac1..00c664cfe 100644 --- a/docs/source/advanced/kit/custom/build/kitrepo.rst +++ b/docs/source/advanced/kit/custom/build/kitrepo.rst @@ -9,7 +9,7 @@ To list the repos defined in the buildkit.conf: :: buildkit listrepo -To build the repositories, specifiy a particular reporitory: :: +To build the repositories, specify a particular repository: :: buildkit buildrepo diff --git a/docs/source/advanced/kit/custom/introduction.rst b/docs/source/advanced/kit/custom/introduction.rst index 3d7042166..9b4bb3eb4 100644 --- a/docs/source/advanced/kit/custom/introduction.rst +++ b/docs/source/advanced/kit/custom/introduction.rst @@ -42,7 +42,7 @@ Once the kit components are added to xCAT osimage definitions, administrators ca #. ``genimage`` command to create a diskless OS image installing the kit components for diskless OS provisioning #. ``updatenode`` command to install the kit components on existing deployed nodes -The ``kitcomponent`` metadata defines the kit packages as dependency packages and the OS package manager (``yum``, ``zypper``, ``apt-get``) automatically installes the required packages during the xCAT ``otherpkgs`` install process. +The ``kitcomponent`` metadata defines the kit packages as dependency packages and the OS package manager (``yum``, ``zypper``, ``apt-get``) automatically installs the required packages during the xCAT ``otherpkgs`` install process. Kit Framework ------------- From dab905c8533305b6cbce751fba14e84395d8f15c Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Wed, 9 Feb 2022 14:13:20 -0500 Subject: [PATCH 05/17] Spelling fixes in advanced/migration docs --- docs/source/advanced/migration/migration.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/advanced/migration/migration.rst b/docs/source/advanced/migration/migration.rst index ebd057929..ff3edf5a9 100644 --- a/docs/source/advanced/migration/migration.rst +++ b/docs/source/advanced/migration/migration.rst @@ -141,7 +141,7 @@ Restore xCAT management node 2.2 Configure new xCAT management server using the same ip and hostname as old xCAT management server. Configure the same additional network for hardware management network if needed, for example, bmc network or hmc network. xCAT management server setup refer to :doc:`Prepare the Management Node <../../guides/install-guides/yum/prepare_mgmt_node>` -2.3 Overwrite files/directories methioned in above 1.2, 1.3, 1.4 from backup server to new xCAT management server +2.3 Overwrite files/directories mentioned in above 1.2, 1.3, 1.4 from backup server to new xCAT management server 2.4 Download xcat-core and xcat-dep tar ball, then install xCAT in new xCAT management server, refer to :doc:`install xCAT <../../guides/install-guides/yum/install>` @@ -159,11 +159,11 @@ Restore xCAT management node restorexCATdb -a -p /dbbackup/db - c. (optinal) Overwrite files in above 1.11, restart ``PostgreSQL``: :: + c. (optional) Overwrite files in above 1.11, restart ``PostgreSQL``: :: service postgresql restart -2.8 Overwrite remaining files/directories methioned in above 1.1, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.12; If needed, check if files exist based on above 1.13 and 1.16. +2.8 Overwrite remaining files/directories mentioned in above 1.1, 1.5, 1.6, 1.7, 1.8, 1.9, 1.10, 1.12; If needed, check if files exist based on above 1.13 and 1.16. 2.9 Verify xCAT: :: From 60af1ce6c01220c18eb1ef6f25d8571c888af3f2 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Thu, 10 Feb 2022 08:19:58 -0500 Subject: [PATCH 06/17] Spelling fixes in advanced/networks docs --- .../advanced/networks/ethernet_switches/ethernet_switches.rst | 4 ++-- .../networks/infiniband/mlnxofed_ib_install_diskless.rst | 2 +- .../networks/infiniband/mlnxofed_ib_install_preparation.rst | 2 +- .../source/advanced/networks/infiniband/ufm_configuration.rst | 2 +- docs/source/advanced/networks/onie_switches/index.rst | 2 +- .../advanced/networks/onie_switches/os_cumulus/manage.rst | 2 +- .../advanced/networks/onie_switches/os_cumulus/prepare.rst | 2 +- .../source/advanced/networks/onie_switches/os_cumulus/ztp.rst | 2 +- .../networks/switchdiscover/switch_based_switch_discovery.rst | 2 +- .../advanced/networks/switchdiscover/switches_discovery.rst | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/source/advanced/networks/ethernet_switches/ethernet_switches.rst b/docs/source/advanced/networks/ethernet_switches/ethernet_switches.rst index 2ce4ba05d..029df4fa5 100644 --- a/docs/source/advanced/networks/ethernet_switches/ethernet_switches.rst +++ b/docs/source/advanced/networks/ethernet_switches/ethernet_switches.rst @@ -62,7 +62,7 @@ Switch Management When managing Ethernet switches, the admin often logs into the switches one by one using SSH or Telnet and runs the switch commands. However, it becomes time consuming when there are a lot of switches in a cluster. In a very large cluster, the switches are often identical and the configurations are identical. It helps to configure and monitor them in parallel from a single command. -For managing Mellanox IB switches and Qlogic IB switches, see :doc:`Mellanox IB switches and Qlogic IB switches ` +For managing Mellanox IB switches and Qlogic IB switches, see :doc:`Mellanox IB switches and Qlogic IB switches ` xCAT will not do a lot of switch management functions. Instead, it will configure the switch so that the admin can run remote command such as ``xdsh`` for it. Thus, the admin can use the ``xdsh`` to run proprietary switch commands remotely from the xCAT mn to enable **VLAN**, **bonding**, **SNMP** and others. @@ -77,7 +77,7 @@ Add the switch in xCAT DB. Refer to the "Discovering Switches" section if you wa mkdef bntc125 groups=switch mgt=switch ip=10.4.25.1 nodetype=switch switchtype=BNT -Set the ssh or telnet username an d password. :: +Set the ssh or telnet username and password. :: chdef bntc125 username=admin \ password=password \ diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_diskless.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_diskless.rst index 9c3d8b871..413b18577 100644 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_diskless.rst +++ b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_diskless.rst @@ -26,7 +26,7 @@ Diskless Installation /install/postscripts/mlnxofed_ib_install \ -p /install// -i $1 -n genimage - .. note:: The ``$1`` is a argument that is passed to the the postinstall script at runtime. + .. note:: The ``$1`` is a argument that is passed to the postinstall script at runtime. .. tip:: **Kernel Mismatch** diff --git a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_preparation.rst b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_preparation.rst index 9e7720886..77f6ad726 100644 --- a/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_preparation.rst +++ b/docs/source/advanced/networks/infiniband/mlnxofed_ib_install_preparation.rst @@ -36,7 +36,7 @@ The ``mlnxofed_ib_install`` is a sample script intended to assist with the insta | | || of the string to mark the completion of the option list | | | || option list. | | | || | - | | || If nothing is specified, xCAT passes the the following | + | | || If nothing is specified, xCAT passes the following | | | || ``--without-32bit --without-fw-update --force`` | +---------+------------------+----------------------------------------------------------+ |``-i`` | For diskless || The image root path of the diskless image | diff --git a/docs/source/advanced/networks/infiniband/ufm_configuration.rst b/docs/source/advanced/networks/infiniband/ufm_configuration.rst index 1bce7e480..00fe61dba 100644 --- a/docs/source/advanced/networks/infiniband/ufm_configuration.rst +++ b/docs/source/advanced/networks/infiniband/ufm_configuration.rst @@ -55,7 +55,7 @@ The default port is 162. For example: :: [Notifications] snmp_listeners = 10.0.0.1 -Where 10.0.0.1 is the the ip address of the management node. +Where 10.0.0.1 is the ip address of the management node. 3. On the UFM host, restart the ufmd :: diff --git a/docs/source/advanced/networks/onie_switches/index.rst b/docs/source/advanced/networks/onie_switches/index.rst index 44b381f77..2dd8acf91 100644 --- a/docs/source/advanced/networks/onie_switches/index.rst +++ b/docs/source/advanced/networks/onie_switches/index.rst @@ -1,7 +1,7 @@ Open Network Install Environment Switches ========================================= -The Open Network Install Environment, or "ONIE" [1]_. is an open source project definining an **install environment** for bare metal switches. This environment allows choice for the end users when selecting a network operating system to install onto these bare metal switches. +The Open Network Install Environment, or "ONIE" [1]_. is an open source project defining an **install environment** for bare metal switches. This environment allows choice for the end users when selecting a network operating system to install onto these bare metal switches. .. toctree:: :maxdepth: 2 diff --git a/docs/source/advanced/networks/onie_switches/os_cumulus/manage.rst b/docs/source/advanced/networks/onie_switches/os_cumulus/manage.rst index 325e0f1f6..a79fc1c37 100644 --- a/docs/source/advanced/networks/onie_switches/os_cumulus/manage.rst +++ b/docs/source/advanced/networks/onie_switches/os_cumulus/manage.rst @@ -24,7 +24,7 @@ Switch Port and VLAN Configuration xCAT places the front-panel port configuration in ``/etc/network/interfaces.d/xCAT.intf``. -The ``configinterface`` postscript can be used to pull switch interface configuration from the xCAT Management Node (MN) to the switch. Place the switch specific confguration files in the following directory on the MN: ``/install/custom/sw_os/cumulus/interface/``. +The ``configinterface`` postscript can be used to pull switch interface configuration from the xCAT Management Node (MN) to the switch. Place the switch specific configuration files in the following directory on the MN: ``/install/custom/sw_os/cumulus/interface/``. xCAT will look for files in the above directory in the following order: diff --git a/docs/source/advanced/networks/onie_switches/os_cumulus/prepare.rst b/docs/source/advanced/networks/onie_switches/os_cumulus/prepare.rst index e38d97f65..94a804e62 100644 --- a/docs/source/advanced/networks/onie_switches/os_cumulus/prepare.rst +++ b/docs/source/advanced/networks/onie_switches/os_cumulus/prepare.rst @@ -20,7 +20,7 @@ Prepare the Cumulus Linux files on the xCAT Management Node. Cumulus osimage --------------- -xCAT can able to create a cumulus osimage defintion via ``copycds`` command. ``copycds`` will copy cumulus installer to a destination directory, and create several relevant osimage definitions. **cumulus-** is the default osimage name. :: +xCAT can able to create a cumulus osimage definition via ``copycds`` command. ``copycds`` will copy cumulus installer to a destination directory, and create several relevant osimage definitions. **cumulus-** is the default osimage name. :: #run copycds command # copycds cumulus-linux-3.5.2-bcm-armel.bin diff --git a/docs/source/advanced/networks/onie_switches/os_cumulus/ztp.rst b/docs/source/advanced/networks/onie_switches/os_cumulus/ztp.rst index c8ba68d6b..58ff9206a 100644 --- a/docs/source/advanced/networks/onie_switches/os_cumulus/ztp.rst +++ b/docs/source/advanced/networks/onie_switches/os_cumulus/ztp.rst @@ -55,7 +55,7 @@ Leveraging the ZTP mechanism, xCAT provides the capability to setup ONIE switche 5. Plug the ONIE switches into the cluster according to the network plan and power on them. - For the white-box ONIE switches, the Cumulus OS will be installed, then the switches will be discovered and configured automaticaly, the whole process will take about 1 hour. + For the white-box ONIE switches, the Cumulus OS will be installed, then the switches will be discovered and configured automatically, the whole process will take about 1 hour. For the ONIE switches already with Cumulus OS installed, please make sure the ZTP have been enabled and none of the following manual configuration have been made: diff --git a/docs/source/advanced/networks/switchdiscover/switch_based_switch_discovery.rst b/docs/source/advanced/networks/switchdiscover/switch_based_switch_discovery.rst index 702605c82..7e8c40916 100644 --- a/docs/source/advanced/networks/switchdiscover/switch_based_switch_discovery.rst +++ b/docs/source/advanced/networks/switchdiscover/switch_based_switch_discovery.rst @@ -55,7 +55,7 @@ In order to do switch-based switch discovery, the admin "192_168_0_0-255_255_0_0","192.168.0.0","255.255.0.0","enP4p1s0f2","",,"192.168.3.29",,,,"192.168.5.150-192.168.5.170",,,,,,,,, -dhcp should be restarted after seting up dynamic IP range. +dhcp should be restarted after setting up dynamic IP range. Discover Switches diff --git a/docs/source/advanced/networks/switchdiscover/switches_discovery.rst b/docs/source/advanced/networks/switchdiscover/switches_discovery.rst index 295bad80e..4c9760ea5 100644 --- a/docs/source/advanced/networks/switchdiscover/switches_discovery.rst +++ b/docs/source/advanced/networks/switchdiscover/switches_discovery.rst @@ -37,5 +37,5 @@ The discovery process works with the following four kind of switches: :: BNT Juniper -The ``switchdiscover`` command can display the output in xml format, stanza forma and normal list format. See the man pages for this command for details. +The ``switchdiscover`` command can display the output in xml format, stanza format and normal list format. See the man pages for this command for details. From 77cf333172c4e2654364754e096f2e6aa33748cf Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Thu, 10 Feb 2022 08:28:31 -0500 Subject: [PATCH 07/17] Spelling fixes in advanced/pdu docs --- docs/source/advanced/pdu/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/advanced/pdu/index.rst b/docs/source/advanced/pdu/index.rst index 4438d4368..4896b47f2 100644 --- a/docs/source/advanced/pdu/index.rst +++ b/docs/source/advanced/pdu/index.rst @@ -3,7 +3,7 @@ PDUs Power Distribution Units (PDUs) are devices that distribute power to servers in a frame. They have the capability of monitoring the amount of power that is being used by devices plugged into it and cycle power to individual receptacles. xCAT can support two kinds of PDUs, infrastructure PDU (irpdu) and collaborative PDU (crpdu). -The Infrastructure rack PDUs are switched and monitored 1U PDU products which can connect up to nine C19 devices or up to 12 C13 devices and an additional three C13 peripheral devices to a signle dedicated power source. The Collaborative PDU is on the compute rack and has the 6x IEC 320-C13 receptacles that feed the rack switches. These two types of PDU have different design and implementation. xCAT has different code path to maintains PDU commands via **pdutype**. +The Infrastructure rack PDUs are switched and monitored 1U PDU products which can connect up to nine C19 devices or up to 12 C13 devices and an additional three C13 peripheral devices to a single dedicated power source. The Collaborative PDU is on the compute rack and has the 6x IEC 320-C13 receptacles that feed the rack switches. These two types of PDU have different design and implementation. xCAT has different code path to maintains PDU commands via **pdutype**. .. toctree:: From 87444f885764f4042b35f78e8701ae168ab4ce66 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Thu, 10 Feb 2022 08:34:02 -0500 Subject: [PATCH 08/17] Spelling fixes in advanced/performance_tuning docs --- docs/source/advanced/performance_tuning/index.rst | 2 +- docs/source/advanced/performance_tuning/linux_os_tuning.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/advanced/performance_tuning/index.rst b/docs/source/advanced/performance_tuning/index.rst index 50cd0b2c8..606a1ba08 100644 --- a/docs/source/advanced/performance_tuning/index.rst +++ b/docs/source/advanced/performance_tuning/index.rst @@ -3,7 +3,7 @@ Performance Tuning xCAT supports clusters of all sizes. This document is a collection of hints, tips, and special considerations when working with large clusters, especially a single server (management node or service node) manages more than 128 nodes. -The information in this document should be viewed as example data only. Many of the suggestions are based on anecdotal experiences and may not apply to your particular environment. Suggestions in different sections of this document may recommend different or conflicting settings since they may have been provided by different people for different cluster environments. Often there is a significant amount of flexiblity in most of these settings -- you will need to resolve these differences in a way that works best for your cluster. +The information in this document should be viewed as example data only. Many of the suggestions are based on anecdotal experiences and may not apply to your particular environment. Suggestions in different sections of this document may recommend different or conflicting settings since they may have been provided by different people for different cluster environments. Often there is a significant amount of flexibility in most of these settings -- you will need to resolve these differences in a way that works best for your cluster. .. toctree:: :maxdepth: 2 diff --git a/docs/source/advanced/performance_tuning/linux_os_tuning.rst b/docs/source/advanced/performance_tuning/linux_os_tuning.rst index c45a9a65c..c84735ec5 100644 --- a/docs/source/advanced/performance_tuning/linux_os_tuning.rst +++ b/docs/source/advanced/performance_tuning/linux_os_tuning.rst @@ -32,7 +32,7 @@ Adjusting Operating System tunables can improve large scale cluster performance, net.core.netdev_max_backlog=1500 - And if you encounter **Neighbour table overflow** error, it meams there are two many ARP requests and the server cannot reply. Tune the ARP cache with below parameters. + And if you encounter **Neighbour table overflow** error, it means there are two many ARP requests and the server cannot reply. Tune the ARP cache with below parameters. :: From 027c40ba56c695eabbfa67a12092be13fa536774 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Thu, 10 Feb 2022 08:36:06 -0500 Subject: [PATCH 09/17] Spelling fixes in advanced/probe docs --- docs/source/advanced/probe/osdeploy.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/advanced/probe/osdeploy.rst b/docs/source/advanced/probe/osdeploy.rst index 1c6eef7df..c44075a07 100644 --- a/docs/source/advanced/probe/osdeploy.rst +++ b/docs/source/advanced/probe/osdeploy.rst @@ -88,7 +88,7 @@ To replay history of OS provision from 1 hour 20 minutes ago, use command as :: xcatprobe osdeploy -n cn1 -r 1h20m -Outout will be similar to: :: +Output will be similar to: :: # xcatprobe osdeploy -n c910f03c17k20 The install NIC in current server is enp0s1 [INFO] From 347fe275299833e2564a28537537791fd0250512 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Thu, 10 Feb 2022 09:52:59 -0500 Subject: [PATCH 10/17] Spelling fixes in advanced/restapi docs --- .../restapi_resource/restapi_reference.rst | 210 +++++++++--------- .../restapi/restapi_setup/restapi_setup.rst | 2 +- 2 files changed, 106 insertions(+), 106 deletions(-) diff --git a/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst b/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst index 42c849d72..92f6018cd 100644 --- a/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst +++ b/docs/source/advanced/restapi/restapi_resource/restapi_reference.rst @@ -71,7 +71,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -97,11 +97,11 @@ Refer to the man page: :doc:`chdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -181,7 +181,7 @@ Refer to the man page: :doc:`makehosts : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -377,7 +377,7 @@ Refer to the man page: :doc:`rpower : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -418,11 +418,11 @@ Refer to the man page: :doc:`renergy : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -465,7 +465,7 @@ Refer to the man page: :doc:`rspconfig : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -486,11 +486,11 @@ Refer to the man page: :doc:`rspconfig : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -529,11 +529,11 @@ Refer to the man page: :doc:`rsetboot : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -572,11 +572,11 @@ Refer to the man page: :doc:`nodeset : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** -Get all the vitails attributes for the node1. :: +Get all the vitals attributes for the node1. :: curl -X GET -k 'https://127.0.0.1/xcatws/nodes/node1/vitals?userName=root&userPW=cluster&pretty=1' @@ -625,7 +625,7 @@ Refer to the man page: :doc:`rvitals : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -656,7 +656,7 @@ Refer to the man page: :doc:`rinv ` **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -687,7 +687,7 @@ Refer to the man page: :doc:`rinv ` **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -712,7 +712,7 @@ Refer to the man page: :doc:`reventlog : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -735,7 +735,7 @@ Refer to the man page: :doc:`reventlog : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -785,11 +785,11 @@ Refer to the man page: :doc:`rbeacon : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -885,11 +885,11 @@ Refer to the man page: :doc:`updatenode : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -921,11 +921,11 @@ Refer to the man page: :doc:`xdsh ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: set environment {ENV:{en1:v1,en2:v2}}, raw command {raw:[op1,op2]}, direct command {command:[cmd1,cmd2]}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: set environment {ENV:{en1:v1,en2:v2}}, raw command {raw:[op1,op2]}, direct command {command:[cmd1,cmd2]}. **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -951,11 +951,11 @@ Refer to the man page: :doc:`xdcp ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {src:[file1,file2],target:dir}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {src:[file1,file2],target:dir}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -977,14 +977,14 @@ Refer to the man page: :doc:`chvm ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: Set memory size - {"memorysize":"sizeofmemory(MB)"} Add new disk - {"adddisk":"sizeofdisk1(GB),sizeofdisk2(GB)"} Purge disk - {"purgedisk":"scsi_id1,scsi_id2"} **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example1:** @@ -1011,7 +1011,7 @@ Refer to the man page: :doc:`mkvm ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: Set CPU count - {"cpucount":"numberofcpu"} Set memory size - {"memorysize":"sizeofmemory(MB)"} Set disk size - {"disksize":"sizeofdisk"} @@ -1019,7 +1019,7 @@ Refer to the man page: :doc:`mkvm ` **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1034,13 +1034,13 @@ Refer to the man page: :doc:`rmvm ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: Purge disk - {"purge":"yes"} Do it by force - {"force":"yes"} **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1060,7 +1060,7 @@ Refer to the man page: :doc:`clonevm : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1206,15 +1206,15 @@ Refer to the man page: :doc:`chdef ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {action:gen\pack\export,params:[{attr1:value1,attr2:value2...}]} +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {action:gen\pack\export,params:[{attr1:value1,attr2:value2...}]} **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example1:** @@ -1322,7 +1322,7 @@ Refer to the man page: :doc:`rmimage : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1420,11 +1420,11 @@ Refer to the man page: :doc:`chdef ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {attr1:v1,att2:v2,...}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {attr1:v1,attr2:v2,...}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1458,7 +1458,7 @@ Refer to the man page: :doc:`rmdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1504,13 +1504,13 @@ The URI list which can be used to create, query, change and manage policy entrie GET - Get all the policies in xCAT. ``````````````````````````````````` -It will dislplay all the policy resource. +It will display all the policy resource. Refer to the man page: :doc:`lsdef ` **Returns:** -* Json format: An object which includes multiple ' : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1539,7 +1539,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1563,11 +1563,11 @@ Refer to the man page: :doc:`chdef ` **Parameters:** -* Json format: An object which includes multiple 'att:value' pairs. DataBody: {attr1:v1,att2:v2,...}. +* Json format: An object which includes multiple 'attr:value' pairs. DataBody: {attr1:v1,attr2:v2,...}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1605,7 +1605,7 @@ Refer to the man page: :doc:`rmdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1687,7 +1687,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1708,11 +1708,11 @@ Refer to the man page: :doc:`chdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1764,7 +1764,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1792,7 +1792,7 @@ Refer to the man page: :doc:`lsdef : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1816,11 +1816,11 @@ Refer to the man page: :doc:`chdef ` **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -1860,7 +1860,7 @@ Refer to the man page: :doc:`makedns : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -1950,7 +1950,7 @@ Refer to the man page: :doc:`lsslp : {att:value, attr:value ...}' pairs. +* Json format: An object which includes multiple ' : {attr:value, attr:value ...}' pairs. **Example:** @@ -2075,11 +2075,11 @@ PUT - Change the node table attributes for {noderange}. **Parameters:** -* A hash of table names and attribute objects. DataBody: {table1:{attr1:v1,att2:v2,...}}. +* A hash of table names and attribute objects. DataBody: {table1:{attr1:v1,attr2:v2,...}}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -2196,11 +2196,11 @@ PUT - Change the non-node table attributes for the row that matches the {keys}. **Parameters:** -* A hash of attribute names and values. DataBody: {attr1:v1,att2:v2,...}. +* A hash of attribute names and values. DataBody: {attr1:v1,attr2:v2,...}. **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** @@ -2213,7 +2213,7 @@ DELETE - Delete rows from a non-node table that have the attribute values specif **Returns:** -* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errocode:errornum}. +* No output when execution is successful. Otherwise output the error information in the Standard Error Format: {error:[msg1,msg2...],errorcode:errornum}. **Example:** diff --git a/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst b/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst index 73b452a42..5b9470bf2 100644 --- a/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst +++ b/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst @@ -86,7 +86,7 @@ Set Up an Account for Web Service Access User needs a username and password to access the REST API. When the REST API request is passed to xcatd, the username and password will be verified based on the :doc:`xCAT passwd Table `, and then xcatd will look in the :doc:`xCAT policy Table ` to see if the user is allowed to perform the requested operation. -The account with key of **xcat** will be used for the REST API authentication. The username and password should be passed in as the attirbutes of URL: +The account with key of **xcat** will be used for the REST API authentication. The username and password should be passed in as the attributes of URL: :userName: Pass the username of the account :userPW: Pass the password of the account (xCAT 2.10) From 074c9bb2005f5ef7bad72bc8431d91194f480ff1 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Thu, 10 Feb 2022 10:03:42 -0500 Subject: [PATCH 11/17] Spelling fixes in advanced/security docs --- docs/source/advanced/security/ssl_config.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/advanced/security/ssl_config.rst b/docs/source/advanced/security/ssl_config.rst index 0c411e8d7..28ff05036 100644 --- a/docs/source/advanced/security/ssl_config.rst +++ b/docs/source/advanced/security/ssl_config.rst @@ -24,7 +24,7 @@ After making any changes to these configuration values, ``xcatd`` must be restar service restart xcatd -If any mistakes have been made and communiation is lost to xCAT, use ``XCATBYPASS`` to fix/remove the bad configuration: :: +If any mistakes have been made and communication is lost to xCAT, use ``XCATBYPASS`` to fix/remove the bad configuration: :: XCATBYPASS=1 tabedit site @@ -42,7 +42,7 @@ Use the ``openssl`` command to validate the SSL configuration is valid and expec openssl s_client -connect localhost:3001 -ssl3 - You should get a reponse similar to: :: + You should get a response similar to: :: 70367087597568:error:14094410:SSL routines:SSL3_READ_BYTES:sslv3 alert handshake failure:s3_pkt.c:1259:SSL alert number 40 70367087597568:error:1409E0E5:SSL routines:SSL3_WRITE_BYTES:ssl handshake failure:s3_pkt.c:598: From 56547d1fde085e0bf236a3f3dd484bb90a2d3ba9 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Thu, 10 Feb 2022 10:10:33 -0500 Subject: [PATCH 12/17] Spelling fixes in advanced/xcat-inventory docs --- docs/source/advanced/xcat-inventory/define_create_cluster.rst | 2 +- docs/source/advanced/xcat-inventory/index.rst | 2 +- .../advanced/xcat-inventory/version_control_inventory.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/advanced/xcat-inventory/define_create_cluster.rst b/docs/source/advanced/xcat-inventory/define_create_cluster.rst index f7cfb43dc..92ee0052c 100644 --- a/docs/source/advanced/xcat-inventory/define_create_cluster.rst +++ b/docs/source/advanced/xcat-inventory/define_create_cluster.rst @@ -17,7 +17,7 @@ The steps to create your first xCAT cluster is: cp /opt/xcat/share/xcat/inventory_templates/flat_cluster_template.yaml /git/cluster/mycluster.yaml -2. custmize the cluster inventory file "mycluster.yaml" by modifying the attributs in the line under token ``#CHANGEME`` according to the setup of your phisical cluster. You can create new node definition by duplicating and modifying the node definition in the template. +2. customize the cluster inventory file "mycluster.yaml" by modifying the attributes in the line under token ``#CHANGEME`` according to the setup of your physical cluster. You can create new node definition by duplicating and modifying the node definition in the template. 3. import the cluster inventory file :: diff --git a/docs/source/advanced/xcat-inventory/index.rst b/docs/source/advanced/xcat-inventory/index.rst index 46ed319e6..021eacced 100644 --- a/docs/source/advanced/xcat-inventory/index.rst +++ b/docs/source/advanced/xcat-inventory/index.rst @@ -9,7 +9,7 @@ xcat-inventory * inventory templates for typical clusters, which help user to defines a cluster easily -* ability to intergrate with Ansible(Comming Soon) +* ability to integrate with Ansible(Coming Soon) This section presents 2 typical user case of ``xcat-inventory`` diff --git a/docs/source/advanced/xcat-inventory/version_control_inventory.rst b/docs/source/advanced/xcat-inventory/version_control_inventory.rst index 3669dc103..393e7eefd 100644 --- a/docs/source/advanced/xcat-inventory/version_control_inventory.rst +++ b/docs/source/advanced/xcat-inventory/version_control_inventory.rst @@ -41,7 +41,7 @@ By managing the inventory file under source control system, you can manage the x *Notice:* -1. The cluster inventory data exported by ``xcat-inventory`` does not include intermidiate data, transiate data and historical data in xCAT DataBase, such as node status, auditlog table +1. The cluster inventory data exported by ``xcat-inventory`` does not include intermediate data, transient data and historical data in xCAT DataBase, such as node status, auditlog table 2. We suggest you backup your xCAT database by ``dumpxCATdb`` before your trial on this feature, although we have run sufficient test on this From a681e35c0ef1c94bf909e5988a1342bcc5a411e4 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Fri, 11 Feb 2022 07:54:30 -0500 Subject: [PATCH 13/17] Spelling fixes in admin-guides/manage_clusters/common docs --- .../common/deployment/additionalpkg/nonubuntu_os_pkg.rst | 2 +- .../manage_clusters/common/deployment/create_img.rst | 2 +- .../manage_clusters/common/deployment/driver_update_disk.rst | 2 +- .../common/deployment/network/cfg_network_bridge.rst | 2 +- .../common/deployment/network/cfg_network_vlan.rst | 2 +- .../common/deployment/prepostscripts/postinstall_script.rst | 2 +- .../common/deployment/syncfile/syncfile_synclist_file.rst | 2 +- .../common/deployment/syncfile/syncfile_xdcp.rst | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/additionalpkg/nonubuntu_os_pkg.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/additionalpkg/nonubuntu_os_pkg.rst index 09003fc57..7380332a9 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/additionalpkg/nonubuntu_os_pkg.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/additionalpkg/nonubuntu_os_pkg.rst @@ -82,7 +82,7 @@ Group/Pattern Names It is only supported for stateful deployment. -In Linux, a groups of rpms can be packaged together into one package. It is called a group on RedHat, CentOS, Fedora and Scientific Linux. To get the a list of available groups, run +In Linux, a groups of rpms can be packaged together into one package. It is called a group on RedHat, CentOS, Fedora and Scientific Linux. To get the list of available groups, run * **[RHEL]** :: diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst index fcf2cafb4..f27c2e7bf 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/create_img.rst @@ -79,7 +79,7 @@ If this is the same distro version as what your management node uses, create a ` enabled=1 gpgcheck=0 -This way, if you need to install some additional RPMs into your MN later, you can simply install them with ``yum``. Or if you are installing a software on your MN that depends some RPMs from this disto, those RPMs will be found and installed automatically. +This way, if you need to install some additional RPMs into your MN later, you can simply install them with ``yum``. Or if you are installing a software on your MN that depends some RPMs from this distro, those RPMs will be found and installed automatically. **[Tips 2]** diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst index 2a31a51cc..834afb0c9 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst @@ -79,7 +79,7 @@ If 'osupdatename' is specified, the kernel shipped with the 'osupdatename' will - If putting the driver disk in /driverdisk//: -Running 'nodeset ' in anyway will load the driver disk +Running 'nodeset ' in anyway will load the driver disk .. END_inject_into_initrd__for_diskful_for_DUD diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_bridge.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_bridge.rst index 816e8fc08..bd3c36fd9 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_bridge.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_bridge.rst @@ -4,7 +4,7 @@ Configure Bridge Based On Ethernet NIC The following example set the xCAT properties for compute node ``cn1`` to create: * Compute node ``cn1`` has one physical NIC: eth1 - * User wants to confgure 1 bridge br1 based on eth1 + * User wants to configure 1 bridge br1 based on eth1 * Assign ip ``30.5.106.9`` to br0 Add network object into the networks table diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_vlan.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_vlan.rst index 65ee1de30..7263956d0 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_vlan.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/network/cfg_network_vlan.rst @@ -4,7 +4,7 @@ Configure VLAN Based on Ethernet Adapter The following example set the xCAT properties for compute node ``cn1`` to create: * Compute node ``cn1`` has one physical NIC: eth0 - * Confgure 2 vlans: eth0.6 and eth0.7 based on eth0 + * Configure 2 vlans: eth0.6 and eth0.7 based on eth0 * Assign ip ``60.5.106.9`` to eth0.6 and ``70.5.106.9`` to eth0.7 Define the additional networks to xCAT diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/prepostscripts/postinstall_script.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/prepostscripts/postinstall_script.rst index d3066b65c..15f9fe40c 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/prepostscripts/postinstall_script.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/prepostscripts/postinstall_script.rst @@ -32,7 +32,7 @@ When do ``postinstall`` scripts run? High level flow of ``genimage`` process: a) install the packages specified by ``pkglist`` into ``rootimgdir`` directory -b) cumstomize the ``rootimgdir`` directory +b) customize the ``rootimgdir`` directory c) generate the initrd based on the ``rootimgdir`` directory The ``postinstall`` scripts are executed in step b). diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst index 77b42e398..766dcdd5b 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst @@ -115,7 +115,7 @@ The **EXECUTE** clause is used to list all the postsync scripts (.post **EXECUTEALWAYS** -The **EXECUTEALWAYS** clause is used to list all the postsync scripts you would like to run after the files are synced, whether or not any file is actually updated. The files in this list must be added to the list of files to sync. If noderange is used in the synclist for the file listed in the **EXECUTEALWAYS** clause, the script will only be exectuted on the nodes in that noderange. +The **EXECUTEALWAYS** clause is used to list all the postsync scripts you would like to run after the files are synced, whether or not any file is actually updated. The files in this list must be added to the list of files to sync. If noderange is used in the synclist for the file listed in the **EXECUTEALWAYS** clause, the script will only be executed on the nodes in that noderange. .. note:: The path to the file to EXECUTE or EXECUTEALWAYS, is the location of the file on the MN. diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_xdcp.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_xdcp.rst index 41cc01990..3056741b0 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_xdcp.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_xdcp.rst @@ -25,7 +25,7 @@ For Linux nodes, you can use ``xdcp`` command **-i** option with **-F** to sync xdcp -i /install/////rootimg -F /install/custom///.synclist -You can use the ``xdcp`` **-s** option to sync the files only to the service nodes for the node group named **compute**. The files will be placed in the default **/var/xcat/syncfiles** directory or in the directory as indicated in the **site.SNsyncfiledir** attribute. If you want the files synched to the same directory on the service node that they come from on the Management Node, set **site.SNsyncfiledir=/** attribute. This can be setup before a node install, to have the files available to be synced during the install: :: +You can use the ``xdcp`` **-s** option to sync the files only to the service nodes for the node group named **compute**. The files will be placed in the default **/var/xcat/syncfiles** directory or in the directory as indicated in the **site.SNsyncfiledir** attribute. If you want the files synced to the same directory on the service node that they come from on the Management Node, set **site.SNsyncfiledir=/** attribute. This can be setup before a node install, to have the files available to be synced during the install: :: xdcp compute -s -F /install/custom///.synclist From 4f99f07f5a2004653b05a68ed70a9083516e8925 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Fri, 11 Feb 2022 13:39:31 -0500 Subject: [PATCH 14/17] Spelling fixes in admin-guides/manage_clusters/ppc64le docs --- .../ppc64le/discovery/mtms/discovery_using_defined.rst | 2 +- .../ppc64le/discovery/mtms/discovery_using_dhcp.rst | 2 +- .../manage_clusters/ppc64le/discovery/seq_discovery.rst | 2 +- .../manage_clusters/ppc64le/discovery/switch_discovery.rst | 2 +- .../diskful/customize_image/network/cfg_network_adapter.rst | 2 +- .../diskless/customize_image/network/cfg_network_adapter.rst | 2 +- .../admin-guides/manage_clusters/ppc64le/statelite/index.rst | 2 +- .../manage_clusters/ppc64le/statelite/provision_statelite.rst | 4 ++-- .../manage_clusters/ppc64le/virtual_machines/FAQ.rst | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_defined.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_defined.rst index 03a207d8e..1ed630f19 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_defined.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_defined.rst @@ -101,7 +101,7 @@ The BMC IP address is obtained by the open range dhcp server and the plan in thi chdef cn01 chain="runcmd=bmcsetup" -#. **[Optional]** More operation plan to do after hardware disocvery is done, ``ondiscover`` option can be used. +#. **[Optional]** More operation plan to do after hardware discovery is done, ``ondiscover`` option can be used. For example, configure console, copy SSH key for **OpenBMC**, then disable ``powersupplyredundancy`` :: diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_dhcp.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_dhcp.rst index 3bc786f7a..8690e7073 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_dhcp.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms/discovery_using_dhcp.rst @@ -85,7 +85,7 @@ The BMC IP address is obtained by the open range dhcp server and the plan is to chdef cn01 chain="runcmd=bmcsetup" -#. **[Optional]** More operation plan to do after hardware disocvery is done, ``ondiscover`` option can be used. +#. **[Optional]** More operation plan to do after hardware discovery is done, ``ondiscover`` option can be used. For example, configure console, copy SSH key for **OpenBMC**, then disable ``powersupplyredundancy`` :: diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst index 81df59ae5..62fe928e4 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/seq_discovery.rst @@ -28,7 +28,7 @@ In order to do BMC configuration during the discovery process, set ``runcmd=bmcs chdef cn1 chain="runcmd=bmcsetup" -**[Optional]** More operation plan to do after hardware disocvery is done, ``ondiscover`` option can be used. +**[Optional]** More operation plan to do after hardware discovery is done, ``ondiscover`` option can be used. For example, configure console, copy SSH key for **OpenBMC**, then disable ``powersupplyredundancy`` :: diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst index e30ce9555..555d352a0 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/switch_discovery.rst @@ -65,7 +65,7 @@ In order to do BMC configuration during the discovery process, set ``runcmd=bmcs chdef cn1 chain="runcmd=bmcsetup" -**[Optional]** More operation plan to do after hardware disocvery is done, ``ondiscover`` option can be used. +**[Optional]** More operation plan to do after hardware discovery is done, ``ondiscover`` option can be used. For example, configure console, copy SSH key for **OpenBMC**, then disable ``powersupplyredundancy`` :: diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/cfg_network_adapter.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/cfg_network_adapter.rst index 1e4f71ff2..effc48c5c 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/cfg_network_adapter.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskful/customize_image/network/cfg_network_adapter.rst @@ -1,7 +1,7 @@ Configure Additional Network Interfaces - confignetwork ------------------------------------------------------- -The ``confignetwork`` postscript can be used to configure the network interfaces on the compute nodes to support Ethernet adapters, VLAN, BONDs, and BRIDGES. ``confignetwork`` can be used in postscripts during OS privision, it can also be executed in ``updatenode``. The way the ``confignetwork`` postscript decides what IP address to give the secondary adapter is by checking the ``nics`` table, in which the nic configuration information is stored. In order for the ``confignetwork`` postscript to run successfully, the following attributes must be configured for the node in the ``nics`` table: +The ``confignetwork`` postscript can be used to configure the network interfaces on the compute nodes to support Ethernet adapters, VLAN, BONDs, and BRIDGES. ``confignetwork`` can be used in postscripts during OS provisioning, it can also be executed in ``updatenode``. The way the ``confignetwork`` postscript decides what IP address to give the secondary adapter is by checking the ``nics`` table, in which the nic configuration information is stored. In order for the ``confignetwork`` postscript to run successfully, the following attributes must be configured for the node in the ``nics`` table: * ``nicips`` * ``nictypes`` diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/cfg_network_adapter.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/cfg_network_adapter.rst index 1e4f71ff2..effc48c5c 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/cfg_network_adapter.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/diskless/customize_image/network/cfg_network_adapter.rst @@ -1,7 +1,7 @@ Configure Additional Network Interfaces - confignetwork ------------------------------------------------------- -The ``confignetwork`` postscript can be used to configure the network interfaces on the compute nodes to support Ethernet adapters, VLAN, BONDs, and BRIDGES. ``confignetwork`` can be used in postscripts during OS privision, it can also be executed in ``updatenode``. The way the ``confignetwork`` postscript decides what IP address to give the secondary adapter is by checking the ``nics`` table, in which the nic configuration information is stored. In order for the ``confignetwork`` postscript to run successfully, the following attributes must be configured for the node in the ``nics`` table: +The ``confignetwork`` postscript can be used to configure the network interfaces on the compute nodes to support Ethernet adapters, VLAN, BONDs, and BRIDGES. ``confignetwork`` can be used in postscripts during OS provisioning, it can also be executed in ``updatenode``. The way the ``confignetwork`` postscript decides what IP address to give the secondary adapter is by checking the ``nics`` table, in which the nic configuration information is stored. In order for the ``confignetwork`` postscript to run successfully, the following attributes must be configured for the node in the ``nics`` table: * ``nicips`` * ``nictypes`` diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/index.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/index.rst index 7ae22087e..528bae069 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/index.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/index.rst @@ -31,7 +31,7 @@ There are two solutions: ``NFSROOT-based`` and ``RAMdisk-based``. **Disadvantages** -However, there're still several disadvantages, especially for the ``NFSROOT-based`` solution. +However, there are still several disadvantages, especially for the ``NFSROOT-based`` solution. #. NFS Root requires more network traffic to run as the majority of the disk image runs over NFS. This may depend on your workload, but can be minimized. Since the bulk of the image is read-only, NFS caching on the server helps minimize the disk access on the server, and NFS caching on the client helps reduce the network traffic. #. NFS Root can be complex to set up. As more files are created in different places, there are greater chances for failures. This flexibility is also one of the great virtues of Statelite. The image can work in nearly any environment. diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/provision_statelite.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/provision_statelite.rst index da1ae4cdf..bf30e5ee0 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/provision_statelite.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/statelite/provision_statelite.rst @@ -119,7 +119,7 @@ Set up Post scripts for statelite The rules to create post install scripts for statelite image is the same as the rules for stateless/diskless install images. -There're two kinds of postscripts for statelite (also for stateless/diskless). +There are two kinds of postscripts for statelite (also for stateless/diskless). The first kind of postscript is executed at genimage time, it is executed again the image itself on the MN . It was setup in The postinstall file section before the image was generated. @@ -207,7 +207,7 @@ Boot the statelite node Make sure you have set up all the attributes in your node definitions correctly following the node installation instructions corresponding to your hardware: -You can now deploy the node by running the following commmands: :: +You can now deploy the node by running the following commands: :: rinstall diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/FAQ.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/FAQ.rst index a6260fbb2..f210a4d83 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/FAQ.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/virtual_machines/FAQ.rst @@ -67,7 +67,7 @@ rmigrate fails with "Error: 38, message: failed to create directory '' vm1: Error: 38, message: failed to create directory '': File exists: Unknown issue libvirt error code. **Solution**: - Ususally happens when `nfs:` is specified for vmstorage attribute but that NFS directory is no longer mounted. Make sure the directory /var/lib/xcat/pools is empty on the destination kvmhost. + Usually happens when `nfs:` is specified for vmstorage attribute but that NFS directory is no longer mounted. Make sure the directory /var/lib/xcat/pools is empty on the destination kvmhost. Error: Cannot communicate via libvirt to kvmhost1 From 4c23f8012815acea11baf11a9e8b714ce13c5e00 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Fri, 11 Feb 2022 13:53:48 -0500 Subject: [PATCH 15/17] Spelling fixes in references/coral docs --- .../cluster_mgmt/scalability/python/install/index.rst | 2 +- .../references/coral/ha/ha_mgmt_node_with_shared_data.rst | 8 ++++---- docs/source/references/coral/index.rst | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/source/references/coral/cluster_mgmt/scalability/python/install/index.rst b/docs/source/references/coral/cluster_mgmt/scalability/python/install/index.rst index 8e8490f6e..2c08ade49 100644 --- a/docs/source/references/coral/cluster_mgmt/scalability/python/install/index.rst +++ b/docs/source/references/coral/cluster_mgmt/scalability/python/install/index.rst @@ -1,7 +1,7 @@ Installation ============ -A new RPM is created that contains the Python code: ``xCAT-openbmc-py``. The Python code requires additonal Python libraries that may not be available as an operating system provided package. The following will help resolve the dependencies. +A new RPM is created that contains the Python code: ``xCAT-openbmc-py``. The Python code requires additional Python libraries that may not be available as an operating system provided package. The following will help resolve the dependencies. .. toctree:: diff --git a/docs/source/references/coral/ha/ha_mgmt_node_with_shared_data.rst b/docs/source/references/coral/ha/ha_mgmt_node_with_shared_data.rst index 0537cccd8..e52eada62 100644 --- a/docs/source/references/coral/ha/ha_mgmt_node_with_shared_data.rst +++ b/docs/source/references/coral/ha/ha_mgmt_node_with_shared_data.rst @@ -4,9 +4,9 @@ HA Solution Overview ==================== -While a xCAT management node ``xcatmn1`` is running as a primary management node, another node - ``xcatmn2`` can be configured to act as primary management node in case ``xcatmn1`` becomes unavailable. The process is manual and requires disabling primary ``xcatmn1`` and activating backup ``xcatmn2``. Both nodes require access to shared storage described below. Use of Virtual IP is also requred. +While a xCAT management node ``xcatmn1`` is running as a primary management node, another node - ``xcatmn2`` can be configured to act as primary management node in case ``xcatmn1`` becomes unavailable. The process is manual and requires disabling primary ``xcatmn1`` and activating backup ``xcatmn2``. Both nodes require access to shared storage described below. Use of Virtual IP is also required. -An interactive sample script `xcatha.py `_ is availabe to guide through the steps of disabling and activation of xCAT management nodes. ``Dryrun`` option in that scrip allows viewing the actions without executing them. +An interactive sample script `xcatha.py `_ is available to guide through the steps of disabling and activation of xCAT management nodes. ``Dryrun`` option in that scrip allows viewing the actions without executing them. Configure and Activate Primary xCAT Management Node =================================================== @@ -95,12 +95,12 @@ The following xCAT directory structure should be accessible from primary xCAT ma Synchronize ``/etc/hosts`` `````````````````````````` -Since the ``/etc/hosts`` is used by xCAT commands, the ``/etc/hosts`` should be synchronized between the primary management node and bakup management node. +Since the ``/etc/hosts`` is used by xCAT commands, the ``/etc/hosts`` should be synchronized between the primary management node and backup management node. Synchronize Clock ````````````````` -It is recommended that the clocks are synchrinized between the primary management node and bakup management node. +It is recommended that the clocks are synchronized between the primary management node and backup management node. Activate Primary xCAT Management Node ````````````````````````````````````` diff --git a/docs/source/references/coral/index.rst b/docs/source/references/coral/index.rst index 5e28d2137..17b70b2ab 100644 --- a/docs/source/references/coral/index.rst +++ b/docs/source/references/coral/index.rst @@ -1,7 +1,7 @@ CORAL ===== -CORAL stands for Collaboration of Oak Ridge, Argonne, and Livermore and is solution that IBM is building for the Department of Energy to superseed its current cluster of Supercomputers. +CORAL stands for Collaboration of Oak Ridge, Argonne, and Livermore and is solution that IBM is building for the Department of Energy to supersede its current cluster of Supercomputers. .. toctree:: From c923d52b729ffacb538a0810507a05d8b9383c2e Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Fri, 11 Feb 2022 13:57:49 -0500 Subject: [PATCH 16/17] Spelling fixes in security docs --- docs/source/security/2016/20160115_openssl.rst | 2 +- docs/source/security/2017/20171212_tls.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/security/2016/20160115_openssl.rst b/docs/source/security/2016/20160115_openssl.rst index 5d0a3ebe2..87b6c7893 100644 --- a/docs/source/security/2016/20160115_openssl.rst +++ b/docs/source/security/2016/20160115_openssl.rst @@ -6,7 +6,7 @@ A detailed description of this issue can be seen in the following blog posting: Advisory CVEs ------------- -`CVE-2015-7575 `_ - TLS 1.2 Transcipt Collision attacks against MD5 in key exchange protocol (SLOTH) +`CVE-2015-7575 `_ - TLS 1.2 Transcript Collision attacks against MD5 in key exchange protocol (SLOTH) Action ------ diff --git a/docs/source/security/2017/20171212_tls.rst b/docs/source/security/2017/20171212_tls.rst index 63cf60467..96ceb1541 100644 --- a/docs/source/security/2017/20171212_tls.rst +++ b/docs/source/security/2017/20171212_tls.rst @@ -1,7 +1,7 @@ 2017-12-12 - TLS Vulnerabilities ================================ -*Dec 12, 2017*, TLS implementations may disclose side channel information via discrepencies between valid and invalid PKCS#1 padding +*Dec 12, 2017*, TLS implementations may disclose side channel information via discrepancies between valid and invalid PKCS#1 padding Advisory CVEs ------------- From 27a14d454d6f4e47d37c885bec0a96c5bfbd3005 Mon Sep 17 00:00:00 2001 From: besawn <38794505+besawn@users.noreply.github.com> Date: Fri, 11 Feb 2022 13:59:09 -0500 Subject: [PATCH 17/17] Spelling fixes in troubleshooting docs --- docs/source/troubleshooting/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/troubleshooting/index.rst b/docs/source/troubleshooting/index.rst index e09ac69de..ed5859086 100644 --- a/docs/source/troubleshooting/index.rst +++ b/docs/source/troubleshooting/index.rst @@ -3,7 +3,7 @@ Troubleshooting This chapter introduces the methods of debugging and troubleshooting a xCAT cluster. `General xCAT troubleshooting and debugging suggestions `_ -Additional recomendations: +Additional recommendations: .. toctree:: :maxdepth: 2