2
0
mirror of https://github.com/xcat2/xcat-core.git synced 2026-07-31 18:19:40 +00:00

docs: port man-page clarifications from lenovobuild

Recover several man-page clarifications that never merged from the lenovobuild
branch.  All are documentation-only -- the man .pod sources with their
generated .rst, plus the networks-table description in Schema.pm:

  * makedhcp / nodeset: note that UEFI boot directives are intentionally
    omitted when nodetype.os names an OS without UEFI support, even for
    'nodeset shell'.
  * networks table dhcpserver: warn that it should be set only for service
    node operation and that <xcatmaster> is not a valid value.
  * noderange: clarify that the syntax is for xCAT.
  * reventlog: note that unimplemented sensor types yield 'No Mappings Found'
    and point to confluent's nodeeventlog facility.
  * rcons: document confluent console auto-reconnect (a randomized 2-4 minute
    retry, or 'ctrl-e o a' to force one); the original's stray backtick markup
    is corrected.

Recovered from the unmerged lenovobuild branch (originals 2d4f12f4, 760f2f8b,
23d63d59, 44b47c44, c63d780f, db4dc42b).

Co-authored-by: Jarrod Johnson <10814490+jjohnson42@users.noreply.github.com>
This commit is contained in:
Vinícius Ferrão
2026-07-22 22:00:51 -03:00
parent cf44f51463
commit de3d68dd1d
12 changed files with 30 additions and 10 deletions
@@ -37,6 +37,10 @@ If \ *conserver-host*\ is specified, the conserver daemon on that host will be
To exit the console session, enter: 'ctrl-e c .' (3 characters: ctrl-e, 'c' and '.').
For confluent backed consoles, an extended outage of connectivity to the endpoint will result in an automated retry
of a randomized interval between 2 to 4 minutes. You can either close and reopen the console to force a quicker
reconnect, or enter 'ctrl-e o a' (3 characters: ctrl-e, 'o' and 'a') to request an immediate reconnect attempt.
***************
\ **Options**\
@@ -38,7 +38,10 @@ OpenPOWER OpenBMC specific :
\ **reventlog**\ can display any number of remote hardware event log entries
or clear them for a range of nodes. Hardware event
logs are stored on each servers service processor.
logs are stored on each servers service processor. Note that some sensor types
are not currently implemented, resulting in 'No Mappings Found' messages. If these
are observed, it is suggested to look at confluent's equivalent 'nodeeventlog' facility,
which supports a broader set of sensor types.
***************
@@ -11,7 +11,7 @@ Name
****
\ **noderange**\ - syntax for compactly expressing a list of node names
\ **noderange**\ - syntax for compactly expressing a list of node names in \ **xCAT**\
****************
@@ -68,7 +68,7 @@ networks Attributes:
\ **dhcpserver**\
The DHCP server that is servicing this network. Required to be explicitly set for pooled service node operation.
The DHCP server that is servicing this network. Required to be explicitly set for pooled service node operation. This field should not be set except for service node operation. Also, <xcatmaster> is not a valid field value for this field.
@@ -40,7 +40,8 @@ DESCRIPTION
The \ **makedhcp**\ command creates and updates the DHCP configuration on the management node and service nodes.
The \ **makedhcp**\ command is supported for both Linux and AIX clusters.
The \ **makedhcp**\ command is supported for both Linux and AIX clusters. Note that it will intentionally not
generate UEFI configuration if the OS indicated in nodetype.os is not UEFI supported, even if the OS being booted is shell.
On Linux, the DHCP implementation is selected by the ``site.dhcpbackend`` attribute.
The ``auto`` setting keeps ISC DHCP on platforms where it is still available and uses Kea DHCP on platforms such as EL10 and Ubuntu 24.04.
For legacy ISC DHCP deployments that need a non-default OMAPI/TSIG key, use
@@ -38,7 +38,9 @@ nodes or groups. It tells xCAT what you want to happen the next time the
nodes are booted up. See noderange(3)|noderange.3. \ **nodeset**\ accomplishes this by
changing the network boot files. Each xCAT node always boots from the
network and downloads a boot file with instructions on what action to
take next.
take next. Should the nodetype.os indicates an OS that does not support UEFI
boot, then the dhcp definition will not include UEFI boot directives, even
if doing \ **nodeset shell**\ .
\ **nodeset**\ will manipulate the boot configuration files of xnba, grub2, petitboot, yaboot and pxelinux.0.
+1 -1
View File
@@ -566,7 +566,7 @@ passed as argument rather than by table value',
mask => 'The network mask.',
mgtifname => 'The interface name of the management/service node facing this network. !remote!<nicname> indicates a non-local network on a specific nic for relay DHCP.',
gateway => 'The network gateway. It can be set to an ip address or the keyword <xcatmaster>, the keyword <xcatmaster> indicates the cluster-facing ip address configured on this management node or service node. Leaving this field blank means that there is no gateway for this network.',
dhcpserver => 'The DHCP server that is servicing this network. Required to be explicitly set for pooled service node operation.',
dhcpserver => 'The DHCP server that is servicing this network. Required to be explicitly set for pooled service node operation. This field should not be set except for service node operation. Also, <xcatmaster> is not a valid field value for this field.',
tftpserver => 'The TFTP server that is servicing this network. If not set, the DHCP server is assumed.',
nameservers => 'A comma delimited list of DNS servers that each node in this network should use. This value will end up in the nameserver settings of the /etc/resolv.conf on each node in this network. If this attribute value is set to the IP address of an xCAT node, make sure DNS is running on it. In a hierarchical cluster, you can also set this attribute to "<xcatmaster>" to mean the DNS server for each node in this network should be the node that is managing it (either its service node or the management node). Used in creating the DHCP network definition, and DNS configuration.',
ntpservers => 'The ntp servers for this network. Used in creating the DHCP network definition. Assumed to be the DHCP server if not set.',
+4
View File
@@ -18,6 +18,10 @@ If I<conserver-host> is specified, the conserver daemon on that host will be con
To exit the console session, enter: 'ctrl-e c .' (3 characters: ctrl-e, 'c' and '.').
For confluent backed consoles, an extended outage of connectivity to the endpoint will result in an automated retry
of a randomized interval between 2 to 4 minutes. You can either close and reopen the console to force a quicker
reconnect, or enter 'ctrl-e o a' (3 characters: ctrl-e, 'o' and 'a') to request an immediate reconnect attempt.
=head1 B<Options>
=over 5
+4 -1
View File
@@ -17,7 +17,10 @@ B<reventlog> I<noderange> [B<resolved=>{I<id-list>|B<LED>}]
B<reventlog> can display any number of remote hardware event log entries
or clear them for a range of nodes. Hardware event
logs are stored on each servers service processor.
logs are stored on each servers service processor. Note that some sensor types
are not currently implemented, resulting in 'No Mappings Found' messages. If these
are observed, it is suggested to look at confluent's equivalent 'nodeeventlog' facility,
which supports a broader set of sensor types.
=head1 B<Options>
+1 -1
View File
@@ -1,6 +1,6 @@
=head1 Name
B<noderange> - syntax for compactly expressing a list of node names
B<noderange> - syntax for compactly expressing a list of node names in B<xCAT>
=head1 B<Synopsis>
+2 -1
View File
@@ -21,7 +21,8 @@ B<makedhcp> B<[-h|--help]>
=head1 DESCRIPTION
The B<makedhcp> command creates and updates the DHCP configuration on the management node and service nodes.
The B<makedhcp> command is supported for both Linux and AIX clusters.
The B<makedhcp> command is supported for both Linux and AIX clusters. Note that it will intentionally not
generate UEFI configuration if the OS indicated in nodetype.os is not UEFI supported, even if the OS being booted is shell.
On Linux, the DHCP implementation is selected by the C<site.dhcpbackend> attribute.
The C<auto> setting keeps ISC DHCP on platforms where it is still available and uses Kea DHCP on platforms such as EL10 and Ubuntu 24.04.
+3 -1
View File
@@ -19,7 +19,9 @@ nodes or groups. It tells xCAT what you want to happen the next time the
nodes are booted up. See L<noderange(3)|noderange.3>. B<nodeset> accomplishes this by
changing the network boot files. Each xCAT node always boots from the
network and downloads a boot file with instructions on what action to
take next.
take next. Should the nodetype.os indicates an OS that does not support UEFI
boot, then the dhcp definition will not include UEFI boot directives, even
if doing B<nodeset shell>.
B<nodeset> will manipulate the boot configuration files of xnba, grub2, petitboot, yaboot and pxelinux.0.