196 Commits

Author SHA1 Message Date
Paul Vinciguerra
7fa3dd2881 docs: cleanup typos on readthrough
Type: style

Change-Id: I3b15035ea6c13cd1ca3cdc9dfa9b10a6e1be9880
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-10-28 13:51:13 +00:00
Nathan Skrzypczak
66f2a8891f docs: Add macos build documentation
Type: docs

Change-Id: Iee03aacab2cfcb4e87190302dc641e8273b7f096
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-10-09 13:18:47 +00:00
Dave Barach
56f62afe63 docs: grammar police raid
Edit the front-page intro text. Fix egregious grammar errors,
including an "it's" vs. "its" blunder.

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: If9d7d07899c402cd49bbae988110a15216035b02
2019-10-07 13:20:41 +00:00
Dave Barach
66a332cf19 docs: add packet-generator writeup
Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I4abb5c17e6fdfeaed5bbadb2ce83098dde6d05b1
2019-10-04 19:03:31 +00:00
Dave Barach
f5667c3055 misc: add vnet classify filter set support
Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I79b216d2499df143f53977e5b70382f6f887e0bc
2019-09-26 19:39:06 +00:00
Dave Barach
33909777c6 misc: unify pcap rx / tx / drop trace
Use a single vnet_pcap_t in vlib_global_main, specifically to support
unified tracing

Update sphinx docs, doxygen tags

Type: refactor
Ticket: VPP-1776

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Id15d41a596712968c0714cef1bd2cd5bc9cbdd55
2019-09-23 16:20:06 +00:00
Dave Barach
9137e54006 misc: classifier-based packet trace filter
See .../src/vnet/classify/trace_classify.h for the business end
of the scheme.

It would be best to hash pkts, prefetch buckets, and do the primary
table lookups two at a time. The inline as given works, but perf
tuning will be required. "At least it works..."

Add "classify filter" debug cli, for example:
classify filter mask l3 ip4 src dst \
  match l3 ip4 dst 192.168.2.10 src 192.168.1.10

Add "pcap rx | tx trace ... filter" to use the current classify filter chain

Patch includes sphinx documentation and doxygen tags.

Next step: device-driver integration

Type: feature

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I05b1358a769f61e6d32470e0c87058f640486b26
2019-09-20 15:55:25 +00:00
jdenisco
8b1c7f34fb docs: run-sphinx-docs-merged
Type: docs

Signed-off-by: jdenisco <jdenisco@cisco.com>
Change-Id: I571222f3e3672253930700e23cca4812dde84a6d
2019-09-11 19:20:56 +00:00
Dave Barach
5b786fb894 docs: improve unformat documentation
Specifically: document the unformat specifiers "%=", "%|", and correct
usage of unformat_line_input.

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I254f9c4a61c5c8d3edbf76f521e5f38fb89150f1
2019-09-09 18:37:35 +00:00
Andrew Yourtchenko
61b28ba69d misc: 19.08 new features
The full RELEASE.md diff is b610f2022c9f4e10a922e7b57c80ec77cd45d021

Change-Id: Ide6d85d41bdc836a03390a50ab94f6ebbaae0b28
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
(cherry picked from commit 1c586de48cc76fc6eac50f5d87003e2a80aa43e7)
2019-08-26 17:08:23 +00:00
jdenisco
c54235776c docs: Add Ray's ACL use case
Change-Id: Id99f16953a23a4be4cc1fb94419ea8282fa720e8
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-08-08 22:57:31 +00:00
Ole Troan
6595ff7f88 api: api socket respect unix runtime directory
socksvr {} should respect the unix runtime directory.
Default is now /run/vpp/api.sock
The 'default' keyword is deprecated.
The user is responsible for creating directories outside of the
unix runtime directory.

Not yet done: Exit VPP when socket cannot be opened.
              (currently only process exits).

Type: fix
Signed-off-by: Ole Troan <ot@cisco.com>
Change-Id: I6dd66ed58a3d7e02674dfa16d72c1d7bba07b79e
2019-08-08 11:23:31 +00:00
Nathan Skrzypczak
7858d6e9e2 docs: Add more quic plugin documentation
Type: docs

Change-Id: I0209769f73a46ddad7c2625ad0f774ee2eef43dd
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-08-05 16:19:54 +00:00
Nathan Skrzypczak
55c68c9521 docs: Small fixes and ordering
* deactivtates the TODOs on doxygen (were empty)
* This move punt.md to readthedocs (should be the new
place for dev doc ?)
* Makes Handoff queue demo plugin a child of dev doc
in doxygen

Type: fix

Change-Id: I1f0476a911b35208212af8dd608bc76160efd22a
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2019-08-01 18:01:57 +00:00
Dave Barach
af57799fde docs: add binary api trace replay details
Folks need to know that they MUST carefully control the set of plugins
to avoid feeding messages to the wrong binary API message handlers.

Change-Id: Iefeeda6670aae4627446caee21717b847305c9b5
Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-26 14:46:17 +00:00
Dave Barach
d455e5a2ef docs: improve home gateway use-case documentation
Add plugin config, systemd config, netplan config, software
installation via ssh, and a quick HowTo for setting up a double-nat
test gateway.

Fix a minor doc bug which caused a complaint on vpp-dev@lists.fd.io:
/etc/vpp/startup.conf -> /setup.gate, but the vpp configuration file
wasn't explicitly tagged with the name /setup.gate.

Type: docs

Change-Id: Ib219040d7c3c8b50ed66f8e9d3afd3dcf51b6b7b
Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-22 17:28:09 +00:00
jdenisco
675c2396a1 docs: Fix conf.py for read the docs
Change-Id: Iaaf9e6ef5acc82fb751c851cc943cf0c48a8940d
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-07-19 10:22:13 -04:00
Dave Barach
edff805464 docs: add compressed core file description
To the issue reporting page

Change-Id: I3d2b53521bcb1b9b4a85802a84427f17390f0f77
Type: docs
Signed-off-by: Dave Barach <dave@barachs.net>
2019-07-12 18:01:10 +00:00
Benoît Ganne
6d72c175ed docs: how to enable coredump with systemd
Type: docs

Change-Id: I1f657389fec716cc6cdc942803e65f861ffea5f5
Signed-off-by: Benoît Ganne <bganne@cisco.com>
2019-07-12 01:51:59 +00:00
jdenisco
08b8ce1d6c docs: Update the vhost section
Change-Id: Ic7a144ffda0d0a3e0f6f9bc1a4790ab36fdf002e
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-06-27 15:03:04 +00:00
Neale Ranns
05cac30a92 FIB: correctly report IPv6 FIB Unicast and Multicast memory usage (VPP-1578)"
and document scaling

Change-Id: I65d8999e65616d77e525963c770d91e9b0d5e593
Signed-off-by: Neale Ranns <nranns@cisco.com>
2019-05-30 11:52:00 +00:00
jdenisco
65e410b3f3 docs: Add some packages for building the docs
Change-Id: I7af427ba6378ddd8480a153a65ec11c578bab12e
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-28 18:43:57 +00:00
jdenisco
3bfeff7a98 docs: Fix Versions and Titles
Change-Id: I131e33a570bff8b22c767585d03e2eb281dd7184
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-17 20:31:10 +00:00
jdenisco
8a6e1b190c docs: Update sphinx, requirements, support markdown tables
Change-Id: Ie7c546f5720b10fe5423397204e1ab5c22d7a2ba
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-16 17:42:13 +00:00
Dave Barach
8fa01c17aa DOC ONLY: document VLIB_INIT_FUNCTION scheme
Change-Id: I15c4256621da6c8d47b1a7c41755ee6587996757
Signed-off-by: Dave Barach <dave@barachs.net>
2019-05-16 16:59:19 +00:00
jdenisco
0da895dffe docs: Add 1904
Change-Id: Icf0e01d1dec69d48664ed633205248359b653f4d
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-10 19:48:54 +00:00
Dave Wallace
c4a0afe5a6 Sphinx docs: Fix security vulnerability (VPP-1655)
Change-Id: I9b11d15866d708eb843936ebfd120940d284a2de
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
(cherry picked from commit facb4d44475cd0040cc8964be30180e1adeb2021)
2019-04-30 01:11:10 +00:00
Dave Barach
bcfcb8e7fe DOC ONLY: add a buffer metadata writeup
Change-Id: Ic8034cfe3d3c5a9c3d32e97e93e5d9334cc58ca2
Signed-off-by: Dave Barach <dave@barachs.net>
2019-04-29 17:12:01 -04:00
Francesco Spinelli
22e9c03ad2 docs: Add VPP inside the Cloud
This commit updates the VPP docs, adding the  VPP deployment and configuration inside the cloud

Change-Id: I97322deb57f0dfb1aa46cca301adbc91ce4a19f6
Signed-off-by: Francesco Spinelli <francescospinelli94@live.it>
2019-04-25 22:44:55 +00:00
Jim Thompson
f324dec0a3 fixing typos
Change-Id: I215e1e0208a073db80ec6f87695d734cf40fabe3
Signed-off-by: Jim Thompson <jim@netgate.com>
2019-04-08 21:54:17 +00:00
Dave Barach
6c1f56f08c DOC-ONLY: improve multi-arch documentation
Document CLIB_MARCH_FN and CLIB_MARCH_FN_SELECT

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I661ba2af79db8205d70fa87203d40a2e31b795e4
2019-03-22 15:52:57 -04:00
Steven Luong
1ea74b5df5 docs: break up long lines in vmxnet3.rst to avoid line wrap
Although it does not make a difference for the formatter with long lines, it
is easier to view and read the raw text with conventional editor when there no
line wrap. Just break up the long lines to 80 characters or less.

Change-Id: Ia916638e974abd19b8d19aee4dd72ff6a243ca48
Signed-off-by: Steven Luong <sluong@cisco.com>
2019-03-21 18:19:38 +00:00
Steven Luong
ee94ffa35d docs: Update vmxnet3 usecase
Update vmxnet3 usecase to reflect the current supported features.

Change-Id: I4558eb422d5b2641b3acfc7c0a3734bf31a8fb0f
Signed-off-by: Steven Luong <sluong@cisco.com>
2019-03-19 07:39:51 +00:00
Dave Barach
3fef8f811a DOC ONLY: fix g2 build documentation
Removed a broken paragraph, replaced it with a link.

Some nuisance white-space cleanups courtesy of emacs:
(add-hook 'before-save-hook 'delete-trailing-whitespace)

Change-Id: Ib348107c2dc0df8249461591015347d7b4f6fa4a
Signed-off-by: Dave Barach <dave@barachs.net>
2019-03-15 11:29:45 -04:00
Dave Barach
c4be9850f2 DOC ONLY: add packet handoff doc
Change-Id: I2e8076bb4f697819780e61ff761defdc74bf4f09
Signed-off-by: Dave Barach <dave@barachs.net>
2019-03-12 18:41:06 +00:00
jdenisco
e869269121 Fix centos build and build documentation
Change-Id: I326204d26b613254e39c6a0ffe9f9491981ba3c3
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-27 21:03:06 +00:00
Dave Barach
b93452b531 DOC ONLY: update bug report section
More detail on why it's important to supply .debs or .rpms which
precisely match core files. Probably won't help, but we can try...

Change-Id: I7842eaea0ef921b934e84b7f18f6a333b1381292
Signed-off-by: Dave Barach <dave@barachs.net>
2019-02-27 20:32:52 +00:00
jdenisco
2cefb06404 Add support for 19.01
Change-Id: I8583f6f6432d8d7c449f43d62d8707a1718f3240
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-02-23 09:42:48 +00:00
Paul Vinciguerra
0be7451ddb docs: use python3 for make docs.
Change-Id: If62b5ef563523b400fb5160d0343210407905094
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
2019-02-20 09:35:10 +00:00
Michal Cmarada
4e633e1043 VPP-1504: Remove JVPP
As part of JVPP migration this removes JVPP completely from VPP.

Change-Id: I6b74e7961aa474ae471e63fe43a624cd9fc3659b
Signed-off-by: Michal Cmarada <mcmarada@cisco.com>
2019-02-19 15:14:02 +00:00
jdenisco
f5de036c91 docs: Instructions for using vmxnet3 on mac
Change-Id: Ie6770e3a3801a23a6eb64cf1699ef0018eab6445
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-01-31 19:56:13 +00:00
Damjan Marion
6434430fd5 buffers: don't init metadata, as it is already initialized
Change-Id: Ia083050389853c25b069f0f8286d50d3f4aef527
Signed-off-by: Damjan Marion <damarion@cisco.com>
2019-01-20 19:24:46 +00:00
Dave Barach
1d052d2ef2 DOC ONLY: wireshark dissector upstreamed
Remove the last remnant from extra/wireshark, update the Sphinx docs

Change-Id: I5886557f17192475c03fcb0dfde581e1e63cea5c
Signed-off-by: Dave Barach <dave@barachs.net>
2019-01-17 09:31:00 -05:00
Dave Barach
8dc146e000 Update tcpdump / wireshark packet format writeup
Change-Id: I8195bae1421f68a823b86e12373840f5292ac0df
Signed-off-by: Dave Barach <dave@barachs.net>
2019-01-07 15:55:53 +00:00
jdenisco
82b22f75b9 docs: Add vmxmet3 driver
Change-Id: I96425804c310a1ac1b7f5f12bb636e591c7bd429
Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-12-17 21:35:27 +00:00
Dave Wallace
4659d0e823 docs: clarify vector element alignment description.
Change-Id: I6da153779010263e6fc4b51c64b01444aaadca17
Signed-off-by: Dave Wallace <dwallacelf@gmail.com>
2018-12-17 00:10:16 +00:00
jdenisco
6f666ad99a docs: Update the requirements
Change-Id: I80ea8a65317805c6542e338a92a21e6090f6c015
Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-12-13 08:14:30 +00:00
Dave Barach
10c5ff143a nsim: add packet loss simulation, docs
Change-Id: Ic9747541aad8148ebf7d520b525b99c4cc3961f3
Signed-off-by: Dave Barach <dave@barachs.net>
2018-12-06 18:28:47 +00:00
Neale Ranns
995ff06fb7 DOC-ONLY: MFIB documentation
Change-Id: I8c7277584f231dd4732a4c6013e156a5bb821f41
Signed-off-by: Neale Ranns <nranns@cisco.com>
2018-12-06 08:36:55 -08:00
Dave Barach
01fdbcca13 DOC ONLY: describe dispatch pcap tracing
and wireshark dissection of these traces.

Change-Id: I61029fd20d6d5f6c40638e3ea9223f2354abedba
Signed-off-by: Dave Barach <dave@barachs.net>
2018-12-05 15:26:45 +00:00