vpp/docs/usecases/contiv/MULTI_NIC_SETUP.rst
Nathan Skrzypczak 9ad39c026c docs: better docs, mv doxygen to sphinx
This patch refactors the VPP sphinx docs
in order to make it easier to consume
for external readers as well as VPP developers.

It also makes sphinx the single source
of documentation, which simplifies maintenance
and operation.

Most important updates are:

- reformat the existing documentation as rst
- split RELEASE.md and move it into separate rst files
- remove section 'events'
- remove section 'archive'
- remove section 'related projects'
- remove section 'feature by release'
- remove section 'Various links'
- make (Configuration reference, CLI docs,
  developer docs) top level items in the list
- move 'Use Cases' as part of 'About VPP'
- move 'Troubleshooting' as part of 'Getting Started'
- move test framework docs into 'Developer Documentation'
- add a 'Contributing' section for gerrit,
  docs and other contributer related infos
- deprecate doxygen and test-docs targets
- redirect the "make doxygen" target to "make docs"

Type: refactor

Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
2021-10-13 23:22:32 +00:00

25 lines
804 B
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Setting Up a Node with Multiple NICs
====================================
- First, configure hardware interfaces in the VPP startup config, as
described
`here <https://github.com/contiv/vpp/blob/master/docs/VPP_CONFIG.md#multi-nic-configuration>`__.
- For each interface owned by Linux, you need to provide individual
configuration for each interface used by VPP in the Node
Configuration for the node in the ``contiv-vpp.yaml``. For example,
if both ``ens3`` and ``ens4`` are known to Linux, then put the
following stanza into the nodes NodeConfig:
::
...
NodeConfig:
- NodeName: "ubuntu-1"
StealInterface: "ens3"
StealInterface: "ens4"
...
If only ``ens3`` is known to Linux, you only put a line for ``ens3``
into the above NodeConfig.