Skip to content

Update build steps in BuildTargetImage.md #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions BuildTargetImage.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,20 @@ your image, follow the instructions in [Exercise 1 - Deploy SONiC/PINS Target
Image to Switches](./Exercise1).

The following software is needed to build the image: `curl, zip, unzip, tar,
python,` and `j2cli`. If you need to do a local build of the ONOS driver and SAI
python, j2cli` and `docker`.
> Note: Ensure that docker is not installed through snap. You may follow this guide [here](https://docs.docker.com/engine/install/ubuntu/). Follow post-install steps to make sure docker runs without `sudo`.

If you need to do a local build of the ONOS driver and SAI
pipeline, you will also need `maven` and a Java JDK.

1. Clone the PINS/sonic-buildimage repository using one of the following:
* HTTPS: `git clone https://github.com/Azure/sonic-buildimage.git`
* SSH: `git clone [email protected]:Azure/sonic-buildimage.git`
* Github CLI: `gh repo clone Azure/sonic-buildimage`
2. Change to the new directory: `cd sonic-buildimage`
3. Download submodules and checkout the correct commit number: `make init`
3. Ensure that overlay module is loaded on your development system: `sudo modprobe overlay`
4. (Optional) Checkout a specific branch. By default, it uses master branch: `git checkout [branch_name]`
5. Download submodules and checkout the correct commit number: `make init`

### Build Target Binary

Expand Down