Recent changes to Capture_Linux_Image

Capture_Linux_Image modified by Guang Cheng Li

Guang Cheng Li — Mon, 18 May 2015 02:23:15 -0000

--- v6
+++ v7
@@ -28,7 +28,7 @@

 #### Customize the osimage

-The .pkglist, .exlist, .postinstall and exlist files are the major attributes could be customized for the osimage to be captured, they work the same as when genimage command is running. Refer to [Deploying Stateless Nodes](XCAT_iDataPlex_Cluster_Quick_Start/#deploying-stateless-nodes) to see how to configure these files.
+The pkglist, postinstall and exlist files are the major attributes could be customized for the osimage to be captured, they work the same as when genimage command is running. Refer to [Deploying Stateless Nodes](XCAT_iDataPlex_Cluster_Quick_Start/#deploying-stateless-nodes) to see how to configure these files.

 During **imgcapture** is running, the user might need to exlude some files/directories from the image to be captured.

Capture_Linux_Image modified by Guang Cheng Li

Guang Cheng Li — Mon, 18 May 2015 02:22:33 -0000

--- v5
+++ v6
@@ -17,42 +17,27 @@

 ### Prepare the configuration files

+## Define the osimage object
+
+The image to be captured needs to be associated with one specific osimage object, you can use the existing osimage objects, or you can use the following command to create a new osimage <osimagename>
+
+~~~~
+    mkdef -t osimage -o <osimgname> attr1=val1 attr2=val2 ...
+~~~~

-#### The .pkglist, .exlist and .postinstall files
+#### Customize the osimage

-The following files will be used by the **imgcapture** command. And, they work the same as when genimage command is running. Refer to [Deploying Stateless Nodes](XCAT_iDataPlex_Cluster_Quick_Start/#deploying-stateless-nodes) to see how to configure these files.
-
-~~~~
-  <profile>.<osver>.<arch>.pkglist
-  <profile>.<osver>.<arch>.exlist
-  <profile>.<osver>.<arch>.postinstall
-~~~~
-
-#### The exlist file
-
-The file is named:
-
-~~~~
-   <profile>.<osver>.<arch>.imgcapture.exlist file
-~~~~
+The .pkglist, .exlist, .postinstall and exlist files are the major attributes could be customized for the osimage to be captured, they work the same as when genimage command is running. Refer to [Deploying Stateless Nodes](XCAT_iDataPlex_Cluster_Quick_Start/#deploying-stateless-nodes) to see how to configure these files.

 During **imgcapture** is running, the user might need to exlude some files/directories from the image to be captured.

-xCAT provides the <profile>.<osver><arch>.imgcapture.exlist configuration file, the user can add any files/directories into this file.
+xCAT provides the exlist configuration file, the user can add any files/directories into this file.

-For example, there's one directory (/root/test/), which should be excluded from the image to be captured, the user can add the following line into the <profile>.<osver>.<arch>.imgcapture.exlist file:
+For example, there's one directory (/root/test/), which should be excluded from the image to be captured, the user can add the following line into the exlist file:

 ~~~~
      ./root/test*
-~~~~
-
-## Define the osimage object (Optional)
-
-If the image to be captured needs to be associated with one specific osimage object, you can use the existing osimage objects, or you can use the
-
-~~~~
-    chdef -t osimage -o <osimgname> .... command to set the attributes for <osimgname>.
 ~~~~

 ## Run imgcapture
@@ -94,20 +79,6 @@
 Run nodeset to set the node status ready for network boot.

 ~~~~
-     nodeset node1 netboot
-~~~~
-
-
-Or:
-
-~~~~
-     nodeset node1 statelite
-~~~~
-
-
-Or:
-
-~~~~
      nodeset node1 osimage=<osimagename>
 ~~~~

Capture_Linux_Image modified by Lissa Valletta

Lissa Valletta — Tue, 26 Aug 2014 15:05:13 -0000

--- v4
+++ v5
@@ -2,101 +2,118 @@

 ## How To Capture Image from the Running Diskful Linux Node

-xCAT provides the [imgcapture](http://xcat.sourceforge.net/man1/imgcapture.1.html) command to capture an OS image from a running diskful Linux node, and prepares the rootimg directory, kernel and initial ramdisks for **liteimg**/**packimage** to generate the statelite/stateless rootimg. 
+xCAT provides the **imgcapture** command to capture an OS image from a running diskful Linux node, and prepares the rootimg directory, kernel and initial ramdisks for **liteimg**/**packimage** to generate the statelite/stateless rootimg.

-This command is very helpful, especially when there's already one diskful Linux node in which all the necessary applications are installed and configured, or the user needs to migrate the diskful environment to the diskless environment (including **statelite**/**stateless**). 
+This command is very helpful, especially when there's already one diskful Linux node in which all the necessary applications are installed and configured, or the user needs to migrate the diskful environment to the diskless environment (including **statelite**/**stateless**).

-The following are the steps to capture image. 
+See man page [imgcapture](http://xcat.sourceforge.net/man1/imgcapture.1.html).

-## Prepare one diskful Linux node

-The diskful Linux node to be captured must be managed by the xCAT MN, and the remote shell between the xCAT MN and this node must be configured. 
+The following are the steps to capture image.

-## Prepare the configuration files
+### Prepare one diskful Linux node

-### The <profile>.<osver>.<arch>.imgcapture.exlist file
+The diskful Linux node to be captured must be managed by the xCAT MN, and the remote shell between the xCAT MN and this node must be configured.

-During **imgcapture** is running, the user might need to exlude some files/directories from the image to be captured. 
+### Prepare the configuration files

-xCAT provides the _<profile>.<osver><arch>.imgcapture.exlist_ configuration file, the user can add any files/directories into this file. 

-For example, there's one directory (_/root/test/_), which should be exlcuded from the image to be captured, the user can add the following line into the _<profile>.<osver>.<arch>.imgcapture.exlist_ file: 
-    
+
+#### The .pkglist, .exlist and .postinstall files
+
+The following files will be used by the **imgcapture** command. And, they work the same as when genimage command is running. Refer to [Deploying Stateless Nodes](XCAT_iDataPlex_Cluster_Quick_Start/#deploying-stateless-nodes) to see how to configure these files.
+
+~~~~
+  <profile>.<osver>.<arch>.pkglist
+  <profile>.<osver>.<arch>.exlist
+  <profile>.<osver>.<arch>.postinstall
+~~~~
+
+#### The exlist file
+
+The file is named:
+
+~~~~
+   <profile>.<osver>.<arch>.imgcapture.exlist file
+~~~~
+
+During **imgcapture** is running, the user might need to exlude some files/directories from the image to be captured.
+
+xCAT provides the <profile>.<osver><arch>.imgcapture.exlist configuration file, the user can add any files/directories into this file.
+
+For example, there's one directory (/root/test/), which should be excluded from the image to be captured, the user can add the following line into the <profile>.<osver>.<arch>.imgcapture.exlist file:
+
+~~~~
      ./root/test*
-    
-
-For the searching orders for the _.imgcapture.exlist_ files, you can refer to the [XCAT_pLinux_Clusters#Search_order_for_installation_templates] section. 
-
-### The *.pkglist, *.exlist and *.postinstall files
-
-The _<profile>.<osver>.<arch>.pkglist_, _<profile>.<osver>.<arch>.exlist_ and _<profile>.<osver>.<arch>.postinstall_ files will be used by the **imgcapture** command. And, they work the same as when _genimage_ command is running, so please refer to [XCAT_pLinux_Clusters#Statelessnode_installation] to see how to configure these files. 
+~~~~

 ## Define the osimage object (Optional)

-If the image to be captured needs to be associated with one specific _osimage_ object, you can use the existing _osimage_ objects, or you can use the _chdef -t osimage -o <osimgname> ...._ command to set the attributes for _<osimgname>_. 
+If the image to be captured needs to be associated with one specific osimage object, you can use the existing osimage objects, or you can use the
+
+~~~~
+    chdef -t osimage -o <osimgname> .... command to set the attributes for <osimgname>.
+~~~~

 ## Run imgcapture

-## The usage of imgcapture
-    
-    imgcapture <node> [-p | --profile <profile>] [-o|--osimage <osimage>] [-i <nodebootif>] [-n <nodenetdrivers>] [-V | --verbose]
-    imgcapture [-h|--help]
-    imgcapture [-v|--version]
-    
+## The usage of imgcapture and examples

-## Examples
+  See man page [imgcapture](http://xcat.sourceforge.net/man1/imgcapture.1.html).

-  * Capture the image from _node1_
-    
-     imgcapture node1
-    

-  * Capture the image from _node1_, and associate this image with the _osimage_ object: **ibmhpc**
-    
-     imgcapture node1 -o ibmhpc
-    
-
-For more explainations and examples, please refer to the manpage of _imgcapture_. 

 ## Generate stateless/statelite images

-After the image (_rootimg_), kernel (_kernel_) and initial ramdisks (_initrd-stateless.gz_ and _initrd-statelite.gz_)has been generated and put into _$installroot/netboot/<osver>/<arch>/<profile>/_, you can customize the image by running **packimage**/**liteimg** with the options you want. 
+After the image (rootimg), kernel (kernel) and initial ramdisks (initrd-stateless.gz and initrd-statelite.gz)has been generated and put into $installroot/netboot/<osver>/<arch>/<profile>/, you can customize the image by running **packimage**/**liteimg** with the options you want.

 ### Generate stateless images

-Run _packimage_: 
-    
-     packimage <osimagename>
-    
+Run packimage:

-For more info about _packimage_, please refer to the manpage of _packimage_. 
+~~~~
+     packimage <osimagename>
+~~~~
+
+
+For more info about packimage, please refer to the manpage of packimage.

 ### Generate statelite images

-Run _liteimg_: 
-    
-     liteimg <osimagename>
-    
+Run liteimg:

-For more info about _liteimg_, please refer to the manpage of _liteimg_. 
+~~~~
+     liteimg <osimagename>
+~~~~
+
+
+For more info about liteimg, please refer to the manpage of liteimg.

 ## Set the node status ready for network boot

-Run _nodeset_ to set the node status ready for network boot. 
-    
+Run nodeset to set the node status ready for network boot.
+
+~~~~
      nodeset node1 netboot
-    
+~~~~

-Or: 
-    
+
+Or:
+
+~~~~
      nodeset node1 statelite
-    
+~~~~

-Or: 
-    
-     nodeset node1 osimage=<osimagename>
-    
+
+Or:
+
+~~~~
+     nodeset node1 osimage=<osimagename>
+~~~~
+

 ## Notes

-If the node is set to _stateless_ or _RAMdisk-based statelite_ status, before booting the node up, please make sure the node has enough memory capabilities. In order to boot up the LPAR with the redhat6/PPC64 Linux image, the node should have about 5120MB memory. 
+If the node is set to stateless or RAMdisk-based statelite status, before booting the node up, please make sure the node has enough memory capabilities. In order to boot up the LPAR with the redhat6/PPC64 Linux image, the node should have about 5120MB memory.
+
+

Capture_Linux_Image modified by Bruce

Bruce — Mon, 23 Jun 2014 21:46:42 -0000

--- v3
+++ v4
@@ -10,7 +10,7 @@

 ## Prepare one diskful Linux node

-The diskful Linux node must be managed by the xCAT MN, and the remote shell between the xCAT MN and this node must be configured. 
+The diskful Linux node to be captured must be managed by the xCAT MN, and the remote shell between the xCAT MN and this node must be configured. 

 ## Prepare the configuration files

Capture_Linux_Image modified by Bruce

Bruce — Mon, 23 Jun 2014 21:46:40 -0000

--- v2
+++ v3
@@ -2,9 +2,9 @@

 ## How To Capture Image from the Running Diskful Linux Node

-xCAT provides **imgcapture** to capture image from the running diskful Linux node, and prepares the rootimg directory, kernel and initial ramdisks for **liteimg**/**packimage** to generate the statelite/stateless rootimg. 
+xCAT provides the [imgcapture](http://xcat.sourceforge.net/man1/imgcapture.1.html) command to capture an OS image from a running diskful Linux node, and prepares the rootimg directory, kernel and initial ramdisks for **liteimg**/**packimage** to generate the statelite/stateless rootimg. 

-This command is very helpful. Especially when there's already one diskful Linux node in which all the necessary applications are installed and configured, the user needs to migrate the diskful environment to the diskless environment (including **statelite**/**stateless**). 
+This command is very helpful, especially when there's already one diskful Linux node in which all the necessary applications are installed and configured, or the user needs to migrate the diskful environment to the diskless environment (including **statelite**/**stateless**). 

 The following are the steps to capture image.

Capture_Linux_Image modified by Bruce

Bruce — Mon, 23 Jun 2014 21:46:38 -0000

--- v1
+++ v2
@@ -1,6 +1,6 @@
 [TOC]

-# How To Capture Image from the Running Diskful Linux Node
+## How To Capture Image from the Running Diskful Linux Node

 xCAT provides **imgcapture** to capture image from the running diskful Linux node, and prepares the rootimg directory, kernel and initial ramdisks for **liteimg**/**packimage** to generate the statelite/stateless rootimg.

Capture_Linux_Image modified by minjun xi

minjun xi — Mon, 23 Jun 2014 21:46:33 -0000

How To Capture Image from the Running Diskful Linux Node

How To Capture Image from the Running Diskful Linux Node

xCAT provides imgcapture to capture image from the running diskful Linux node, and prepares the rootimg directory, kernel and initial ramdisks for liteimg/packimage to generate the statelite/stateless rootimg.

This command is very helpful. Especially when there's already one diskful Linux node in which all the necessary applications are installed and configured, the user needs to migrate the diskful environment to the diskless environment (including statelite/stateless).

The following are the steps to capture image.

Prepare one diskful Linux node

The diskful Linux node must be managed by the xCAT MN, and the remote shell between the xCAT MN and this node must be configured.

Prepare the configuration files

The <profile>.<osver>.<arch>.imgcapture.exlist file

During imgcapture is running, the user might need to exlude some files/directories from the image to be captured.

xCAT provides the <profile>.<osver><arch>.imgcapture.exlist configuration file, the user can add any files/directories into this file.

For example, there's one directory (/root/test/), which should be exlcuded from the image to be captured, the user can add the following line into the <profile>.<osver>.<arch>.imgcapture.exlist file:

 ./root/test*

For the searching orders for the .imgcapture.exlist files, you can refer to the [XCAT_pLinux_Clusters#Search_order_for_installation_templates] section.

The .pkglist, .exlist and *.postinstall files

The <profile>.<osver>.<arch>.pkglist, <profile>.<osver>.<arch>.exlist and <profile>.<osver>.<arch>.postinstall files will be used by the imgcapture command. And, they work the same as when genimage command is running, so please refer to [XCAT_pLinux_Clusters#Statelessnode_installation] to see how to configure these files.

Define the osimage object (Optional)

If the image to be captured needs to be associated with one specific osimage object, you can use the existing osimage objects, or you can use the chdef -t osimage -o <osimgname> .... command to set the attributes for <osimgname>.

Run imgcapture

The usage of imgcapture

imgcapture &lt;node&gt; [-p | --profile &lt;profile&gt;] [-o|--osimage &lt;osimage&gt;] [-i &lt;nodebootif&gt;] [-n &lt;nodenetdrivers&gt;] [-V | --verbose]
imgcapture [-h|--help]
imgcapture [-v|--version]

Examples

Capture the image from node1

imgcapture node1
Capture the image from node1, and associate this image with the osimage object: ibmhpc

imgcapture node1 -o ibmhpc

For more explainations and examples, please refer to the manpage of imgcapture.

Generate stateless/statelite images

After the image (rootimg), kernel (kernel) and initial ramdisks (initrd-stateless.gz and initrd-statelite.gz)has been generated and put into $installroot/netboot/<osver>/<arch>/<profile>/, you can customize the image by running packimage/liteimg with the options you want.

Generate stateless images

Run packimage:

 packimage &lt;osimagename&gt;

For more info about packimage, please refer to the manpage of packimage.

Generate statelite images

Run liteimg:

 liteimg &lt;osimagename&gt;

For more info about liteimg, please refer to the manpage of liteimg.

Set the node status ready for network boot

Run nodeset to set the node status ready for network boot.

 nodeset node1 netboot

Or:

 nodeset node1 statelite

Or:

 nodeset node1 osimage=&lt;osimagename&gt;

Notes

If the node is set to stateless or RAMdisk-based statelite status, before booting the node up, please make sure the node has enough memory capabilities. In order to boot up the LPAR with the redhat6/PPC64 Linux image, the node should have about 5120MB memory.