Chapter 14. Updating network configuration

Procedure

1. Log in to the undercloud as the stack user.

2. Source the stackrc file.

   $ source ~/stackrc

3. On the undercloud, create a file called update-nic-templates.sh and include the following content in the file:

   #!/bin/bash
   STACK_NAME="overcloud"
   ROLES_DATA="/usr/share/openstack-tripleo-heat-templates/roles_data.yaml"
   NETWORK_DATA="/usr/share/openstack-tripleo-heat-templates/network_data.yaml"
   NIC_CONFIG_LINES=$(openstack stack environment show $STACK_NAME | grep "::Net::SoftwareConfig" | sed -E 's/ *OS::TripleO::// ; s/::Net::SoftwareConfig:// ; s/ http.*user-files/ /')
   echo "$NIC_CONFIG_LINES" | while read LINE; do
       ROLE=$(echo "$LINE" | awk '{print $1;}')
       NIC_CONFIG=$(echo "$LINE" | awk '{print $2;}')
   
       if [ -f "$NIC_CONFIG" ]; then
           echo "Updating template for $ROLE role."
           python3 /usr/share/openstack-tripleo-heat-templates/tools/merge-new-params-nic-config-script.py \
               --tht-dir /usr/share/openstack-tripleo-heat-templates \
               --roles-data $ROLES_DATA \
               --network-data $NETWORK_DATA \
               --role-name "$ROLE" \
               --discard-comments yes \
               --template "$NIC_CONFIG"
       else
           echo "No NIC template detected for $ROLE role. Skipping $ROLE role."
       fi
   done

   • If you use a custom overcloud name, Set the STACK_NAME variable to the name of your overcloud. The default name for an overcloud stack is overcloud.
   • If you use a custom roles_data file, set the ROLES_DATA variable to the location of the custom file. If you use the default roles_data file, leave the variable as /usr/share/openstack-tripleo-heat-templates/roles_data.yaml
   • If you use a custom network_data file, set the NETWORK_DATA variable to the location of the custom file. If you use the default network_data file, leave the variable as /usr/share/openstack-tripleo-heat-templates/network_data.yaml
   • Run /usr/share/openstack-tripleo-heat-templates/tools/merge-new-params-nic-config-script.py -h to see a list of options to add to the script.

4. Add executable permissions to the script:

   $ chmod +x update-nic-templates.sh

5. Optional: If you use a spine-leaf network topology for your RHOSP environment, check the roles_data.yaml file and ensure that it uses the correct role names for the NIC templates for your deployment. The script uses the value of the deprecated_nic_config_name parameter in the roles_data.yaml file.

6. Run the script:

   $ ./update-nic-templates.sh

   The script saves a copy of each custom NIC template and updates each template with the missing parameters. The script also skips any roles that do not have a custom template:

   No NIC template detected for BlockStorage role. Skipping BlockStorage role.
   Updating template for CephStorage role.
   The original template was saved as: /home/stack/templates/custom-nics/ceph-storage.yaml.20200903144835
   The update template was saved as: /home/stack/templates/custom-nics/ceph-storage.yaml
   Updating template for Compute role.
   The original template was saved as: /home/stack/templates/custom-nics/compute.yaml.20200903144838
   The update template was saved as: /home/stack/templates/custom-nics/compute.yaml
   Updating template for Controller role.
   The original template was saved as: /home/stack/templates/custom-nics/controller.yaml.20200903144841
   The update template was saved as: /home/stack/templates/custom-nics/controller.yaml
   No NIC template detected for ObjectStorage role. Skipping ObjectStorage role.