Chapter 10. Configuring Quality of Service (QoS) policies

1. If the qos extension is not already enabled for OpenStack Networking in /etc/neutron/plugins/ml2/<agent_name>_agent.ini, then follow these steps:

   1. Create a custom Heat environment file, and add the following lines:

      parameter_defaults:
        NeutronSriovAgentExtensions: 'qos'

      Important

      YAML files are extremely sensitive about where in the file a parameter is placed. Make sure that parameter_defaults: starts in the first column (no leading whitespace characters), and your parameter value pair starts in column three (the parameter has two whitespace characters in front of it).

   2. Run the Red Hat OpenStack Platform director command, openstack overcloud deploy and include all your current environment files and this custom new one.

      For more information, see "Modifying the overcloud environment" in the Director Installation and Usage guide.

2. Review the list of tenants and determine the id of where you need to create QoS policy:

   # openstack project list
   +----------------------------------+----------+
   | ID                               | Name     |
   +----------------------------------+----------+
   | 4b0b98f8c6c040f38ba4f7146e8680f5 | auditors |
   | 519e6344f82e4c079c8e2eabb690023b | services |
   | 80bf5732752a41128e612fe615c886c6 | demo     |
   | 98a2f53c20ce4d50a40dac4a38016c69 | admin    |
   +----------------------------------+----------+

3. Create a QoS policy named bw-limiter in the admin tenant:

   # openstack network qos policy create --project 98a2f53c20ce4d50a40dac4a38016c69 bw-limiter

4. Configure the policing rules for the bw-limiter policy:

   # openstack network qos rule create --type bandwidth-limit --max-kbps 3000 --max-burst-kbits 30000 bw-limiter

5. Configure a neutron port to apply the bw-limiter policy:

   # openstack port set --qos-policy bw-limiter port_name_or_id

6. Review the QoS rule. For example:

   # openstack network qos policy show 9be535c3-daa2-4d7b-88ea-e8de16
   
   +-------------------+---------------------------------+
   | Field             | Value                           |
   +-------------------+---------------------------------+
   | id                | 9be535c3-daa2-4d7b-88ea-e8de16  |
   | rule_type         | bandwidth_limit                 |
   | description       |                                 |
   | max_kbps          | 3000                            |
   | max_burst_kbps    | 300                             |
   +-------------------+---------------------------------+

Procedure

1. If you are:

   • using ML2/OVN, skip to step 2.
   • using ML2/OVS without a tunneling protocol, skip to step 2.

   • using ML2/OVS with a tunneling protocol (VXLAN and GRE), then perform the following steps:

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

        $ source ~/stackrc

     2. Create a custom YAML environment file.

        Example

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

     3. In the YAML environment file under parameter_defaults, add the following lines:

        parameter_defaults:
            ControllerExtraConfig:
                neutron::config::server_config:
                  agent/dscp_inherit:
                    value: true

        When dscp_inherit is true, the Networking service copies the DSCP value of the inner header to the outer header.

     4. 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 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/ \
        neutron-ovs.yaml \
        -e /home/stack/templates/my-neutron-environment.yaml

2. Source your credentials file.

   Example

   $ source ~/overcloudrc

3. Create a new QoS policy:

   Example

   openstack network qos policy create --project 98a2f53c20ce4d50a40dac4a38016c69 qos-web-servers

4. Create a DSCP rule and apply it to a policy.

   Example

   In this example, a DSCP rule is created using DSCP mark 18 and is applied to the qos-web-servers policy:

   openstack network qos rule create --type dscp-marking --dscp-mark 18 qos-web-servers

   Sample output

   Created a new dscp_marking_rule:
   +-----------+--------------------------------------+
   | Field     | Value                                |
   +-----------+--------------------------------------+
   | dscp_mark | 18                                   |
   | id        | d7f976ec-7fab-4e60-af70-f59bf88198e6 |
   +-----------+--------------------------------------+

5. You can change the DSCP value assigned to a rule.

   Example

   openstack network qos rule set --dscp-mark 22 qos-web-servers d7f976ec-7fab-4e60-af70-f59bf88198e6

6. You can delete a DSCP rule.

   Example

   openstack network qos rule delete qos-web-servers d7f976ec-7fab-4e60-af70-f59bf88198e6