Bug 1286499

Summary:	[Docs] [Networking] Provide an outline of network QoS and the configuration thereof
Product:	Red Hat OpenStack	Reporter:	Andrew Dahms <adahms>
Component:	documentation	Assignee:	Martin Lopes <mlopes>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Radek Bíba <rbiba>
Severity:	medium	Docs Contact:
Priority:	high
Version:	8.0 (Liberty)	CC:	mlopes, rbiba, yeylon
Target Milestone:	ga	Keywords:	Documentation
Target Release:	8.0 (Liberty)
Hardware:	Unspecified
OS:	Unspecified
URL:	http://docs.openstack.org/developer/neutron/devref/quality_of_service.html
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2016-04-13 04:41:37 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:	1194126
Bug Blocks:

Description Andrew Dahms 2015-11-30 03:50:55 UTC

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?

Comment 1 Andrew Dahms 2015-12-02 03:16:37 UTC

Assigning to Martin for review.

Comment 4 Andrew Dahms 2015-12-07 02:56:26 UTC

Assigning Radek as the QA contact.

Radek - could you take a look at the changes for this bug?

Comment 5 Radek Bíba 2015-12-07 08:03:59 UTC

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. +
These 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:

[subs="verbatim,quotes"]
+----
+# 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?

Comment 6 Martin Lopes 2015-12-11 03:46:21 UTC

 Removed '+' character as requested.

Comment 7 Martin Lopes 2015-12-11 03:48:40 UTC

Replaced emdash characters.

Comment 8 Martin Lopes 2015-12-11 04:02:45 UTC

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.

Comment 9 Radek Bíba 2015-12-11 07:38:54 UTC

Works for me. Marking as verified.

Comment 10 Andrew Dahms 2016-04-13 04:41:37 UTC

This content is now live on the Customer Portal.

Closing.