VyOS toplevel build
===================

# WARNING

This repository is for building the VyOS version that is to become 1.2.0 and that is currently in beta testing.
For 1.1.x, use the build-iso repository.


# What is VyOS

VyOS is an open source operating system for network devices (routers, firewalls and so on).
If you want to use it in your network, check out download and installation instructions at https://vyos.io

If you want to modify VyOS and/or join its development, read on.

VyOS is not new. It is a fork of Vyatta Core that was created when the open source version of it was
discontinued. If you are a Vyatta Core user, you can upgrade your installation to VyOS.

# What is this repository?

VyOS is a GNU/Linux distribution based on Debian. Just like any other distribution, it consists of multiple
packages.

Some packages are taken from the upstream, while other are modified or written from scratch by VyOS developers.
Every package maintained by the VyOS team has its own git repository. VyOS image build is therefore a multi-step
process. Packages are compiled first, then an ISO is built from Debian packages and our own packages.

This is the top level repository that contains links to repositories with VyOS-specific packages (organized
as git submodules) and scripts and data that are used for building those packages and the installation image.

# Structure of this repository

There are several directories with their own purpose:

    build/    Used for temporary files used for the build and for build artifacts
    scripts/  Contains scripts that are used for the build process
    data/     Contains data required for buildng the ISO (such as boot splash)
    tools/    Contains scripts that are used for maintainer's tasks automation
              and other purposes, but not in ISO build process

# Building VyOS installation images

## Prerequisites

To build a VyOS image, you need a machine that runs Debian Jessie. Other build hosts are not supported.

Several packages are required for building the ISO and all packages, namely python3, live-build, pbuilder, python3-pystache and devscripts.
Individual packages may have other build dependencies. If some packages are missing, build scripts will tell you.

## Building the ISO image

Before you can build an image, you need to configure your build. 

To build an image, use the following commands:

```
./configure
make iso
```

The ./configure script has a number of options that you can see by calling it with --help

## Building the images for virtualization platforms

* QEMU

Run following command after building the ISO image.

```
make qemu
```

* VMware

Run following command after building the QEMU image.

```
make vmware
```

# Development process

## git branches

The default branch that contains the most recent VyOS code is called 'current' rather than 'master'.
We know if'ts confusing, but it's not easy to fix.
In a nutshell, the code we inherited from Vyatta Core had its master branch so out of sync with everything
it was beyong any repair. Vyatta developers used to create a new branch not when a release is ready for
code freeze, but rather before starting to work on a new release.
This is hard to change in existing code, so this is just the way it is, for now.

All new code goes to the 'current' branch. When it's time for a code freeze, a new branch is created
for the release, and new code from 'current' is backported to the release branch as needed.

For branch naming we use chemical elements (hydrogen, helium, ...).