diff options
Diffstat (limited to 'docs/gettingstarted/users')
| -rw-r--r-- | docs/gettingstarted/users/configuring/hugepages.rst | 27 | ||||
| -rw-r--r-- | docs/gettingstarted/users/configuring/index.rst | 4 | ||||
| -rw-r--r-- | docs/gettingstarted/users/index.rst | 12 | ||||
| -rw-r--r-- | docs/gettingstarted/users/installing/centos.rst | 40 | ||||
| -rw-r--r-- | docs/gettingstarted/users/installing/index.rst | 20 | ||||
| -rw-r--r-- | docs/gettingstarted/users/installing/opensuse.rst | 9 | ||||
| -rw-r--r-- | docs/gettingstarted/users/installing/ubuntu.rst | 18 |
7 files changed, 74 insertions, 56 deletions
diff --git a/docs/gettingstarted/users/configuring/hugepages.rst b/docs/gettingstarted/users/configuring/hugepages.rst index 76ac7d0807d..da812e37048 100644 --- a/docs/gettingstarted/users/configuring/hugepages.rst +++ b/docs/gettingstarted/users/configuring/hugepages.rst @@ -3,13 +3,14 @@ Huge Pages ---------- -VPP requires *'hugepages'* to run. VPP will overwrite existing hugepage settings -when VPP is installed. By default, VPP sets the number of hugepages on a system -to 1024 2M hugepages (1G hugepages are no longer supported). This is the number -of hugepages on the system, not just used by VPP. +VPP requires *hugepages* to run during VPP operation, to manage large pages of memory. +During VPP installation, VPP will overwrite the existing hugepage settings. By +default, VPP sets the number of hugepages on a system to 1024 2M hugepages (1G hugepages +are no longer supported). This is the number of hugepages on the system, not just used by VPP. -When VPP is installed, the following file is copied to the system and used to apply the -hugepage settings on VPP installation and system reboot: +When VPP is installed, the following configuration file is copied to the system. The +hugepage settings are applied in the VPP installation and on system reboots. To set +the hugepage settings, perform the following commands: .. code-block:: console @@ -30,10 +31,10 @@ hugepage settings on VPP installation and system reboot: # to current shmmax value. kernel.shmmax=2147483648 -Depending on how the system is being used, this file can be updated to adjust +Depending on how the system is being used, this configuration file can be updated to adjust the number of hugepages reserved on a system. Below are some examples of -possible values. - +possible settings. + For a small VM with minimal workload: .. code-block:: console @@ -54,9 +55,9 @@ For a large system running multiple VMs, each needing its own set of hugepages: .. note:: If VPP is being run in a Virtual Machine (VM), the VM must have hugepage - backing. When VPP is installed, it will attempt to overwrite existing - hugepage setting. If the VM does not have hugepage backing, this will fail, - but this may go unnoticed. When the VM is rebooted, on system startup, - *'vm.nr_hugepages'* will be reapplied, will fail, and the VM will abort kernel + backing. When VPP is installed, it will attempt to overwrite existing the + hugepage setting. If the VM does not have hugepage backing, the install will fail, + but the failure may go unnoticed. When the VM is rebooted, on system startup, + *'vm.nr_hugepages'* will be reapplied, and will fail, and the VM will abort kernel boot, locking up the VM. To avoid this scenario, ensure the VM has enough hugepage backing. diff --git a/docs/gettingstarted/users/configuring/index.rst b/docs/gettingstarted/users/configuring/index.rst index f1244c61a4f..0de77adea6c 100644 --- a/docs/gettingstarted/users/configuring/index.rst +++ b/docs/gettingstarted/users/configuring/index.rst @@ -3,8 +3,8 @@ Configuring VPP ================== -There is some basic configuration that is needed to run FD.io VPP. This section -describes the basic configuration: +There is some basic configuration that needs to be performed before running +FD.io VPP. This section describes the configuration process: .. toctree:: :maxdepth: 2 diff --git a/docs/gettingstarted/users/index.rst b/docs/gettingstarted/users/index.rst index 36640a8b454..7bac586d65a 100644 --- a/docs/gettingstarted/users/index.rst +++ b/docs/gettingstarted/users/index.rst @@ -4,13 +4,19 @@ Users ######## +The Users section describe a basic VPP installation and configuration operation. +The installation and configuration of VPP can be done either manually, or by +using a configuration utility. + +This section covers the following areas: + The Users section covers basic VPP installation and configuration operations. This section covers the following areas: * Describes the different types of VPP packages -* Describes how to install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE) -* Explains how to configure, then use VPP -* Explains how to use the Configuration Utility +* Describes how to manually install VPP Binaries on different OS platforms (Ubuntu, Centos, openSUSE) +* Explains how to manually configure, then run VPP +* Explains how to install, then configure VPP using the Configuration Utility .. toctree:: :maxdepth: 2 diff --git a/docs/gettingstarted/users/installing/centos.rst b/docs/gettingstarted/users/installing/centos.rst index 470ca87be1f..dae24f6b4c8 100644 --- a/docs/gettingstarted/users/installing/centos.rst +++ b/docs/gettingstarted/users/installing/centos.rst @@ -8,7 +8,8 @@ Setup the fd.io Repository - Centos 7 Update the OS ------------- -Before starting the repository setup, it is a good idea to first update and upgrade the OS. +Before starting the repository setup, it is a good idea to first update and upgrade +the OS; run the following command to update the OS: .. code-block:: console @@ -18,8 +19,7 @@ Before starting the repository setup, it is a good idea to first update and upgr Point to the Repository ----------------------- -For CentOS based systems, there are two respositories to pull VPP binaries -from. +For CentOS based systems, there are two respositories to pull VPP binaries from: * CentOS NFV SIG Repository * Nexus Repository @@ -28,15 +28,14 @@ from. CentOS NFV SIG Repository ^^^^^^^^^^^^^^^^^^^^^^^^^ -VPP is not in the official CentOS 7 distro. However, CentOS has Special +VPP is not in the official CentOS 7 distro; however, CentOS has Special Interest Groups (SIG), which are smaller groups within the CentOS community that focus on a small set of issues. The CentOS NFV (Network Function Virtualization) SIG was created to provide a CentOS-based stack that will serve as a platform -for the deployment and testing of virtual network functions (VNFs). VPP has been -included in this SIG. To install released packages from the CentOS NFV SIG Repository on an updated -Centos 7 system, first, install the CentOS NFV SIG FIDO repo file: +Centos 7 system, first, install the CentOS NFV SIG FIDO repo file by running the +following command: .. code-block:: console @@ -109,7 +108,7 @@ VPP Latest Release """""""""""""""""" To allow *'yum'* access to the official VPP releases, create the file -*'/etc/yum.repos.d/fdio-release.repo'* with the following content: +*'/etc/yum.repos.d/fdio-release.repo'* with the following content. .. code-block:: console @@ -122,7 +121,7 @@ To allow *'yum'* access to the official VPP releases, create the file The *'yum install vpp'* command will install the most recent release. To install older releases, run the following command to get the list of releases -provided: +provided. .. code-block:: console @@ -133,10 +132,10 @@ sample *'yum --showduplicates list'* output and an example of installing a particular version of the RPMs. VPP Stable Branch -""""""""""""""""" +""""""""""""""""""" To allow *yum* access to the build artifacts for a VPP stable branch, create -the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content: +the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content. .. code-block:: console @@ -164,10 +163,10 @@ particular version of the RPMs. VPP Master Branch -""""""""""""""""" +""""""""""""""""""" To allow *yum* access to the nightly builds from the VPP master branch, create -the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content: +the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content. .. code-block:: console @@ -180,7 +179,7 @@ the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content: The *'yum install vpp'* command will install the most recent build on the branch. Run the following command to get the list of images produce by the -branch: +branch. .. code-block:: console @@ -194,18 +193,18 @@ particular version of the RPMs. Install VPP RPMs ================ -To install the VPP packet engine, run the following: +To install the VPP packet engine, run the following command: .. code-block:: console $ sudo yum install vpp -The **'vpp'** RPM depend on the **'vpp-lib'** and **'vpp-selinux-policy'** +The *vpp* RPM depends on the *vpp-lib* and *vpp-selinux-policy* RPMs, so they will be installed as well. .. note:: - The **'vpp-selinux-policy'** will not enable SELinux on the system. It + The *vpp-selinux-policy* will not enable SELinux on the system. It will install a Custom VPP SELinux policy that will be used if SELinux is enabled at any time. @@ -221,19 +220,18 @@ Starting VPP ============ Once VPP is installed on the system, to run VPP as a systemd service on CentOS, -run: +run the following command: .. code-block:: console $ sudo systemctl start vpp -Then to enable VPP to start on system reboot: +Then to enable VPP to start on system reboot, run the following command: .. code-block:: console $ sudo systemctl enable vpp - Outside of running VPP as a systemd service, VPP can be started manually or made to run within GDB for debugging. See :ref:`running` for more details and ways to tailor VPP to a specific system. @@ -242,6 +240,8 @@ ways to tailor VPP to a specific system. Uninstall the VPP RPMs ====================== +To uninstall a VPP RPM, run the following command: + .. code-block:: console $ sudo yum autoremove vpp* diff --git a/docs/gettingstarted/users/installing/index.rst b/docs/gettingstarted/users/installing/index.rst index 4a8ac7a6952..12a5ab8e015 100644 --- a/docs/gettingstarted/users/installing/index.rst +++ b/docs/gettingstarted/users/installing/index.rst @@ -12,16 +12,8 @@ existing packages. This guide describes how to pull, install and run the VPP pac .. toctree:: -Package Descriptions --------------------- -The following is a brief description of the packages to be installed with VPP. - -.. toctree:: - - packages - -Installing VPP Binaries ----------------------------------- +Installing VPP +--------------- This section provides directions on how to Install VPP binaries on Ubuntu, Centos, and openSUSE platforms. @@ -49,3 +41,11 @@ The following are instructions on how to install VPP on openSUSE. .. toctree:: opensuse + +Package Descriptions +-------------------- +The following is a brief description of the packages to be installed with VPP. + +.. toctree:: + + packages diff --git a/docs/gettingstarted/users/installing/opensuse.rst b/docs/gettingstarted/users/installing/opensuse.rst index b5dcbc35820..6d7873820dc 100644 --- a/docs/gettingstarted/users/installing/opensuse.rst +++ b/docs/gettingstarted/users/installing/opensuse.rst @@ -4,8 +4,9 @@ Installing ========== -To install VPP on openSUSE, first install the following release and then execute -the appropriate commands. + +To install VPP on openSUSE, first install the following release, and then execute +the associated commands. openSUSE Tumbleweed (rolling release) ------------------------------------------------------------ @@ -25,6 +26,8 @@ openSUSE Leap 42.3 Uninstall ========= +To uninstall the vpp plugins, run the following command: + .. code-block:: console sudo zypper remove -u vpp vpp-plugins @@ -32,6 +35,8 @@ Uninstall openSUSE Tumbleweed (rolling release) ------------------------------------- +To uninstall the openSUSE Tumbleweed, run the following command: + .. code-block:: console sudo zypper remove -u vpp vpp-plugins diff --git a/docs/gettingstarted/users/installing/ubuntu.rst b/docs/gettingstarted/users/installing/ubuntu.rst index 5b4a1d86fee..cb7a1c6097d 100644 --- a/docs/gettingstarted/users/installing/ubuntu.rst +++ b/docs/gettingstarted/users/installing/ubuntu.rst @@ -5,13 +5,13 @@ Ubuntu 16.04 - Setup the fd.io Repository ========================================== -From the following, choose one of the releases to install. +Choose one of the following releases to install. Update the OS ----------------------- -It is probably a good idea to update and upgrade the OS before starting +It is a good idea to first update and upgrade the OS before starting; run the following command to update the OS: .. code-block:: console @@ -21,7 +21,7 @@ It is probably a good idea to update and upgrade the OS before starting Point to the Repository ----------------------------------- -Create a file **"/etc/apt/sources.list.d/99fd.io.list"** with the contents that point to +Create a file **/etc/apt/sources.list.d/99fd.io.list** with contents that point to the version needed. The contents needed are shown below. .. _install_vpp: @@ -29,7 +29,7 @@ the version needed. The contents needed are shown below. VPP latest Release ^^^^^^^^^^^^^^^^^^^ -Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents: +Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents: .. code-block:: console @@ -39,7 +39,7 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents: VPP stable/1804 Branch ^^^^^^^^^^^^^^^^^^^^^^^ -Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents: +Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents: .. code-block:: console @@ -49,7 +49,7 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents: VPP master Branch ^^^^^^^^^^^^^^^^^^^^ -Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents: +Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents: .. code-block:: console @@ -59,6 +59,8 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** with contents: Install the Mandatory Packages =============================== +Install the mandatory packages by running the following commands: + .. code-block:: console sudo apt-get update @@ -68,6 +70,8 @@ Install the Mandatory Packages Install the Optional Packages ============================== +Install the optional packages by running the following command: + .. code-block:: console sudo apt-get install vpp-dbg vpp-dev vpp-api-java vpp-api-python vpp-api-lua @@ -76,6 +80,8 @@ Install the Optional Packages Uninstall the Packages ====================== +Uninstall the packages by running the following command: + .. code-block:: console sudo apt-get remove --purge vpp* |