Chapter 7. Using Quality of Service (QoS) policies to manage data traffic

Procedure

1. If you are using the ML2/SR-IOV mechanism driver, you must enable the qos agent extension on the Compute nodes, also referred to as the RHOSO data plane.

   For more information, see Configuring the Networking service for QoS policies for SR-IOV.

2. Add the required QoS configuration. Place the configuration in the edpm_network_config_template under ansibleVars:

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneNodeSet
   metadata:
     name: my-data-plane-node-set
   spec:
     ...
     nodeTemplate:
       ...
       ansible:
         ansibleVars:
           edpm_network_config_template: |
             ---
             OvnHardwareOffloadedQos: true
             ...

3. If you want to create DSCP marking policies, add edpm_ovn_encap_tos: '1' under ansibleVars:

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneNodeSet
   metadata:
     name: my-data-plane-node-set
   spec:
     ...
     nodeTemplate:
       ...
       ansible:
         ansibleVars:
           edpm_network_config_template: |
             ---
             OvnHardwareOffloadedQos: true
           edpm_ovn_encap_tos: 1
             ...

   When edpm_ovn_encap_tos is enabled (has a value of 1), the Networking service copies the DSCP value of the inner header to the outer header. The default is 0.

4. Save the OpenStackDataPlaneNodeSet CR definition file.

5. Apply the updated OpenStackDataPlaneNodeSet CR configuration:

   $ oc apply -f my_data_plane_node_set.yaml

6. Verify that the data plane resource has been updated:

   $ oc get openstackdataplanenodeset

   Sample output

   NAME                     STATUS MESSAGE
   my-data-plane-node-set   False  Deployment not started

7. Create a file on your workstation to define the OpenStackDataPlaneDeployment CR, for example, my_data_plane_deploy.yaml:

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneDeployment
   metadata:
     name: my-data-plane-deploy

   Tip

   Give the definition file and the OpenStackDataPlaneDeployment CR a unique and descriptive name that indicates the purpose of the modified node set.

8. Add the OpenStackDataPlaneNodeSet CR that you modified:

   spec:
     nodeSets:
       - my-data-plane-node-set

9. Save the OpenStackDataPlaneDeployment CR deployment file.

10. Deploy the modified OpenStackDataPlaneNodeSet CR:

    $ oc create -f my_data_plane_deploy.yaml -n openstack

    You can view the Ansible logs while the deployment executes:

    $ oc get pod -l app=openstackansibleee -n openstack -w
    
    $ oc logs -l app=openstackansibleee -n openstack -f \
    --max-log-requests 10

11. Verify that the modified OpenStackDataPlaneNodeSet CR is deployed:

    Example

    $ oc get openstackdataplanedeployment -n openstack

    Sample output

    NAME                     STATUS   MESSAGE
    my-data-plane-node-set   True     Setup Complete

12. Repeat the oc get command until you see the NodeSet Ready message:

    Example

    $ oc get openstackdataplanenodeset -n openstack

    Sample output

    NAME                     STATUS   MESSAGE
    my-data-plane-node-set   True     NodeSet Ready

    For information on the meaning of the returned status, see Data plane conditions and states in the Deploying Red Hat OpenStack Services on OpenShift guide.

Procedure

1. Open the OpenStackDataPlaneNodeSet CR definition file for the node set you want to update, for example, my_data_plane_node_set.yaml.

2. Add the required QoS configuration, NeutronSriovAgentExtensions: "qos".

   Place the configuration in the edpm_network_config_template under ansibleVars:

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneNodeSet
   metadata:
     name: my-data-plane-node-set
   spec:
     ...
     nodeTemplate:
       ...
       ansible:
         ansibleVars:
           edpm_network_config_template: |
             ---
             NeutronSriovAgentExtensions: "qos"
             ...

3. Save the OpenStackDataPlaneNodeSet CR definition file.

4. Apply the updated OpenStackDataPlaneNodeSet CR configuration:

   $ oc apply -f my_data_plane_node_set.yaml

5. Verify that the data plane resource has been updated:

   $ oc get openstackdataplanenodeset

   Sample output

   NAME                     STATUS MESSAGE
   my-data-plane-node-set   False  Deployment not started

6. Create a file on your workstation to define the OpenStackDataPlaneDeployment CR, for example, my_data_plane_deploy.yaml:

   apiVersion: dataplane.openstack.org/v1beta1
   kind: OpenStackDataPlaneDeployment
   metadata:
     name: my-data-plane-deploy

   Tip

   Give the definition file and the OpenStackDataPlaneDeployment CR a unique and descriptive name that indicates the purpose of the modified node set.

7. Add the OpenStackDataPlaneNodeSet CR that you modified:

   spec:
     nodeSets:
       - my-data-plane-node-set

8. Save the OpenStackDataPlaneDeployment CR deployment file.

9. Deploy the modified OpenStackDataPlaneNodeSet CR:

   $ oc create -f my_data_plane_deploy.yaml -n openstack

   You can view the Ansible logs while the deployment executes:

   $ oc get pod -l app=openstackansibleee -n openstack -w
   
   $ oc logs -l app=openstackansibleee -n openstack -f \
   --max-log-requests 10

10. Verify that the modified OpenStackDataPlaneNodeSet CR is deployed:

    Example

    $ oc get openstackdataplanedeployment -n openstack

    Sample output

    NAME                     STATUS   MESSAGE
    my-data-plane-node-set   True     Setup Complete

11. Repeat the oc get command until you see the NodeSet Ready message:

    Example

    $ oc get openstackdataplanenodeset -n openstack

    Sample output

    NAME                     STATUS   MESSAGE
    my-data-plane-node-set   True     NodeSet Ready

    For information on the meaning of the returned status, see Data plane conditions and states in the Deploying Red Hat OpenStack Services on OpenShift guide.

1. Obtain the UUID for the NIC switch agent:

   $ openstack network agent list

2. With the neutron-sriov-nic-agent UUID, run the following command:

   $ openstack network agent show <uuid>

   Example

   $ openstack network agent show 8676ccb3-1de0-4ca6-8fb7-b814015d9e5f \
   --max-width 70

   Sample output

   You should see an agent object with a field called configuration. When the qos extension is loaded, the extensions field should contain qos in its list.

   -------------------------------------------------------------------+
   | Field             | Value                                          |
   -------------------------------------------------------------------+
   | admin_state_up    | UP                                             |
   | agent_type        | NIC Switch agent                               |
   | alive             | :-)                                            |
   | availability_zone | None                                           |
   | binary            | neutron-sriov-nic-agent                        |
   | configuration     | {device_mappings: {}, devices: 0, extensi | | | ons: [qos], resource_provider_bandwidths: |
   |                   | {}, resource_provider_hypervisors: {}, reso | | | urce_provider_inventory_defaults: {allocatio | | | n_ratio: 1.0, min_unit: 1, step_size: 1,  |
   |                   | reserved: 0}}                                |
   | created_at        | 2024-08-08 08:22:57                            |
   | description       | None                                           |
   | ha_state          | None                                           |
   | host              | edpm-compute-0.ctlplane.example.com            |
   | id                | 8676ccb3-1de0-4ca6-8fb7-b814015d9e5f           |
   | last_heartbeat_at | 2024-08-08 08:24:27                            |
   | resources_synced  | None                                           |
   | started_at        | 2024-08-08 08:22:57                            |
   | topic             | N/A                                            |
   -------------------------------------------------------------------+