From b6456132beed89f5885f6ed9a2dc8dfc994744e3 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Thu, 27 Oct 2016 02:17:12 -0400 Subject: [PATCH] Add a note into the packimage man page to help clarify that (#2027) during the time of running genimage, the rootimg file is unavail to be served to the compute nodes --- .../admin-guides/references/man1/packimage.1.rst | 13 +++++-------- xCAT-client/pods/man1/packimage.1.pod | 13 +++++-------- 2 files changed, 10 insertions(+), 16 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/packimage.1.rst b/docs/source/guides/admin-guides/references/man1/packimage.1.rst index 0ab919668..5be66f428 100644 --- a/docs/source/guides/admin-guides/references/man1/packimage.1.rst +++ b/docs/source/guides/admin-guides/references/man1/packimage.1.rst @@ -31,12 +31,9 @@ DESCRIPTION *********** -Packs the stateless image from the chroot file system into a file system to be -sent to the node for a diskless install. -The install dir is setup by using "installdir" attribute set in the site table. -The nodetype table "profile" attribute for the node should reflect the profile of the install image. +Packs the stateless image from the chroot file system into a file to be sent to the node for a diskless boot. -This command will get all the necessary os image definition files from the \ *osimage*\ and \ *linuximage*\ tables. +Note: For an osimage that is deployed on a cluster, running packimage will overwrite the existing rootimage file and be unavailable to the compute nodes while the command executes. ********** @@ -44,7 +41,7 @@ PARAMETERS ********** -\ *imagename*\ specifies the name of a os image definition to be used. The specification for the image is stored in the \ *osimage*\ table and \ *linuximage*\ table. +\ *imagename*\ specifies the name of a OS image definition to be used. The specification for the image is stored in the \ *osimage*\ table and \ *linuximage*\ table. ******* @@ -76,7 +73,7 @@ EXAMPLES ******** -1. To pack the osimage rhels7.1-x86_64-netboot-compute: +1. To pack the osimage 'rhels7.1-x86_64-netboot-compute': .. code-block:: perl @@ -84,7 +81,7 @@ EXAMPLES packimage rhels7.1-x86_64-netboot-compute -2. To pack the osimage rhels7.1-x86_64-netboot-compute with "tar" to archive and "pigz" to compress: +2. To pack the osimage 'rhels7.1-x86_64-netboot-compute' with "tar" to archive and "pigz" to compress: .. code-block:: perl diff --git a/xCAT-client/pods/man1/packimage.1.pod b/xCAT-client/pods/man1/packimage.1.pod index c3cf60d65..5b2b2a837 100644 --- a/xCAT-client/pods/man1/packimage.1.pod +++ b/xCAT-client/pods/man1/packimage.1.pod @@ -12,16 +12,13 @@ B [B<-m>|B<--method> I] [B<-c>|B<--compress> I and I tables. +Note: For an osimage that is deployed on a cluster, running packimage will overwrite the existing rootimage file and be unavailable to the compute nodes while packimage is running. =head1 PARAMETERS -I specifies the name of a os image definition to be used. The specification for the image is stored in the I table and I table. +I specifies the name of a OS image definition to be used. The specification for the image is stored in the I table and I table. =head1 OPTIONS @@ -43,11 +40,11 @@ B<-c| --compress> Compress Method (pigz,gzip,xz, default is pigz/gzip) =head1 EXAMPLES -1. To pack the osimage rhels7.1-x86_64-netboot-compute: +1. To pack the osimage 'rhels7.1-x86_64-netboot-compute': packimage rhels7.1-x86_64-netboot-compute -2. To pack the osimage rhels7.1-x86_64-netboot-compute with "tar" to archive and "pigz" to compress: +2. To pack the osimage 'rhels7.1-x86_64-netboot-compute' with "tar" to archive and "pigz" to compress: packimage -m tar -c pigz rhels7.1-x86_64-netboot-compute