Chapter 9. Custom composable networks

Procedure

1. Copy the default network_data.yaml file:

   $ cp /usr/share/openstack-tripleo-heat-templates/network_data.yaml /home/stack/.

2. Edit the local copy of the network_data.yaml file and add a section for your new network:

   - name: StorageBackup
     name_lower: storage_backup
     vlan: 21
     vip: true
     ip_subnet: '172.21.1.0/24'
     allocation_pools: [{'start': '171.21.1.4', 'end': '172.21.1.250'}]
     gateway_ip: '172.21.1.1'

   You can use the following parameters in your network_data.yaml file:

   name

   Sets the human readable name of the network. This parameter is the only mandatory parameter. You can also use name_lower to normalize names for readability. For example, change InternalApi to internal_api.

   name_lower

   Sets the lowercase version of the name, which director maps to respective networks assigned to roles in the roles_data.yaml file.

   vlan

   Sets the VLAN that you want to use for this network.

   vip: true

   Creates a virtual IP address (VIP) on the new network. This IP is used as the target IP for services listed in the service-to-network mapping parameter (ServiceNetMap). Note that VIPs are used only by roles that use Pacemaker. The overcloud load-balancing service redirects traffic from these IPs to their respective service endpoint.

   ip_subnet

   Sets the default IPv4 subnet in CIDR format.

   allocation_pools

   Sets the IP range for the IPv4 subnet

   gateway_ip

   Sets the gateway for the network.

   routes

   Adds additional routes to the network. Uses a JSON list that contains each additional route. Each list item contains a dictionary value mapping. Use the following example syntax:

     routes: [{'destination':'10.0.0.0/16', 'nexthop':'10.0.2.254'}]

   subnets

   Creates additional routed subnets that fall within this network. This parameter accepts a dict value that contains the lowercase name of the routed subnet as the key and the vlan, ip_subnet, allocation_pools, and gateway_ip parameters as the value mapped to the subnet. The following example demonstrates this layout:

   - name: StorageBackup
     name_lower: storage_backup
     vlan: 200
     vip: true
     ip_subnet: '172.21.0.0/24'
     allocation_pools: [{'start': '171.21.0.4', 'end': '172.21.0.250'}]
     gateway_ip: '172.21.0.1'
     subnets:
       storage_backup_leaf1:
         vlan: 201
         ip_subnet: '172.21.1.0/24'
         allocation_pools: [{'start': '171.21.1.4', 'end': '172.21.1.250'}]
         gateway_ip: '172.19.1.254'

   This mapping is common in spine leaf deployments. For more information, see the Spine Leaf Networking guide.

3. When you add an extra composable network that contains a virtual IP, and want to map some API services to this network, use the CloudName{network.name} definition to set the DNS name for the API endpoint:

   CloudName{{network.name}}

   Here is an example:

   parameter_defaults:
     ...
     CloudNameOcProvisioning: baremetal-vip.example.com

4. Include the custom network_data.yaml file in your deployment command using the -n option. Without the -n option, the deployment command uses the default set of networks.

5. If you want a predictable virtual IP address (VIP), add a VirtualFixedIPs parameter for your custom network to the parameter_defaults section of a heat environment file, for example, my_network_vips.yaml:

   <% my_customer_network %>VirtualFixedIPs:  [{'ip_address':'<% ipaddres %>'}]

   Here is an example:

   parameter_defaults:
     ...
     # Predictable VIPs
     StorageBackuptVirtualFixedIPs:  [{'ip_address':'172.21.1.9'}]

6. Include the heat environment file, my_network_vips.yaml, in your deployment command by using the -e option.

Procedure

1. If you do not already have a custom roles_data.yaml file, copy the default to your home directory:

   $ cp /usr/share/openstack-tripleo-heat-templates/roles_data.yaml /home/stack/.

2. Edit the custom roles_data.yaml file.

3. Include the network name in the networks list for the role that you want to add the network to. For example, to add the StorageBackup network to the Ceph Storage role, use the following example snippet:

   - name: CephStorage
     description: |
       Ceph OSD Storage node role
     networks:
       - Storage
       - StorageMgmt
       - StorageBackup

4. After you add custom networks to their respective roles, save the file.

Procedure

1. When you run the openstack overcloud deploy command, ensure that you include the following files:

   • The custom network_data.yaml file.
   • The custom roles_data.yaml file with network-to-role assignments.
   • The rendered file name of the default network isolation.
   • The rendered file name of the default network environment file.
   • The rendered file name of the default network interface configuration.
   • Any additional environment files related to your network, such as the service reassignments.

Procedure

1. In your network_data.yaml file, enter new names in the name_lower parameter for each network that you want to rename:

   - name: InternalApi
     name_lower: MyCustomInternalApi

2. Include the default value of the name_lower parameter in the service_net_map_replace parameter:

   - name: InternalApi
     name_lower: MyCustomInternalApi
     service_net_map_replace: internal_api