docs: add 1810, including package cloud 43/15843/2
authorjdenisco <jdenisco@cisco.com>
Fri, 9 Nov 2018 20:20:26 +0000 (15:20 -0500)
committerDamjan Marion <dmarion@me.com>
Mon, 12 Nov 2018 13:01:56 +0000 (13:01 +0000)
Change-Id: Ieae5fc7c1e099392bc2a4e5948669d9210f2ebac
Signed-off-by: jdenisco <jdenisco@cisco.com>
docs/about.rst
docs/featuresbyrelease/index.rst
docs/featuresbyrelease/vpp17.01.rst
docs/featuresbyrelease/vpp17.07.rst
docs/featuresbyrelease/vpp17.10.rst
docs/featuresbyrelease/vpp18.04.rst
docs/featuresbyrelease/vpp18.07.rst
docs/featuresbyrelease/vpp18.10.rst [new file with mode: 0644]
docs/gettingstarted/installing/centos.rst
docs/gettingstarted/installing/ubuntu.rst

index 08e4dfd..86310c2 100644 (file)
@@ -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
index 4ea4693..ca5fb16 100644 (file)
@@ -9,6 +9,7 @@ This section provides information about the features that are provided for each
 .. toctree::\r
    :maxdepth: 1\r
 \r
+   vpp18.10\r
    vpp18.07\r
    vpp18.04\r
    vpp18.01\r
@@ -18,4 +19,4 @@ This section provides information about the features that are provided for each
    vpp17.01\r
    vpp16.09\r
    vpp16.06\r
-   
\ No newline at end of file
+   \r
index a52a306..ab7a969 100644 (file)
@@ -68,4 +68,4 @@ Issues fixed
 For the full list of fixed issues please refer to:\r
 \r
 * fd.io `JIRA <https://jira.fd.io/>`_\r
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_\r
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1701>`_\r
index e91d27a..9774421 100644 (file)
@@ -65,6 +65,4 @@ Issues fixed
 For the full list of fixed issues please refer to:\r
 \r
 * fd.io `JIRA <https://jira.fd.io/>`_\r
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_\r
-\r
-\r
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1707>`_\r
index 3348f73..b3fff89 100644 (file)
@@ -64,6 +64,4 @@ Issues fixed
 For the full list of fixed issues please refer to:\r
 \r
 * fd.io `JIRA <https://jira.fd.io/>`_\r
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_\r
-\r
-\r
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1710>`_\r
index d5e2ca5..ecb3a4c 100644 (file)
@@ -73,5 +73,5 @@ Issues fixed
 For the full list of fixed issues please refer to:\r
 \r
 * fd.io `JIRA <https://jira.fd.io/>`_\r
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_\r
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1810>`_\r
 \r
index a14435b..b4ee1ae 100644 (file)
@@ -71,5 +71,5 @@ Issues fixed
 For the full list of fixed issues please refer to:\r
 \r
 * fd.io `JIRA <https://jira.fd.io/>`_\r
-* git `commit log <https://git.fd.io/vpp/log/?h=stable/1804>`_\r
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1807>`_\r
 \r
diff --git a/docs/featuresbyrelease/vpp18.10.rst b/docs/featuresbyrelease/vpp18.10.rst
new file mode 100644 (file)
index 0000000..8fb9d22
--- /dev/null
@@ -0,0 +1,54 @@
+.. _vpp18.10:\r
+\r
+###############################\r
+Features for Release VPP 18.10\r
+###############################\r
+\r
+This section lists those features that became available in VPP Release 18.10: \r
+\r
+Infrastructure\r
++++++++++++++++\r
+\r
+* DPDK 18.08 Integration\r
+* New Stats infrastructure (interface, error, node performance counters)\r
+* Add configurable "Doug Lea malloc" support\r
+\r
+VNET & Plugins\r
++++++++++++++++\r
+\r
+* Load balancing: support per-port VIP and all-port VIP\r
+* Port NSH plugin to VPP\r
+* NAT\r
+\r
+  - Configurable port range\r
+  - Virtual Fragmentation Reassembly for endpoint-dependent mode\r
+  - Client-IP based session affinity for load-balancing\r
+  - TCP MSS clamping\r
+  - Session timeout\r
+  - Bug-fixing and performance optimizations\r
+\r
+Host stack\r
++++++++++++\r
+\r
+* Support for applications with multiple workers\r
+* Support for binds from multiple app workers to same ip:port\r
+* Switched to a message queue for io and control event notifications\r
+* Support for eventfd based notifications as alternative to mutext-condvar pair\r
+* VCL refactor to support async event notifications and multiple workers\r
+* TLS async support in client for HW accleration\r
+* Performance optimizations and bug-fixing\r
+* A number of binary APIs will be deprecated in favor of using the event message queue. Details in the API section.\r
+\r
+Known issues\r
+---------------\r
+\r
+For the full list of issues please refer to fd.io `JIRA <https://jira.fd.io/>`_.\r
+\r
+Issues fixed\r
+--------------\r
+\r
+For the full list of fixed issues please refer to:\r
+\r
+* fd.io `JIRA <https://jira.fd.io/>`_\r
+* git `commit log <https://git.fd.io/vpp/log/?h=stable/1810>`_\r
+\r
index dae24f6..e69bc84 100644 (file)
 
 .. 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
 ================
 
index d1daed1..f887597 100644 (file)
@@ -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
 ==============================