Chapter 21. Common administrative networking tasks

Procedure

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

2. Source the undercloud credentials file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. Create a custom YAML environment file.

   Example

   $ vi /home/stack/templates/my-environment.yaml

   Copy to Clipboard Toggle word wrap

4. Your environment file must contain the keywords parameter_defaults. Under these keywords, add the following lines:

   parameter_defaults:
     NeutronMechanismDrivers: ['openvswitch', 'l2population']
     NeutronEnableL2Pop: 'True'
     NeutronEnableARPResponder: true

   Copy to Clipboard Toggle word wrap

5. Run the deployment command and include the core heat templates, environment files, and this new custom environment file.

   Important

   The order of the environment files is important because the parameters and resources defined in subsequent environment files take precedence.

   Example

   $ openstack overcloud deploy --templates \
   -e <your_environment_files> \
   -e /home/stack/templates/my-environment.yaml

   Copy to Clipboard Toggle word wrap

Verification

1. Obtain the IDs for the OVS agents.

   $ openstack network agent list -c ID -c Binary

   Copy to Clipboard Toggle word wrap

   Sample output

   +--------------------------------------+---------------------------+
   | ID                                   | Binary                    |
   +--------------------------------------+---------------------------+
   | 003a8750-a6f9-468b-9321-a6c03c77aec7 | neutron-openvswitch-agent |
   | 02bbbb8c-4b6b-4ce7-8335-d1132df31437 | neutron-l3-agent          |
   | 0950e233-60b2-48de-94f6-483fd0af16ea | neutron-openvswitch-agent |
   | 115c2b73-47f5-4262-bc66-8538d175029f | neutron-openvswitch-agent |
   | 2a9b2a15-e96d-468c-8dc9-18d7c2d3f4bb | neutron-metadata-agent    |
   | 3e29d033-c80b-4253-aaa4-22520599d62e | neutron-dhcp-agent        |
   | 3ede0b64-213d-4a0d-9ab3-04b5dfd16baa | neutron-dhcp-agent        |
   | 462199be-0d0f-4bba-94da-603f1c9e0ec4 | neutron-sriov-nic-agent   |
   | 54f7c535-78cc-464c-bdaa-6044608a08d7 | neutron-l3-agent          |
   | 6657d8cf-566f-47f4-856c-75600bf04828 | neutron-metadata-agent    |
   | 733c66f1-a032-4948-ba18-7d1188a58483 | neutron-l3-agent          |
   | 7e0a0ce3-7ebb-4bb3-9b89-8cccf8cb716e | neutron-openvswitch-agent |
   | dfc36468-3a21-4a2d-84c3-2bc40f224235 | neutron-metadata-agent    |
   | eb7d7c10-69a2-421e-bd9e-aec3edfe1b7c | neutron-openvswitch-agent |
   | ef5219b4-ee49-4635-ad04-048291209373 | neutron-sriov-nic-agent   |
   | f36c7af0-e20c-400b-8a37-4ffc5d4da7bd | neutron-dhcp-agent        |
   +--------------------------------------+---------------------------+

   Copy to Clipboard Toggle word wrap

2. Using an ID from one of the OVS agents, confirm that the L2 Population driver is set on the OVS agent.

   Example

   This example verifies the configuration of the L2 Population driver on the neutron-openvswitch-agent with ID 003a8750-a6f9-468b-9321-a6c03c77aec7:

   $ openstack network agent show 003a8750-a6f9-468b-9321-a6c03c77aec7 -c configuration -f json | grep l2_population

   Copy to Clipboard Toggle word wrap

   Sample output

       "l2_population": true,

   Copy to Clipboard Toggle word wrap

3. Ensure that the ARP responder feature is enabled for the OVS agent.

   Example

   $ openstack network agent show 003a8750-a6f9-468b-9321-a6c03c77aec7 -c configuration -f json | grep arp_responder_enabled

   Copy to Clipboard Toggle word wrap

   Sample output

       "arp_responder_enabled": true,

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user, and source the stackrc file to enable the director command line tools.

   Example

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Create a custom YAML environment file.

   Example

   $ vi /home/stack/templates/my-neutron-environment.yaml

   Copy to Clipboard Toggle word wrap

   Tip

   The Red Hat OpenStack Platform Orchestration service (heat) uses a set of plans called templates to install and configure your environment. You can customize aspects of the overcloud with a custom environment file, which is a special type of template that provides customization for your heat templates.

3. In the YAML environment file, increase the VRRP advertisement interval using the ha_vrrp_advert_int argument with a value specific for your site. (The default is 2 seconds.)

   You can also set values for gratuitous ARP messages:

   ha_vrrp_garp_master_repeat

   The number of gratuitous ARP messages to send at one time after the transition to the master state. (The default is 5 messages.)

   ha_vrrp_garp_master_delay

   The delay for second set of gratuitous ARP messages after the lower priority advert is received in the master state. (The default is 5 seconds.)

   Example

   parameter_defaults:
     ControllerExtraConfig:
       neutron::agents::l3::ha_vrrp_advert_int: 7
       neutron::config::l3_agent_config:
         DEFAULT/ha_vrrp_garp_master_repeat:
           value: 5
         DEFAULT/ha_vrrp_garp_master_delay:
           value: 5

   Copy to Clipboard Toggle word wrap

4. Run the openstack overcloud deploy command and include the core heat templates, environment files, and this new custom environment file.

   Important

   The order of the environment files is important because the parameters and resources defined in subsequent environment files take precedence.

   Example

   $ openstack overcloud deploy --templates \
   -e [your-environment-files] \
   -e /usr/share/openstack-tripleo-heat-templates/environments/services/my-neutron-environment.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the undercloud as the stack user, and source the stackrc file to enable the director command line tools.

   Example

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

2. Create a custom YAML environment file (my-neutron-environment.yaml).

   Note

   Values inside parentheses are sample values that are used in the example commands in this procedure. Substitute these sample values with values that are appropriate for your site.

   Example

   $ vi /home/stack/templates/my-neutron-environment.yaml

   Copy to Clipboard Toggle word wrap

   Tip

   The undercloud includes a set of Orchestration service templates that form the plan for your overcloud creation. You can customize aspects of the overcloud with environment files, which are YAML-formatted files that override parameters and resources in the core Orchestration service template collection. You can include as many environment files as necessary.

3. In the environment file, add a parameter_defaults section. Under this section, add the DNS domain for ports extension, dns_domain_ports.

   Example

   parameter_defaults:
     NeutronPluginExtensions: "qos,port_security,dns_domain_ports"

   Copy to Clipboard Toggle word wrap

   Note

   If you set dns_domain_ports, ensure that the deployment does not also use dns_domain, the DNS Integration extension. These extensions are incompatible, and both extensions cannot be defined simultaneously.

4. Also in the parameter_defaults section, add your domain name (example.com) using the NeutronDnsDomain parameter.

   Example

   parameter_defaults:
       NeutronPluginExtensions: "qos,port_security,dns_domain_ports"
       NeutronDnsDomain: "example.com"

   Copy to Clipboard Toggle word wrap

5. Run the openstack overcloud deploy command and include the core Orchestration templates, environment files, and this new environment file.

   Important

   The order of the environment files is important because the parameters and resources defined in subsequent environment files take precedence.

   Example

   $ openstack overcloud deploy --templates \
   -e [your-environment-files] \
   -e /usr/share/openstack-tripleo-heat-templates/environments/services/my-neutron-environment.yaml

   Copy to Clipboard Toggle word wrap

Verification

1. Log in to the overcloud, and create a new port (new_port) on a network (public). Assign a DNS name (my_port) to the port.

   Example

   $ source ~/overcloudrc
   $ openstack port create --network public --dns-name my_port new_port

   Copy to Clipboard Toggle word wrap

2. Display the details for your port (new_port).

   Example

   $ openstack port show -c dns_assignment -c dns_domain -c dns_name -c name new_port

   Copy to Clipboard Toggle word wrap

   Sample output

   +-------------------------+----------------------------------------------+
   | Field                   | Value                                        |
   +-------------------------+----------------------------------------------+
   | dns_assignment          | fqdn='my_port.example.com',                  |
   |                         | hostname='my_port',                          |
   |                         | ip_address='10.65.176.113'                   |
   | dns_domain              | example.com                                  |
   | dns_name                | my_port                                      |
   | name                    | new_port                                     |
   +-------------------------+----------------------------------------------+

   Copy to Clipboard Toggle word wrap

   Under dns_assignment, the fully qualified domain name (fqdn) value for the port contains a concatenation of the DNS name (my_port) and the domain name (example.com) that you set earlier with NeutronDnsDomain.

3. Create a new VM instance (my_vm) using the port (new_port) that you just created.

   Example

   $ openstack server create --image rhel --flavor m1.small --port new_port my_vm

   Copy to Clipboard Toggle word wrap

4. Display the details for your port (new_port).

   Example

   $ openstack port show -c dns_assignment -c dns_domain -c dns_name -c name new_port

   Copy to Clipboard Toggle word wrap

   Sample output

   +-------------------------+----------------------------------------------+
   | Field                   | Value                                        |
   +-------------------------+----------------------------------------------+
   | dns_assignment          | fqdn='my_vm.example.com',                    |
   |                         | hostname='my_vm',                            |
   |                         | ip_address='10.65.176.113'                   |
   | dns_domain              | example.com                                  |
   | dns_name                | my_vm                                        |
   | name                    | new_port                                     |
   +-------------------------+----------------------------------------------+

   Copy to Clipboard Toggle word wrap

   Note that the Compute service changes the dns_name attribute from its original value (my_port) to the name of the instance with which the port is associated (my_vm).

Procedure

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

2. Source the undercloud credentials file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. Create a custom YAML environment file.

   Example

   $ vi /home/stack/templates/my-environment.yaml

   Copy to Clipboard Toggle word wrap

4. Your environment file must contain the keywords parameter_defaults. Under these keywords, add the extra DHCP option extension, extra_dhcp_opt.

   Example

   parameter_defaults:
     NeutronPluginExtensions: "qos,port_security,extra_dhcp_opt"

   Copy to Clipboard Toggle word wrap

5. Run the deployment command and include the core heat templates, environment files, and this new custom environment file.

   Important

   The order of the environment files is important because the parameters and resources defined in subsequent environment files take precedence.

   Example

   $ openstack overcloud deploy --templates \
   -e <your_environment_files> \
   -e /usr/share/openstack-tripleo-heat-templates/environments/services/octavia.yaml \
   -e /home/stack/templates/my-environment.yaml

   Copy to Clipboard Toggle word wrap

Verification

1. Source your credentials file.

   Example

   $ source ~/overcloudrc

   Copy to Clipboard Toggle word wrap

2. Create a new port (new_port) on a network (public). Assign a valid attribute from the DHCP specification to the new port.

   Example

   $ openstack port create --extra-dhcp-option \
   name=domain-name,value=test.domain --extra-dhcp-option \
   name=ntp-server,value=192.0.2.123 --network public new_port

   Copy to Clipboard Toggle word wrap

3. Display the details for your port (new_port).

   Example

   $ openstack port show new_port -c extra_dhcp_opts

   Copy to Clipboard Toggle word wrap

   Sample output

   +-----------------+-----------------------------------------------------------------+
   | Field           | Value                                                           |
   +-----------------+-----------------------------------------------------------------+
   | extra_dhcp_opts | ip_version='4', opt_name='domain-name', opt_value='test.domain' |
   |                 | ip_version='4', opt_name='ntp-server', opt_value='192.0.2.123'  |
   +-----------------+-----------------------------------------------------------------+

   Copy to Clipboard Toggle word wrap

Procedure

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

2. Source the undercloud credentials file:

   $ source ~/stackrc

   Copy to Clipboard Toggle word wrap

3. To enable the port_numa_affinity_policy extension, open the environment file where the NeutronPluginExtensions parameter is defined, and add port_numa_affinity_policy to the list:

   parameter_defaults:
     NeutronPluginExtensions: "qos,port_numa_affinity_policy"

   Copy to Clipboard Toggle word wrap

4. Add the environment file that you modified to the stack with your other environment files, and redeploy the overcloud:

   Important

   The order of the environment files is important because the parameters and resources defined in subsequent environment files take precedence.

   $ openstack overcloud deploy --templates \
   -e <your_environment_files> \
   -e /home/stack/templates/<custom_environment_file>.yaml

   Copy to Clipboard Toggle word wrap

Verification

1. Source your credentials file.

   Example

   $ source ~/overcloudrc

   Copy to Clipboard Toggle word wrap

2. Create a new port.

   When you create a port, use one of the following options to specify the NUMA affinity policy to apply to the port:

   • --numa-policy-required - NUMA affinity policy required to schedule this port.
   • --numa-policy-preferred - NUMA affinity policy preferred to schedule this port.

   • --numa-policy-legacy - NUMA affinity policy using legacy mode to schedule this port.

     Example

     $ openstack port create --network public \
       --numa-policy-legacy  myNUMAAffinityPort

     Copy to Clipboard Toggle word wrap

3. Display the details for your port.

   Example

   $ openstack port show myNUMAAffinityPort -c numa_affinity_policy

   Copy to Clipboard Toggle word wrap

   Sample output

   When the extension is loaded, the Value column should read, legacy, preferred or required. If the extension has failed to load, Value reads None:

   +----------------------+--------+
   | Field                | Value  |
   +----------------------+--------+
   | numa_affinity_policy | legacy |
   +----------------------+--------+

   Copy to Clipboard Toggle word wrap

Procedure

1. On the undercloud host, logged in as the stack user, create a custom YAML environment file.

   Example

   $ vi /home/stack/templates/my-modules-environment.yaml

   Copy to Clipboard Toggle word wrap
   Tip

   Heat uses a set of plans called templates to install and configure your environment. You can customize aspects of the overcloud with a custom environment file, which is a special type of template that provides customization for your heat templates.

2. In the YAML environment file under parameter_defaults, set ExtraKernelModules to the name of the module that you want to load.

   Example

   ComputeParameters:
     ExtraKernelModules:
       nf_conntrack_proto_gre: {}
   ControllerParameters:
     ExtraKernelModules:
       nf_conntrack_proto_gre: {}

   Copy to Clipboard Toggle word wrap

3. Run the openstack overcloud deploy command and include the core heat templates, environment files, and this new custom environment file.

   Important

   The order of the environment files is important as the parameters and resources defined in subsequent environment files take precedence.

   Example

   $ openstack overcloud deploy --templates \
   -e [your-environment-files] \
   -e /usr/share/openstack-tripleo-heat-templates/environments/services/my-modules-environment.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. On every Compute node, in the metadata_rate_limiting section of /var/lib/config-data/puppet-generated/neutron/etc/neutron/neutron.conf, set values for the following parameters:

   rate_limit_enabled

   enables you to limit the rate of metadata requests. The default value is false. Set the value to true to enable metadata rate limiting.

   ip_versions

   the IP version, 4, used for metadata IP addresses on which you want to control query rates. RHOSP does not yet support metadata rate limiting for IPv6 networks.

   base_window_duration

   the time span, in seconds, during which query requests are limited. The default value is 10 seconds.

   base_query_rate_limit

   the maximum number of requests allowed during the base_window_duration. The default value is 10 requests.

   burst_window_duration

   the time span, in seconds, that a request rate higher than the base_window_duration is allowed. The default value is 10 seconds.

   burst_query_rate_limit

   the maximum number of requests allowed during the burst_window_duration. The default value is 10 requests.

   Example

   In this example, the Networking service is configured for a base time and rate that allows instances to query the IPv4 metadata service IP address 6 times over a 60 second period. The Networking service is also configured for a burst time and rate that allows a higher rate of 2 queries during shorter periods of 10 seconds each:

   [metadata_rate_limiting]
   rate_limit_enabled = True
   ip_versions = 4
   base_window_duration = 60
   base_query_rate_limit = 6
   burst_window_duration = 10
   burst_query_rate_limit = 2

   Copy to Clipboard Toggle word wrap

2. Restart the metadata service.

   Depending on the Networking service mechanism driver your deployment uses, do one of the following:

   ML2/OVN

   On the Compute nodes, restart tripleo_ovn_metadata_agent.service.

   ML2/OVS

   On the Compute nodes, restart tripleo_neutron_metadata_agent.service.