From 174f92a5da065dbc2eed37c7b63f14f3706fc973 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 15 Sep 2016 13:58:13 -0400 Subject: [PATCH 1/3] Update the documentation to recommend users go directly into provisioning the OS --- docs/source/advanced/mixed_cluster/power/diskful.rst | 1 - .../ppc64le/discovery/mtms/discovery_using_defined.rst | 3 +++ .../ppc64le/discovery/mtms/discovery_using_dhcp.rst | 4 ++++ .../manage_clusters/ppc64le/discovery/seq_discovery.rst | 8 +++++++- .../ppc64le/discovery/switch_discovery.rst | 8 +++++++- 5 files changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/source/advanced/mixed_cluster/power/diskful.rst b/docs/source/advanced/mixed_cluster/power/diskful.rst index 40f9d4cb3..7381ffe13 100644 --- a/docs/source/advanced/mixed_cluster/power/diskful.rst +++ b/docs/source/advanced/mixed_cluster/power/diskful.rst @@ -26,7 +26,6 @@ Create a node definition for the x86_64 compute node, here is a sample: :: bmc=10.4.42.254 bmcpassword=PASSW0RD bmcusername=USERID - chain=runcmd=bmcsetup,shell cons=ipmi groups=all initrd=xcat/osimage/rhels6.6-x86_64-install-compute/initrd.img 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 ca8e4c571..7049af972 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 @@ -105,6 +105,9 @@ The BMC IP address is obtained by the open range dhcp server and the plan in thi chdef cn01 chain="runcmd=bmcsetup" +#. Set the target `osimage` into the chain table to automatically provision the operating system after the node discovery is complete. :: + + chdef cn01 -p chain="osimage=" #. Change the BMC IP address 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 7759e3c2e..3634c067b 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 @@ -82,6 +82,10 @@ The BMC IP address is obtained by the open range dhcp server and the plan is to chdef cn01 chain="runcmd=bmcsetup" +#. Set the target `osimage` into the chain table to automatically provision the operating system after the node discovery is complete. :: + + chdef cn01 -p chain="osimage=" + #. Define the compute nodes into xCAT: :: cat predefined.stanzas | mkdef -z 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 ea26332cc..91934420a 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 @@ -18,10 +18,16 @@ Predefine a group of nodes with desired IP address for host and IP address for F 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 -In order to do BMC configuration during the discovery process, set ``runcmd=bmcsetup``. For more info about chain, please refer to :doc:`Chain <../../../../../advanced/chain/index>` :: +In order to do BMC configuration during the discovery process, set ``runcmd=bmcsetup``. :: chdef cn1 chain="runcmd=bmcsetup" +Set the target `osimage` into the chain table to automatically provision the operating system after the node discovery is complete. :: + + chdef cn1 -p chain="osimage=" + +For more information about chain, please refer to :doc:`Chain <../../../../../advanced/chain/index>` + Initialize the discovery process ```````````````````````````````` 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 ad2c60a31..857bc35be 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 @@ -54,10 +54,16 @@ After switches are defined, the server node can be predefined with the following chdef cn1 mgt=ipmi cons=ipmi ip=10.0.101.1 bmc=50.0.101.1 netboot=petitboot installnic=mac primarynic=mac chdef cn1 switch=switch1 switchport=0 -In order to do BMC configuration during the discovery process, set ``runcmd=bmcsetup``. For more info about chain, please refer to :doc:`Chain <../../../../../advanced/chain/index>` :: +In order to do BMC configuration during the discovery process, set ``runcmd=bmcsetup``. :: chdef cn1 chain="runcmd=bmcsetup" +Set the target `osimage` into the chain table to automatically provision the operating system after the node discovery is complete. :: + + chdef cn1 -p chain="osimage=" + +For more information about chain, please refer to :doc:`Chain <../../../../../advanced/chain/index>` + Add cn1 into DNS:: makehosts cn1 From 031a5022ce7a305c103f48e9b0d49ede12c60411 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 15 Sep 2016 14:01:04 -0400 Subject: [PATCH 2/3] Change the man page for the chain table --- docs/source/guides/admin-guides/references/man5/chain.5.rst | 2 +- docs/source/guides/admin-guides/references/man7/group.7.rst | 2 +- docs/source/guides/admin-guides/references/man7/node.7.rst | 2 +- perl-xCAT/xCAT/Schema.pm | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man5/chain.5.rst b/docs/source/guides/admin-guides/references/man5/chain.5.rst index 0b9ae1cb0..d339f5760 100644 --- a/docs/source/guides/admin-guides/references/man5/chain.5.rst +++ b/docs/source/guides/admin-guides/references/man5/chain.5.rst @@ -56,7 +56,7 @@ chain Attributes: \ **chain**\ - A comma-delimited chain of actions to be performed automatically when this node is discovered. ("Discovered" means a node booted, but xCAT and DHCP did not recognize the MAC of this node. In this situation, xCAT initiates the discovery process, the last step of which is to run the operations listed in this chain attribute, one by one.) Valid values: boot, runcmd=, runimage=, shell, standby. (Default - same as no chain - it will do only the discovery.). Example, for BMC machines use: runcmd=bmcsetup,shell. + A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell. diff --git a/docs/source/guides/admin-guides/references/man7/group.7.rst b/docs/source/guides/admin-guides/references/man7/group.7.rst index b2b3ea39d..d5fd8a202 100644 --- a/docs/source/guides/admin-guides/references/man7/group.7.rst +++ b/docs/source/guides/admin-guides/references/man7/group.7.rst @@ -147,7 +147,7 @@ group Attributes: \ **chain**\ (chain.chain) - A comma-delimited chain of actions to be performed automatically when this node is discovered. ("Discovered" means a node booted, but xCAT and DHCP did not recognize the MAC of this node. In this situation, xCAT initiates the discovery process, the last step of which is to run the operations listed in this chain attribute, one by one.) Valid values: boot, runcmd=, runimage=, shell, standby. (Default - same as no chain - it will do only the discovery.). Example, for BMC machines use: runcmd=bmcsetup,shell. + A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell. diff --git a/docs/source/guides/admin-guides/references/man7/node.7.rst b/docs/source/guides/admin-guides/references/man7/node.7.rst index 73203e7cd..a0838cec0 100644 --- a/docs/source/guides/admin-guides/references/man7/node.7.rst +++ b/docs/source/guides/admin-guides/references/man7/node.7.rst @@ -159,7 +159,7 @@ node Attributes: \ **chain**\ (chain.chain) - A comma-delimited chain of actions to be performed automatically when this node is discovered. ("Discovered" means a node booted, but xCAT and DHCP did not recognize the MAC of this node. In this situation, xCAT initiates the discovery process, the last step of which is to run the operations listed in this chain attribute, one by one.) Valid values: boot, runcmd=, runimage=, shell, standby. (Default - same as no chain - it will do only the discovery.). Example, for BMC machines use: runcmd=bmcsetup,shell. + A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell. diff --git a/perl-xCAT/xCAT/Schema.pm b/perl-xCAT/xCAT/Schema.pm index 05b81c736..f7d3a9f38 100755 --- a/perl-xCAT/xCAT/Schema.pm +++ b/perl-xCAT/xCAT/Schema.pm @@ -358,7 +358,7 @@ passed as argument rather than by table value', node => 'The node name or group name.', currstate => 'The current or next chain step to be executed on this node by xCAT-genesis. Set by xCAT during node discovery or as a result of nodeset.', currchain => 'The chain steps still left to do for this node. This attribute will be automatically adjusted by xCAT while xCAT-genesis is running on the node (either during node discovery or a special operation like firmware update). During node discovery, this attribute is initialized from the chain attribute and updated as the chain steps are executed.', - chain => 'A comma-delimited chain of actions to be performed automatically when this node is discovered. ("Discovered" means a node booted, but xCAT and DHCP did not recognize the MAC of this node. In this situation, xCAT initiates the discovery process, the last step of which is to run the operations listed in this chain attribute, one by one.) Valid values: boot, runcmd=, runimage=, shell, standby. (Default - same as no chain - it will do only the discovery.). Example, for BMC machines use: runcmd=bmcsetup,shell.', + chain => 'A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell.', ondiscover => 'This attribute is currently not used by xCAT. The "nodediscover" operation is always done during node discovery.', comments => 'Any user-written notes.', disable => "Set to 'yes' or '1' to comment out this row.", From 6bdfc2044be5bc11d952d13816d842d0fd242590 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Fri, 16 Sep 2016 19:03:21 -0400 Subject: [PATCH 3/3] Fixed based on review comments --- docs/source/guides/admin-guides/references/man5/chain.5.rst | 2 +- docs/source/guides/admin-guides/references/man7/group.7.rst | 2 +- docs/source/guides/admin-guides/references/man7/node.7.rst | 2 +- perl-xCAT/xCAT/Schema.pm | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man5/chain.5.rst b/docs/source/guides/admin-guides/references/man5/chain.5.rst index d339f5760..37ac50f22 100644 --- a/docs/source/guides/admin-guides/references/man5/chain.5.rst +++ b/docs/source/guides/admin-guides/references/man5/chain.5.rst @@ -56,7 +56,7 @@ chain Attributes: \ **chain**\ - A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell. + A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server do not recognize the MAC address of the node when xCAT initializes the discovery process.) The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. For example, to have the genesis kernel pause to the shell, use chain=shell. diff --git a/docs/source/guides/admin-guides/references/man7/group.7.rst b/docs/source/guides/admin-guides/references/man7/group.7.rst index d5fd8a202..25a2486a3 100644 --- a/docs/source/guides/admin-guides/references/man7/group.7.rst +++ b/docs/source/guides/admin-guides/references/man7/group.7.rst @@ -147,7 +147,7 @@ group Attributes: \ **chain**\ (chain.chain) - A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell. + A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server do not recognize the MAC address of the node when xCAT initializes the discovery process.) The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. For example, to have the genesis kernel pause to the shell, use chain=shell. diff --git a/docs/source/guides/admin-guides/references/man7/node.7.rst b/docs/source/guides/admin-guides/references/man7/node.7.rst index a0838cec0..52581902c 100644 --- a/docs/source/guides/admin-guides/references/man7/node.7.rst +++ b/docs/source/guides/admin-guides/references/man7/node.7.rst @@ -159,7 +159,7 @@ node Attributes: \ **chain**\ (chain.chain) - A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell. + A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server do not recognize the MAC address of the node when xCAT initializes the discovery process.) The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. For example, to have the genesis kernel pause to the shell, use chain=shell. diff --git a/perl-xCAT/xCAT/Schema.pm b/perl-xCAT/xCAT/Schema.pm index f7d3a9f38..ebe64b87d 100755 --- a/perl-xCAT/xCAT/Schema.pm +++ b/perl-xCAT/xCAT/Schema.pm @@ -358,7 +358,7 @@ passed as argument rather than by table value', node => 'The node name or group name.', currstate => 'The current or next chain step to be executed on this node by xCAT-genesis. Set by xCAT during node discovery or as a result of nodeset.', currchain => 'The chain steps still left to do for this node. This attribute will be automatically adjusted by xCAT while xCAT-genesis is running on the node (either during node discovery or a special operation like firmware update). During node discovery, this attribute is initialized from the chain attribute and updated as the chain steps are executed.', - chain => 'A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server does not recognize the MAC address of the node and xCAT initializes the discovery process. The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. Example, to have the genesis kernel pause, chain=shell.', + chain => 'A comma-delimited chain of actions to be performed automatically when this node is discovered for the first time. (xCAT and the DHCP server do not recognize the MAC address of the node when xCAT initializes the discovery process.) The last step in this process is to run the operations listed in the chain attribute, one by one. Valid values: boot, runcmd=, runimage=, shell, standby. For example, to have the genesis kernel pause to the shell, use chain=shell.', ondiscover => 'This attribute is currently not used by xCAT. The "nodediscover" operation is always done during node discovery.', comments => 'Any user-written notes.', disable => "Set to 'yes' or '1' to comment out this row.",