diff options
| author |   Maxime Peim <mpeim@cisco.com> | 2022-11-17 15:29:10 +0000 |
|---|---|---|
| committer |   Dave Wallace <dwallacelf@gmail.com> | 2022-11-22 19:21:25 +0000 |
| commit | ed5f291a2283dd2882a39a3019e82fd325079631 (patch) | |
| tree | e8ce460cc191a921fe442dff0206a53f997ab2f2 /docs | |
| parent | 9a8d12d9b317379cfff56fd415a5f7a13bb58453 (diff) | |
policer: adding documentation
Type: docs
Several kinds of policers are implemented in VPP.
However, they could differ from the RFCs it is
said they are from.
Additionally, the CLI command's help has been
updated with the current list of acceptable
parameters.
Signed-off-by: Maxime Peim <mpeim@cisco.com>
Change-Id: Ic9bf94e1094bea0fcc87ccaa882c2c5f88824041
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_images/policer-1r2c-aware.png | bin | 0 -> 73985 bytes | |||
| -rw-r--r-- | docs/_images/policer-1r2c-blind.png | bin | 0 -> 67455 bytes | |||
| -rw-r--r-- | docs/_images/policer-1r2c-bucket.png | bin | 0 -> 54000 bytes | |||
| -rw-r--r-- | docs/_images/policer-1r3c-aware.png | bin | 0 -> 69156 bytes | |||
| -rw-r--r-- | docs/_images/policer-1r3c-blind.png | bin | 0 -> 48057 bytes | |||
| -rw-r--r-- | docs/_images/policer-1r3c-bucket.png | bin | 0 -> 116653 bytes | |||
| -rw-r--r-- | docs/_images/policer-2r3c-aware.png | bin | 0 -> 73084 bytes | |||
| -rw-r--r-- | docs/_images/policer-2r3c-blind.png | bin | 0 -> 59999 bytes | |||
| -rw-r--r-- | docs/_images/policer-2r3c-bucket.png | bin | 0 -> 101915 bytes | |||
| -rw-r--r-- | docs/developer/corefeatures/index.rst | 1 | ||||
| l--------- | docs/developer/corefeatures/policer.rst | 1 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 3 |
12 files changed, 5 insertions, 0 deletions
diff --git a/docs/_images/policer-1r2c-aware.png b/docs/_images/policer-1r2c-aware.png Binary files differnew file mode 100644 index 00000000000..8eb4f8d341f --- /dev/null +++ b/docs/_images/policer-1r2c-aware.png diff --git a/docs/_images/policer-1r2c-blind.png b/docs/_images/policer-1r2c-blind.png Binary files differnew file mode 100644 index 00000000000..ec8a1dd62f4 --- /dev/null +++ b/docs/_images/policer-1r2c-blind.png diff --git a/docs/_images/policer-1r2c-bucket.png b/docs/_images/policer-1r2c-bucket.png Binary files differnew file mode 100644 index 00000000000..dc4587074d7 --- /dev/null +++ b/docs/_images/policer-1r2c-bucket.png diff --git a/docs/_images/policer-1r3c-aware.png b/docs/_images/policer-1r3c-aware.png Binary files differnew file mode 100644 index 00000000000..6a904b5abc7 --- /dev/null +++ b/docs/_images/policer-1r3c-aware.png diff --git a/docs/_images/policer-1r3c-blind.png b/docs/_images/policer-1r3c-blind.png Binary files differnew file mode 100644 index 00000000000..1bcef6adf6d --- /dev/null +++ b/docs/_images/policer-1r3c-blind.png diff --git a/docs/_images/policer-1r3c-bucket.png b/docs/_images/policer-1r3c-bucket.png Binary files differnew file mode 100644 index 00000000000..24094ee79f8 --- /dev/null +++ b/docs/_images/policer-1r3c-bucket.png diff --git a/docs/_images/policer-2r3c-aware.png b/docs/_images/policer-2r3c-aware.png Binary files differnew file mode 100644 index 00000000000..214dc62c6aa --- /dev/null +++ b/docs/_images/policer-2r3c-aware.png diff --git a/docs/_images/policer-2r3c-blind.png b/docs/_images/policer-2r3c-blind.png Binary files differnew file mode 100644 index 00000000000..a2faa1fb9f4 --- /dev/null +++ b/docs/_images/policer-2r3c-blind.png diff --git a/docs/_images/policer-2r3c-bucket.png b/docs/_images/policer-2r3c-bucket.png Binary files differnew file mode 100644 index 00000000000..a0c427281be --- /dev/null +++ b/docs/_images/policer-2r3c-bucket.png diff --git a/docs/developer/corefeatures/index.rst b/docs/developer/corefeatures/index.rst index 1012387a17a..8daadaabc27 100644 --- a/docs/developer/corefeatures/index.rst +++ b/docs/developer/corefeatures/index.rst @@ -20,3 +20,4 @@ Core Features eventviewer stats selinux_doc + policer diff --git a/docs/developer/corefeatures/policer.rst b/docs/developer/corefeatures/policer.rst new file mode 120000 index 00000000000..cc75a1a6ec0 --- /dev/null +++ b/docs/developer/corefeatures/policer.rst @@ -0,0 +1 @@ +../../../src/vnet/policer/policer.rst
\ No newline at end of file diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 97bd0b573e1..8ab46744793 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -113,6 +113,7 @@ buildingrst builtin builtinurl Builtinurl +burstiness busybox BV bvi @@ -843,6 +844,8 @@ Pnat PoC podSubnet policer +Policer +policers Policers Pollable portranges |
