X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Fconfiguration%2Freference.rst;fp=docs%2Fgettingstarted%2Fusers%2Fconfiguring%2Fstartup.rst;h=84b2fd758879b793ef5a9fcb56434f863b3a8025;hb=9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160;hp=e594b6a08a45e5bdb0281fe6b23d45221020c633;hpb=f47122e07e1ecd0151902a3cabe46c60a99bee8e;p=vpp.git diff --git a/docs/gettingstarted/users/configuring/startup.rst b/docs/configuration/reference.rst similarity index 93% rename from docs/gettingstarted/users/configuring/startup.rst rename to docs/configuration/reference.rst index e594b6a08a4..84b2fd75887 100644 --- a/docs/gettingstarted/users/configuring/startup.rst +++ b/docs/configuration/reference.rst @@ -1,90 +1,7 @@ -.. _startup: +.. _configuration_reference: -========================================== -VPP Configuration - CLI and 'startup.conf' -========================================== - -After a successful installation, VPP installs a startup config file named -*startup.conf* in the */etc/vpp/* directory. This file can be tailored to -make VPP run as desired, but contains default values for typical installations. - -Below are more details about this file and some of the the parameters and values -it contains. - -Command-line Arguments ----------------------- - -Before we describe details of the startup configuration file (startup.conf) it -should be mentioned that VPP can be started without a startup configuration -file. - -Parameters are grouped by a section name. When providing more than one -parameter to a section, all parameters for that section must be wrapped in -curly braces. For example, to start VPP with configuration data via the -command line with the section name *'unix'*: - -.. code-block:: console - - $ sudo /usr/bin/vpp unix { interactive cli-listen 127.0.0.1:5002 } - -The command line can be presented as a single string or as several; anything -given on the command line is concatenated with spaces into a single string -before parsing. VPP applications must be able to locate their own executable -images. The simplest way to ensure this will work is to invoke a VPP -application by giving its absolute path. For example: -*'/usr/bin/vpp '* At startup, VPP applications parse through their -own ELF-sections [primarily] to make lists of init, configuration, and exit -handlers. - -When developing with VPP, in gdb it's often sufficient to start an application -like this: - -.. code-block:: console - - (gdb) run unix interactive - - -Startup Configuration File (startup.conf) ------------------------------------------ - -The more typical way to specify the startup configuration to VPP is with the -startup configuration file (startup.conf). - -The path of the file is provided to the VPP application on the command line. -This is typically at /etc/vpp/startup.conf. If VPP is installed as a package -a default startup.conf file is provided at this location. - -The format of the configuration file is a simple text file with the same content -as the command line. - -**A very simple startup.conf file:** - -.. code-block:: console - - $ cat /etc/vpp/startup.conf - unix { - nodaemon - log /var/log/vpp/vpp.log - full-coredump - cli-listen localhost:5002 - } - - api-trace { - on - } - - dpdk { - dev 0000:03:00.0 - } - -VPP is instructed to load this file with the -c option. For example: - -.. code-block:: console - - $ sudo /usr/bin/vpp -c /etc/vpp/startup.conf - -Configuration Parameters ------------------------- +Configuration Reference +======================= Below is the list of some section names and their associated parameters. This is not an exhaustive list, but should give you an idea of how VPP can be configured. @@ -587,7 +504,7 @@ buffers-per-numa number Increase number of buffers allocated, needed only in scenarios with large number of interfaces and worker threads. Value is per numa node. -Default is 16384 (8192 if running unpriviledged) +Default is 16384 (8192 if running unprivileged) .. code-block:: console