..  SPDX-License-Identifier: BSD-3-Clause
    Copyright(c) 2017-2018 Nippon Telegraph and Telephone Corporation

.. _spp_container_build_img:

Build Images
============

As explained in :doc:`getting_started` section,
container image is built with ``build/main.py``.
This script is for running ``docker build`` with a set of
``--build-args`` options for building DPDK applications.

This script supports building application from any of repositories.
For example, you can build SPP hosted on your repository
``https://github.com/your/spp.git``
with DPDK 18.11 as following.

.. code-block:: console

    $ cd /path/to/spp/tools/sppc
    $ python3 build/main.py -t spp \
      --dpdk-branch v18.11 \
      --spp-repo https://github.com/your/spp.git

Refer all of options running with ``-h`` option.

.. code-block:: console

    $ python3 build/main.py -h
    usage: main.py [-h] [-t TARGET] [-ci CONTAINER_IMAGE]
                   [--dist-name DIST_NAME] [--dist-ver DIST_VER]
                   [--dpdk-repo DPDK_REPO] [--dpdk-branch DPDK_BRANCH]
                   [--pktgen-repo PKTGEN_REPO] [--pktgen-branch PKTGEN_BRANCH]
                   [--spp-repo SPP_REPO] [--spp-branch SPP_BRANCH]
                   [--suricata-repo SURICATA_REPO]
                   [--suricata-branch SURICATA_BRANCH]
                   [--only-envsh] [--dry-run]

    Docker image builder for DPDK applications

    optional arguments:
      -h, --help            show this help message and exit
      -t TARGET, --target TARGET
                            Build target ('dpdk', 'pktgen', 'spp' or 'suricata')
      -ci CONTAINER_IMAGE, --container-image CONTAINER_IMAGE
                            Name of container image
      --dist-name DIST_NAME
                            Name of Linux distribution
      --dist-ver DIST_VER   Version of Linux distribution
      --dpdk-repo DPDK_REPO
                            Git URL of DPDK
      --dpdk-branch DPDK_BRANCH
                            Specific version or branch of DPDK
      --pktgen-repo PKTGEN_REPO
                            Git URL of pktgen-dpdk
      --pktgen-branch PKTGEN_BRANCH
                            Specific version or branch of pktgen-dpdk
      --spp-repo SPP_REPO   Git URL of SPP
      --spp-branch SPP_BRANCH
                            Specific version or branch of SPP
      --suricata-repo SURICATA_REPO
                            Git URL of DPDK-Suricata
      --suricata-branch SURICATA_BRANCH
                            Specific version or branch of DPDK-Suricata
      --only-envsh          Create config 'env.sh' and exit without docker build
      --dry-run             Print matrix for checking and exit without docker
                            build


.. _sppc_build_img_vci:

Version Control for Images
~~~~~~~~~~~~~~~~~~~~~~~~~~

SPP container provides version control as combination of
target name, Linux distribution name and version.
Built images are referred such as ``sppc/dpdk-ubuntu:latest``,
``sppc/spp-ubuntu:16.04`` or so.
``sppc`` is just a prefix to indicate an image of SPP container.

Build script decides a name from given options or default values.
If you run build script with only target and without distribution
name and version, it uses default values ``ubuntu`` and ``latest``.

.. code-block:: console

    # build 'sppc/dpdk-ubuntu:latest'
    $ python3 build/main.py -t dpdk

    # build 'sppc/spp-ubuntu:16.04'
    $ python3 build/main.py -t spp --dist-ver 16.04

.. note::

    SPP container does not support distributions other than Ubuntu
    currently.
    It is because SPP container has no Dockerfiles for building
    CentOS, Fedora or so. It will be supported in a future release.

    You can build any of distributions with build script
    if you prepare Dockerfile by yourself.
    How Dockerfiles are managed is described in
    :ref:`sppc_build_img_dockerfiles` section.


App container scripts also understand this naming rule.
For launching ``testpmd`` on Ubuntu 18.04,
simply give ``--dist-ver`` to indicate the version and other options
for ``testpmd`` itself.

.. code-block:: console

    # launch testpmd on 'sppc/dpdk-ubuntu:18.04'
    $ python3 app/testpmd.py --dist-ver 18.04 -l 3-4 ...

But, how can we build images for different versions of DPDK,
such as 18.11 and 19.11, on the same distribution?
In this case, you can use ``--container-image`` or ``-ci`` option for
using any of names. It is also referred from app container scripts.

.. code-block:: console

    # build image with arbitrary name
    $ python3 build/main.py -t dpdk -ci sppc/dpdk18.11-ubuntu:latest \
      --dpdk-branch v18.11

    # launch testpmd with '-ci'
    $ python3 app/testpmd.py -ci sppc/dpdk18.11-ubuntu:latest -l 3-4 ...


.. _sppc_build_img_dockerfiles:

Dockerfiles
~~~~~~~~~~~

SPP container includes Dockerfiles for each of distributions and
its versions.
For instance, Dockerfiles for Ubuntu are found in ``build/ubuntu``
directory.
You notice that each of Dockerfiles has its version as a part of
file name.
In other words, the list of Dockerfiles under the ``ubuntu`` directory
shows all of supported versions of Ubuntu.
You can not find Dockerfiles for CentOS as ``build/centos`` or other
distributions because it is not supported currently.
It is included in a future release.

.. code-block:: console

    $ tree build/ubuntu/
    build/ubuntu/
    |--- dpdk
    |    |--- Dockerfile.16.04
    |    |--- Dockerfile.18.04
    |    ---- Dockerfile.latest
    |--- pktgen
    |    |--- Dockerfile.16.04
    |    |--- Dockerfile.18.04
    |    ---- Dockerfile.latest
    |--- spp
    |    |--- Dockerfile.16.04
    |    |--- Dockerfile.18.04
    |    ---- Dockerfile.latest
    ---- suricata
         |--- Dockerfile.16.04
         |--- Dockerfile.18.04
         ---- Dockerfile.latest


.. _sppc_build_img_suricata:

Build suricata image
~~~~~~~~~~~~~~~~~~~~

Building DPDK, pktgen and SPP is completed by just running ``build/main.py``
script. However, building suricata requires few additional few steps.


First, build an image with ``main.py`` script as similar to other apps.
In this example, use DPDK v18.11 and Ubuntu 18.04.

.. code-block:: console

    $ python3 build/main.py -t suricata --dpdk-branch v18.11 --dist-ver 18.04

After build is completed, you can find image named as
``sppc/suricata-ubuntu:18.04`` from ``docker images``.
Run bash command with this image, and execute an installer script in home
directory which is created while building.

.. code-block:: console

    $ docker run -it sppc/suricata-ubuntu:18.04 /bin/bash
    # ./install_suricata.sh

It clones and compiles suricata under home directory. You can find
``$HOME/DPDK_SURICATA-4_1_1`` after runing this script is completed.

Although now you are ready to use suricata, it takes a little time for doing
this task everytime you run the app container.
For skipping this task, you can create another image from running container
with ``docker commit`` command.

Logout and create a new docker image with ``docker commit`` image's
container ID. In this example, new image is named as
`sppc/suricata-ubuntu2:18.04`.

.. code-block:: console

    # exit
    $ docker ps -a
    CONTAINER_ID  sppc/suricata-ubuntu:18.04  "/bin/bash"  3 minutes ...
    $ docker commit CONTAINER_ID sppc/suricata-ubuntu2:18.04

You can run compiled suricata with the new image with docker as following,
or app container launcher with specific options as described in.
:ref:`sppc_appl_suricata`.

.. code-block:: console

    $ docker run -it sppc/suricata-ubuntu:18.04 /bin/bash
    # suricata --build-info


.. _sppc_build_img_inspect:

Inspect Inside of Container
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Container is useful, but just bit annoying to inspect inside
the container because it is cleaned up immediately after process
is finished and there is no clue what is happened in.

``build/run.sh`` is a helper script to inspect inside the container.
You can run ``bash`` on the container to confirm behaviour of
targetting application, or run any of command.

This script refers ``ubuntu/dpdk/env.sh`` for Ubuntu image  to include
environment variables.
So, it is failed to ``build/run.sh`` if this config file
does not exist.
You can create it from ``build/main.py`` with ``--only-envsh`` option
if you removed it accidentally.