xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-22 03:32:04 +00:00
Code Issues Releases Wiki Activity

Some more doc fixes

Browse Source
This commit is contained in:
Mark Gurevich 2019-03-12 14:01:58 -04:00
parent 6d0197c632
commit b04d280317
7 changed files with 32 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst
View File

@ -45,7 +45,7 @@ sync file **/etc/file2** to the file **/etc/file2** on the node ::
/etc/file2 -> /etc/
sync all files in **/home/mikev** to directory **/home/mikev** on the node ::
sync all files, including subdirectories, in **/home/mikev** to directory **/home/mikev** on the node ::
/home/mikev/* -> /home/mikev/

2
docs/source/guides/admin-guides/references/man1/updatenode.1.rst
View File

@ -61,7 +61,7 @@ Update the ca and credentials for the service nodes.
The default behavior when no options are input to \ **updatenode**\ will be to run
the following options \ **-S**\ , \ **-P**\ and \ **-F**\ options in this order.
If you wish to limit \ **updatenode**\ to specific
actions you can use combinations of the \ **-S**\ , \ **-P**\ , and \ **-F**\ flags.
actions you can use combination of the \ **-S**\ , \ **-P**\ , and \ **-F**\ flags.
For example, If you just want to synchronize configuration file you could
specify the \ **-F**\ flag. If you want to synchronize files and update

2
docs/source/guides/admin-guides/references/man1/xdcp.1.rst
View File

@ -21,7 +21,7 @@ xdcp.1
\ **xdcp**\ \ *noderange*\ [[\ **-B**\ | \ **-**\ **-bypass**\ ] [\ **-f**\ \ *fanout*\ ] [\ **-L**\ ] [\ **-l**\ \ *userID*\ ] [\ **-o**\ \ *node_options*\ ] [\ **-p**\ ] [\ **-P**\ ] [\ **-r**\ \ *node remote copy command] [\ \*\*-R\*\*\ ] [\ \*\*-t\*\*\ \ \*timeout\*\ ] [\ \*\*-T\*\*\ ] [\ \*\*-v\*\*\ ] [\ \*\*-q\*\*\ ] [\ \*\*-X\*\*\ \ \*env_list\*\ ] \ \*sourcefile.... targetpath\*\ *\
\ **xdcp**\ \ *noderange*\ [\ **-F**\ Irsynclist input file>] [\ **-r**\ \ *node remote copy command*\ ]
\ **xdcp**\ \ *noderange*\ [\ **-F**\ \ *rsynclist input file*\ ] [\ **-r**\ \ *node remote copy command*\ ]
\ **xdcp**\ \ *computenoderange*\ [\ **-s**\ \ **-F**\ \ *synclist input file*\ ] [\ **-r**\ \ *node remote copy command*\ ]

2
docs/source/guides/admin-guides/references/man5/site.5.rst
View File

@ -406,7 +406,7 @@ site Attributes:
dbtracelevel: The trace level for the database access log. To activate this setting, please.
restart xcatd or send HUP signal to the 'xcatd: DB Access' process, Like: .
pkill -f -HUP 'xcatd: DB Access'
pkill -f -HUP 'xcatd: DB Access'
Currrent support values:
0: disable the trace log for db
1: trace the calls of database subroutines

16
xCAT-client/pods/man1/updatenode.1.pod
View File

@ -4,7 +4,7 @@ B<updatenode> - Update nodes in an xCAT cluster environment.
=head1 SYNOPSIS
B<updatenode> I<noderange> [B<-V>|B<--verbose>] [B<-F>|B<--sync>] [B<-f>|B<--snsync>] [B<-r>|B<--node-rcp> [I<full_path_to_remote_copy_command>]] [B<-S>|B<--sw>] [B<-l> I<userID>] [B<-P>|B<--scripts> [I<script1,script2...>]] [B<-s>|B<--sn>] [B<-A>|B<--updateallsw>] [B<-c>|B<--cmdlineonly>] [B<-d> I<alt_source_dir>] [B<--fanout>=I<fanout_value>] [B<-t> I<timeout>} [I<attr=val> [I<attr=val...>]] [B<-n>|B<--noverify>]
B<updatenode> I<noderange> [B<-V>|B<--verbose>] [B<-F>|B<--sync>] [B<-f>|B<--snsync>] [B<-r>|B<--node-rcp> [I<node_remote_copy_command>]] [B<-S>|B<--sw>] [B<-l> I<userID>] [B<-P>|B<--scripts> [I<script1,script2...>]] [B<-s>|B<--sn>] [B<-A>|B<--updateallsw>] [B<-c>|B<--cmdlineonly>] [B<-d> I<alt_source_dir>] [B<--fanout>=I<fanout_value>] [B<-t> I<timeout>} [I<attr=val> [I<attr=val...>]] [B<-n>|B<--noverify>]
B<updatenode> B<noderange> [B<-k>|B<--security>] [B<-t> I<timeout>]
@ -41,7 +41,7 @@ Update the ca and credentials for the service nodes.
The default behavior when no options are input to B<updatenode> will be to run
the following options B<-S>, B<-P> and B<-F> options in this order.
If you wish to limit B<updatenode> to specific
actions you can use combinations of the B<-S>, B<-P>, and B<-F> flags.
actions you can use combination of the B<-S>, B<-P>, and B<-F> flags.
For example, If you just want to synchronize configuration file you could
specify the B<-F> flag. If you want to synchronize files and update
@ -315,17 +315,17 @@ read-only option for files/directories listed in
B<litefile> table with source location specified in the B<litetree> table.
=item [B<-r>|B<--node-rcp> [I<full_path_to_remote_copy_command>]]
=item [B<-r>|B<--node-rcp> [I<node_remote_copy_command>]]
Specifies the full path of the remote copy command used for syncing files to node targets, such as "/usr/bin/rsync" or "/usr/bin/scp". If not specified, rsync will be used by default.
Specifies the full path of the remote copy command used for syncing files to node targets, such as B</usr/bin/rsync> or B</usr/bin/scp>. If not specified, B<rsync> will be used by default.
Notice: The synclist for "-r /usr/bin/scp" has some differences with "-r /usr/bin/rsync":
Note: The synclist processing for B<-r /usr/bin/scp> has some differences with B<-r /usr/bin/rsync>:
1) the ``EXECUTE`` clause is not supported in "-r /usr/bin/scp"
1) the B<EXECUTE> clause in synclist file is not supported with B<-r /usr/bin/scp> flag
2) if the destination directory specified in synclist is an existing file on target node, "updatenode -r /usr/bin/scp" will fail with ``scp: <destination directory>: Not a directory``
2) if the destination directory specified in synclist file is an existing file on target node, B<updatenode -r /usr/bin/scp> will fail with "scp: <destination directory>: Not a directory"
3) if the destination file specified in synclist is an existing directory on target node, "updatenode -r /usr/bin/scp" will fail with ``scp: <destination file>: Is a directory``
3) if the destination file specified in synclist file is an existing directory on target node, B<updatenode -r /usr/bin/scp> will fail with "scp: <destination file>: Is a directory"
=item B<-g|--genmypost>

27
xCAT-client/pods/man1/xdcp.1.pod
View File

@ -4,15 +4,13 @@ B<xdcp> - Concurrently copies files to or from multiple nodes. In addition, prov
=head1 B<SYNOPSIS>
B<xdcp> I<noderange> [[B<-B> | B<--bypass>] [B<-f> I<fanout>] [B<-L>] [B<-l> I<userID>] [B<-o> I<node_options>] [B<-p>] [B<-P>] [B<-r> I<node_remote_shell>] [B<-R>] [B<-t> I<timeout>] [B<-T>] [B<-v>] [B<-q>] [B<-X> I<env_list>] I<sourcefile.... targetpath>
B<xdcp> I<noderange> [[B<-B> | B<--bypass>] [B<-f> I<fanout>] [B<-L>] [B<-l> I<userID>] [B<-o> I<node_options>] [B<-p>] [B<-P>] [B<-r> I<node remote copy command] [B<-R>] [B<-t> I<timeout>] [B<-T>] [B<-v>] [B<-q>] [B<-X> I<env_list>] I<sourcefile.... targetpath>
B<xdcp> I<noderange> [B<-F> I<rsync input file>]
B<xdcp> I<noderange> [B<-F> I<rsynclist input file>] [B<-r> I<node remote copy command>]
B<xdcp> I<computenoderange> [B<-s> B<-F> I<rsync input file>]
B<xdcp> [B<-i> I<install image>] [B<-F> I<rsync input file>]
B<xdcp> I<computenoderange> [B<-s> B<-F> I<synclist input file>] [B<-r> I<node remote copy command>]
B<xdcp> [B<-i> I<install image>] [B<-F> I<synclist input file>] [B<-r> I<node remote copy command>]
B<xdcp> [B<-h> | B<-V> | B<-q>]
@ -46,7 +44,7 @@ For node targets, the remote copy command is determined by the following order
1. The B<-r> flag.
2. The B</usr/bin/scp> command.
2. The B</usr/bin/rsync> command.
B<COMMAND> B<EXECUTIONS>:
@ -99,7 +97,7 @@ Specifies a fanout value for the maximum number of concurrently executing rem
can be specified by indicating a fanout value of B<1>.
If B<-f> is not specified, a default fanout value of B<64> is used.
=item B<-F>|B<--File> I<rsync input file>
=item B<-F>|B<--File> I<synclist input file>
Specifies the path to the file that will be used to
build the B<rsync> command.
@ -151,10 +149,17 @@ valid contexts. Each setting is prefixed with I<context>: to
identify the source context of the setting.
=item B<-r>|B<--node-rcp> I<node_remote_copy>
=item B<-r>|B<--node-rcp> I<node remote copy command>
Specifies the full path of the remote copy command used
for remote command execution on node targets.
Specifies the full path of the remote copy command used for syncing files to node targets, such as B</usr/bin/rsync> or B</usr/bin/scp>. If not specified, B<rsync> will be used by default.
Note: The synclist processing for B<-r /usr/bin/scp> has some differences with B<-r /usr/bin/rsync>:
1) the B<EXECUTE> clause in synclist file is not supported with B<-r /usr/bin/scp> flag
2) if the destination directory specified in synclist file is an existing file on target node, B<xdcp -r /usr/bin/scp> will fail with "scp: <destination directory>: Not a directory"
3) if the destination file specified in synclist file is an existing directory on target node, B<xdcp -r /usr/bin/scp> will fail with "scp: <destination file>: Is a directory"
=item B<-R>|B<--recursive> I<recursive>

8
xCAT-server/lib/xcat/plugins/DBobjectdefs.pm
View File

@ -4609,7 +4609,7 @@ sub defmk_usage
}
$rsp->{data}->[$n] = "$dataobj\n";
$n++;
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t\' option to";
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t <object-types>\' option to";
$n++;
$rsp->{data}->[$n] = " get a list of valid attribute names for each object type.\n";
xCAT::MsgUtils->message("I", $rsp, $::callback);
@ -4656,7 +4656,7 @@ sub defch_usage
}
$rsp->{data}->[$n] = "$dataobj\n";
$n++;
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t\' option to";
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t <object-types>\' option to";
$n++;
$rsp->{data}->[$n] = " get a list of valid attribute names for each object type.\n";
xCAT::MsgUtils->message("I", $rsp, $::callback);
@ -4700,7 +4700,7 @@ sub defls_usage
}
$rsp->{data}->[$n] = "$dataobj\n";
$n++;
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t\' option to";
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t <object-types>\' option to";
$n++;
$rsp->{data}->[$n] = " get a list of valid attribute names for each object type.\n";
xCAT::MsgUtils->message("I", $rsp, $::callback);
@ -4741,7 +4741,7 @@ sub defrm_usage
}
$rsp->{data}->[$n] = "$dataobj\n";
$n++;
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t\' option to";
$rsp->{data}->[$n] = "\nUse the \'-h\' option together with the \'-t <object-types>\' option to";
$n++;
$rsp->{data}->[$n] = " get a list of valid attribute names for each object type.\n";
xCAT::MsgUtils->message("I", $rsp, $::callback);