Skip to content
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.

Sign up for GitHub

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

Update README.md #1

Closed
wants to merge 1 commit into from
Closed

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 10 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,19 @@
# Build Switch Images - buildimage
## Build Switch Images - buildimage

# Description
Build an [Open Network Install Environment (ONIE)](https://github.com/opencomputeproject/onie) compatiable network operating system (NOS) installer image for network switches, and also build docker images running inside the NOS.
Build an [Open Network Install Environment (ONIE)](https://github.com/opencomputeproject/onie) compatible network operating system (NOS) installer image for network switches, and also build docker images running inside the NOS.

# Prerequisite
## 1. Build environment
Preferably use [the Dockerfile](https://github.com/Azure/sonic-build-tools/blob/master/sonic-slave/Dockerfile), or use Debian Jessie and manually install packages appearing in the Dockerfile.
## 2. Linux kernel with switch drivers
Build the [Azure/sonic-linux-kernel](https://github.com/Azure/sonic-linux-kernel) project and copy the output .deb file into ./deps directory.

## 3. initramfs-tools with loop device support
Run the script to build the .deb file into ./deps directory.
## Prerequisites
**1.** Build environment - Preferably use [the Dockerfile](https://github.com/Azure/sonic-build-tools/blob/master/sonic-slave/Dockerfile), or use Debian Jessie and manually install packages appearing in the Dockerfile.
**2.** Linux kernel with switch drivers - Build the [Azure/sonic-linux-kernel](https://github.com/Azure/sonic-linux-kernel) project and copy the output .deb file into ./deps directory.
* initramfs-tools with loop device support - Run the script to build the .deb file into ./deps directory.

./get_deps.sh

## 4. Fetch the git submodule
If there is no files under ./docker-base, manually fetch them.
**3.** Fetch the git submodule - If there is no files under ./docker-base, manually fetch them.

git submodule update --init --recursive

# Usage
## Build NOS installer image
## Build NOS Installer Image

./build_debian USERNAME PASSWORD_ENCRYPTED && ./build_image.sh

Expand All @@ -31,7 +24,7 @@ For example, the user name is 'admin' and the password is 'YourPaSsWoRd'.
The root is disabled, but the created user could sudo.


## Build docker images
## Build Docker Images

./build_docker.sh docker-sswsyncd
./build_docker.sh docker-database
Expand All @@ -40,7 +33,7 @@ The root is disabled, but the created user could sudo.
./build_docker.sh docker-lldp
./build_docker.sh docker-basic_router

# Contribution guide
## Contribution Guide

All contributors must sign a contribution license agreement before contributions can be accepted. Contact [email protected]. Later this will be automated.

Expand Down