openstack/neutron
Code Issues Proposed changes

Merge "docs: Correct various mistakes in QoS doc"

Browse Source
This commit is contained in:
Zuul 2017-11-29 01:48:21 +00:00 committed by Gerrit Code Review
commit 921cfa9cdb
1 changed files with 18 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/source/admin/config-qos.rst
View File

@ -209,26 +209,21 @@ First, create a QoS policy and its bandwidth limit rule:
.. code-block:: console .. code-block:: console
$ openstack network qos policy create bw-limiter $ openstack network qos policy create bw-limiter
Created a new policy:
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
| Field | Value | | Field | Value |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
| description | | | description | |
| id | 5df855e9-a833-49a3-9c82-c0839a5f103f | | id | 5df855e9-a833-49a3-9c82-c0839a5f103f |
| is_default | False | | is_default | False |
| name | qos1 | | name | bw-limiter |
| project_id | 4db7c1ed114a4a7fb0f077148155c500 | | project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| revision_number | 1 |
| rules | [] | | rules | [] |
| shared | False | | shared | False |
| tags | [] |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
$ openstack network qos rule create --type bandwidth-limit --max-kbps 3000 \ $ openstack network qos rule create --type bandwidth-limit --max-kbps 3000 \
--max-burst-kbits 300 --egress bw-limiter --max-burst-kbits 300 --egress bw-limiter
Created a new bandwidth_limit_rule:
+----------------+--------------------------------------+ +----------------+--------------------------------------+
| Field | Value | | Field | Value |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
@ -236,8 +231,11 @@ First, create a QoS policy and its bandwidth limit rule:
| id | 92ceb52f-170f-49d0-9528-976e2fee2d6f | | id | 92ceb52f-170f-49d0-9528-976e2fee2d6f |
| max_burst_kbps | 300 | | max_burst_kbps | 300 |
| max_kbps | 3000 | | max_kbps | 3000 |
| name | None |
| project_id | |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
.. note:: .. note::
The QoS implementation requires a burst value to ensure proper behavior of The QoS implementation requires a burst value to ensure proper behavior of
@ -253,7 +251,6 @@ the already created policy. In the next example, we will assign the
.. code-block:: console .. code-block:: console
$ openstack port list $ openstack port list
+--------------------------------------+-----------------------------------+ +--------------------------------------+-----------------------------------+
| ID | Fixed IP Addresses | | ID | Fixed IP Addresses |
+--------------------------------------+-----------------------------------+ +--------------------------------------+-----------------------------------+
@ -278,8 +275,6 @@ Ports can be created with a policy attached to them too.
.. code-block:: console .. code-block:: console
$ openstack port create --qos-policy bw-limiter --network private port1 $ openstack port create --qos-policy bw-limiter --network private port1
Created a new port:
+-----------------------+--------------------------------------------------+ +-----------------------+--------------------------------------------------+
| Field | Value | | Field | Value |
+-----------------------+--------------------------------------------------+ +-----------------------+--------------------------------------------------+
@ -291,6 +286,7 @@ Ports can be created with a policy attached to them too.
| binding_vif_type | unbound | | binding_vif_type | unbound |
| binding_vnic_type | normal | | binding_vnic_type | normal |
| created_at | 2017-05-15T08:43:00Z | | created_at | 2017-05-15T08:43:00Z |
| data_plane_status | None |
| description | | | description | |
| device_id | | | device_id | |
| device_owner | | | device_owner | |
@ -313,6 +309,7 @@ Ports can be created with a policy attached to them too.
| status | DOWN | | status | DOWN |
| subnet_id | None | | subnet_id | None |
| tags | [] | | tags | [] |
| trunk_details | None |
| updated_at | 2017-05-15T08:43:00Z | | updated_at | 2017-05-15T08:43:00Z |
+-----------------------+--------------------------------------------------+ +-----------------------+--------------------------------------------------+
@ -357,41 +354,32 @@ be used.
.. code-block:: console .. code-block:: console
$ openstack network qos policy create --default bw-limiter $ openstack network qos policy create --default bw-limiter
Created a new policy:
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
| Field | Value | | Field | Value |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
| description | | | description | |
| id | 5df855e9-a833-49a3-9c82-c0839a5f103f | | id | 5df855e9-a833-49a3-9c82-c0839a5f103f |
| is_default | True | | is_default | True |
| name | qos1 | | name | bw-limiter |
| project_id | 4db7c1ed114a4a7fb0f077148155c500 | | project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| revision_number | 1 |
| rules | [] | | rules | [] |
| shared | False | | shared | False |
| tags | [] |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
$ openstack network qos policy set --no-default bw-limiter $ openstack network qos policy set --no-default bw-limiter
Created a new policy:
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
| Field | Value | | Field | Value |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
| description | | | description | |
| id | 5df855e9-a833-49a3-9c82-c0839a5f103f | | id | 5df855e9-a833-49a3-9c82-c0839a5f103f |
| is_default | False | | is_default | False |
| name | qos1 | | name | bw-limiter |
| project_id | 4db7c1ed114a4a7fb0f077148155c500 | | project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| revision_number | 1 |
| rules | [] | | rules | [] |
| shared | False | | shared | False |
| tags | [] |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
Administrator enforcement Administrator enforcement
------------------------- -------------------------
@ -410,12 +398,11 @@ attached port.
.. code-block:: console .. code-block:: console
$ openstack network qos rule set --max-kbps 2000 --max-burst-kbps 200 \ $ openstack network qos rule set --max-kbps 2000 --max-burst-kbits 200 \
--ingress bw-limiter 92ceb52f-170f-49d0-9528-976e2fee2d6f --ingress bw-limiter 92ceb52f-170f-49d0-9528-976e2fee2d6f
$ openstack network qos rule show \ $ openstack network qos rule show \
bw-limiter 92ceb52f-170f-49d0-9528-976e2fee2d6f bw-limiter 92ceb52f-170f-49d0-9528-976e2fee2d6f
+----------------+--------------------------------------+ +----------------+--------------------------------------+
| Field | Value | | Field | Value |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
@ -423,6 +410,8 @@ attached port.
| id | 92ceb52f-170f-49d0-9528-976e2fee2d6f | | id | 92ceb52f-170f-49d0-9528-976e2fee2d6f |
| max_burst_kbps | 200 | | max_burst_kbps | 200 |
| max_kbps | 2000 | | max_kbps | 2000 |
| name | None |
| project_id | |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
Just like with bandwidth limiting, create a policy for DSCP marking rule: Just like with bandwidth limiting, create a policy for DSCP marking rule:
@ -430,7 +419,6 @@ Just like with bandwidth limiting, create a policy for DSCP marking rule:
.. code-block:: console .. code-block:: console
$ openstack network qos policy create dscp-marking $ openstack network qos policy create dscp-marking
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
| Field | Value | | Field | Value |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
@ -439,10 +427,8 @@ Just like with bandwidth limiting, create a policy for DSCP marking rule:
| is_default | False | | is_default | False |
| name | dscp-marking | | name | dscp-marking |
| project_id | 4db7c1ed114a4a7fb0f077148155c500 | | project_id | 4db7c1ed114a4a7fb0f077148155c500 |
| revision_number | 1 |
| rules | [] | | rules | [] |
| shared | False | | shared | False |
| tags | [] |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
You can create, update, list, delete, and show DSCP markings You can create, update, list, delete, and show DSCP markings
@ -452,13 +438,13 @@ with the neutron client:
$ openstack network qos rule create --type dscp-marking --dscp-mark 26 \ $ openstack network qos rule create --type dscp-marking --dscp-mark 26 \
dscp-marking dscp-marking
Created a new dscp marking rule
+----------------+--------------------------------------+ +----------------+--------------------------------------+
| Field | Value | | Field | Value |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
| id | 115e4f70-8034-4176-8fe9-2c47f8878a7d |
| dscp_mark | 26 | | dscp_mark | 26 |
| id | 115e4f70-8034-4176-8fe9-2c47f8878a7d |
| name | None |
| project_id | |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
.. code-block:: console .. code-block:: console
@ -467,7 +453,6 @@ with the neutron client:
dscp-marking 115e4f70-8034-4176-8fe9-2c47f8878a7d dscp-marking 115e4f70-8034-4176-8fe9-2c47f8878a7d
$ openstack network qos rule list dscp-marking $ openstack network qos rule list dscp-marking
+--------------------------------------+----------------------------------+ +--------------------------------------+----------------------------------+
| ID | DSCP Mark | | ID | DSCP Mark |
+--------------------------------------+----------------------------------+ +--------------------------------------+----------------------------------+
@ -476,12 +461,13 @@ with the neutron client:
$ openstack network qos rule show \ $ openstack network qos rule show \
dscp-marking 115e4f70-8034-4176-8fe9-2c47f8878a7d dscp-marking 115e4f70-8034-4176-8fe9-2c47f8878a7d
+----------------+--------------------------------------+ +----------------+--------------------------------------+
| Field | Value | | Field | Value |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
| id | 115e4f70-8034-4176-8fe9-2c47f8878a7d |
| dscp_mark | 22 | | dscp_mark | 22 |
| id | 115e4f70-8034-4176-8fe9-2c47f8878a7d |
| name | None |
| project_id | |
+----------------+--------------------------------------+ +----------------+--------------------------------------+
$ openstack network qos rule delete \ $ openstack network qos rule delete \
@ -503,7 +489,6 @@ You can also include minimum bandwidth rules in your policy:
| revision_number | 1 | | revision_number | 1 |
| rules | [] | | rules | [] |
| shared | False | | shared | False |
| tags | [] |
+-------------------+--------------------------------------+ +-------------------+--------------------------------------+
$ openstack network qos rule create \ $ openstack network qos rule create \
@ -558,5 +543,4 @@ It is also possible to combine several rules in one policy:
| | u'id': u'da858b32-44bc-43c9-b92b-cf6e2fa836ab', | | | u'id': u'da858b32-44bc-43c9-b92b-cf6e2fa836ab', |
| | u'qos_policy_id': u'8491547e-add1-4c6c-a50e-42121237256c'}] | | | u'qos_policy_id': u'8491547e-add1-4c6c-a50e-42121237256c'}] |
| shared | False | | shared | False |
| tags | [] |
+-------------------+-------------------------------------------------------------------+ +-------------------+-------------------------------------------------------------------+