aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Pettit <jpettit@nicira.com>2009-06-09 23:32:30 -0700
committerJustin Pettit <jpettit@nicira.com>2009-06-09 23:32:30 -0700
commitd798447957d98428fdddae744f2e58d2802286d8 (patch)
treedea7e64be4796f59f99421eb8d0b44d009e5fb19
parentc611392b0eefb4f8dbb94d635bbf532ac14ef143 (diff)
vswitch: Clarify what "ingress" means in policing
The man page for ovs-vswitchd.conf explains how ingress policing works. However, what "ingress" means is a bit confusing depending on the perspective. For vSwitch, it's from the switch's perspective. This means on a PIF, it's the rate traffic comes into the box. On a VIF, it's the rate traffic can be *transmitted* from a VM. This commit clarifies the man page a bit. Thanks to Johan for pointing out the problem.
-rw-r--r--vswitchd/ovs-vswitchd.conf.5.in16
1 files changed, 11 insertions, 5 deletions
diff --git a/vswitchd/ovs-vswitchd.conf.5.in b/vswitchd/ovs-vswitchd.conf.5.in
index 89872184..81e007fb 100644
--- a/vswitchd/ovs-vswitchd.conf.5.in
+++ b/vswitchd/ovs-vswitchd.conf.5.in
@@ -275,11 +275,17 @@ dropped. Shaping uses queues to delay packets so that egress traffic
leaves at the specified rate.
.ST "Ingress Policing"
-The rate at which traffic is allowed to enter through a particular
-physical port can be configured with ingress policing. The rate is
-specified in kilobits (1000 bits) per second with a maximum burst size
-specified in kilobits (1000 bits). The burst size should be at least
-the size of the port's MTU.
+The rate at which traffic is allowed to enter through a port may be
+configured with ingress policing. Note that "ingress" is from the
+perspective of \fBovs\-vswitchd\fR. If configured on a physical port,
+then it limits the rate at which traffic is allowed into the system from
+the outside. If configured on a virtual interface that is connected to
+a virtual machine, then it limits the rate at which the guest is able to
+transmit.
+
+The rate is specified in kilobits (1000 bits) per second with a maximum
+burst size specified in kilobits (1000 bits). The burst size should be at
+least the size of the interface's MTU.
A port may be configured to enforce ingress policing by defining the
key \fBport.\fIname\fB.ingress.policing-rate\fR with an integer