Description

SONiC-VPP is a platform under SONIC that supports VPP data plane. For more details about VPP see What is VPP

This repo contains scripts, Makefiles, configuration file, Docker files etc to build a SONIC-VPP image. It also pulls some extra git repos and makes these repos part of SONiC build. In this process it will prompt for user/password while cloning. There are some VPP platform specific Makefile, config files which are applied to the sonic-buildimage repo to fecilitate the successful build of the SONiC-VPP image.

Note: The first build takes good amount of time. The SONiC image build has two parts to it, backend and frontend. The backend consumes a lot of time when the build is done first time. The follow on builds only do the frontend.

Caveat- The documentation for this project is a work in progress and a bit terse. We hope to address this in coming weeks.

Prerequisites

• Linux host machine running ubuntu 18.x or later distribution (Ubuntu 20.x is preferred).
• Install the following packages

sudo apt-get install -y make automake autoconf
sudo apt install -y python3-pip
sudo pip3 install j2cli

• Install Docker and configure your system to allow running the 'docker' command without 'sudo':
  • Add current user to the docker group: sudo gpasswd -a ${USER} docker
  • Log out and log back in so that your group membership is re-evaluated

SONiC VPP image build

There are two types of sonic-vpp image build targets supported

• Single docker container image (docker-sonic-vpp.gz) with a subset of SONIC features
• Comprehensive SONiC-VPP qemu VM image

Building a single container image

Issue the command shown below. It will pull the required repos, setup the vpp platform, configure and then initiate the image build.

make sonic

Note- If your internet access is only through a proxy, set the http_proxy and issue the command as suggested below

http_proxy=http_proxy_url https_proxy=https_proxy_url no_proxy=localhost,127.0.0.1,<other_hosts_or_ipaddresses> make sonic

To use a different label for SONiC build

SONIC_CHECKOUT_LABEL=sonic_git_commit_label make sonic

To build a debug container image run below command

INSTALL_DEBUG_TOOLS=y make sonic

Note: Refer the instructions above on how to pass proxy if internet access is only though proxy

The ./build directory contains all the repos pulled. The ./build/sonic-buildimage/target directory contains the sonic vpp targets.

In case of a build failure just run below command. There is no need to do rest of targets in the Makefile.

make sonic_build

If internet access is only through a proxy use below command

http_proxy=http_proxy_url http_proxy=https_proxy_url no_proxy=localhost,127.0.0.1,other_hosts_or_ipaddresses make sonic

To use a different label for SONiC build

SONIC_CHECKOUT_LABEL=sonic_git_commit_label make sonic_build

Note : The nightly build labels can be found here

The built image can be found at ./build/sonic-buildimage/target/docker-sonic-vpp.gz.

Testing the single container image

Refer to the Getting started document in docs directory for details.

Building a KVM VM image

Run below make command (in case of proxy use the proxy parameters as mentioned above in the "make sonic" build)

make sonic_vm

To build a debug VM image image run below command

INSTALL_DEBUG_TOOLS=y make sonic_vm

The built vm image can be found at build/sonic-buildimage/target/sonic-vpp.img.gz.

Testing the qemu VM image

Refer to the document in docs directory for details.

Troubleshooting

http(s)_proxy driven make fails sometimes with package download failure. It says hash mismatch. This may be caused by some bug in the proxy which corrupts some bytes or downloaded package is incomplete. The fix is to run the make sonic_build again.

E: Failed to fetch http://debian-archive.trafficmanager.net/debian/pool/main/p/perl/libperl5.32_5.32.1-4%2bdeb11u2_amd64.deb  Hash Sum mismatch
   Hashes of expected file:
    - SHA256:224cafe65968deb83168113b74dff2d2f13b115a41d99eb209ed3b8f981df0b3
    - MD5Sum:4a5dab70f461660deab6fd03b2f991f6 [weak]
    - Filesize:4106072 [weak]
    - SHA512:6f65c014dc3d71538eeff28499e857315b001edf34b7d27f9ba63ba4ae84296b23a03cf4d3684f048d2cf3ae6591f961e808041015c8cbf87993b37fceae21fc
    - SHA1:70b59e8890820d4b278dee5bea5d6c09e94a5c6a [weak]
   Hashes of received file:
    - SHA512:62f8a2073aab62c19e5233c527057365e928d4c27eb37e0cb5081fd2982cda265ff7088baf4539af754333fa0625370e1b38e02715fba056e1f8bad1d589c2b1
    - SHA256:f7b2db46905d4209ffea09a103f8a1b6e836075a547d1cd173ea49a12ce2f6d0
    - SHA1:988a27690b32fafa9bed3a20574554bd27599e71 [weak]
    - MD5Sum:0816cefaa91ea671925de07760480d86 [weak]
    - Filesize:4106072 [weak]
   Last modification reported: Thu, 30 Sep 2021 21:42:11 +0000
E: Unable to fetch some archives, maybe run apt-get update or try with --fix-missing?