summaryrefslogtreecommitdiffstats
path: root/docs/index.rst
blob: 391c5832820b62e8cb4cbc74976afc65b229261e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
.. fdio-vpp documentation master file, created by
   sphinx-quickstart on Thu Apr 12 11:02:31 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

#########################################
What is the Vector Packet Processor (VPP)
#########################################

FD.io's Vector Packet Processor (VPP) is a fast, scalable layer 2-4
multi-platform network stack. It runs in `Linux Userspace <https://en.wikipedia.org/wiki/User_space>`_
on multiple architectures including x86, ARM, and Power architectures.
VPP is built using the `Dataplane Development Kit (DPDK) <https://en.wikipedia.org/wiki/Data_Plane_Development_Kit>`_.

VPP benefits include high performance, proven technology, modularity,
and a rich feature set.

VPP supports integration with OpenStack and Kubernetes. Network
management features include configuration, counters, sampling and
more. For developers, VPP includes plugin extensibility,
high-performance event-logging, and multiple kinds of packet
tracing. Development debug images include complete symbol tables, and
extensive consistency checking.

Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls
and Load Balancers, to name a few. Out of the box, VPP can work as a
software development kit or an appliance.

For more details click on the links below or press next.

.. toctree::
   :maxdepth: 2

   whatisvpp/index.rst
   gettingstarted/index
   links/index
   usecases/index
   featuresbyrelease/index
   troubleshooting/index
   events/index
   reference/index
   relatedprojects/index
   archive/index
   about.rst
class="n">DEFAULT_TEMPLATES = os.path.dirname(__file__) + "/siphon_templates" ap = argparse.ArgumentParser() ap.add_argument("--log-file", default=DEFAULT_LOGFILE, help="Log file [%s]" % DEFAULT_LOGFILE) ap.add_argument("--log-level", default=DEFAULT_LOGLEVEL, choices=["debug", "info", "warning", "error", "critical"], help="Logging level [%s]" % DEFAULT_LOGLEVEL) ap.add_argument("--type", '-t', metavar="siphon_type", default=DEFAULT_SIPHON, choices=siphon.process.siphons.keys(), help="Siphon type to process [%s]" % DEFAULT_SIPHON) ap.add_argument("--format", '-f', default=DEFAULT_FORMAT, choices=siphon.process.formats.keys(), help="Output format to generate [%s]" % DEFAULT_FORMAT) ap.add_argument("--output", '-o', metavar="file", default=DEFAULT_OUTPUT, help="Output file (uses stdout if not defined) [%s]" % DEFAULT_OUTPUT) ap.add_argument("--templates", metavar="directory", default=DEFAULT_TEMPLATES, help="Path to render templates directory [%s]" % DEFAULT_TEMPLATES) ap.add_argument("input", nargs='+', metavar="input_file", help="Input .siphon files") args = ap.parse_args() logging.basicConfig(filename=args.log_file, level=getattr(logging, args.log_level.upper(), None)) log = logging.getLogger("siphon_process") # Determine where to send the generated output if args.output is None: out = sys.stdout else: out = open(args.output, "w+") # Get our processor klass = siphon.process.siphons[args.type] processor = klass(template_directory=args.templates, format=args.format) # Load the input files processor.load_json(args.input) # Process the data processor.process(out=out) # All done