Red Hat Bugzilla – Bug 1286499
[Docs] [Networking] Provide an outline of network QoS and the configuration thereof
Last modified: 2016-04-13 00:41:37 EDT
In Red Hat Enterprise Linux OpenStack Platform 8, there are new capabilities for shaping and controlling network traffic. The following items must be added to the Networking Guide, ideally in the section on tenant networking -
* What is QoS, and to what network types can it be applied? For example, all
networks, or only tenant networks?
* How does QoS interact with organization - tenant - policy relationships.
* Are there any considerations in terms of usage or security?
* How can users create and configure QoS policies?
Assigning to Martin for review.
Assigning Radek as the QA contact.
Radek - could you take a look at the changes for this bug?
The content looks good to me. There are two minor formatting suggestions that I have, and I see a kind of dash that probably won't work if copied and pasted to a reader's terminal:
1 - In:
RHEL OpenStack Platform 8 introduces support for network quality-of-service (QoS) policies. +
Why the forced break ("+" at the end of the line)? I'd say the second sentence could be on the same line.
2 - In:
+# neutron port-update <port id> –qos-policy bw-limiter
You can make asciidoc render a nice replaceable parameter (in italics) this way:
+# neutron port-update _port id_ –qos-policy bw-limiter
About the dash: notice the difference between – and -. The former is a Unicode dash (en dash, probably) and I'm pretty sure that neutron won't take –qos-policy, –max_kbps, and –max_burst_kbps as options; instead, it will think they are parameters. (I don't have an OSP 8 system at hand, but try e.g. "ls –l" on any Linux system.) Can you replace these dashes with standard ASCII minus signs (hyphens) so folks can copy and paste the commands?
Removed '+' character as requested.
Replaced emdash characters.
Tested replaceable parameter formatting, but from the render testing I would suggest that the <port id> usage seems more easily distinguishable than italics?
In addition, using the <port id> style would persist through a copy/paste operation, compared to italics formatting, which would be lost.
Works for me. Marking as verified.
This content is now live on the Customer Portal.