diff --git a/xCAT-client/pods/man1/mkzone.1.pod b/xCAT-client/pods/man1/mkzone.1.pod new file mode 100644 index 000000000..f59c74f6d --- /dev/null +++ b/xCAT-client/pods/man1/mkzone.1.pod @@ -0,0 +1,123 @@ +=head1 B + +B - Defines a new zone in the cluster. + +=head1 B + +B [B<--defaultzone>] [B<-k> I] [B<-a> I] [B<-g>] [B<-f>] [B<-s> I] [-V] + +B [B<-h> | B<-v>] + + +=head1 B + +The B command is designed to divide the xCAT cluster into multiple zones. The nodes in each zone will share common root ssh keys. This allows the nodes in a zone to be able to as root ssh to each other without password, but cannot do the same to any node in another zone. All zones share a common xCAT Management Node and database including the site table, which defines the attributes of the entire cluster. +The mkzone command is only supported on Linux ( No AIX support). +The nodes are not updated with the new root ssh keys by mkzone. You must run updatenode -k or xdsh -K to the nodes to update the root ssh keys to the new generated zone keys. + + +=head1 B + +=over 5 + +=item B<-h>|B<--help> + +Displays usage information. + +=item B<-v>|B<--version> + +Displays command version and build date. + +=item B<-k | --sshkeypath> I + +This is the path to the id_rsa key that will be used to build root's ssh keys for the zone. If -f is used, it will generate the ssh public key and store both in /etc/xcat/sshkeys//.ssh directory. +If -f is not used, then it will generate a set of root ssh keys for the zone and store them in /etc/xcat/sshkeys//.ssh. + +=item B<--default> + +if --defaultzone is input, then it will set the zone defaultzone attribute to yes; otherwise it will set to no. +if --defaultzone is input and another zone is currently the default, +then the -f flag must be used to force a change to the new defaultzone. +If -f flag is not use an error will be returned and no change made. + +=item B<-a | --addnoderange> I + +For each node in the noderange, it will set the zonename attribute for that node to the input zonename. +If the -g flag is also on the command, then +it will add the group name "zonename" to each node in the noderange. + +=item B<-s| --sshbetweennodes> B + +If -s entered, the zone sshbetweennodes attribute will be set to yes or no. It defaults to yes. When this is set to yes, then ssh will be setup +to allow passwordless root access between nodes. If no, then root will be prompted for a password when running ssh between the nodes in the zone. + +=item B<-f | --force> + +Used with the (--defaultzone) flag to override the current default zone. + +=item B<-g | --assigngroup> + +Used with the (-a) flag to create the group zonename for all nodes in the input noderange. + +=item B<-V>|B<--Verbose> + +Verbose mode. + + +=back + + +=head1 B + +=over 3 + +=item * + +To make a new zone1 using defaults , enter: + +B I + +Note: with the first mkzone, you will automatically get the xcatdefault zone created as the default zone. This zone uses ssh keys from + /.ssh directory. + +=item * + +To make a new zone2 using defaults and make it the default zone enter: + +B I --defaultzone -f + +=item * + +To make a new zone2A using the ssh id_rsa private key in /root/.ssh: + +B I -k /root/.ssh + +=item * + +To make a new zone3 and assign the noderange compute3 to the zone enter: + +B I -a compute3 + +=item * + +To make a new zone4 and assign the noderange compute4 to the zone and add zone4 as a group to each node enter: + +B I -a compute4 -g + +=item * + +To make a new zone5 and assign the noderange compute5 to the zone and add zone5 as a group to each node but not allow passwordless ssh between the nodes enter: + +B I -a compute5 -g -s no + +=back + +B + +B + +Location of the mkzone command. + +=head1 B + +L , L