Added more descriptions to the db tables.
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@548 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
bp-sawyers
parent
318537d267
commit
98602058a0
@ -19,7 +19,7 @@ chain => {
|
||||
currstate => 'The current chain state for this node. Set by xCAT.',
|
||||
currchain => 'The current execution chain for this node. Set by xCAT. Initialized from chain and updated as chain is executed.',
|
||||
chain => 'A comma-delimited chain of actions to be performed automatically for this node. Valid values: discover, boot or reboot, install or netboot, runcmd=<cmd>, runimage=<image>, shell, standby. (Default - same as no chain). Example, for BMC machines use: runcmd=bmcsetup,standby.',
|
||||
ondiscover => 'What to do when a new node is discovered. Valid values: nodediscover, ??',
|
||||
ondiscover => 'What to do when a new node is discovered. Valid values: nodediscover.',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
},
|
||||
@ -56,8 +56,8 @@ ipmi => {
|
||||
descriptions => {
|
||||
node => 'The node name or group name.',
|
||||
bmc => 'The hostname of the BMC adapater.',
|
||||
username => 'The BMC userid. Default is ??',
|
||||
password => 'The BMC password.',
|
||||
username => 'The BMC userid. If not specified, the key=ipmi row in the passwd table is used as the default.',
|
||||
password => 'The BMC password. If not specified, the key=ipmi row in the passwd table is used as the default.',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
},
|
||||
@ -70,11 +70,11 @@ iscsi => {
|
||||
node => 'The node name or group name.',
|
||||
server => 'The server containing the iscsi boot device for this node.',
|
||||
target => '??The target of the iscsi disk used for the boot device for this node.',
|
||||
file => '',
|
||||
file => '??',
|
||||
userid => 'The userid of the iscsi server containing the boot device for this node.',
|
||||
passwd => 'The password for the iscsi server containing the boot device for this node.',
|
||||
kernel => '',
|
||||
kcmdline => '',
|
||||
kernel => 'The linux kernel version to use with iSCSI for this node.',
|
||||
kcmdline => 'The kernel command line to use with iSCSI for this node.',
|
||||
initrd => 'The initial ramdisk to use when network booting this node.',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
@ -96,9 +96,9 @@ monitoring => {
|
||||
cols => [qw(name nodestatmon comments disable)],
|
||||
keys => [qw(name)],
|
||||
required => [qw(name)],
|
||||
table_desc => 'Controls what external monitoring tools xCAT sets up and uses.',
|
||||
table_desc => 'Controls what external monitoring tools xCAT sets up and uses. Entries should be added and removed from this table using the provided xCAT commands startmon and stopmon.',
|
||||
descriptions => {
|
||||
name => 'The name of the mornitoring plug-in module. Location??',
|
||||
name => "The name of the mornitoring plug-in module. The plug-in must be put in $ENV{XCATROOT}/lib/perl/xCAT_monitoring/. See the man page for startmon for details.",
|
||||
nodestatmon => 'Specifies if the monitoring plug-in is used to feed the node status to the xCAT cluster. Any one of the following values indicates "yes": y, Y, yes, Yes, YES, 1. Any other value or blank (default), indicates "no".',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
@ -122,8 +122,8 @@ mpa => {
|
||||
table_desc => 'Contains info about each Management Module and how to access it.',
|
||||
descriptions => {
|
||||
mpa => 'Hostname of the management module.',
|
||||
username => 'Userid to use to access the management module.',
|
||||
password => 'Password to use to access the management module.',
|
||||
username => 'Userid to use to access the management module. If not specified, the key=blade row in the passwd table is used as the default.',
|
||||
password => 'Password to use to access the management module. If not specified, the key=blade row in the passwd table is used as the default.',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
},
|
||||
@ -136,7 +136,7 @@ networks => {
|
||||
netname => 'Name used to identify this network definition.',
|
||||
net => 'The network address.',
|
||||
mask => 'The network mask.',
|
||||
mgtifname => '??',
|
||||
mgtifname => 'Default ethernet interface name used by nodes on this network??',
|
||||
gateway => 'The network gateway.',
|
||||
dhcpserver => 'The DHCP server that is servicing this network.',
|
||||
tftpserver => 'The TFTP server that is servicing this network.',
|
||||
@ -153,8 +153,8 @@ nodegroup => {
|
||||
table_desc => 'Not supported yet! Contains group definitions, whose membership is dynamic depending on characteristics of the node.',
|
||||
descriptions => {
|
||||
groupname => 'Name of the group.',
|
||||
grouptype => '??',
|
||||
members => '??',
|
||||
grouptype => 'dynamic or static??',
|
||||
members => 'Not used. Will be deleted. (The membership for static groups is stored in the nodelist table.)',
|
||||
wherevals => 'A list of comma-separated "attr=val" pairs that can be used to determine the members of a dynamic group.',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
@ -166,15 +166,15 @@ nodehm => {
|
||||
table_desc => "Settings that control how each node's hardware is managed. Typically, an additional table that is specific to the hardware type of the node contains additional info. E.g. the ipmi, mp, and ppc tables.",
|
||||
descriptions => {
|
||||
node => 'The node name or group name.',
|
||||
power => 'The power method. If not set, the mgt attribute will be used. Valid values: ipmi, blade, hmc, ivm, fsp??. If "ipmi", xCAT will search for this node in the ipmi table for more info. If "blade", xCAT will search for this node in the mp table. If "hmc", "ivm", or "fsp", xCAT will search for this node in the ppc table.',
|
||||
mgt => 'The hardware management method. Valid values: ipmi, blade, hmc, ivm, fsp. See the power attribute for more details.',
|
||||
cons => 'The console method. If not set, the mgt attribute will be used. Valid values: cyclades, mrv, ??',
|
||||
power => 'The method to use to control the power of the node. If not set, the mgt attribute will be used. Valid values: ipmi, blade, hmc, ivm, fsp??. If "ipmi", xCAT will search for this node in the ipmi table for more info. If "blade", xCAT will search for this node in the mp table. If "hmc", "ivm", or "fsp", xCAT will search for this node in the ppc table.',
|
||||
mgt => 'The method to use to do general hardware management of the node. This attribute is used as the default if poweer, cons, or getmac is not set. Valid values: ipmi, blade, hmc, ivm, fsp. See the power attribute for more details.',
|
||||
cons => 'The console method. If not set, the mgt attribute will be used. Valid values: cyclades, mrv, or the values valid for mgt??',
|
||||
termserver => 'The hostname of the terminal server.',
|
||||
termport => 'The port number on the terminal server that this node is connected to.',
|
||||
conserver => 'Not used??',
|
||||
conserver => 'The hostname of the machine where the conserver daemon is running. If not set, the default is the xCAT management node.',
|
||||
serialspeed => 'The speed of the serial port for this node. For SOL on blades, this is typically 19200.',
|
||||
serialflow => "The flow value of the serial port for this node. For SOL on blades, this is typically 'hard'.",
|
||||
getmac => 'Not used??',
|
||||
getmac => 'The method to use to get MAC address of the node. If not set, the mgt attribute will be used. Valid values: switch, blade, ivm, hmc??',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
},
|
||||
@ -226,8 +226,8 @@ noderes => {
|
||||
installnic => 'The network adapter on the node that will be used for OS deployment. If not set, primarynic will be used.',
|
||||
primarynic => 'The network adapter on the node that will be used for xCAT management. Default is eth0.',
|
||||
xcatmaster => 'The hostname of the xCAT management node as known from this node.',
|
||||
current_osimage => 'Not used?? The name of the osimage data object that represents the OS image currently deployed on this node.',
|
||||
next_osimage => 'Not used?? The name of the osimage data object that represents the OS image that will be installed on the node the next time it is deployed.',
|
||||
current_osimage => 'Not currently used. The name of the osimage data object that represents the OS image currently deployed on this node.',
|
||||
next_osimage => 'Not currently used. The name of the osimage data object that represents the OS image that will be installed on the node the next time it is deployed.',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
},
|
||||
@ -249,10 +249,10 @@ notification => {
|
||||
cols => [qw(filename tables tableops comments disable)],
|
||||
keys => [qw(filename)],
|
||||
required => [qw(tables filename)],
|
||||
table_desc => 'Contains registrations to be notified when a table in the xCAT database changes. Users can add entries to have additional software notified of changes.',
|
||||
table_desc => 'Contains registrations to be notified when a table in the xCAT database changes. Users can add entries to have additional software notified of changes. Add and remove entries using the provided xCAT commands regnotif and unregnotif.',
|
||||
descriptions => {
|
||||
filename => 'A file that implements the callback routine when the monitored table changes. Location and format??',
|
||||
tables => 'The name of the xCAT database table to monitor. More than 1??',
|
||||
filename => 'The path name of a file that implements the callback routine when the monitored table changes. Can be a perl module or a command. See the regnotif man page for details.',
|
||||
tables => 'Comma-separated list of xCAT database tables to monitor.',
|
||||
tableops => 'Specifies the table operation to monitor for. Valid values: "d" (rows deleted), "a" (rows added), "u" (rows updated).',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
@ -263,7 +263,7 @@ osimage => {
|
||||
keys => [qw(imagename)],
|
||||
table_desc => 'Not used yet! All the info that specifies a particular operating system image that can be used on nodes.',
|
||||
descriptions => {
|
||||
imagename => '',
|
||||
imagename => 'User given name of the OS image.',
|
||||
osname => '',
|
||||
osvers => '',
|
||||
osdistro => '',
|
||||
@ -355,7 +355,7 @@ site => {
|
||||
keys => [qw(key)],
|
||||
table_desc => 'Global settings for the whole cluster. This table is different from the other tables in that each attribute is just named in the key column, rather than having a separate column for each attribute.',
|
||||
descriptions => {
|
||||
key => 'Name of the attribute. Valid values: master (xCAT management node), xcatconfdir (default /etc/xcat), domain (DNS domain name used for the cluster), installdir (directory that holds the node deployment pkgs), xcatdport (port used by xcatd daemon??), xcatiport (??), timezone (e.g. America/New_York), nameservers (list of DNS servers for the cluster), rsh (path of remote shell command), rcp (path of remote copy command), blademaxp (max # of processes for blade hw ctrl), ppcmaxp (max # of processes for PPC hw ctrl), ipmimaxp, ipmitimeout, ipmiretries, ipmisdrcache, iscsidir, xcatservers (service nodes??), dhcpinterfaces (network interfaces DHCP should listen on??), forwarders (DNS forwarders??), genpasswords (generate BMC passwords??).',
|
||||
key => 'Name of the attribute. Valid values: master (xCAT management node), xcatconfdir (default /etc/xcat), domain (DNS domain name used for the cluster), installdir (directory that holds the node deployment pkgs), xcatdport (port used by xcatd daemon for client/server communication), xcatiport (port used by xcatd to receive install status updates from nodes), timezone (e.g. America/New_York), nameservers (list of DNS servers for the cluster), rsh (path of remote shell command), rcp (path of remote copy command), blademaxp (max # of processes for blade hw ctrl), ppcmaxp (max # of processes for PPC hw ctrl), ipmimaxp, ipmitimeout, ipmiretries, ipmisdrcache, iscsidir, xcatservers (service nodes??), dhcpinterfaces (network interfaces DHCP should listen on??), forwarders (DNS forwarders??), genpasswords (generate BMC passwords??).',
|
||||
value => 'The value of the attribute specified in the "key" column.',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
@ -373,7 +373,7 @@ switch => {
|
||||
node => 'The node name or group name.',
|
||||
switch => 'The switch hostname.',
|
||||
port => 'The port number in the switch that this node is connected to.',
|
||||
vlan => '??',
|
||||
vlan => 'Not used??',
|
||||
comments => 'Any user-written notes.',
|
||||
disable => "Set to 'yes' or '1' to comment out this row.",
|
||||
},
|
||||
|
||||
Loading…
Reference in New Issue
Block a user