[doc]: Update README.md (#11960)
* Remove faulty pipeline URLs * Miscellaneous minor fixes
This commit is contained in:
Muhammad Danish
GitHub
parent
5efd6f9748
commit
3b9bbf7d28
31
README.md
31
README.md
@ -14,7 +14,6 @@
|
||||
[](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://sonic-jenkins.westus2.cloudapp.azure.com/job/p4/job/buildimage-p4-all)
|
||||
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142&branchName=master)
|
||||
|
||||
*202205 builds*:
|
||||
@ -70,25 +69,13 @@
|
||||
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=149&branchName=201811)
|
||||
[](https://dev.azure.com/mssonic/build/_build/latest?definitionId=142&branchName=201811)
|
||||
|
||||
*201807 builds*:
|
||||
|
||||
[](https://sonic-jenkins.westus2.cloudapp.azure.com/job/broadcom/job/buildimage-brcm-201807/)
|
||||
[](https://sonic-jenkins.westus2.cloudapp.azure.com/job/barefoot/job/buildimage-bf-201807/)
|
||||
|
||||
*201803 builds*:
|
||||
|
||||
[](https://sonic-jenkins.westus2.cloudapp.azure.com/job/broadcom/job/buildimage-brcm-201803/)
|
||||
[](https://sonic-jenkins.westus2.cloudapp.azure.com/job/nephos/job/buildimage-nephos-201803/)
|
||||
[](https://sonic-jenkins.westus2.cloudapp.azure.com/job/marvell/job/buildimage-mrvl-201803/)
|
||||
[](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/sonic-net/SONiC/wiki/Supported-Devices-and-Platforms)
|
||||
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)
|
||||
|
||||
# Hardware
|
||||
|
||||
@ -156,12 +143,14 @@ To build SONiC installer image and docker images, run the following commands:
|
||||
- PLATFORM=vs
|
||||
|
||||
## Usage for ARM Architecture
|
||||
To build Arm32 bit for (ARMHF) platform
|
||||
ARM build has dependency in docker version 18,
|
||||
if docker version is 19, downgrade to 18 as below
|
||||
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
|
||||
|
||||
ARM build has dependency in docker version 18. If docker version is 19, downgrade to 18 with:
|
||||
```
|
||||
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
|
||||
```
|
||||
To build Arm32 bit for (ARMHF) platform
|
||||
|
||||
# Execute make configure once to configure ASIC and ARCH
|
||||
|
||||
make configure PLATFORM=[ASIC_VENDOR] PLATFORM_ARCH=armhf
|
||||
@ -174,7 +163,7 @@ To build Arm32 bit for (ARMHF) platform
|
||||
|
||||
make target/sonic-marvell-armhf.bin
|
||||
|
||||
To build Arm32 bit for (ARMHF) Marvell platform on amd64 host for debian buster using cross-compilation run the following commands:
|
||||
To build Arm32 bit for (ARMHF) Marvell platform on amd64 host for debian buster using cross-compilation, run the following commands:
|
||||
|
||||
# Execute make configure once to configure ASIC and ARCH for cross-compilation build
|
||||
|
||||
@ -239,7 +228,7 @@ Every target has a clean target, so in order to clean swss, execute:
|
||||
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 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).
|
||||
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).
|
||||
|
||||
## SAI Version
|
||||
Please refer to [SONiC roadmap](https://github.com/sonic-net/SONiC/wiki/Sonic-Roadmap-Planning) on the SAI version for each SONiC release.
|
||||
|
||||
Reference in New Issue
Block a user