Scripts which perform an installable binary image build for SONiC
Go to file
Joe LeVeque c9d4afede9 [sonic-utilities] Update submodule (#3173)
* ee56d54 2019-07-16 | [fast-reboot] Stop services after killing containers to prevent automatic restart (#572) (HEAD -> master, origin/master, origin/HEAD) [Joe LeVeque]
* c718cab 2019-07-17 | [acl_loader]: Fix show mirror_session error (#580) [JaredLius]
* 2764c6c 2019-07-16 | [Mellanox] Improve the prompt of the Mellanox sdk sniffer command. (#546) [Stephen Sun]
* 5a5b74d 2019-07-10 | Generate interface table to have an entry for default VRF (#525) [Prince Sunny]
* c30e9ff 2019-07-10 | [show] Don't abort in InterfaceAliasConverter ctor if PORT table doesn't exist (#571) [Joe LeVeque]
* 1aac696 2019-07-10 | [fast reboot] stop removing opennsl module before reboot (#560) [Ying Xie]
* 37823d4 2019-07-09 | Modified CLI doc for 201904 release, changed the config interface command, etc., (#561) [kannankvs]
* 77ae6b8 2019-07-03 | [PR template] Add reminder to update Command Line Reference Guide if modifying user-facing commands (#569) [Joe LeVeque]
* dc52015 2019-06-25 | [Sonic-utilities]: Added commands to view acl and port running configs (#557) [Prem Prakash]
* c7f45c3 2019-06-19 | [warm-reboot] Use retryCount option of orchagent_restart_check program (#555) [Jipan Yang]
* c6a08f7 2019-06-17 | [scripts]: add support to db_migrator for non-default unix socket (#551) [Lawrence Lee]
* 98e087f 2019-06-06 | [show]: Edit comment (#549) [Vasant Patil]
* 5667a90 2019-06-06 | [intfutil] Fix error when <interface name> specified in show interface related commands (#548) [Gord Chen]
* b7fcb1f 2019-06-04 | Add buffer pool watermark support in watermarkstat and counterpoll (#521) [Wenda Ni]
* 635dc88 2019-06-03 | [config]: Add config acl add/remove table command (#541) [Shuotian Cheng]
* dcdc922 2019-06-03 | [show]: Add show policer command (#540) [Shuotian Cheng]
* 82ef3ec 2019-06-01 | IP Address validation check (#530) [Tapash Das]
* 1f326ad 2019-05-31 | [show] Remove ability to clear counters from 'show' commands (#518) [Joe LeVeque]
* 669d36d 2019-06-01 | Add SONIC CLI Manual (#533) [kannankvs]
* 7657001 2019-06-01 | 'show vlan config' not displaying the VLAN members, after the clear config and reload with default l2 configuration. (#457) [RAMA CHANDRA REDDY GADDAM]
* 9493883 2019-05-28 | use vlan members (#542) [trzhang-msft]
* 128462a 2019-05-22 | [config]: Add --policer option for mirror session (#537) [Shuotian Cheng]
* 38da7f3 2019-05-22 | [acl_loader]: Add policer attribute in show mirror_session command (#538) [Shuotian Cheng]
* f95ff00 2019-05-22 | [acl_loader]: Do not apply default DENY rule for MIRRORV6 table (#522) [Shuotian Cheng]
* 50b7256 2019-05-21 | [sonic_installer] If asked to install an image which is already installed, simply set as default (#534) [Joe LeVeque]
* d823062 2019-05-20 | [201811] enable DB migrator code (#536) [Ying Xie]
* 7f7f384 2019-05-10 | update scheme variable name (#531) [trzhang-msft]
* c66315a 2019-05-10 | Config interface Loopback0 ip add/del is not working (#443) [Kiran Kumar Kella]
* 430d4b8 2019-05-10 | decode-syseeprom : added new option to show the Product Name. (#496) [Olivier Singla]
2019-07-17 08:45:08 -07:00
.github [github]: add templates for submitting issues and PR (#947) 2017-09-08 21:27:15 -07:00
device [devices]: DellEMC S6100 Enabling Polling Mode for Miim Operation (#3133) 2019-07-16 15:14:43 -07:00
dockers [sonic-cfggen][FRR] Support T2 chassis frontend (#3100) 2019-07-08 17:32:20 -07:00
files [baseimage]: Fix process-reboot-cause possibly throwing OSError (#3159) 2019-07-16 08:34:11 -07:00
installer [submodule] update sonic-linux-kernel (#2985) 2019-06-18 10:00:16 -07:00
platform [Mellanox]Update hw-mgmt package to v183 (#3138) 2019-07-12 13:09:36 +03:00
rules [sairedis.mk] do not build rpc sairedis when not needed (#3109) 2019-07-06 14:55:31 -07:00
scripts [build]: Added debug symbols to many debug dockers. (#3098) 2019-07-03 22:13:55 -07:00
sonic-slave [build] Add option to avoid Docker base image :latest tag (#3124) 2019-07-13 12:43:45 -07:00
sonic-slave-stretch [build] Add option to avoid Docker base image :latest tag (#3124) 2019-07-13 12:43:45 -07:00
src [sonic-utilities] Update submodule (#3173) 2019-07-17 08:45:08 -07:00
.gitignore [gitignore] Ignore .DS_Store files (#2997) 2019-06-13 16:00:30 -07:00
.gitmodules [FRR]: Update frr to frr-7.0.1 (#2899) 2019-05-16 10:59:12 -07:00
build_debian.sh [baseimage]: Remove old ping permission fix because of aufs->overlay filesystem (#3154) 2019-07-13 12:38:10 -07:00
build_debug_docker_j2.sh [build]: Updated Makefile infrastructure to build debug images. (#2753) 2019-04-13 17:05:18 -07:00
build_docker.sh Split script: push_docker.sh (#89) 2016-12-01 02:18:59 -08:00
build_image.sh [vs]: fail the build when build kvm image fails (#2297) 2018-11-25 11:33:00 -08:00
build_kvm_image.sh [build] force Linux to drop cache before calling kvm (#2717) 2019-03-29 15:25:17 -07:00
check_install.py [vs]: fail the build when build kvm image fails (#2297) 2018-11-25 11:33:00 -08:00
functions.sh [build] When generating image version, handle case where current commit has no reachable tags (#2506) 2019-01-31 14:48:48 -08:00
get_docker-base.sh Add mkdir if the target dir does not exist (#130) 2016-12-16 02:19:15 +00:00
LICENSE updating readme, formatting in license 2016-03-09 17:39:34 +00:00
MAINTAINERS Adding license and maintainers 2016-03-08 19:10:18 -08:00
Makefile [build]: make sonic-slave-stretch as the default build docker (#2921) 2019-05-27 15:50:51 -07:00
Makefile.work [build] Add option to avoid Docker base image :latest tag (#3124) 2019-07-13 12:43:45 -07:00
onie-image.conf [vs]: build sonic vs kvm image (#2269) 2018-11-20 22:32:40 -08:00
onie-mk-demo.sh [image]: build sonic-broadcom.raw image for sonic conversion from ftos (#901) 2017-08-27 20:13:38 -07:00
push_docker.sh [docker] Refine docker tag for build number (#1484) 2018-03-12 14:45:35 -07:00
README.buildsystem.md [build]: Added debug dockers & image info (#3121) 2019-07-13 12:44:46 -07:00
README.md [build]: Added debug dockers & image info (#3121) 2019-07-13 12:44:46 -07:00
slave.mk [build]: Added debug symbols to many debug dockers. (#3098) 2019-07-03 22:13:55 -07:00
ThirdPartyLicenses.txt Config apt inside docker images to save disk space: auto clean, gz, no trans (#69) 2016-11-16 12:46:15 -08:00
update_screen.sh [rules/functions][slave.mk]: Refine build output (#838) 2017-07-25 09:49:39 +03:00

master: Barefoot: Barefoot Broadcom: Broadcom Mellanox: Mellanox Nephos: Nephos P4: P4 VS: VS

201811: Broadcom: Broadcom Barefoot: Mellanox Centec: Centec Nephos: Nephos Marvell: Marvell Mellanox: Mellanox VS: VS

201807: Broadcom: Broadcom Barefoot: Mellanox Centec: Centec Nephos: Nephos Marvell: Marvell Mellanox: Mellanox

201803: Broadcom: Broadcom Cavium: Cavium Centec: Centec Nephos: Nephos Marvell: Marvell Mellanox: Mellanox

sonic-buildimage

Build SONiC Switch Images

Description

Following is the instruction on how to build an (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 image 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

Hardware

Any server can be a build image server. We are using a server with 1T hard disk. The OS is Ubuntu 16.04.

Prerequisites

SAI Version

Please refer to SONiC roadmap on the SAI version for each SONiC release.

Clone or fetch the code repository with all git submodules

To clone the code repository recursively, assuming git version 1.9 or newer:

git clone https://github.com/Azure/sonic-buildimage.git

Usage

To build SONiC installer image and docker images, run the following commands:

# Ensure the 'overlay' module is loaded on your development system
sudo modprobe overlay

# Enter the source directory
cd sonic-buildimage

# (Optional) Checkout a specific branch. By default, it uses master branch
git checkout [branch_name]

# Execute make init once after cloning the repo, or after fetching remote repo with submodule updates
make init

# Execute make configure once to configure ASIC
make configure PLATFORM=[ASIC_VENDOR]

# Build SONiC image
make all

NOTE:

  • Recommend reserving 50G free space to build one platform.

  • 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 to a partition with more free space.

  • Use http_proxy=[your_proxy] https_proxy=[your_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. The supported ASIC vendors are:

  • PLATFORM=broadcom
  • PLATFORM=marvell
  • PLATFORM=mellanox
  • PLATFORM=cavium
  • PLATFORM=centec
  • PLATFORM=nephos
  • PLATFORM=p4
  • PLATFORM=vs

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.

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

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.

Every docker image is built and saved to target/ directory. So, for instance, to build only docker-database, execute:

make target/docker-database.gz

Same goes for debian packages, which are under target/debs/:

make target/debs/swss_1.0.0_amd64.deb

Every target has a clean target, so in order to clean swss, execute:

make target/debs/swss_1.0.0_amd64.deb-clean

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.

Build debug dockers and debug SONiC installer image:

SONiC build system supports building dockers and ONE-image with debug tools and debug symbols, to help with live & core debugging. For details refer to (SONiC Buildimage Guide).

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-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)

Contribution Guide

All contributors must sign a contribution license agreement before contributions can be accepted. Contact sonic-cla-agreements@microsoft.com.

GitHub Workflow

We're following basic GitHub Flow. If you have no idea what we're talking about, check out GitHub's official guide. Note that merge is only performed by the repository maintainer.

Guide for performing commits:

  • Isolate each commit to one component/bugfix/issue/feature
  • Use a standard commit message format:
[component/folder touched]: Description intent of your changes

[List of changes]

Signed-off-by: Your Name your@email.com

For example:

swss-common: Stabilize the ConsumerTable

* 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).

  Signed-off-by: user@dev.null
  • Each developer should fork this repository and add the team as a Contributor
  • 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

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.