feat(network): provision a node over IPv6

.gitignore

@@ -8,3 +8,15 @@ xCAT-client/share/doc
 
 # Build residue: buildrpms.pl rewrites this at every run.
 Gitinfo
+
+# Build residue: buildrpms.pl and builddebs.pl write these into the source
+# tree, so a "git add -A" after a build sweeps them into a commit.
+dist/
+perl-xCAT/pods
+perl-xCAT/share/doc
+perl-xCAT/share/man
+xCAT-client/pods/man1/xcat.1.pod
+xCAT-vlan/share
+xCAT-test/share/man
+xCAT-buildkit/share/man
+pod2htmd.tmp

docs/source/QA/makehosts.rst

@@ -78,6 +78,14 @@ There are 3 methods to configure aliases:
 
         20.1.1.1 node1-hd
 
+    * For an IPv6 address, use ``!`` instead of ``:`` to separate the interface hostname and address: ::
+
+        chdef node1 otherinterfaces='node1-v6!2001:db8::101'
+
+      After executing ``makehosts -n``, the generated record is: ::
+
+        2001:db8::101 node1-v6
+
 **Note**: If suffixes or aliases for the same IP are configured in both ``hosts`` table and ``nics`` table, will cause conflicts. ``makehosts`` will use values from ``nics`` table. The values from ``nics`` table will over-write that from ``hosts`` table to create ``/etc/hosts`` records.
 
 Q: How to handle the same short hostname in different domains?

docs/source/guides/admin-guides/references/man5/hosts.5.rst

@@ -44,7 +44,7 @@ hosts Attributes:
 
 \ **ip**\ 
 
- The IP address of the node. This is only used in makehosts.  The rest of xCAT uses system name resolution to resolve node names to IP addresses.
+ The IPv4 or IPv6 address literal of the node. makehosts and makedns use this value; the rest of xCAT uses system name resolution to resolve node names to IP addresses.
 
 
 
@@ -56,7 +56,7 @@ hosts Attributes:
 
 \ **otherinterfaces**\ 
 
- Other IP addresses to add for this node.  Format: -<ext>:<ip>,<intfhostname>:<ip>,...
+ Other IP addresses to add for this node. Format: -<ext>:<IPv4>, <intfhostname>:<IPv4>, -<ext>!<IPv6>, or <intfhostname>!<IPv6>. A leading - derives the interface hostname from the node name; ! is required as the delimiter for IPv6 addresses.
 
 
 
@@ -79,4 +79,3 @@ SEE ALSO
 
 
 \ **nodels(1)**\ , \ **chtab(8)**\ , \ **tabdump(8)**\ , \ **tabedit(8)**\ 
-

docs/source/guides/admin-guides/references/man7/group.7.rst

@@ -391,7 +391,7 @@ group Attributes:
 
 \ **ip**\  (hosts.ip)
 
- The IP address of the node. This is only used in makehosts.  The rest of xCAT uses system name resolution to resolve node names to IP addresses.
+ The IPv4 or IPv6 address literal of the node. makehosts and makedns use this value; the rest of xCAT uses system name resolution to resolve node names to IP addresses.
 
 
 
@@ -705,7 +705,7 @@ group Attributes:
 
 \ **otherinterfaces**\  (hosts.otherinterfaces)
 
- Other IP addresses to add for this node.  Format: -<ext>:<ip>,<intfhostname>:<ip>,...
+ Other IP addresses to add for this node. Format: -<ext>:<IPv4>, <intfhostname>:<IPv4>, -<ext>!<IPv6>, or <intfhostname>!<IPv6>. A leading - derives the interface hostname from the node name; ! is required as the delimiter for IPv6 addresses.
 
 
 
@@ -1392,4 +1392,3 @@ SEE ALSO
 
 
 \ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
-

docs/source/guides/admin-guides/references/man7/node.7.rst

@@ -403,7 +403,7 @@ node Attributes:
 
 \ **ip**\  (hosts.ip)
 
- The IP address of the node. This is only used in makehosts.  The rest of xCAT uses system name resolution to resolve node names to IP addresses.
+ The IPv4 or IPv6 address literal of the node. makehosts and makedns use this value; the rest of xCAT uses system name resolution to resolve node names to IP addresses.
 
 
 
@@ -711,7 +711,7 @@ node Attributes:
 
 \ **otherinterfaces**\  (hosts.otherinterfaces)
 
- Other IP addresses to add for this node.  Format: -<ext>:<ip>,<intfhostname>:<ip>,...
+ Other IP addresses to add for this node. Format: -<ext>:<IPv4>, <intfhostname>:<IPv4>, -<ext>!<IPv6>, or <intfhostname>!<IPv6>. A leading - derives the interface hostname from the node name; ! is required as the delimiter for IPv6 addresses.
 
 
 
@@ -1428,4 +1428,3 @@ SEE ALSO
 
 
 \ **mkdef(1)**\ , \ **chdef(1)**\ , \ **lsdef(1)**\ , \ **rmdef(1)**\ 
-

docs/source/guides/admin-guides/references/man8/makehosts.8.rst

@@ -102,16 +102,31 @@ EXAMPLES
     "compute","|node(\d+)|1.2.3.($1+0)|","|(.*)|($1).cluster.net|",,
 
 
- Assuming the group "compute" contains node01, node02, etc., then in /etc/hosts they will be given
+ Assuming the group "compute" contains node01, node02, etc., then in /etc/hosts they will be given
  IP addresses of 1.2.3.1, 1.2.3.2, etc.
-
 
 
+3. Add an IPv6 primary address and an IPv6 additional interface for node01. The
+exclamation mark separates an interface hostname from an IPv6 address because
+the address itself contains colons. This example assumes the site domain is
+example.com.
+
+ .. code-block:: perl
+
+    chdef node01 ip=2001:db8::10 otherinterfaces='node01-storage!2001:db8:1::10'
+    makehosts node01
+
+ The resulting entries include:
+
+ .. code-block:: perl
+
+    2001:db8::10 node01 node01.example.com
+    2001:db8:1::10 node01-storage node01-storage.example.com
+
 
 ********
 SEE ALSO
 ********
 
 
 hosts(5)|hosts.5, makedns(8)|makedns.8
-

perl-xCAT/xCAT/DHCP/Backend/Kea.pm

@@ -660,10 +660,17 @@ sub check_services {
 }
 
 sub upsert_reservations {
-    my ( $self, $config, $reservations ) = @_;
+    my ( $self, $config, $reservations, $deleted ) = @_;
+
+    # Remove stale matches before adding the complete requested set.  A DHCPv6
+    # client DUID is valid in more than one subnet, so deleting while adding
+    # would otherwise remove an earlier reservation from the same batch.
+    foreach my $reservation (@$reservations) {
+        my $removed = $self->delete_reservations($config, $reservation);
+        push @$deleted, @$removed if $deleted;
+    }
 
     foreach my $reservation (@$reservations) {
-        $self->delete_reservations($config, $reservation);
         my $subnet = _find_subnet_by_id( $config, $reservation->{'subnet-id'} );
         next unless $subnet;
         $subnet->{reservations} ||= [];
@@ -740,7 +747,9 @@ sub control_agent_url {
 
     my $host = $opts{host} || $self->{control_agent_host} || '127.0.0.1';
     my $port = $opts{port} || $self->{control_agent_port} || 8000;
-    return "http://$host:$port/";
+    my $authority = xCAT::NetworkUtils->format_host_port($host, $port);
+    return unless $authority;
+    return "http://$authority/";
 }
 
 sub control_agent_command {
@@ -781,10 +790,32 @@ sub live_upsert_reservations {
     my ( $self, $reservations, %opts ) = @_;
 
     my $service = $opts{service} || ['dhcp4'];
-    foreach my $reservation (@$reservations) {
+    my @delete = (
+        @{ $opts{stale_reservations} || [] },
+        @$reservations,
+    );
+    my %seen;
+    foreach my $reservation (@delete) {
+        my ( $identifier_type, $identifier );
+        if ($reservation->{'hw-address'}) {
+            ( $identifier_type, $identifier ) = ( 'hw-address', $reservation->{'hw-address'} );
+        } elsif ($reservation->{duid}) {
+            ( $identifier_type, $identifier ) = ( 'duid', $reservation->{duid} );
+        } elsif ($reservation->{'ip-address'}) {
+            ( $identifier_type, $identifier ) = ( 'ip-address', $reservation->{'ip-address'} );
+        } elsif (ref($reservation->{'ip-addresses'}) eq 'ARRAY' && @{ $reservation->{'ip-addresses'} }) {
+            ( $identifier_type, $identifier ) = ( 'ip-address', $reservation->{'ip-addresses'}[0] );
+        }
+        my $key = join('|',
+            map { defined($_) ? lc($_) : '' }
+              $reservation->{'subnet-id'}, $identifier_type, $identifier,
+        );
+        next if $seen{$key}++;
         my $delete = $self->_live_delete_reservation($reservation, service => $service, ignore_not_found => 1);
         return $delete if $delete->{error};
+    }
 
+    foreach my $reservation (@$reservations) {
         my ($stored) = @{ _render_entry_option_data( [$reservation] ) };
         my $result = $self->control_agent_command(
             'reservation-add',

perl-xCAT/xCAT/DSHCore.pm

@@ -12,7 +12,17 @@ use strict;
 use Socket;
 
 use xCAT::MsgUtils;
+use xCAT::NetworkUtils;
 use xCAT::Utils;
+use Text::ParseWords qw(shellwords);
+
+=head1 NAME
+
+xCAT::DSHCore - distributed command execution and reachability helpers
+
+=head1 FUNCTIONS
+
+=head2 Process and ping helpers
 
 #---------------------------------------------------------------------------
 
@@ -676,6 +686,166 @@ sub ping_hostnames
 }
 
 
+#---------------------------------------------------------------------------
+
+=head3
+        partition_ping_targets
+
+        Resolves ping targets and separates them into the address family that
+        should be probed.  IPv4 remains preferred for dual-stack targets so
+        existing behavior is preserved.
+
+        Arguments:
+                @targets - hostnames or address literals
+
+        Returns:
+                references to the IPv4, IPv6, and unresolved target arrays
+
+=cut
+
+#---------------------------------------------------------------------------
+
+sub partition_ping_targets
+{
+    my ($class, @targets) = @_;
+    my (@ipv4, @ipv6, @unresolved);
+
+    foreach my $target (@targets)
+    {
+        my $family = xCAT::NetworkUtils->node_address_family($target);
+        if (defined($family) && $family == 4)
+        {
+            push @ipv4, $target;
+        }
+        elsif (defined($family) && $family == 6)
+        {
+            push @ipv6, $target;
+        }
+        else
+        {
+            push @unresolved, $target;
+        }
+    }
+
+    return (\@ipv4, \@ipv6, \@unresolved);
+}
+
+
+#---------------------------------------------------------------------------
+
+=head3
+        nmap_ping_command
+
+        Builds the nmap command pping runs for one address family.
+
+        Arguments:
+                $family - 4 or 6
+                $more_options - the site nmapoptions value, or undef
+                $targets - reference to the target list
+
+        Returns:
+                the command as a list
+
+        Comments:
+                The command is a list, not a string, so pping can exec it
+                without a shell. nmap needs -6 for an IPv6 target: it reads an
+                IPv6 literal as a hostname otherwise.
+
+=cut
+
+#---------------------------------------------------------------------------
+
+sub nmap_ping_command
+{
+    my ($class, $family, $more_options, $targets) = @_;
+
+    my @command = ('nmap');
+    push @command, '-6' if defined($family) && $family == 6;
+
+    # Port 22 is here for the unprivileged case (#4324).
+    push @command, qw(-PE --system-dns --send-ip -sP --unprivileged -PA80,443,22);
+    push @command, shellwords($more_options)
+      if defined($more_options) && length($more_options);
+    push @command, @{ $targets || [] };
+    return @command;
+}
+
+
+#---------------------------------------------------------------------------
+
+=head3
+        fping_ping_command
+
+        Builds the fping command pping runs for one address family.
+
+        Arguments:
+                $family - 4 or 6
+                $binaries - reference to a hash with the fping and fping6
+                            paths that exist on this host, either one undef
+                $targets - reference to the target list
+
+        Returns:
+                the command as a list, or an empty list when no fping on this
+                host can probe that family
+
+        Comments:
+                fping6 is a separate program on an older distribution. A
+                current fping takes -6 instead and ships no fping6.
+
+=cut
+
+#---------------------------------------------------------------------------
+
+sub fping_ping_command
+{
+    my ($class, $family, $binaries, $targets) = @_;
+    $binaries ||= {};
+
+    my @command;
+    if (defined($family) && $family == 6)
+    {
+        if ($binaries->{fping6})
+        {
+            @command = ($binaries->{fping6});
+        }
+        elsif ($binaries->{fping})
+        {
+            @command = ($binaries->{fping}, '-6');
+        }
+    }
+    elsif ($binaries->{fping})
+    {
+        @command = ($binaries->{fping});
+    }
+    return () unless @command;
+
+    push @command, '-a', @{ $targets || [] };
+    return @command;
+}
+
+
+#---------------------------------------------------------------------------
+
+=head3
+        parse_pping_result_line
+
+        Parses the stable C<target: ping|noping> output contract.  The greedy
+        target match intentionally accepts IPv6 address literals containing
+        colons.
+
+=cut
+
+#---------------------------------------------------------------------------
+
+sub parse_pping_result_line
+{
+    my ($class, $line) = @_;
+    return unless defined($line);
+    return ($1, $2) if $line =~ /^(.+):\s+(ping|noping)\s*$/;
+    return;
+}
+
+
 #---------------------------------------------------------------------------
 
 =head3
@@ -735,9 +905,8 @@ sub pping_hostnames
     my @no_response = ();
     foreach my $line (@output)
     {
-        my ($hostname, $result) = split ':', $line;
-        my ($token,    $status) = split ' ', $result;
-        chomp($token);
+        my ($hostname, $token) = $class->parse_pping_result_line($line);
+        next unless defined($hostname);
         if ($token ne 'ping') {
             push @no_response, $hostname;
         }