aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/about.rst4
-rw-r--r--docs/featuresbyrelease/index.rst3
-rw-r--r--docs/featuresbyrelease/vpp17.01.rst2
-rw-r--r--docs/featuresbyrelease/vpp17.07.rst4
-rw-r--r--docs/featuresbyrelease/vpp17.10.rst4
-rw-r--r--docs/featuresbyrelease/vpp18.04.rst2
-rw-r--r--docs/featuresbyrelease/vpp18.07.rst2
-rw-r--r--docs/featuresbyrelease/vpp18.10.rst54
-rw-r--r--docs/gettingstarted/installing/centos.rst195
-rw-r--r--docs/gettingstarted/installing/ubuntu.rst39
10 files changed, 178 insertions, 131 deletions
diff --git a/docs/about.rst b/docs/about.rst
index 08e4dfdfdb1..86310c23990 100644
--- a/docs/about.rst
+++ b/docs/about.rst
@@ -4,6 +4,6 @@
About
=====
-**VPP Version:** 19.01-rc0~191-g3206bb1
+**VPP Version:** 19.01-rc0~227-g46eecfd
-**Built on:** Tue Nov 6 17:30:04 GMT 2018
+**Built on:** Fri Nov 9 20:17:32 GMT 2018
diff --git a/docs/featuresbyrelease/index.rst b/docs/featuresbyrelease/index.rst
index 4ea46932cb5..ca5fb16d000 100644
--- a/docs/featuresbyrelease/index.rst
+++ b/docs/featuresbyrelease/index.rst
@@ -9,6 +9,7 @@ This section provides information about the features that are provided for each
.. toctree::
:maxdepth: 1
+ vpp18.10
vpp18.07
vpp18.04
vpp18.01
@@ -18,4 +19,4 @@ This section provides information about the features that are provided for each
vpp17.01
vpp16.09
vpp16.06
- \ No newline at end of file
+
diff --git a/docs/featuresbyrelease/vpp17.01.rst b/docs/featuresbyrelease/vpp17.01.rst
index a52a3064cc2..ab7a969e756 100644
--- a/docs/featuresbyrelease/vpp17.01.rst
+++ b/docs/featuresbyrelease/vpp17.01.rst
@@ -68,4 +68,4 @@ Issues fixed
For the full list of fixed issues please refer to:
* fd.io `JIRA <https://jira.fd.io/>`_
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1701>`_
diff --git a/docs/featuresbyrelease/vpp17.07.rst b/docs/featuresbyrelease/vpp17.07.rst
index e91d27a97f4..977442175e2 100644
--- a/docs/featuresbyrelease/vpp17.07.rst
+++ b/docs/featuresbyrelease/vpp17.07.rst
@@ -65,6 +65,4 @@ Issues fixed
For the full list of fixed issues please refer to:
* fd.io `JIRA <https://jira.fd.io/>`_
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_
-
-
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1707>`_
diff --git a/docs/featuresbyrelease/vpp17.10.rst b/docs/featuresbyrelease/vpp17.10.rst
index 3348f7366ce..b3fff891adb 100644
--- a/docs/featuresbyrelease/vpp17.10.rst
+++ b/docs/featuresbyrelease/vpp17.10.rst
@@ -64,6 +64,4 @@ Issues fixed
For the full list of fixed issues please refer to:
* fd.io `JIRA <https://jira.fd.io/>`_
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_
-
-
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1710>`_
diff --git a/docs/featuresbyrelease/vpp18.04.rst b/docs/featuresbyrelease/vpp18.04.rst
index d5e2ca54b48..ecb3a4c6129 100644
--- a/docs/featuresbyrelease/vpp18.04.rst
+++ b/docs/featuresbyrelease/vpp18.04.rst
@@ -73,5 +73,5 @@ Issues fixed
For the full list of fixed issues please refer to:
* fd.io `JIRA <https://jira.fd.io/>`_
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1810>`_
diff --git a/docs/featuresbyrelease/vpp18.07.rst b/docs/featuresbyrelease/vpp18.07.rst
index a14435b5cac..b4ee1aea461 100644
--- a/docs/featuresbyrelease/vpp18.07.rst
+++ b/docs/featuresbyrelease/vpp18.07.rst
@@ -71,5 +71,5 @@ Issues fixed
For the full list of fixed issues please refer to:
* fd.io `JIRA <https://jira.fd.io/>`_
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1807>`_
diff --git a/docs/featuresbyrelease/vpp18.10.rst b/docs/featuresbyrelease/vpp18.10.rst
new file mode 100644
index 00000000000..8fb9d22d281
--- /dev/null
+++ b/docs/featuresbyrelease/vpp18.10.rst
@@ -0,0 +1,54 @@
+.. _vpp18.10:
+
+###############################
+Features for Release VPP 18.10
+###############################
+
+This section lists those features that became available in VPP Release 18.10:
+
+Infrastructure
++++++++++++++++
+
+* DPDK 18.08 Integration
+* New Stats infrastructure (interface, error, node performance counters)
+* Add configurable "Doug Lea malloc" support
+
+VNET & Plugins
++++++++++++++++
+
+* Load balancing: support per-port VIP and all-port VIP
+* Port NSH plugin to VPP
+* NAT
+
+ - Configurable port range
+ - Virtual Fragmentation Reassembly for endpoint-dependent mode
+ - Client-IP based session affinity for load-balancing
+ - TCP MSS clamping
+ - Session timeout
+ - Bug-fixing and performance optimizations
+
+Host stack
++++++++++++
+
+* Support for applications with multiple workers
+* Support for binds from multiple app workers to same ip:port
+* Switched to a message queue for io and control event notifications
+* Support for eventfd based notifications as alternative to mutext-condvar pair
+* VCL refactor to support async event notifications and multiple workers
+* TLS async support in client for HW accleration
+* Performance optimizations and bug-fixing
+* A number of binary APIs will be deprecated in favor of using the event message queue. Details in the API section.
+
+Known issues
+---------------
+
+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.
+
+Issues fixed
+--------------
+
+For the full list of fixed issues please refer to:
+
+* fd.io `JIRA <https://jira.fd.io/>`_
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1810>`_
+
diff --git a/docs/gettingstarted/installing/centos.rst b/docs/gettingstarted/installing/centos.rst
index dae24f6b4c8..e69bc848df6 100644
--- a/docs/gettingstarted/installing/centos.rst
+++ b/docs/gettingstarted/installing/centos.rst
@@ -2,106 +2,28 @@
.. toctree::
-Setup the fd.io Repository - Centos 7
+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; run the following command to update the OS:
+the OS; run the following commands to update the OS and get some packages.
.. code-block:: console
$ sudo yum update
+ $ sudo yum install pygpgme yum-utils
-Point to the Repository
------------------------
+Package Cloud Repository
+^^^^^^^^^^^^^^^^^^^^^^^^
-For CentOS based systems, there are two respositories to pull VPP binaries from:
-
-* CentOS NFV SIG Repository
-* Nexus Repository
-
-
-CentOS NFV SIG Repository
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-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
-
-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 by running the
-following command:
-
-.. code-block:: console
-
- $ sudo yum install centos-release-fdio
-
-then **'Install VPP RPMs'**, as described below.
-
-This will install the latest VPP version from the repository. To install an
-older version, once the CentOS NFV SIG FDIO repo file has been installed, list
-the stored versions:
-
-.. code-block:: console
-
- $ sudo yum --showduplicates list vpp* | expand
- Loaded plugins: fastestmirror
- Loading mirror speeds from cached hostfile
- * base: repos-va.psychz.net
- * epel: download-ib01.fedoraproject.org
- * extras: mirror.siena.edu
- * updates: repo1.ash.innoscale.net
- Available Packages
- vpp.x86_64 17.10-1 centos-fdio
- vpp.x86_64 18.01.1-1 centos-fdio
- vpp.x86_64 18.01.2-1 centos-fdio
- vpp.x86_64 18.04-1 centos-fdio
- vpp-api-java.x86_64 17.10-1 centos-fdio
- vpp-api-java.x86_64 18.01.1-1 centos-fdio
- vpp-api-java.x86_64 18.01.2-1 centos-fdio
- vpp-api-java.x86_64 18.04-1 centos-fdio
- vpp-api-lua.x86_64 17.10-1 centos-fdio
- vpp-api-lua.x86_64 18.01.1-1 centos-fdio
- vpp-api-lua.x86_64 18.01.2-1 centos-fdio
- vpp-api-lua.x86_64 18.04-1 centos-fdio
- vpp-api-python.x86_64 17.10-1 centos-fdio
- vpp-api-python.x86_64 18.01.1-1 centos-fdio
- vpp-api-python.x86_64 18.01.2-1 centos-fdio
- vpp-api-python.x86_64 18.04-1 centos-fdio
- vpp-devel.x86_64 17.10-1 centos-fdio
- vpp-devel.x86_64 18.01.1-1 centos-fdio
- vpp-devel.x86_64 18.01.2-1 centos-fdio
- vpp-devel.x86_64 18.04-1 centos-fdio
- vpp-lib.x86_64 17.10-1 centos-fdio
- vpp-lib.x86_64 18.01.1-1 centos-fdio
- vpp-lib.x86_64 18.01.2-1 centos-fdio
- vpp-lib.x86_64 18.04-1 centos-fdio
- vpp-plugins.x86_64 17.10-1 centos-fdio
- vpp-plugins.x86_64 18.01.1-1 centos-fdio
- vpp-plugins.x86_64 18.01.2-1 centos-fdio
- vpp-plugins.x86_64 18.04-1 centos-fdio
- vpp-selinux-policy.x86_64 18.04-1 centos-fdio
-
-Then install a particular version:
-
-.. code-block:: console
-
- $ sudo yum install vpp-17.10-1.x86_64
-
-
-Nexus Repository
-^^^^^^^^^^^^^^^^
-
-Build artifacts are also posted to a FD.io Nexus Repository. This includes
-official point releases, as well as nightly builds. To use any of these build
-artifacts, create a file *'/etc/yum.repos.d/fdio-release.repo'* with the
-content that points to the version needed. Below are some common examples of
-the content needed:
+Build artifacts are also posted to a packagecloud.io Repository. This includes
+official point releases. To use any of these build artifacts, create a file
+*'/etc/yum.repos.d/fdio-release.repo'* with the content that points to the
+version needed. Below are some common examples of the content needed:
VPP Latest Release
@@ -113,11 +35,33 @@ To allow *'yum'* access to the official VPP releases, create the file
.. code-block:: console
$ cat /etc/yum.repos.d/fdio-release.repo
- [fdio-release]
- name=fd.io release branch latest merge
- baseurl=https://nexus.fd.io/content/repositories/fd.io.centos7/
+ [fdio_release]
+ name=fdio_release
+ baseurl=https://packagecloud.io/fdio/release/el/7/$basearch
+ repo_gpgcheck=1
+ gpgcheck=0
enabled=1
+ gpgkey=https://packagecloud.io/fdio/release/gpgkey
+ sslverify=1
+ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
+ metadata_expire=300
+
+ [fdio_release-source]
+ name=fdio_release-source
+ baseurl=https://packagecloud.io/fdio/release/el/7/SRPMS
+ repo_gpgcheck=1
gpgcheck=0
+ enabled=1
+ gpgkey=https://packagecloud.io/fdio/release/gpgkey
+ sslverify=1
+ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
+ metadata_expire=300
+
+Update your local yum cache.
+
+.. code-block:: console
+
+ $ sudo yum -q makecache -y --disablerepo='*' --enablerepo='fdio_release'
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
@@ -127,10 +71,6 @@ provided.
$ sudo yum --showduplicates list vpp* | expand
-Then choose the release to install. See **'CentOS NFV SIG Repository'** for
-sample *'yum --showduplicates list'* output and an example of installing a
-particular version of the RPMs.
-
VPP Stable Branch
"""""""""""""""""""
@@ -140,15 +80,37 @@ the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content.
.. code-block:: console
$ cat /etc/yum.repos.d/fdio-release.repo
- [fdio-stable-1804]
- name=fd.io stable/1804 branch latest merge
- baseurl=https://nexus.fd.io/content/repositories/fd.io.stable.1804.centos7/
+ [fdio_1810]
+ name=fdio_1810
+ baseurl=https://packagecloud.io/fdio/1810/el/7/$basearch
+ repo_gpgcheck=1
+ gpgcheck=0
enabled=1
+ gpgkey=https://packagecloud.io/fdio/1810/gpgkey
+ sslverify=1
+ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
+ metadata_expire=300
+
+ [fdio_1810-source]
+ name=fdio_1810-source
+ baseurl=https://packagecloud.io/fdio/1810/el/7/SRPMS
+ repo_gpgcheck=1
gpgcheck=0
+ enabled=1
+ gpgkey=https://packagecloud.io/fdio/1810/gpgkey
+ sslverify=1
+ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
+ metadata_expire=300
-For other stable branches, replace the *'1804'* from the above content with the
+For other stable branches, replace the *'1810'* from the above content with the
desired release. Examples: 1606, 1609, 1701, 1704, 1707, 1710, 1804, 1807
+Update your local yum cache.
+
+.. code-block:: console
+
+ $ sudo yum -q makecache -y --disablerepo='*' --enablerepo='fdio_1810'
+
The *'yum install vpp'* command will install the most recent build on the
branch, not the latest offical release. Run the following command to get the
list of images produce by the branch:
@@ -157,10 +119,6 @@ list of images produce by the branch:
$ sudo yum --showduplicates list vpp* | expand
-Then choose the image to install. See **'CentOS NFV SIG Repository'** for
-sample *'yum --showduplicates list'* output and an example of installing a
-particular version of the RPMs.
-
VPP Master Branch
"""""""""""""""""""
@@ -171,11 +129,33 @@ the file *'/etc/yum.repos.d/fdio-release.repo'* with the following content.
.. code-block:: console
$ cat /etc/yum.repos.d/fdio-release.repo
- [fdio-master]
- name=fd.io master branch latest merge
- baseurl=https://nexus.fd.io/content/repositories/fd.io.master.centos7/
+ [fdio_master]
+ name=fdio_master
+ baseurl=https://packagecloud.io/fdio/master/el/7/$basearch
+ repo_gpgcheck=1
+ gpgcheck=0
enabled=1
+ gpgkey=https://packagecloud.io/fdio/master/gpgkey
+ sslverify=1
+ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
+ metadata_expire=300
+
+ [fdio_master-source]
+ name=fdio_master-source
+ baseurl=https://packagecloud.io/fdio/master/el/7/SRPMS
+ repo_gpgcheck=1
gpgcheck=0
+ enabled=1
+ gpgkey=https://packagecloud.io/fdio/master/gpgkey
+ sslverify=1
+ sslcacert=/etc/pki/tls/certs/ca-bundle.crt
+ metadata_expire=300
+
+Update your local yum cache.
+
+.. code-block:: console
+
+ $ sudo yum -q makecache -y --disablerepo='*' --enablerepo='fdio_master'
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
@@ -185,11 +165,6 @@ branch.
$ sudo yum --showduplicates list vpp* | expand
-Then choose the image to install. See **'CentOS NFV SIG Repository'** for
-sample *'yum --showduplicates list'* output and an example of installing a
-particular version of the RPMs.
-
-
Install VPP RPMs
================
diff --git a/docs/gettingstarted/installing/ubuntu.rst b/docs/gettingstarted/installing/ubuntu.rst
index d1daed14ddb..f887597f1bb 100644
--- a/docs/gettingstarted/installing/ubuntu.rst
+++ b/docs/gettingstarted/installing/ubuntu.rst
@@ -2,16 +2,20 @@
.. toctree::
-Ubuntu 16.04 - Setup the fd.io Repository
+Ubuntu 16.04 - Setup the FD.io Repository
==========================================
-Choose one of the following releases to install.
+FD.io VPP is installed using Package Cloud. For a complete set of
+instructuctions on how to install VPP with package cloud please refer
+to `Package Cloud <https://packagecloud.io/fdio/release>`_
+Choose one of the following releases to install.
Update the OS
-----------------------
-It is a good idea to first update and upgrade the OS before starting; run the following command to update the OS:
+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
@@ -33,17 +37,28 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the follow
.. code-block:: console
- deb [trusted=yes] https://nexus.fd.io/content/repositories/fd.io.ubuntu.xenial.main/ ./
+ deb [trusted=yes] https://packagecloud.io/fdio/release/ubuntu xenial main ./
+Get the key:
-VPP stable/1804 Branch
-^^^^^^^^^^^^^^^^^^^^^^^
+.. code-block:: console
+
+ curl -L https://packagecloud.io/fdio/release/gpgkey | sudo apt-key add -
+
+VPP 1810 Branch
+^^^^^^^^^^^^^^^^
Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the following contents:
.. code-block:: console
- deb [trusted=yes] https://nexus.fd.io/content/repositories/fd.io.stable.1804.ubuntu.xenial.main/ ./
+ deb [trusted=yes] https://packagecloud.io/fdio/1810/ubuntu xenial main ./
+
+Get the key:
+
+.. code-block:: console
+
+ curl -L https://packagecloud.io/fdio/1810/gpgkey | sudo apt-key add -
VPP master Branch
@@ -53,7 +68,13 @@ Create the file **/etc/apt/sources.list.d/99fd.io.list** that contain the follow
.. code-block:: console
- deb [trusted=yes] https://nexus.fd.io/content/repositories/fd.io.master.ubuntu.xenial.main/ ./
+ deb [trusted=yes] https://packagecloud.io/fdio/master/ubuntu xenial main ./
+
+Get the key:
+
+.. code-block:: console
+
+ curl -L https://packagecloud.io/fdio/master/gpgkey | sudo apt-key add -
Install the Mandatory Packages
@@ -66,7 +87,7 @@ Install the mandatory packages by running the following commands:
sudo apt-get update
sudo apt-get install vpp-lib vpp vpp-plugins
-
+
Install the Optional Packages
==============================