* [spp] [PATCH 1/2] docs: add RPM installation for DPDK and SPP
[not found] <20191216091718.27178-1-x-fn-spp@sl.ntt-tx.co.jp>
@ 2019-12-16 9:17 ` x-fn-spp
2019-12-16 9:17 ` [spp] [PATCH 2/2] docs: introduce RPM package support x-fn-spp
1 sibling, 0 replies; 2+ messages in thread
From: x-fn-spp @ 2019-12-16 9:17 UTC (permalink / raw)
To: ferruh.yigit, yasufum.o; +Cc: spp
From: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
For CentOS, RPM installation is supported for DPDK and SPP. this update
is to add how to build RPM packages from source and installation with
the RPMs.
Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
---
docs/guides/gsg/install.rst | 307 +++++++++++++++++++++++++++++++++++-
1 file changed, 299 insertions(+), 8 deletions(-)
diff --git a/docs/guides/gsg/install.rst b/docs/guides/gsg/install.rst
index 335a151..90c4c8c 100644
--- a/docs/guides/gsg/install.rst
+++ b/docs/guides/gsg/install.rst
@@ -14,7 +14,6 @@ Refer to `DPDK documentation
For Linux, see `Getting Started Guide for Linux
<http://www.dpdk.org/doc/guides/linux_gsg/index.html>`_ .
-
.. _setup_install_packages:
Required Packages
@@ -23,6 +22,10 @@ Required Packages
Installing packages for DPDK and SPP is almost the on Ubunu and CentOS,
but names are different for some packages.
+For CentOS, you can install packages with RPM instead of using ``yum``
+command as described in
+:ref:`Build RPM Packages<setup_install_rpm_dpdk_spp>`.
+
Ubuntu
~~~~~~
@@ -360,6 +363,8 @@ Refer to `L2 Forwarding Sample Application
for more details.
+.. _setup_install_build_document:
+
Build Documentation
-------------------
@@ -374,7 +379,9 @@ For HTML documentation, install sphinx and additional theme.
$ pip3 install sphinx \
sphinx-rtd-theme
-For PDF, inkscape and latex packages are required.
+For PDF, install inkscape and latex packages. Some of package names are
+a little bit different between Ubuntu and CentOS. Here is an example on
+Ubuntu.
.. code-block:: console
@@ -383,19 +390,63 @@ For PDF, inkscape and latex packages are required.
texlive-latex-extra \
texlive-latex-recommended
+You might also need to install ``latexmk`` in addition to if you use
+Ubuntu 18.04 LTS.
+
+.. code-block:: console
+
+ $ sudo apt install latexmk
+
+
+This is an example of package installation on CentOS.
+
.. code-block:: console
# CentOS
$ sudo yum install inkscape \
- texlive-latex
+ latexmk \
+ texlive-latex \
+ texlive-*.noarch
-You might also need to install ``latexmk`` in addition to if you use
-Ubuntu 18.04 LTS.
+On CentOS, you are required to install additional style files,
+``tabulary``, ``capt-of`` and ``needspace``, without using ``yum`` command.
+It should be added to ``texlive``'s directory by yourself.
+
+First, download style file packages from CTAN and unzip the files in any
+directory.
.. code-block:: console
- $ sudo apt install latexmk
+ $ cd /path/to/any
+ $ CTAN_PKG_URL=http://mirrors.ctan.org/macros/latex/contrib
+ $ wget ${CTAN_PKG_URL}/{tabulary,capt-of,needspace}.zip
+ $ unzip '*.zip'
+
+Then, generate sty files by running installer scripts in each of
+directories.
+
+.. code-block:: console
+
+ $ for pkg in tabulary capt-of needspace
+ do cd ${pkg}; latex ${pkg}.ins; cd ..
+ done
+
+You can find sty files if installer is finished successfully.
+
+.. code-block:: console
+ $ ls ./*/*.sty
+ ./capt-of/capt-of.sty ./needspace/needspace.sty ./tabulary/tabulary.sty
+
+Finally, move them to ``texlive``'s directory and run ``texhash``.
+
+.. code-block:: console
+
+ $ sudo mv tabulary capt-of needspace \
+ /usr/share/texlive/texmf-dist/tex/latex/
+ $ sudo texhash
+
+After package installation,
HTML documentation is compiled by running make with ``doc-html``. This
command launch sphinx for compiling HTML documents.
Compiled HTML files are created in ``docs/guides/_build/html/`` and
@@ -421,6 +472,246 @@ You can also compile both of HTML and PDF documentations with ``doc`` or
# or
$ make doc-all
-.. note::
- For CentOS, compilation PDF document is not supported.
+.. _setup_install_rpm_dpdk_spp:
+
+Build RPM Packages
+------------------
+
+This section describes how to build RPMs of DPDK and SPP from spec files.
+
+
+Required Packages
+~~~~~~~~~~~~~~~~~
+
+First of all, install dev tools.
+
+.. code-block:: console
+
+ $ sudo yum groupinstall "Development Tools"
+ $ sudo yum install rpm-build rpmdevtools
+
+Install EPEL (Extra Packages for Enterprise Linux) and required packages.
+
+.. code-block:: console
+
+ $ sudo rpm -ivh \
+ https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
+
+.. code-block:: console
+
+ $ sudo yum install python-pip \
+ kernel-devel \
+ kernel-headers \
+ libpcap-devel \
+ doxygen \
+ python-sphinx \
+ inkscape \
+ numactl-devel \
+ kernel-devel-$(uname -r) \
+ wireshark
+
+ $ sudo yum install texlive \
+ texlive-latex \
+ texlive-xetex \
+ texlive-collection-xetex \
+ texlive-*.noarch \
+ latexmk
+
+Then, install ``sphinx`` and its theme with ``pip``.
+
+.. code-block:: console
+
+ $ sudo pip install sphinx==1.3.1 sphinx_rtd_theme
+
+
+.. _setup_install_rpm_dpdk:
+
+DPDK
+~~~~
+
+Instead of creating spec file from scratch, you get it provided
+as a part of ``dpdk-stable`` release.
+However, the version of DPDK in this spec file is just bit old from our
+targeting version ``v18.08.1``. So we need to make some updates for the
+spec file before running build task.
+
+Considering working directory for building RPMs, although you can build it
+in any directory, it is already provided as ``spp/rpmbuild`` for conciseness.
+Download spec file and source in the directory as following.
+
+.. code-block:: console
+
+ $ wget -P rpmbuild/SPECS \
+ http://git.dpdk.org/dpdk-stable/plain/pkg/dpdk.spec
+ $ wget -P rpmbuild/SOURCES \
+ https://fast.dpdk.org/rel/dpdk-18.08.1.tar.xz
+
+Edit this spec file by following example of diff styled
+(``diff -u`` exactly) below.
+``+`` means a newly added line, and ``-`` means a deleted line.
+
+.. code-block:: none
+
+ Name: dpdk
+ -Version: 18.11.5
+ +Version: 18.08.1
+ Release: 1
+ Packager: packaging@6wind.com
+ URL: http://dpdk.org
+ -Source: http://dpdk.org/browse/dpdk/snapshot/dpdk-%{version}.tar.gz
+ +Source: https://fast.dpdk.org/rel/dpdk-%{version}.tar.xz
+ ...
+
+Remove entries of no needed architectures, in this case, other than
+x86_64.
+
+.. code-block:: none
+
+ ...
+ -ExclusiveArch: i686 x86_64 aarch64
+ -%ifarch aarch64
+ -%global machine armv8a
+ -%global target arm64-%{machine}-linuxapp-gcc
+ -%global config arm64-%{machine}-linuxapp-gcc
+ -%else
+ -%global machine default
+ +ExclusiveArch: x86_64
+ +%global machine native
+ %global target %{_arch}-%{machine}-linuxapp-gcc
+ %global config %{_arch}-native-linuxapp-gcc
+ -%endif
+ ...
+
+Update ``BuildRequires`` for additional required packages.
+
+.. code-block:: none
+
+ ...
+ BuildRequires: doxygen, python-sphinx, inkscape
+ -BuildRequires: texlive-collection-latexextra
+ +BuildRequires: numactl-devel wireshark texlive texlive-latex
+ +BuildRequires: texlive-xetex texlive-collection-xetex latexmk
+ ...
+
+Add ``-n`` option in ``%prep`` section.
+
+.. code-block:: none
+
+ ...
+ %prep
+ -%setup -q
+ +%setup -q -n %{name}-stable-%{version}
+ ...
+
+Add modifications of config params in ``%build`` section.
+
+.. code-block:: none
+
+ ...
+ %build
+ ...
+ sed -ri 's,(LIBRTE_PMD_PCAP=).*,\1y,' %{target}/.config
+ +sed -ri 's,(CONFIG_RTE_LIBRTE_PMD_PCAP=).*,\1y,' %{target}/.config
+ +sed -ri 's,(CONFIG_RTE_PORT_PCAP=).*,\1y,' %{target}/.config
+ +sed -ri 's,(CONFIG_RTE_EAL_PMD_PATH=).*,\1\"%{_libdir}/dpdk\",' %{target}/.config
+ make O=%{target} %{?_smp_mflags}
+ ...
+
+The rest of things is to change to move some libraries in
+``%install`` section.
+
+.. code-block:: none
+
+ ...
+ %install
+ rm -rf %{buildroot}
+ make install O=%{target} DESTDIR=%{buildroot} \
+ prefix=%{_prefix} bindir=%{_bindir} sbindir=%{_sbindir} \
+ includedir=%{_includedir}/dpdk libdir=%{_libdir} \
+ datadir=%{_datadir}/dpdk docdir=%{_docdir}/dpdk
+ +mkdir %{buildroot}%{_libdir}/dpdk
+ +mv %{buildroot}%{_libdir}/librte_pmd_* %{buildroot}%{_libdir}/dpdk
+ +mv %{buildroot}%{_libdir}/dpdk/librte_pmd_ring* %{buildroot}%{_libdir}/
+ +mv %{buildroot}%{_libdir}/dpdk/librte_pmd_vhost* %{buildroot}%{_libdir}/
+ ...
+
+Finally, build RPM with updated spec file.
+
+.. code-block:: console
+
+ $ rpmbuild -ba --define="_topdir /path/to/spp/rpmbuild" SPECS/dpdk.spec
+
+You can find three RPMs after build tasks are done in succeed.
+
+.. code-block:: console
+
+ $ ls rpmbuild/RPMS/x86_64/
+ dpdk-18.08.1-1.x86_64.rpm
+ dpdk-debuginfo-18.08.1-1.x86_64.rpm
+ dpdk-devel-18.08.1-1.x86_64.rpm
+
+
+Now, you can install DPDK with ``yum localinstall``,
+or remove with ``yum erase``.
+
+.. code-block:: console
+
+ # Install DPDK
+ $ sudo yum localinstall rpmbuild/RPMS/x86_64/dpdk-18.08.1-1.x86_64.rpm
+
+ # remove
+ $ sudo yum erase dpdk
+
+
+.. _setup_install_rpm_spp:
+
+SPP
+~~~
+
+For SPP, spec file is provided as ``spp/rpmbuild/SPECS/spp.spec``.
+You download SPP v18.08.4, or update ``Version`` entry in the spec file
+if you use other version.
+
+.. code-block:: console
+
+ $ wget -P rpmbuild/SOURCES \
+ http://git.dpdk.org/apps/spp/snapshot/spp-18.08.4.tar.gz
+
+Installing DPDK with RPMs created in the previous section is required
+for building SPP's RPM pakcage.
+
+.. code-block:: console
+
+ $ cd rpmbuild/RPMS/x86_64/
+ $ sudo yum localinstall dpdk-18.08.1-1.x86_64.rpm \
+ dpdk-devel-18.08.1-1.x86_64.rpm \
+
+Packages for building SPP should also be installed as described in
+:ref:`Required Packages<setup_install_packages>` and
+:ref:`Build Documentation<setup_install_build_document>`.
+
+Return to the project root and start building SPP RPM.
+
+.. code-block:: console
+
+ $ cd /path/to/spp
+ $ rpmbuild -ba --define="_topdir /path/to/spp/rpmbuild" SPECS/spp.spec
+
+Confirm that two RPMs are generated in ``RPM/x86_64`` directory.
+
+.. code-block:: console
+
+ $ ls rpmbuild/RPMS/x86_64/
+ spp-18.08.3-1.x86_64.rpm
+ spp-debuginfo-18.08.3-1.x86_64.rpm
+
+You can install SPP with ``yum localinstall``, or remove with ``yum erase``.
+
+.. code-block:: console
+
+ # install SPP
+ $ sudo yum localinstall rpmbuild/RPMS/x86_64/spp-18.08.3-1.x86_64.rpm
+
+ # remove SPP
+ $ sudo yum erase spp
--
2.17.1
^ permalink raw reply [flat|nested] 2+ messages in thread
* [spp] [PATCH 2/2] docs: introduce RPM package support
[not found] <20191216091718.27178-1-x-fn-spp@sl.ntt-tx.co.jp>
2019-12-16 9:17 ` [spp] [PATCH 1/2] docs: add RPM installation for DPDK and SPP x-fn-spp
@ 2019-12-16 9:17 ` x-fn-spp
1 sibling, 0 replies; 2+ messages in thread
From: x-fn-spp @ 2019-12-16 9:17 UTC (permalink / raw)
To: ferruh.yigit, yasufum.o; +Cc: spp
From: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
This update is to add RPM SPEC files for CentOS distro. RPM packages of
DPDK and SPP are built from the spec files in `spp/rpmbuild/SPECS`
directory. Because of dependencies, DPDK should be installed with
this package before SPP.
RPM file is built after installing required packages as following.
$ rpmbuild -ba --define="_topdir /path/to/spp" SPECS/dpdk.spec
Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
Signed-off-by: Naoki Takada <ntakada14@gmail.com>
---
rpmbuild/SPECS/spp.spec | 222 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 222 insertions(+)
create mode 100644 rpmbuild/SPECS/spp.spec
diff --git a/rpmbuild/SPECS/spp.spec b/rpmbuild/SPECS/spp.spec
new file mode 100644
index 0000000..05570dc
--- /dev/null
+++ b/rpmbuild/SPECS/spp.spec
@@ -0,0 +1,222 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2019 Nippon Telegraph and Telephone Corporation
+
+##################################################
+# Basic information
+##################################################
+Summary: Soft Patch Panel (SPP) is a DPDK app for Service Function Chaining in NFV
+Name: spp
+Version: 18.08.4
+Release: 1
+License: BSD-3-Clause
+URL: http://git.dpdk.org/apps/spp/
+Source: http://git.dpdk.org/apps/spp/snapshot/%{name}-%{version}.tar.gz
+Group: Applications/File
+Prefix: %{_prefix}
+
+##################################################
+# Requires
+##################################################
+BuildRequires: python36 python36-pip python-devel python-six libpcap-devel lz4-devel wireshark-devel
+BuildRequires: inkscape texlive-latex latexmk
+BuildRequires: dpdk-devel
+
+Requires: lz4 libpcap wireshark python36 python36-pip
+Requires: lz4-devel libpcap-devel wireshark-devel libX11-devel
+Requires: dpdk
+
+##################################################
+# Description
+##################################################
+%description
+Soft Patch Panel (SPP) is a DPDK application for providing
+switching functionality for Service Function Chaining in NFV
+(Network Function Virtualization).
+
+##################################################
+# Define
+##################################################
+# Points to the DPDK installation and target env directory
+%define RTE_SDK /usr/share/dpdk
+%define RTE_TARGET x86_64-native-linuxapp-gcc
+
+# Installation path
+%define INS /opt/spp
+%define INS_DOC /usr/share/doc/spp
+%define INS_LINK /usr/bin
+
+# Source directory
+%define SRC src
+
+# SPP tools directory
+%define TOOLS tools
+%define HELPS %{TOOLS}/helpers
+
+# Document path
+%define DOC_TREE docs/guides/_build/doctrees
+%define DOC_HTML docs/guides/_build/html
+%define DOC_LATEX docs/guides/_build/latex
+
+# SPP's licence directory
+%define LICENSE license
+
+# `%{buildroot}` is expanded into `rpmbuild/BUILDROOT` as default.
+
+# Binary path
+%define CLI cli
+%define CTL spp-ctl
+%define PRI primary/%{RTE_TARGET}
+%define VF_PATH vf/%{RTE_TARGET}
+%define NFV nfv/%{RTE_TARGET}
+%define MIR mirror/%{RTE_TARGET}
+%define PCAP pcap/%{RTE_TARGET}
+
+# Python path
+%define PYTHON /usr/lib64/python3.6:/usr/lib64/python3.6/lib-dynload:/usr/local/lib64/python3.6/site-packages:/usr/local/lib/python3.6/site-packages:/usr/lib64/python3.6/site-packages:/usr/lib/python3.6/site-packages
+
+##################################################
+# prep section
+##################################################
+%prep
+%setup -q
+
+##################################################
+# build section
+##################################################
+%build
+export RTE_SDK=%{RTE_SDK}
+export RTE_RTE_TARGET=%{RTE_TARGET}
+export PYTHONPATH=%{PYTHON}
+make
+make doc-all
+
+##################################################
+# install section
+##################################################
+%install
+# Clearn up
+rm -rf %{buildroot}
+
+# Make install directory
+mkdir -p %{buildroot}%{INS}
+mkdir -p %{buildroot}%{INS}/%{LICENSE}
+mkdir -p %{buildroot}%{INS}/%{HELPS}
+mkdir -p %{buildroot}%{INS}/bin
+mkdir -p %{buildroot}%{INS}/bin/%{PRI}
+mkdir -p %{buildroot}%{INS}/bin/%{VF_PATH}
+mkdir -p %{buildroot}%{INS}/bin/%{NFV}
+mkdir -p %{buildroot}%{INS}/bin/%{MIR}
+mkdir -p %{buildroot}%{INS}/bin/%{PCAP}
+mkdir -p %{buildroot}%{INS_DOC}
+mkdir -p %{buildroot}%{INS_LINK}
+
+# File copy
+cp README.md %{buildroot}%{INS}
+cp requirements.txt %{buildroot}%{INS}
+cp CONTRIBUTING.txt %{buildroot}%{INS}
+
+# License copy
+cp %{LICENSE}/* %{buildroot}%{INS}/%{LICENSE}/
+
+# Execute file copy
+cp -r %{SRC}/%{CLI} %{buildroot}%{INS}/bin
+cp -r %{SRC}/%{CTL} %{buildroot}%{INS}/bin
+cp %{SRC}/spp.py %{buildroot}%{INS}/bin
+cp %{SRC}/%{PRI}/app/spp_primary %{buildroot}%{INS}/bin/%{PRI}
+cp %{SRC}/%{VF_PATH}/app/spp_vf %{buildroot}%{INS}/bin/%{VF_PATH}
+cp %{SRC}/%{NFV}/app/spp_nfv %{buildroot}%{INS}/bin/%{NFV}
+cp %{SRC}/%{MIR}/app/spp_mirror %{buildroot}%{INS}/bin/%{MIR}
+cp %{SRC}/%{PCAP}/app/spp_pcap %{buildroot}%{INS}/bin/%{PCAP}
+cp %{HELPS}/sec_launcher.py %{buildroot}%{INS}/%{HELPS}
+
+# Document file copy
+cp -r %{DOC_TREE} %{buildroot}%{INS_DOC}
+cp -r %{DOC_HTML} %{buildroot}%{INS_DOC}
+cp -r %{DOC_LATEX} %{buildroot}%{INS_DOC}
+
+# Create symbolic link
+ln -sf %{INS}/bin/spp.py %{buildroot}%{INS_LINK}/spp
+ln -sf %{INS}/bin/%{CTL}/spp-ctl %{buildroot}%{INS_LINK}/spp-ctl
+ln -sf %{INS}/bin/%{PRI}/spp_primary %{buildroot}%{INS_LINK}/spp_primary
+ln -sf %{INS}/bin/%{VF_PATH}/spp_vf %{buildroot}%{INS_LINK}/spp_vf
+ln -sf %{INS}/bin/%{NFV}/spp_nfv %{buildroot}%{INS_LINK}/spp_nfv
+ln -sf %{INS}/bin/%{MIR}/spp_mirror %{buildroot}%{INS_LINK}/spp_mirror
+ln -sf %{INS}/bin/%{PCAP}/spp_pcap %{buildroot}%{INS_LINK}/spp_pcap
+
+
+##################################################
+# post section
+##################################################
+%post
+# python package install
+pip3 install -r %{INS}/requirements.txt
+
+##################################################
+# clean section
+##################################################
+%clean
+rm -rf %{buildroot}
+
+##################################################
+# files section
+##################################################
+%files
+# Executable files
+%dir %{INS}
+%dir %{INS}/bin
+%dir %attr(777,root,root) %{INS}/bin/%{CLI}
+%dir %{INS}/bin/%{CTL}
+%dir %{INS}/bin/primary
+%dir %{INS}/bin/primary/%{RTE_TARGET}
+%dir %{INS}/bin/vf
+%dir %{INS}/bin/vf/%{RTE_TARGET}
+%dir %{INS}/bin/nfv
+%dir %{INS}/bin/nfv/%{RTE_TARGET}
+%dir %{INS}/bin/mirror
+%dir %{INS}/bin/mirror/%{RTE_TARGET}
+%dir %{INS}/bin/pcap
+%dir %{INS}/bin/pcap/%{RTE_TARGET}
+%attr(755,root,root) %{INS}/bin/spp.py
+%attr(755,root,root) %{INS}/bin/%{CTL}/spp-ctl
+%attr(744,root,root) %{INS}/bin/%{PRI}/spp_primary
+%attr(744,root,root) %{INS}/bin/%{VF_PATH}/spp_vf
+%attr(744,root,root) %{INS}/bin/%{NFV}/spp_nfv
+%attr(744,root,root) %{INS}/bin/%{MIR}/spp_mirror
+%attr(744,root,root) %{INS}/bin/%{PCAP}/spp_pcap
+%{INS}/bin/%{CLI}/*
+%{INS}/bin/%{CTL}/*.py
+%{INS}/%{TOOLS}
+%{INS}/%{HELPS}
+%{INS}/%{LICENSE}
+
+#Symbolic link files
+%{INS_LINK}/spp
+%{INS_LINK}/spp-ctl
+%{INS_LINK}/spp_primary
+%{INS_LINK}/spp_vf
+%{INS_LINK}/spp_nfv
+%{INS_LINK}/spp_mirror
+%{INS_LINK}/spp_pcap
+
+# Doc files
+%doc %{INS}/README.md
+%doc %{INS}/requirements.txt
+%doc %{INS}/CONTRIBUTING.txt
+%doc %{INS_DOC}
+
+##################################################
+# preun section
+##################################################
+%preun
+if [ -e %{INS} ]; then
+ # delete log file
+ find %{INS} -name "*.log" | xargs --no-run-if-empty rm
+
+ if [ -d %{INS}/bin/%{CLI}/log/ ]; then
+ rmdir %{INS}/bin/%{CLI}/log/
+ fi
+
+ # delete python cache
+ find %{INS} -name "*.pyc" | xargs --no-run-if-empty rm
+ find %{INS} -name "__pycache__" | xargs --no-run-if-empty rmdir
+fi
--
2.17.1
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-12-16 9:32 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
[not found] <20191216091718.27178-1-x-fn-spp@sl.ntt-tx.co.jp>
2019-12-16 9:17 ` [spp] [PATCH 1/2] docs: add RPM installation for DPDK and SPP x-fn-spp
2019-12-16 9:17 ` [spp] [PATCH 2/2] docs: introduce RPM package support x-fn-spp
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).