33a1b26a11
Added details on how to build debug docker images and how they can be exploited for debugging.
187 lines
13 KiB
Markdown
187 lines
13 KiB
Markdown
*master*:
|
|
Barefoot: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/barefoot/job/buildimage-bf-all)
|
|
Broadcom: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/broadcom/job/buildimage-brcm-all)
|
|
Mellanox: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/mellanox/job/buildimage-mlnx-all)
|
|
Nephos: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/nephos/job/buildimage-nephos-all)
|
|
P4: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/p4/job/buildimage-p4-all)
|
|
VS: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/buildimage-vs-all)
|
|
|
|
*201811*:
|
|
Broadcom: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/broadcom/job/buildimage-brcm-201811/)
|
|
Barefoot: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/barefoot/job/buildimage-bf-201811/)
|
|
Centec: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/centec/job/buildimage-centec-201811/)
|
|
Nephos: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/nephos/job/buildimage-nephos-201811/)
|
|
Marvell: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/marvell/job/buildimage-mrvl-201811/)
|
|
Mellanox: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/mellanox/job/buildimage-mlnx-201811/)
|
|
VS: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/buildimage-vs-201811)
|
|
|
|
*201807*:
|
|
Broadcom: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/broadcom/job/buildimage-brcm-201807/)
|
|
Barefoot: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/barefoot/job/buildimage-bf-201807/)
|
|
Centec: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/centec/job/buildimage-centec-201807/)
|
|
Nephos: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/nephos/job/buildimage-nephos-201807/)
|
|
Marvell: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/marvell/job/buildimage-mrvl-201807/)
|
|
Mellanox: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/mellanox/job/buildimage-mlnx-201807/)
|
|
|
|
*201803*:
|
|
Broadcom: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/broadcom/job/buildimage-brcm-201803/)
|
|
Cavium: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/cavium/job/buildimage-cavm-201803/)
|
|
Centec: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/centec/job/buildimage-centec-201803/)
|
|
Nephos: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/nephos/job/buildimage-nephos-201803/)
|
|
Marvell: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/marvell/job/buildimage-mrvl-201803/)
|
|
Mellanox: [](https://sonic-jenkins.westus2.cloudapp.azure.com/job/mellanox/job/buildimage-mlnx-201803/)
|
|
|
|
# sonic-buildimage
|
|
|
|
## Build SONiC Switch Images
|
|
|
|
# Description
|
|
|
|
Following is the instruction 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 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](https://github.com/Azure/SONiC/wiki/Supported-Devices-and-Platforms)
|
|
|
|
# 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](https://github.com/Azure/SONiC/wiki/Sonic-Roadmap-Planning) 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](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] 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](README.buildsystem.md).
|
|
|
|
## 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)](https://github.com/Azure/sonic-buildimage/blob/master/README.buildsystem.md).
|
|
|
|
## 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](mailto: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](https://guides.github.com/introduction/flow/). 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](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
|
|
|
|
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.
|