Remove ipv6 specific network templates

This change renders the IPv6 versions of the isolated
networks using j2. To allow for backward compatibility,
there will be 2 versions of the network definitions,
<network>.yaml and <network>_v6.yaml. If the ip_subnet
contains an IPv6 address, or if ipv6: true is set on the
network definition in network_data.yaml, then the
<network>.yaml version will contain an IPv6 definition,
otherwise the <network>.yaml will be IPv4, and the
<network>_v6.yaml will be IPv6.

In a future follow-up patch, we will probably only
create the required versions of the networks, either
IPv4, IPv6, not both.

The ipv6_subnet, ipv6_allocation_pools, and ipv6_gateway
settings in the network_data.yaml definition file are
used for the <network>_v6.yaml network definition.
Note that these subnet/cidr/gateway definitions only set
the defaults, which can be overridden with parameters
set in an environment file.

Since the parameters for IP and subnet range are the
same (e.g. InternalApiNetCidr applies to both IPv4/v6),
only one version can be used at a time. If an operator
wishes to use dual-stack IPv4/IPv6, then two different
networks should be created, and both networks can be
applied to a single interface.

Note that the workflow for the operator is the same as
before this change, but a new example template has been
added to environments/network-environment-v6.yaml.

Change-Id: I0e674e4b1e43786717ae6416571dde3a0e11a5cc
Partially-Implements: blueprint composable-networks
Closes-bug: 1714115
(cherry picked from commit dd299f08bd6b1df43760148d83ce9b6e09ba6572)

1 files changed, 37 insertions, 12 deletions

diff --git a/network_data.yaml b/network_data.yaml
index 6ad37dfe..fed11576 100644
--- a/network_data.yaml
+++ b/network_data.yaml
@@ -6,19 +6,22 @@
 # name_lower: lowercase version of name used for filenames
 #             (optional, defaults to name.lower())
 # enabled: Is the network enabled (optional, defaults to true)
-# ipv6: Does this network use IPv6 IPs? (optional, defaults to false)
-#                   (optional, may use parameter defaults in environment to set)
 # vlan: vlan for the network (optional)
 # vip: Enable creation of a virtual IP on this network
-#      [TODO] (dsneddon@redhat.com) - Enable dynamic creation of VIP ports,
-#      to support VIPs on non-default networks.
-#      See https://bugs.launchpad.net/tripleo/+bug/1667104
-# ip_subnet: IP/CIDR, e.g. '192.168.24.0/24' (optional, may use parameter defaults)
-# allocation_pools: IP range list e.g. [{'start':'10.0.0.4', 'end':'10.0.0.250}]
+# ip_subnet: IP/CIDR, e.g. '192.168.24.0/24' or '2001:db8:fd00:1000::/64'
+#            (optional, may use parameter defaults instead)
+# allocation_pools: IP range list e.g. [{'start':'10.0.0.4', 'end':'10.0.0.250'}]
 # gateway_ip: gateway for the network (optional, may use parameter defaults)
-# NOTE: IP-related values set parameter defaults in templates, may be overridden.
-# compat_name: for existing stack you may need to override the default transformation
-#              for the resource's name.
+# ipv6_subnet: Optional, sets default IPv6 subnet if IPv4 is already defined.
+# ipv6_allocation_pools: Set default IPv6 allocation pools if IPv4 allocation pools
+#                        are already defined.
+# ipv6_gateway: Set an IPv6 gateway if IPv4 gateway already defined.
+# ipv6: If ip_subnet not defined, this specifies that the network is IPv6-only.
+# NOTE: IP-related values set parameter defaults in templates, may be overridden,
+# either by operators, or e.g in environments/network-isolation-v6.yaml where we
+# set some default IPv6 addresses.
+# compat_name: for existing stack you may need to override the default
+#              transformation for the resource's name.
 #
 # Example:
 # - name Example
@@ -27,8 +30,17 @@
 #   allocation_pools: [{'start': '10.0.2.4', 'end': '10.0.2.250'}]
 #   gateway_ip: '10.0.2.254'
 #
-# TODO (dsneddon) remove existing templates from j2_excludes.yaml
-#                 and generate all templates dynamically.
+# To support backward compatility, two versions of the network definitions will
+# be created, network/<network>.yaml and network/<network>_v6.yaml. Only
+# one of these files may be used in the deployment at a time, since the
+# parameters used for configuration are the same in both files. In the
+# future, this behavior may be changed to create only one file for custom
+# networks. You may specify IPv6 addresses for ip_subnet, allocation_pools,
+# and gateway_ip if no IPv4 addresses are used for a custom network, or set
+# ipv6: true, and the network/<network>.yaml file will be configured as IPv6.
+#
+# For configuring both IPv4 and IPv6 on the same interface, use two separate
+# networks, and then assign both IPs in the custom NIC configuration templates.
 
 - name: External
   vip: true
@@ -36,27 +48,38 @@
   ip_subnet: '10.0.0.0/24'
   allocation_pools: [{'start': '10.0.0.4', 'end': '10.0.0.250'}]
   gateway_ip: '10.0.0.1'
+  ipv6_subnet: '2001:db8:fd00:1000::/64'
+  ipv6_allocation_pools: [{'start': '2001:db8:fd00:1000::10', 'end': '2001:db8:fd00:1000:ffff:ffff:ffff:fffe'}]
+  gateway_ipv6: '2001:db8:fd00:1000::1'
 - name: InternalApi
   name_lower: internal_api
   vip: true
   ip_subnet: '172.16.2.0/24'
   allocation_pools: [{'start': '172.16.2.4', 'end': '172.16.2.250'}]
+  ipv6_subnet: 'fd00:fd00:fd00:2000::/64'
+  ipv6_allocation_pools: [{'start': 'fd00:fd00:fd00:2000::10', 'end': 'fd00:fd00:fd00:2000:ffff:ffff:ffff:fffe'}]
   compat_name: Internal
 - name: Storage
   vip: true
   name_lower: storage
   ip_subnet: '172.16.1.0/24'
   allocation_pools: [{'start': '172.16.1.4', 'end': '172.16.1.250'}]
+  ipv6_subnet: 'fd00:fd00:fd00:3000::/64'
+  ipv6_allocation_pools: [{'start': 'fd00:fd00:fd00:3000::10', 'end': 'fd00:fd00:fd00:3000:ffff:ffff:ffff:fffe'}]
 - name: StorageMgmt
   name_lower: storage_mgmt
   vip: true
   ip_subnet: '172.16.3.0/24'
   allocation_pools: [{'start': '172.16.3.4', 'end': '172.16.3.250'}]
+  ipv6_subnet: 'fd00:fd00:fd00:4000::/64'
+  ipv6_allocation_pools: [{'start': 'fd00:fd00:fd00:4000::10', 'end': 'fd00:fd00:fd00:4000:ffff:ffff:ffff:fffe'}]
 - name: Tenant
   vip: false  # Tenant network does not use VIPs
   name_lower: tenant
   ip_subnet: '172.16.0.0/24'
   allocation_pools: [{'start': '172.16.0.4', 'end': '172.16.0.250'}]
+  ipv6_subnet: 'fd00:fd00:fd00:5000::/64'
+  ipv6_allocation_pools: [{'start': 'fd00:fd00:fd00:5000::10', 'end': 'fd00:fd00:fd00:5000:ffff:ffff:ffff:fffe'}]
 - name: Management
   # Management network is disabled by default
   enabled: false
@@ -64,3 +87,5 @@
   name_lower: management
   ip_subnet: '10.0.1.0/24'
   allocation_pools: [{'start': '10.0.1.4', 'end': '10.0.1.250'}]
+  ipv6_subnet: 'fd00:fd00:fd00:6000::/64'
+  ipv6_allocation_pools: [{'start': 'fd00:fd00:fd00:6000::10', 'end': 'fd00:fd00:fd00:6000:ffff:ffff:ffff:fffe'}]