vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-21 13:03:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #255 from fetzerms/clarfiy-docker-documentation

Browse Source 
T2474: Contributing/Docker: Put more detail into building instructions.
This commit is contained in:
Daniil Baturin 2020-05-20 01:05:01 +07:00 committed by GitHub
commit f84e1d07cf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/contributing/build-vyos.rst
View File

@ -48,7 +48,14 @@ will ensure that the container is always up-to-date. A rebuild is triggered once
the container changes (please note this will take 2-3 hours after pushing to the container changes (please note this will take 2-3 hours after pushing to
the vyos-build repository). the vyos-build repository).
The container can always be built directly from source: To download the container from DockerHub run:
.. code-block:: none
$ docker pull vyos/vyos-build:crux # for the LTS version
$ docker pull vyos/vyos-build:current # for the current version
The container can also be built directly from source:
.. code-block:: none .. code-block:: none
@ -71,14 +78,27 @@ Build ISO
After the container is generated either manually or fetched from DockerHub, After the container is generated either manually or fetched from DockerHub,
a fresh build of the VyOS ISO can begin. a fresh build of the VyOS ISO can begin.
If you pulled the image from DockerHub, you need to clone the repository to
your local machine:
.. code-block:: none .. code-block:: none
$ git clone -b current --single-branch https://github.com/vyos/vyos-build
After cloning, change directory to the ``vyos-build`` directory and run:
.. code-block:: none
$ cd vyos-build
$ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build bash $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build bash
vyos_bld@d4220bb519a0:/vyos# ./configure --architecture amd64 \ vyos_bld@d4220bb519a0:/vyos# ./configure --architecture amd64 \
--build-by "your@email.tld" \ --build-by "your@email.tld" \
--build-type release --version 1.2.0 --build-type release --version 1.2.0
vyos_bld@d4220bb519a0:/vyos# sudo make iso vyos_bld@d4220bb519a0:/vyos# sudo make iso
When the build is successful, the resulting iso can be found inside the ``build``
directory.
.. note:: Attempting to use the docker build image on MacOS or Windows will fail .. note:: Attempting to use the docker build image on MacOS or Windows will fail
as docker does not expose all the filesystem feature required to the container. as docker does not expose all the filesystem feature required to the container.
Building within a VirtualBox server on Mac or Windows is however possible. Building within a VirtualBox server on Mac or Windows is however possible.