From 5f92ad4aa24ef5e6e22bae2653bd15cbf2f5a890 Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 14:01:52 -0500 Subject: [PATCH 01/10] network_planning/xcat_net_planning.rst: Add bullets to the separate lines so they actually become separate lines. --- .../basic_concepts/network_planning/xcat_net_planning.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/admin-guides/basic_concepts/network_planning/xcat_net_planning.rst b/docs/source/guides/admin-guides/basic_concepts/network_planning/xcat_net_planning.rst index ce7faca7d..6a8c15368 100644 --- a/docs/source/guides/admin-guides/basic_concepts/network_planning/xcat_net_planning.rst +++ b/docs/source/guides/admin-guides/basic_concepts/network_planning/xcat_net_planning.rst @@ -11,8 +11,8 @@ Service Nodes For very large clusters, xCAT has the ability to distribute the management operations to service nodes. This allows the management node to delegate all management responsibilities for a set of compute or storage nodes to a service node so that the management node doesn't get overloaded. Although xCAT automates a lot of the aspects of deploying and configuring the services, it still adds complexity to your cluster. So the question is: at what size cluster do you need to start using service nodes?? The exact answer depends on a lot of factors (mgmt node size, network speed, node type, OS, frequency of node deployment, etc.), but here are some general guidelines for how many nodes a single mgmt node (or single service node) can handle: * **[Linux]:** - Stateful or Stateless: 500 nodes - Statelite: 250 nodes + * Stateful or Stateless: 500 nodes + * Statelite: 250 nodes * **[AIX]:** 150 nodes From 244fdb230d2b2e18e12e3ce305ffa5b81a4de3fd Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 14:32:58 -0500 Subject: [PATCH 02/10] basic_concepts/node_type.rst: separate words in section title --- docs/source/guides/admin-guides/basic_concepts/node_type.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/guides/admin-guides/basic_concepts/node_type.rst b/docs/source/guides/admin-guides/basic_concepts/node_type.rst index 4dff9794e..9c9da0d36 100644 --- a/docs/source/guides/admin-guides/basic_concepts/node_type.rst +++ b/docs/source/guides/admin-guides/basic_concepts/node_type.rst @@ -19,7 +19,7 @@ Traditional cluster with OS on each node's local disk. Admin has to manage all of the individual OS copies, has to face the failure of hard disk. For certain application which requires all the compute nodes have exactly same state, this is also changeable for admin. -Stateless(diskless) +Stateless (diskless) ------------------- Nodes boot from a RAMdisk OS image downloaded from the xCAT mgmt node or service node at boot time. From 8c76061b29c0ff54813739a72a1a36a8fdb147b7 Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 14:52:00 -0500 Subject: [PATCH 03/10] ppc64le/discovery/config_environment.rst: shorten instruction line. --- .../manage_clusters/ppc64le/discovery/config_environment.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst index a8027e495..fd2f0fa16 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst @@ -12,7 +12,7 @@ Normally, there will be at least two entries for the two subnet on MN in ``netwo "10_0_0_0-255_255_0_0","10.0.0.0","255.255.0.0","eth1","",,"10.0.1.1",,,,,,,,,,,, "50_0_0_0-255_255_0_0","50.0.0.0","255.255.0.0","eth2","",,"50.0.1.1",,,,,,,,,,,, -Pls run the following command to add networks in ``networks`` table if no entry in ``networks`` table:: +Run the following command to add networks in ``networks`` table if there are no entries in it:: makenetworks From 2f877d01a94860bcd74b9fa74ecdd39f94f1e4a9 Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 14:58:41 -0500 Subject: [PATCH 04/10] ppc64le/discovery/config_environment.rst: s/pkg/package/ for genesis, and style change on instruction line --- .../ppc64le/discovery/config_environment.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst index fd2f0fa16..f6edeb355 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/config_environment.rst @@ -47,10 +47,10 @@ For hardware management with ipmi, add the following line:: "ipmi","ADMIN","admin",,,, -Verify the genesis pkg +Verify the genesis packages `````````````````````` -Genesis pkg is used to **create the root image for network boot** and it **MUST** be installed before doing hardware discovery. +Genesis packages are used to **create the root image for network boot** and **MUST** be installed before doing hardware discovery. * **[RH]**:: @@ -64,4 +64,4 @@ Genesis pkg is used to **create the root image for network boot** and it **MUST* ii xcat-genesis-base-ppc64 2.10-snap201505172314 all xCAT Genesis netboot image ii xcat-genesis-scripts 2.10-snap201507240105 ppc64el xCAT genesis -**Note:** If the two pkgs are not installed, pls installed them first and then run ``mknb ppc64`` to create the network boot root image. +**Note:** If the two packages are not installed, install them first and then run ``mknb ppc64`` to create the network boot root image. From fd9d4af0b0c247f0aa0bef5ed125a32b8aca469f Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 15:06:47 -0500 Subject: [PATCH 05/10] ppc64le/discovery/mtms_discovery.rst: cosmetic changes to more than 1 BMC within an IP range --- .../manage_clusters/ppc64le/discovery/mtms_discovery.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst index af863e5fb..b4f9d798b 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/mtms_discovery.rst @@ -11,7 +11,7 @@ Discover server and define After environment is ready, and the server is powered, we can start server discovery process. The first thing to do is discovering the FSP/BMC of the server. It is automatically powered on when the physical server is powered. -The following command can be used to discovery BMC within an IP range and write the discovered node definition into a stanza file:: +The following command can be used to discover BMC(s) within an IP range and write the discovered node definition(s) into a stanza file:: bmcdiscover -s nmap --range 50.0.100.1-100 -z > ./bmc.stanza @@ -19,7 +19,7 @@ The following command can be used to discovery BMC within an IP range and write bmcdiscover -s nmap --range 50.0.100.1-100 -z -u -p > ./bmc.stanza -You need to modify the node definition in stanza file before using them, the stanza file will be like this:: +You need to modify the node definition(s) in stanza file before using them, the stanza file will be like this:: # cat pbmc.stanza cn1: From 1ea7d3f978a20447f978bd28152e45c960804fc5 Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 15:09:01 -0500 Subject: [PATCH 06/10] ppc64le/discovery/switch_discovery.rst: minor fix --- .../manage_clusters/ppc64le/discovery/switch_discovery.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 762628d67..d50c95cc7 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 @@ -1,6 +1,6 @@ .. include:: ../../common/discover/switch_discovery.rst -For switch based hardware discovery, the server are identified though the switches and switchposts they directly connect to. +For switch based hardware discovery, the servers are identified through the switches and switchposts they are directly connected to. .. include:: schedule_environment.rst From 9f67664c7602cc60d0ee64acb7484e6ace6d8659 Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 15:15:35 -0500 Subject: [PATCH 07/10] ppc64le/discovery/seq_discovery.rst: Minor fixes --- .../manage_clusters/ppc64le/discovery/seq_discovery.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) 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 42403b26e..00dff6d54 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 @@ -1,6 +1,6 @@ .. include:: ../../common/discover/seq_discovery.rst -When the physical location of the server is not so important, sequential base hardware discovery can be used to simplify the discovery work. The idea is: providing a node pool, each node in the pool will be assigned an IP address for host and an IP address for FSP/BMC, then match first came physical server discovery request to the first free node in the node pool and configure the assigned IP address for host and FSP/BMC onto that pysical server. +When the physical location of the server is not so important, sequential-based hardware discovery can be used to simplify the discovery work. The idea is: provided a node pool, each node in the pool will be assigned an IP address for host and an IP address for FSP/BMC, then the first physical server discovery request will be matched to the first free node in the node pool, and IP addresses for host and FSP/BMC will be assigned to that physical server. .. include:: schedule_environment.rst .. include:: config_environment.rst @@ -13,7 +13,7 @@ To prepare the node pool, shall predefine nodes first, then initialize the disco Predefine nodes ``````````````` -Predefine a group of node with desired IP address for host and IP address for FSP/BMC:: +Predefine a group of nodes with desired IP address for host and IP address for FSP/BMC:: nodeadd cn1 groups=powerLE,all chdef cn1 mgt=ipmi cons=ipmi ip=10.0.101.1 bmc=50.0.101.1 netboot=petitboot installnic=mac primarynic=mac @@ -25,7 +25,7 @@ Specify the predefined nodes to the nodediscoverstart command to initialize the nodediscoverstart noderange=cn1 -Pls see "nodediscoverstart man page" for more details. +See "nodediscoverstart man page" for more details. Display information about the discovery process ``````````````````````````````````````````````` @@ -50,6 +50,6 @@ Note: The sequential discovery process will be stopped automatically when all of Start discovery process ----------------------- -To start discovery process, the system administrator need to power on the servers one by one manually. Then the hardware discovery process will start automatically. +To start the discovery process, the system administrator needs to power on the servers one by one manually. Then the hardware discovery process will start automatically. .. include:: standard_cn_definition.rst From aec309ce4a8e6f02febc982929f47c8535eade3d Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 15:22:10 -0500 Subject: [PATCH 08/10] ppc64le/discovery/manually_discovery.rst: Minor fixes --- .../manage_clusters/ppc64le/discovery/manually_discovery.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst index e29d77069..6568422e9 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/discovery/manually_discovery.rst @@ -1,6 +1,6 @@ .. include:: ../../common/discover/manually_discovery.rst -If you have a few nodes which were not discovered by automated hardware discovery process, you could find them in ``discoverydata`` table using the nodediscoverls. The undiscovered nodes are those that have a discovery method value of 'undef' in the ``discoverydata`` table. +If you have a few nodes which were not discovered by automated hardware discovery process, you can find them in ``discoverydata`` table using the ``nodediscoverls`` command. The undiscovered nodes are those that have a discovery method value of 'undef' in the ``discoverydata`` table. Display the undefined nodes with the ``nodediscoverls`` command:: From a7ede43c7822e9628f3a6f48c2fe70e5bc387df5 Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 15:25:21 -0500 Subject: [PATCH 09/10] ppc64le/management.rst: minor changes, typos, BMC acronym https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface#Baseboard_management_controller --- .../admin-guides/manage_clusters/ppc64le/management.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management.rst b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management.rst index 8c4139880..27a6a6644 100644 --- a/docs/source/guides/admin-guides/manage_clusters/ppc64le/management.rst +++ b/docs/source/guides/admin-guides/manage_clusters/ppc64le/management.rst @@ -99,12 +99,12 @@ As an example, get only the temperature information of a particular machine. :: Firmware Updating ````````````````` -**TODO**: For OpenPower machine, the firmware updating feature is not implement in the ``rflash`` command. The section should be updated after this feature get implemented. +**TODO**: For OpenPower machines, the firmware updating feature is not implemented in the ``rflash`` command. The section should be updated after this feature is implemented. Configures Nodes' Service Processors ```````````````````````````````````` -Here comes the command, ``rspconfig``. It is used to configure the service processor of a phyisical machine. On a OpenPower system, the service processor is the BMC, Base Motherboard Controller. Various variables can be set through the command. But, please also notice, the actual configuration may change among difference machine model type. +Here comes the command, ``rspconfig``. It is used to configure the service processor of a physical machine. On a OpenPower system, the service processor is the BMC, Baseboard Management Controller. Various variables can be set through the command. But, please also notice, the actual configuration may change among different machine-model types. Examples From 1fca1f6426fadbd6d21ee4ce39a09ec1ddb1d15e Mon Sep 17 00:00:00 2001 From: Mauricio Faria de Oliveira Date: Tue, 17 Nov 2015 15:50:01 -0500 Subject: [PATCH 10/10] deployment/create_img.rst: style changes for readability --- .../common/deployment/create_img.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) 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 d33237881..16167d51a 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 @@ -1,9 +1,9 @@ Select or Create an osimage Definition ====================================== -Before creating image by xCAT, distro media should be prepared ahead. That can be ISOs or DVDs. +Before creating an image on xCAT, the distro media should be prepared ahead. That can be ISOs or DVDs. -XCAT use 'copycds' command to create image which will be available to install nodes. "copycds" will copy all contents of Distribution DVDs/ISOs or Service Pack DVDs/ISOs to a destination directory, and create several relevant osimage definitions by default. +XCAT use 'copycds' command to create an image which will be available to install nodes. "copycds" will copy all contents of Distribution DVDs/ISOs or Service Pack DVDs/ISOs to a destination directory, and create several relevant osimage definitions by default. If using an ISO, copy it to (or NFS mount it on) the management node, and then run: :: @@ -21,7 +21,7 @@ To see the attributes of a particular osimage: :: lsdef -t osimage -Initially, some attributes of osimage is assigned to default value by xCAT, they all can work correctly, cause the files or templates invoked by those attributes are shipped with xCAT by default. If need to customize those attribute, refer to next section :doc:`Customize osimage ` +Initially, some attributes of osimage are assigned default values by xCAT - they all can work correctly because the files or templates invoked by those attributes are shipped with xCAT by default. If you need to customize those attributes, refer to the next section :doc:`Customize osimage ` Below is an example of osimage definitions created by ``copycds``: :: @@ -39,7 +39,7 @@ In these osimage definitions shown above **Note**: There are more things needed for **ubuntu ppc64le** osimages: -For ubuntu ppc64le, the shipped initrd.gz within ISO is not supported to do network booting. In order to install ubuntu with xCAT, you need to follow the steps below to complete the osimage definition. +For ubuntu ppc64le, the initrd.gz shipped with the ISO does not support network booting. In order to install ubuntu with xCAT, you need to follow the steps below to complete the osimage definition. * Download mini.iso from @@ -63,7 +63,7 @@ For ubuntu ppc64le, the shipped initrd.gz within ISO is not supported to do netw **[Tips 1]** -If this is the same distro version as what your management node used, create a .repo file in /etc/yum.repos.d with content similar to: :: +If this is the same distro version as what your management node uses, create a .repo file in /etc/yum.repos.d with contents similar to: :: [local--] name=xCAT local @@ -71,17 +71,17 @@ If this is the same distro version as what your management node used, create a . enabled=1 gpgcheck=0 -In this way, if you need install some additional RPMs into your MN later, you can simply install them by yum. Or if you are installing a software on your MN that depends some RPMs from the this disto, those RPMs will be found and installed automatically. +In 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. **[Tips 2]** -Sometime you can create/modify a osimage definition easily based on the default osimage definition. the general steps can be: +You can create/modify an osimage definition easily based on the default osimage definition. The general steps are: * lsdef -t osimage -z --install-compute > .stanza -* modify .stanza depending on your requirement +* modify .stanza according to your requirements * cat .stanza| mkdef -z -For example, if need to change osimage name to your favorite name, below statement maybe helpful: :: +For example, if you need to change the osimage name to your favorite name, this command may be helpful: :: lsdef -t osimage -z rhels6.2-x86_64-install-compute | sed 's/^[^ ]\+:/mycomputeimage:/' | mkdef -z