xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-10-30 19:02:27 +00:00
Code Issues Releases Wiki Activity

Update packimage documentations

Browse Source
This commit is contained in:
Mark Gurevich
2020-04-21 09:56:46 -04:00
parent 72cf0e15d3
commit 424dcfcbf0
2 changed files with 47 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/source/guides/admin-guides/references/man1/packimage.1.rst
View File

@@ -23,7 +23,7 @@ SYNOPSIS
\ **packimage [-v| -**\ **-version]**\
\ **packimage**\ [\ **-m | -**\ **-method**\ \ *cpio|tar*\ ] [\ **-c | -**\ **-compress**\ \ *gzip|pigz|xz*\ ] [\ **-**\ **-nosyncfiles**\ ] \ *imagename*\
\ **packimage**\ [\ **-m | -**\ **-method**\ \ **cpio|tar|squashfs**\ ] [\ **-c | -**\ **-compress**\ \ **gzip|pigz|xz**\ ] [\ **-**\ **-nosyncfiles**\ ] \ *imagename*\
***********
@@ -33,7 +33,7 @@ DESCRIPTION
Packs the stateless image from the chroot file system into a file to be sent to the node for a diskless boot.
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.
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.
**********
@@ -49,15 +49,36 @@ OPTIONS
*******
\ **-h**\ Display usage message.
\ **-v**\ Command Version.
\ **-h**\
Display usage message.
\ **-m| -**\ **-method**\ Archive Method (cpio,tar,squashfs, default is cpio)
\ **-c| -**\ **-compress**\ Compress Method (pigz,gzip,xz, default is pigz/gzip)
\ **-v**\
Command Version.
\ **-m| -**\ **-method**\
Archive Method (cpio, tar, squashfs (requires overlayFS or aufs modules during provisioning), default is cpio)
\ **-c| -**\ **-compress**\
Compress Method (pigz, gzip, xz, default is pigz/gzip)
\ **-**\ **-nosyncfiles**\
Bypass of syncfiles requested, will not sync files to root image directory
\ **-**\ **-nosyncfiles**\ Bypass of syncfiles requested, will not sync files to root image directory
************

26
xCAT-client/pods/man1/packimage.1.pod
View File

@@ -8,13 +8,13 @@ B<packimage [-h| --help]>
B<packimage [-v| --version]>
B<packimage> [B<-m>|B<--method> I<cpio|tar>] [B<-c>|B<--compress> I<gzip|pigz|xz>] [B<--nosyncfiles>] I<imagename>
B<packimage> [B<-m>|B<--method> B<cpio|tar|squashfs>] [B<-c>|B<--compress> B<gzip|pigz|xz>] [B<--nosyncfiles>] I<imagename>
=head1 DESCRIPTION
Packs the stateless image from the chroot file system into a file to be sent to the node for a diskless boot.
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.
Note: For an osimage that is deployed on a cluster, running B<packimage> will overwrite the existing rootimage file and be unavailable to the compute nodes while B<packimage> is running.
=head1 PARAMETERS
@@ -22,17 +22,29 @@ I<imagename> specifies the name of a OS image definition to be used. The specifi
=head1 OPTIONS
=over 10
B<-h> Display usage message.
=item B<-h>
B<-v> Command Version.
Display usage message.
B<-m| --method> Archive Method (cpio,tar,squashfs, default is cpio)
=item B<-v>
B<-c| --compress> Compress Method (pigz,gzip,xz, default is pigz/gzip)
Command Version.
B<--nosyncfiles> Bypass of syncfiles requested, will not sync files to root image directory
=item B<-m| --method>
Archive Method (cpio, tar, squashfs (requires overlayFS or aufs modules during provisioning), default is cpio)
=item B<-c| --compress>
Compress Method (pigz, gzip, xz, default is pigz/gzip)
=item B<--nosyncfiles>
Bypass of syncfiles requested, will not sync files to root image directory
=back
=head1 RETURN VALUE