new dockerfile version (#316)

This commit proposes a solution to the Docker container size problem.
The image is built extracting from an intermediate layer only
the executables (already compiled) and libraries needed.
This way we reduced the image size from 2.5GB to about 250MB.

Signed-off-by: Simone Magnani <[email protected]>

Author: smagnani96

.gitignore

@@ -8,5 +8,6 @@ swagger-codegen*
 cmake-build-debug/*
 Vagrantfile
 libyang
+src/libs/prometheus-cpp/_build/
 
 cmake-build-debug/

CI/Jenkinsfile.groovy

@@ -96,35 +96,6 @@ pipeline {
                 checkout scm
             }
         }
-        stage('Build Base Image') {
-            when {
-                triggeredBy 'TimerTrigger'
-            }
-            agent {
-                label "docker"
-            }
-            steps {
-                script {
-                    docker.withRegistry("", 'polycube-repo') {
-                        sh """
-                            export DOCKER_BUILDKIT=1
-                            docker system prune --all --force
-                            docker build . -t "polycubebot/base_image:${image_tag}" -f Dockerfile_base_image
-                            docker tag polycubebot/base_image:${image_tag} polycubebot/base_image:latest
-                            docker push polycubebot/base_image:${image_tag}
-                            docker push polycubebot/base_image:latest
-                        """
-                    }
-                }
-            }
-            post {
-                failure {
-                    script {
-                        setGithubStatus("${commit_id}", "pending", github_token, "polycube-network/polycube", "Docker Image Build", "Docker Image Build")
-                    }
-                }
-            }
-        }
         stage('Parallel Docker Build') {
             parallel {
                 stage("Build Docker Mode: default") {

Dockerfile

@@ -1,37 +1,74 @@
-# syntax = tonistiigi/dockerfile:runmount20180618 # enables --mount option for run
-FROM polycubebot/base_image:latest
+# syntax = tonistiigi/dockerfile:runmount20180618
+###############################################
+# STEP 1: using an Ubuntu 18.04 image to install the entire Polycube framework with all dependencies.
+# 
+# During this step an ubuntu image is used to compile Polycube with all its dependencies.
+# This dockerfile is reused for all the DEFAULT_MODE (default, pcn-iptables, pcn-k8s) which, thanks to install.sh and pre-requirements.sh scripts,
+# enable/disable Polycube services and install specific tools.
+FROM ubuntu:18.04 AS builder
+
 ARG DEFAULT_MODE=default
 ENV MODE=$DEFAULT_MODE
-RUN echo "The mode is $MODE"
-RUN rm -rf /tmp/polycube
-RUN --mount=target=/polycube cp -r /polycube /tmp/polycube && \
-cd /tmp/polycube && \
+RUN --mount=target=/polycube cp -r /polycube /tmp/polycube && cd /tmp/polycube && \
+mkdir -p /usr/local/share/polycube /usr/local/include/polycube /opt/cni/bin /cni && touch /cni-conf /pcn_k8s /opt/cni/bin/polycube && \
 SUDO="" USER="root" WORKDIR="/tmp/dev" ./scripts/install.sh $MODE && \
-# install pcn-kubernetes only components
+# install pcn-k8s only components
 if [ "$MODE" = "pcn-k8s" ] ; then \
     cd /tmp && mkdir -p tmp && cd tmp && \
     curl -sS -L https://storage.googleapis.com/kubernetes-release/network-plugins/cni-0799f5732f2a11b329d9e3d51b9c8f2e3759f2ff.tar.gz -o cni.tar.gz && \
     tar -xvf cni.tar.gz && \
-    mkdir /cni && \
     cp bin/loopback /cni && \
     cd /tmp/polycube/src/components/k8s/cni/polycube && \
     GOOS=linux go build -o /opt/cni/bin/polycube . && \
     cd /tmp/polycube/src/components/k8s/cni/conf && \
     GOOS=linux go build -o /cni-conf . && \
     cd /tmp/polycube/src/components/k8s/pcn_k8s/ && \
     GOOS=linux go build -o /pcn_k8s . ; \
-fi && \
-apt-get purge --auto-remove -y git bison cmake flex \
-libllvm5.0 llvm-5.0-dev libclang-5.0-dev uuid-dev autoconf software-properties-common golang-go \
-libtool curl && \
-apt-get clean && \
-rm -fr /root /var/lib/apt/lists/* /tmp/* /var/tmp/* /usr/local/go/*
-# TODO: which other apt-get packages can be removed?
+fi
+
+# copying cni scripts (will be removed if not needed)
+ADD src/components/k8s/cni/cni-install.sh src/components/k8s/cni/cni-uninstall.sh src/components/k8s/pcn_k8s/cleanup.sh src/components/k8s/pcn_k8s/init.sh /
+
+###############################################
+# STEP 2: using an Ubuntu 18.04 image and extracting executables obtained by the image created at STEP 1.
+# 
+# During this final step a new fresh ubuntu image is used and all the previously generated executables/libraries are copied.
+# This way, this final image contains only the result of the compilation and NOT the entire softwares/scripts needed at compile-time.
+# Moreover, depending on the DEFAULT_MODE, some tools that are needed at runtime (like iptables and iproute2 for the DEFAULT_MODE=pcn-k8s) are
+# installed.
+
+FROM ubuntu:18.04
 
-ADD src/components/k8s/cni/cni-install.sh /cni-install.sh
-ADD src/components/k8s/cni/cni-uninstall.sh /cni-uninstall.sh
-ADD src/components/k8s/pcn_k8s/cleanup.sh /cleanup.sh
-ADD src/components/k8s/pcn_k8s/init.sh /init.sh
+ARG DEFAULT_MODE=default
+ENV MODE=$DEFAULT_MODE
+# copying binaries
+COPY --from=builder /usr/local/bin /usr/local/bin
+COPY --from=builder /usr/local/share/polycube /usr/local/share/polycube
+# copying polycube services
+COPY --from=builder /usr/lib/lib*.so /usr/lib/
+# copying libpistache libyang libtins libprometheus .so
+COPY --from=builder /usr/local/lib/lib*.so /usr/local/lib/
+# copying libyang folder containing plugins (needed for yanglint)
+COPY --from=builder /usr/local/lib/libyang /usr/local/lib/libyang 
+# copying main OS libraries
+COPY --from=builder /usr/lib/x86_64-linux-gnu/libnl*.so /usr/lib/x86_64-linux-gnu/libcrypto*.so\
+	/usr/lib/x86_64-linux-gnu/libelf*.so /usr/lib/x86_64-linux-gnu/libssl*.so \
+	/usr/lib/x86_64-linux-gnu/libpcap*.so /usr/lib/x86_64-linux-gnu/
+COPY --from=builder /lib/x86_64-linux-gnu/libnl*.so /lib/x86_64-linux-gnu/
+# copying base yang model
+COPY --from=builder /usr/local/include/polycube /usr/local/include/polycube
+# copying k8s scripts and cni if present
+COPY --from=builder /*.sh /cni* /pcn_k8s /
+COPY --from=builder /opt/cni/bin/polycube /opt/cni/bin/
+# creating log dir and file + configuring links for libraries + installing essential runtime tools
+RUN mkdir -p /var/log/polycube && touch /var/log/polycube/polycubed.log && \
+# install pcn-k8s only essential tools, else remove useless scripts
+if [ "$MODE" = "pcn-k8s" ] ; then \
+    apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -yq iptables iproute2 && \
+    apt-get purge --auto-remove && apt-get clean ; \
+else \
+    rm -rf /opt/cni/bin/polycube /*.sh /pcn_k8s /cni*; \
+fi && ldconfig
 
 # by running nsenter --mount=/host/proc/1/ns/mnt polycubed, the daemon has a complete view of the namespaces of the host and it is able to manipulate them (needed for shadow services)
 CMD ["nsenter","--mount=/host/proc/1/ns/mnt","polycubed"]

Dockerfile_base_image

@@ -58,8 +58,8 @@ The list of available kernels is available at https://kernel.ubuntu.com/~kernel-
 Automatic installation from sources
 -----------------------------------
 
-If you are running ``Ubuntu >= 18.04`` and you do not want to manually install Polycube and its dependencies, you can use the install script available under the ``scripts`` folder.
-This scripts has been tested on ``Ubuntu 18.04``, ``Ubuntu 19.04`` and ``Ubuntu 20.04``.
+If you are running ``Ubuntu >= 18.04`` and you do not want to manually install Polycube and its dependencies, you can use the install script available under the ``scripts`` folder as follows: ``./scripts/install.sh``. **DO NOT** run with sudo privileges, it will automatically ask you the password when needed, but the entire operations needs to be run by a default user.
+The scripts has been tested on ``Ubuntu 18.04``, ``Ubuntu 19.04`` and ``Ubuntu 20.04``.
 
 Please notice that this script does not update the kernel version.
 

Documentation/installation.rst

@@ -63,8 +63,10 @@ set -e
 
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
+source scripts/pre-requirements.sh
+
 echo "Install Prometheus-cpp"
-cd src/libs/prometheus-cpp
+cd $DIR/../src/libs/prometheus-cpp
 set +e
 if [ -d _build ]; then
     $SUDO rm -rf _build
@@ -75,9 +77,6 @@ cmake .. -DBUILD_SHARED_LIBS=ON
 make -j $(getconf _NPROCESSORS_ONLN)
 $SUDO make install
 
-cd $DIR/..
-
-source scripts/pre-requirements.sh
 
 echo "Install polycube"
 cd $DIR/..