2021-02-22 11:23:37 -06:00
*static analysis*:
2021-01-07 12:02:39 -06:00
2020-04-08 00:45:20 -05:00
[](https://lgtm.com/projects/g/Azure/sonic-buildimage/alerts/)
[](https://lgtm.com/projects/g/Azure/sonic-buildimage/context:python)
2020-05-27 20:12:42 -05:00
*master builds*:
2021-07-09 01:29:35 -05:00
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=146& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=138& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=143& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=140& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=148& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=139& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=141& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=149& branchName=master)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142& branchName=master)
2021-01-07 12:02:39 -06:00
2022-07-03 23:37:21 -05:00
*202205 builds*:
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=146& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=138& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=143& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=140& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=148& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=139& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=141& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=149& branchName=202205)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142& branchName=202205)
2022-12-14 09:06:59 -06:00
*202111 builds*:
2022-07-03 23:37:21 -05:00
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=146& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=138& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=143& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=140& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=148& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=139& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=141& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=149& branchName=202111)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142& branchName=202111)
2021-01-07 12:02:39 -06:00
*202012 builds*:
2021-07-09 01:29:35 -05:00
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=146& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=138& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=143& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=140& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=148& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=141& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=139& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=149& branchName=202012)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142& branchName=202012)
2020-04-08 00:45:20 -05:00
*201911 builds*:
2021-07-09 01:29:35 -05:00
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=146& branchName=201911)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=138& branchName=201911)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=148& branchName=201911)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=139& branchName=201911)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=149& branchName=201911)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142& branchName=201911)
2020-04-08 00:45:20 -05:00
*201811 builds*:
2021-07-09 01:29:35 -05:00
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=138& branchName=201811)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=139& branchName=201811)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=148& branchName=201811)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=149& branchName=201811)
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142& branchName=201811)
2020-04-08 00:45:20 -05:00
2017-02-27 02:13:36 -06:00
# sonic-buildimage
## Build SONiC Switch Images
2016-03-08 13:42:20 -06:00
2020-12-27 01:08:17 -06:00
# Description
2017-03-04 15:48:36 -06:00
2022-12-14 09:06:59 -06:00
Following are the instructions on how to build an [(ONIE) ](https://github.com/opencomputeproject/onie )
compatible network operating system (NOS) installer image for network switches,
and also how to build docker images running inside the NOS.
Note that SONiC images are build per ASIC platform.
Switches using the same ASIC platform share a common image.
For a list of supported switches and ASIC, please refer to this [list ](https://github.com/sonic-net/SONiC/wiki/Supported-Devices-and-Platforms )
2016-03-08 13:42:20 -06:00
2017-05-10 13:21:56 -05:00
# Hardware
2021-08-25 06:35:31 -05:00
Any server can be a build image server as long as it has:
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
* Multiple cores to increase build speed
* Plenty of RAM (less than 8 GiB is likely to cause issues)
* 300G of free disk space
* KVM Virtualization Support.
2022-08-18 17:19:54 -05:00
> Note: If you are in a VM, make sure you have support for nested virtualization.
2022-12-14 09:06:59 -06:00
> Some cases (e.g. building OVS image) also requires extra configuration
> options to expose the full KVM interface to the VM
> (e.g. [the KVM paravirtualization support on VirtualBox](https://www.virtualbox.org/manual/ch10.html#gimproviders)).
2019-07-26 00:06:41 -05:00
2021-08-25 06:35:31 -05:00
A good choice of OS for building SONiC is currently Ubuntu 20.04.
2017-02-27 02:13:36 -06:00
2021-08-25 06:35:31 -05:00
## Prerequisites
2019-08-26 12:35:41 -05:00
2022-12-14 09:06:59 -06:00
* Install pip and jinja in host build machine, execute below commands
if j2/j2cli is not available:
2021-08-25 06:35:31 -05:00
2022-12-14 09:06:59 -06:00
```shell
2021-08-25 06:35:31 -05:00
sudo apt install -y python3-pip
2022-12-14 08:37:49 -06:00
pip3 install --user j2cli
2021-08-25 06:35:31 -05:00
```
2022-12-14 09:06:59 -06:00
* Install [Docker ](https://docs.docker.com/engine/install/ ) 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
2016-12-21 17:51:23 -06:00
2022-12-14 09:06:59 -06:00
> Note: If a previous installation of Docker using snap was present on the
> system, remove it and also remove docker from snap before reinstallating docker.
> This will avoid [known bugs that falsely report read-only filesystems issues](https://stackoverflow.com/questions/52526219/docker-mkdir-read-only-file-system)
> during the build process.
2022-12-14 08:37:49 -06:00
2022-11-18 01:00:16 -06:00
## Clone the repository with all the git submodules
2016-03-22 23:23:05 -05:00
2022-11-18 01:00:16 -06:00
To clone the code repository recursively:
2022-12-14 09:06:59 -06:00
```shell
git clone --recurse-submodules https://github.com/sonic-net/sonic-buildimage.git
```
2016-03-22 23:23:05 -05:00
2017-02-27 02:13:36 -06:00
## Usage
2016-12-20 06:05:22 -06:00
2017-03-04 12:11:20 -06:00
To build SONiC installer image and docker images, run the following commands:
2016-03-08 13:42:20 -06:00
2022-12-14 09:06:59 -06:00
```shell
# Ensure the 'overlay' module is loaded on your development system
sudo modprobe overlay
2018-09-05 00:32:46 -05:00
2022-12-14 09:06:59 -06:00
# Enter the source directory
cd sonic-buildimage
2018-01-03 23:45:08 -06:00
2022-12-14 09:06:59 -06:00
# (Optional) Checkout a specific branch. By default, it uses master branch.
# For example, to checkout the branch 201911, use "git checkout 201911"
git checkout [branch_name]
2018-01-03 23:45:08 -06:00
2022-12-14 09:06:59 -06:00
# Execute make init once after cloning the repo,
# or after fetching remote repo with submodule updates
make init
2017-10-24 21:49:37 -05:00
2022-12-14 09:06:59 -06:00
# Execute make configure once to configure ASIC
make configure PLATFORM=[ASIC_VENDOR]
2018-08-11 16:26:12 -05:00
2022-12-14 09:06:59 -06:00
# Build SONiC image with 4 jobs in parallel.
# Note: You can set this higher, but 4 is a good number for most cases
# and is well-tested.
make SONIC_BUILD_JOBS=4 all
```
2021-08-25 06:35:31 -05:00
2022-12-14 09:06:59 -06:00
The supported ASIC vendors are:
2021-08-25 06:35:31 -05:00
2022-12-14 09:06:59 -06:00
* PLATFORM=barefoot
* PLATFORM=broadcom
* PLATFORM=marvell
* PLATFORM=mellanox
* PLATFORM=cavium
* PLATFORM=centec
* PLATFORM=nephos
* PLATFORM=innovium
* PLATFORM=vs
2016-03-08 13:42:20 -06:00
2019-07-26 00:06:41 -05:00
## Usage for ARM Architecture
2022-12-14 09:06:59 -06:00
ARM build has dependency in docker version 18.
If docker version is 19, downgrade to 18 with:
```shell
2022-09-06 23:25:44 -05:00
sudo apt-get install --allow-downgrades -y docker-ce=5:18.09.0~3-0~ubuntu-xenial
sudo apt-get install --allow-downgrades -y docker-ce-cli=5:18.09.0~3-0~ubuntu-xenial
```
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
To build Arm32 bit for (ARMHF) platform
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
```shell
# Execute make configure once to configure ASIC and ARCH
make configure PLATFORM=[ASIC_VENDOR] PLATFORM_ARCH=armhf
make target/sonic-[ASIC_VENDER]-armhf.bin
```
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
_example:_
2019-09-11 12:12:10 -05:00
2022-12-14 09:06:59 -06:00
```shell
make configure PLATFORM=marvell-armhf PLATFORM_ARCH=armhf
make target/sonic-marvell-armhf.bin
```
2022-07-21 16:15:16 -05:00
2022-12-14 09:06:59 -06:00
To build Arm32 bit for (ARMHF) Marvell platform on amd64 host for debian buster
using cross-compilation, run the following commands:
2022-07-21 16:15:16 -05:00
2022-12-14 09:06:59 -06:00
```shell
# Execute make configure once to configure ASIC and ARCH for cross-compilation build
2022-07-21 16:15:16 -05:00
2022-12-14 09:06:59 -06:00
NOJESSIE=1 NOSTRETCH=1 BLDENV=buster CROSS_BLDENV=1 \
make configure PLATFORM=marvell-armhf PLATFORM_ARCH=armhf
2022-07-21 16:15:16 -05:00
2022-12-14 09:06:59 -06:00
# Execute Arm32 build using cross-compilation environment
2022-07-21 16:15:16 -05:00
2022-12-14 09:06:59 -06:00
NOJESSIE=1 NOSTRETCH=1 BLDENV=buster CROSS_BLDENV=1 make target/sonic-marvell-armhf.bin
```
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
Running the above Arm32 build using cross-compilation instead of qemu emulator
drastically reduces the build time.
2019-07-26 00:06:41 -05:00
2021-02-22 11:23:37 -06:00
To build Arm64 bit for platform
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
```shell
# Execute make configure once to configure ASIC and ARCH
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
make configure PLATFORM=[ASIC_VENDOR] PLATFORM_ARCH=arm64
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
# example:
2019-07-26 00:06:41 -05:00
2022-12-14 09:06:59 -06:00
make configure PLATFORM=marvell-arm64 PLATFORM_ARCH=arm64
```
2019-07-26 00:06:41 -05:00
2017-12-24 01:34:15 -06:00
**NOTE** :
2022-12-14 09:06:59 -06:00
* Recommend reserving at least 100G free space to build one platform
with a single job.
The build process will use more disk if you are setting `SONIC_BUILD_JOBS`
to more than 1.
* If Docker's workspace folder, `/var/lib/docker` ,
resides on a partition without sufficient free space,
you may encounter an error like the following during a Docker container build job:
`/usr/bin/tar: /path/to/sonic-buildimage/< some_file > :
Cannot write: No space left on device`
The solution is to [move the directory ](https://linuxconfig.org/how-to-move-docker-s-default-var-lib-docker-to-another-directory-on-ubuntu-debian-linux )
to a partition with more free space.
* Use
`http_proxy=[your_proxy] https_proxy=[your_proxy] no_proxy=[your_no_proxy] make`
to enable http(s) proxy in the build process.
* Add your user account to `docker` group and use your user account to make.
`root` or `sudo` are not supported.
The SONiC installer contains all docker images needed.
SONiC uses one image for all devices of a same ASIC vendor.
For Broadcom ASIC, we build ONIE and EOS image.
EOS image is used for Arista devices,
ONIE image is used for all other Broadcom ASIC based devices.
```shell
make configure PLATFORM=broadcom
# build debian stretch required targets
BLDENV=stretch make stretch
# build ONIE image
make target/sonic-broadcom.bin
# build EOS image
make target/sonic-aboot-broadcom.swi
```
2018-08-12 03:20:10 -05:00
2022-12-14 09:06:59 -06:00
You may find the rules/config file useful.
It contains configuration options for the build process,
like adding more verbosity or showing dependencies,
username and password for base image etc.
2016-12-06 17:29:25 -06:00
Every docker image is built and saved to target/ directory.
2017-02-27 02:13:36 -06:00
So, for instance, to build only docker-database, execute:
2016-12-06 17:29:25 -06:00
2022-12-14 09:06:59 -06:00
```shell
make target/docker-database.gz
```
2016-12-06 17:29:25 -06:00
Same goes for debian packages, which are under target/debs/:
2022-12-14 09:06:59 -06:00
```shell
make target/debs/swss_1.0.0_amd64.deb
```
2016-12-06 17:29:25 -06:00
2017-02-27 02:13:36 -06:00
Every target has a clean target, so in order to clean swss, execute:
2016-12-06 17:29:25 -06:00
2022-12-14 09:06:59 -06:00
```shell
make target/debs/swss_1.0.0_amd64.deb-clean
```
2016-03-08 13:42:20 -06:00
2022-12-14 09:06:59 -06:00
It is recommended to use clean targets to clean all packages that are built together,
like dev packages for instance.
In order to be more familiar with build process and make some changes to it,
it is recommended to read this short [Documentation ](README.buildsystem.md ).
2016-03-08 13:42:20 -06:00
2022-12-14 09:06:59 -06:00
## Build debug dockers and debug SONiC installer image
SONiC build system supports building dockers and ONIE-image with debug tools
and debug symbols, to help with live & core debugging.
For details refer to [SONiC Buildimage Guide ](https://github.com/sonic-net/sonic-buildimage/blob/master/README.buildsystem.md ).
2019-07-13 14:44:46 -05:00
2021-08-25 06:35:31 -05:00
## SAI Version
2022-12-14 09:06:59 -06:00
Please refer to [SONiC roadmap ](https://github.com/sonic-net/SONiC/wiki/Sonic-Roadmap-Planning )
on the SAI version for each SONiC release.
## Notes
* If you are running make for the first time, a sonic-slave-${USER} docker image
will be built automatically.
This may take a while, but it is a one-time action, so please be patient.
* The root user account is disabled. However, the created user can `sudo` .
* The target directory is `./target` , containing the NOS installer image
and docker images.
* sonic-generic.bin: SONiC switch installer image (ONIE compatible)
* sonic-aboot.bin: SONiC switch installer image (Aboot compatible)
* docker-base.gz: base docker image where other docker images are built from,
only used in build process (gzip tar archive)
* docker-database.gz: docker image for in-memory key-value store,
used as inter-process communication (gzip tar archive)
* docker-fpm.gz: docker image for quagga with fpm module enabled
(gzip tar archive)
* docker-orchagent.gz: docker image for SWitch State Service (SWSS)
(gzip tar archive)
* docker-syncd-brcm.gz: docker image for the daemon to sync database
and Broadcom switch ASIC (gzip tar archive)
* docker-syncd-cavm.gz: docker image for the daemon to sync database
and Cavium switch ASIC (gzip tar archive)
* docker-syncd-mlnx.gz: docker image for the daemon to sync database
and Mellanox switch ASIC (gzip tar archive)
* docker-syncd-nephos.gz: docker image for the daemon to sync database
and Nephos switch ASIC (gzip tar archive)
* docker-syncd-invm.gz: docker image for the daemon to sync database
and Innovium switch ASIC (gzip tar archive)
* docker-sonic-p4.gz: docker image for all-in-one for p4 software switch
(gzip tar archive)
* docker-sonic-vs.gz: docker image for all-in-one for software virtual switch
(gzip tar archive)
* docker-sonic-mgmt.gz: docker image for
[managing, configuring and monitoring SONiC ](https://github.com/sonic-net/sonic-mgmt )
(gzip tar archive)
2016-03-08 13:42:20 -06:00
2017-02-27 02:13:36 -06:00
## Contribution Guide
2016-03-08 13:42:20 -06:00
2022-12-14 09:06:59 -06:00
All contributors must sign a contribution license agreement before contributions
can be accepted.
Visit [EasyCLA - Linux Foundation ](https://easycla.lfx.linuxfoundation.org ).
2016-03-08 13:42:20 -06:00
2017-02-27 02:13:36 -06:00
## GitHub Workflow
2016-03-08 13:42:20 -06:00
2022-12-14 09:06:59 -06:00
We're following basic GitHub Flow.
If you have no idea what we're talking about, check out [GitHub's official guide ](https://guides.github.com/introduction/flow/ ).
Note that merge is only performed by the repository maintainer.
2016-03-08 13:42:20 -06:00
Guide for performing commits:
* Isolate each commit to one component/bugfix/issue/feature
* Use a standard commit message format:
2022-12-14 09:06:59 -06:00
> [component/folder touched]: Description intent of your changes
2016-03-08 13:42:20 -06:00
>
2022-12-14 09:06:59 -06:00
> [List of changes]
2016-03-08 13:42:20 -06:00
>
2022-12-14 09:06:59 -06:00
> Signed-off-by: Your Name your@email.com
2016-03-08 13:42:20 -06:00
For example:
2022-12-14 09:06:59 -06:00
> swss-common: Stabilize the ConsumerTable
2016-03-08 13:42:20 -06:00
>
2022-12-14 09:06:59 -06:00
> * Fixing autoreconf
> * Fixing unit-tests by adding checkers and initialize the DB before start
> * Adding the ability to select from multiple channels
> * Health-Monitor - The idea of the patch is that if something went wrong
> with the notification channel,
> we will have the option to know about it (Query the LLEN table length).
2016-03-08 13:42:20 -06:00
>
2022-12-14 09:06:59 -06:00
> Signed-off-by: user@dev.null
2016-03-08 13:42:20 -06:00
* Each developer should fork this repository and [add the team as a Contributor ](https://help.github.com/articles/adding-collaborators-to-a-personal-repository )
* Push your changes to your private fork and do "pull-request" to this repository
* Use a pull request to do code review
* Use issues to keep track of what is going on
2016-06-21 14:14:24 -05:00
2022-12-14 09:06:59 -06:00
This project has adopted the [Microsoft Open Source Code of Conduct ](https://opensource.microsoft.com/codeofconduct/ ).
For more information see the [Code of Conduct FAQ ](https://opensource.microsoft.com/codeofconduct/faq/ )
or contact [opencode@microsoft.com ](mailto:opencode@microsoft.com )
with any additional questions or comments.
