summaryrefslogtreecommitdiffstats
path: root/src/plugins
diff options
context:
space:
mode:
authorJohn DeNisco <jdenisco@cisco.com>2020-01-10 10:07:26 -0500
committerOle Trøan <otroan@employees.org>2020-01-10 17:20:21 +0000
commit7c9fe920ce30efaef5a848ba346d0c7b53a77dd4 (patch)
treef0aa216bf2a2e33fe14d7f41fdc63011c4f27665 /src/plugins
parent854eb6e3ff87ace211a45a8053424d8432bd5755 (diff)
docs: Edit FEATURE.yaml files so they can be published
Type: docs Signed-off-by: John DeNisco <jdenisco@cisco.com> Change-Id: I7280e5c5ad10a66c0787a5282291a2ef000bff5f
Diffstat (limited to 'src/plugins')
-rw-r--r--src/plugins/abf/FEATURE.yaml2
-rw-r--r--src/plugins/builtinurl/FEATURE.yaml4
-rw-r--r--src/plugins/crypto_ia32/FEATURE.yaml2
-rw-r--r--src/plugins/crypto_ipsecmb/FEATURE.yaml2
-rw-r--r--src/plugins/crypto_openssl/FEATURE.yaml2
-rw-r--r--src/plugins/dhcp/FEATURE.yaml4
-rw-r--r--src/plugins/gtpu/FEATURE.yaml4
-rw-r--r--src/plugins/http_static/FEATURE.yaml2
-rw-r--r--src/plugins/igmp/FEATURE.yaml2
-rw-r--r--src/plugins/l3xc/FEATURE.yaml2
-rw-r--r--src/plugins/lacp/FEATURE.yaml4
-rw-r--r--src/plugins/lb/FEATURE.yaml4
-rw-r--r--src/plugins/mactime/FEATURE.yaml2
-rw-r--r--src/plugins/map/FEATURE.yaml4
-rw-r--r--src/plugins/mdata/FEATURE.yaml6
-rw-r--r--src/plugins/nat/FEATURE.yaml8
-rw-r--r--src/plugins/svs/FEATURE.yaml2
17 files changed, 28 insertions, 28 deletions
diff --git a/src/plugins/abf/FEATURE.yaml b/src/plugins/abf/FEATURE.yaml
index f77d1a30e98..b9f3285daa3 100644
--- a/src/plugins/abf/FEATURE.yaml
+++ b/src/plugins/abf/FEATURE.yaml
@@ -15,6 +15,6 @@ features:
- ABF runs as an input feature in the L3 path
-description: "ACL Based Forwarding"
+description: ""
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/builtinurl/FEATURE.yaml b/src/plugins/builtinurl/FEATURE.yaml
index ff992999ca1..ba8e3c7ea7b 100644
--- a/src/plugins/builtinurl/FEATURE.yaml
+++ b/src/plugins/builtinurl/FEATURE.yaml
@@ -1,9 +1,9 @@
---
-name: Builtin URL support for the static http/https server (builtinurl)
+name: Builtin URL support for the static http or https server
maintainer: Dave Barach <dave@barachs.net>
features:
- Builtin URLs for the static http/https server
-description: "Adds a set of URLs to the static http/https server.
+description: "The (builtinurl) plugin adds a set of URLs to the static http/https server.
Current URLs, all of which return data in .json fmt:
<root-url>/version.json - vpp version info
<root-url>/interface_list.json - list of interfaces
diff --git a/src/plugins/crypto_ia32/FEATURE.yaml b/src/plugins/crypto_ia32/FEATURE.yaml
index 29f81f4dcaa..206caceb2d4 100644
--- a/src/plugins/crypto_ia32/FEATURE.yaml
+++ b/src/plugins/crypto_ia32/FEATURE.yaml
@@ -5,6 +5,6 @@ features:
- CBC(128, 192, 256)
- GCM(128, 192, 256)
-description: "native crypto-engine"
+description: "An implentation of a native crypto-engine"
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/crypto_ipsecmb/FEATURE.yaml b/src/plugins/crypto_ipsecmb/FEATURE.yaml
index ec33a1bcf9e..3ca03bf5515 100644
--- a/src/plugins/crypto_ipsecmb/FEATURE.yaml
+++ b/src/plugins/crypto_ipsecmb/FEATURE.yaml
@@ -6,6 +6,6 @@ features:
- CBC(128, 192, 256)
- GCM(128, 192, 256)
-description: "IPSecMB crypto-engine"
+description: ""
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/crypto_openssl/FEATURE.yaml b/src/plugins/crypto_openssl/FEATURE.yaml
index 41f939948cf..da0a0812595 100644
--- a/src/plugins/crypto_openssl/FEATURE.yaml
+++ b/src/plugins/crypto_openssl/FEATURE.yaml
@@ -9,6 +9,6 @@ features:
- DES, 3DES
- MD5
-description: "openssl crypto-engine"
+description: ""
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/dhcp/FEATURE.yaml b/src/plugins/dhcp/FEATURE.yaml
index acc7eaf1781..469af29cee5 100644
--- a/src/plugins/dhcp/FEATURE.yaml
+++ b/src/plugins/dhcp/FEATURE.yaml
@@ -1,11 +1,11 @@
---
-name: Dynamic Host Configuration Protocol (DHCP)
+name: Dynamic Host Configuration Protocol
maintainer: Dave Barach <dave@barachs.net>, Neale Ranns <nranns@cisco.com>
features:
- DHCP client (v4/v6)
- DHCPv6 prefix delegation
- DHCP Proxy / Option 82
-description: "DHCP client"
+description: "An implemenation of the Dynamic Host Configuration Protocol (DHCP) client"
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/gtpu/FEATURE.yaml b/src/plugins/gtpu/FEATURE.yaml
index fbd576ba2ce..2ce20ca501c 100644
--- a/src/plugins/gtpu/FEATURE.yaml
+++ b/src/plugins/gtpu/FEATURE.yaml
@@ -1,10 +1,10 @@
---
-name: GTPU
+name: GPRS Tunneling Protocol
maintainer: Hongjun Ni <hongjun.ni@intel.com>
features:
- GTPU decapsulation
- GTPU encapsulation
-description: "GPRS Tunnelling Protocol"
+description: "An implementation of the GPRS Tunnelling Protocol"
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/http_static/FEATURE.yaml b/src/plugins/http_static/FEATURE.yaml
index 67a68425d6d..d40855f2de2 100644
--- a/src/plugins/http_static/FEATURE.yaml
+++ b/src/plugins/http_static/FEATURE.yaml
@@ -1,5 +1,5 @@
---
-name: Static http/https server (http_static)
+name: Static http https server
maintainer: Dave Barach <dave@barachs.net>
features:
- An extensible static http/https server with caching
diff --git a/src/plugins/igmp/FEATURE.yaml b/src/plugins/igmp/FEATURE.yaml
index aab4960c7c6..686ef6d7099 100644
--- a/src/plugins/igmp/FEATURE.yaml
+++ b/src/plugins/igmp/FEATURE.yaml
@@ -4,6 +4,6 @@ maintainer: Neale Ranns <nranns@cisco.com>
features:
- IGMPv3 only.
-description: "IGMP"
+description: "An implementation of the Internet Group Management Protocol (IGMP)"
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/l3xc/FEATURE.yaml b/src/plugins/l3xc/FEATURE.yaml
index 3c2bf07b306..5086fee3c57 100644
--- a/src/plugins/l3xc/FEATURE.yaml
+++ b/src/plugins/l3xc/FEATURE.yaml
@@ -8,6 +8,6 @@ features:
and adding a default route with the same path. However, the L3XC is more
efficient in memory and CPU
-description: "L3-xconnect"
+description: ""
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/lacp/FEATURE.yaml b/src/plugins/lacp/FEATURE.yaml
index 4812c0230e4..516efde32bf 100644
--- a/src/plugins/lacp/FEATURE.yaml
+++ b/src/plugins/lacp/FEATURE.yaml
@@ -1,8 +1,8 @@
---
-name: Link Aggregation Control Protocol (LACP)
+name: Link Aggregation Control Protocol
maintainer: Steven Luong <sluong@cisco.com>
features:
- Support LACP version 1 specification including marker protocol
-description: "Link Aggregation Control Protocol implementation"
+description: "Link Aggregation Control Protocol implementation (LACP)"
state: production
properties: [API, CLI, STATS, MULTITHREAD]
diff --git a/src/plugins/lb/FEATURE.yaml b/src/plugins/lb/FEATURE.yaml
index 7456e68e5c1..9a9887c36aa 100644
--- a/src/plugins/lb/FEATURE.yaml
+++ b/src/plugins/lb/FEATURE.yaml
@@ -1,5 +1,5 @@
---
-name: LB
+name: Load Balancer
maintainer: Pfister <ppfister@cisco.com>, Hongjun Ni <hongjun.ni@intel.com>
features:
- GRE tunnel mode
@@ -8,6 +8,6 @@ features:
- Consistent Hash
- Connection Track
-description: "Load Balancer"
+description: ""
state: production
properties: [API, CLI, MULTITHREAD]
diff --git a/src/plugins/mactime/FEATURE.yaml b/src/plugins/mactime/FEATURE.yaml
index f24450e8375..144c70b4feb 100644
--- a/src/plugins/mactime/FEATURE.yaml
+++ b/src/plugins/mactime/FEATURE.yaml
@@ -1,5 +1,5 @@
---
-name: Time-range-based MAC-address filter (mactime)
+name: Time-range-based MAC-address filter
maintainer: Dave Barach <dave@barachs.net>
features:
- Static / time-range / data quota based MAC address filter
diff --git a/src/plugins/map/FEATURE.yaml b/src/plugins/map/FEATURE.yaml
index b5055914480..18df5f5aa0d 100644
--- a/src/plugins/map/FEATURE.yaml
+++ b/src/plugins/map/FEATURE.yaml
@@ -1,12 +1,12 @@
---
-name: Mapping of Address and Port (MAP)
+name: Mapping of Address and Port
maintainer: Ole Troan <ot@cisco.com>
features:
- LW46 BR (RFC7596):
- Fragmentation and Reassembly
- MAP-E BR (RFC7597)
- MAP-T BR (RFC7599)
-description: "IPv4 as a service mechanisms. Tunnel or translate
+description: "Mapping of Address and Port (MAP): IPv4 as a service mechanisms. Tunnel or translate
an IPv4 address, an IPv4 subnet or a shared IPv4 address.
In shared IPv4 address mode, only UDP, TCP and restricted
ICMP is supported."
diff --git a/src/plugins/mdata/FEATURE.yaml b/src/plugins/mdata/FEATURE.yaml
index d25a71d41e9..d1843e69f58 100644
--- a/src/plugins/mdata/FEATURE.yaml
+++ b/src/plugins/mdata/FEATURE.yaml
@@ -1,11 +1,11 @@
---
-name: Buffer Metadata Change Tracker (mdata)
+name: Buffer Metadata Change Tracker
maintainer: Dave Barach <dave@barachs.net>
features:
- Buffer Metadata Change Tracker
description: |-
- Buffer Metadata Change Tracker
- Uses the before / after graph node main loop performance
+ The Buffer Metadata Change Tracker (mdata)
+ uses the before / after graph node main loop performance
callback hooks to snapshoot buffer metadata, then
compare and summarize results per-node.
Answers the question "what buffer metadata does a particular
diff --git a/src/plugins/nat/FEATURE.yaml b/src/plugins/nat/FEATURE.yaml
index 65cd9590c69..183db052771 100644
--- a/src/plugins/nat/FEATURE.yaml
+++ b/src/plugins/nat/FEATURE.yaml
@@ -1,5 +1,5 @@
---
-name: Network Address Translation (NAT)
+name: Network Address Translation
maintainer:
- Ole Troan <ot@cisco.com>
- Filip Varga <fivarga@cisco.com>
@@ -20,8 +20,8 @@ features:
- NAT66
- DS-lite
- 464XLAT
-description: "The NAT plugin offers a multiple address translation functions.
- These can be used in a raft of different scenarios. CPE, CGN,
- etc."
+description: "The Network Address Translation (NAT) plugin offers a multiple address
+ translation functions. These can be used in a raft of different
+ scenarios. CPE, CGN, etc."
state: production
properties: [API, CLI, STATS, MULTITHREAD]
diff --git a/src/plugins/svs/FEATURE.yaml b/src/plugins/svs/FEATURE.yaml
index 7941df314f4..f37234a0e7d 100644
--- a/src/plugins/svs/FEATURE.yaml
+++ b/src/plugins/svs/FEATURE.yaml
@@ -10,6 +10,6 @@ features:
- Tables are bound to interfaces.
- SVS runs as an input feature in the L3 path
-description: "Source VRF Select"
+description: ""
state: production
properties: [API, CLI, MULTITHREAD]