vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

contribution: build: use 80 char line breaks

Browse Source
This commit is contained in:
Christian Poessinger 2019-11-09 11:19:21 +01:00
parent ae21024935
commit c1c736ff6e
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,19 +3,20 @@
Building VyOS Building VyOS
============= =============
This will guide you though the process of building a VyOS ISO using This will guide you though the process of building a VyOS ISO using Docker_.
Docker_. This process has been tested on clean installs of Debian Jessie, Stretch, and Buster. This process has been tested on clean installs of Debian Jessie, Stretch, and
Buster.
.. note:: Starting with VyOS 1.2 the release model of VyOS has changed. .. note:: Starting with VyOS 1.2 the release model of VyOS has changed.
VyOS is now **free as in speech, but not as in beer**. This means VyOS is now **free as in speech, but not as in beer**. This means
that while VyOS is still an open source project, the release ISOs are no that while VyOS is still an open source project, the release ISOs are no
longer free and can only be obtained via subscription, or by contributing to longer free and can only be obtained via subscription, or by contributing to
the community. the community.
The source code remains public and an ISO can be built The source code remains public and an ISO can be built
using the process outlined here. using the process outlined here.
Installing Docker_ and prerequisites Installing Docker_ and prerequisites:
.. code-block:: sh .. code-block:: sh
@ -34,16 +35,16 @@ To be able to use Docker_, the current non-root user should be added to the
.. note:: It is recommended to use that non-root user for the remaining steps. .. note:: It is recommended to use that non-root user for the remaining steps.
.. note:: The build process needs to be built on a local file system, building .. note:: The build process needs to be built on a local file system, building
on SMB or NFS shares will result in the container failing to build properly! on SMB or NFS shares will result in the container failing to build properly!
Generating the container Generating the container
---------------------- ----------------------
The container can built by hand or by fetching the pre-built one from The container can built by hand or by fetching the pre-built one from DockerHub.
DockerHub. Using the pre-built VyOS DockerHub organisation (https://hub.docker.com/u/vyos) will Using the pre-built VyOS DockerHub organisation (https://hub.docker.com/u/vyos)
ensure that the container is always up-to-date. A rebuild is triggered once the will ensure that the container is always up-to-date. A rebuild is triggered once
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: The container can always be built directly from source:
@ -57,9 +58,8 @@ The container can always be built directly from source:
found on your local machine when the below command is executed. found on your local machine when the below command is executed.
.. note: We require one container per build branch, this means that the used .. note: We require one container per build branch, this means that the used
container in ``crux`` and ``current`` can and will differ once VyOS makes the container in ``crux`` and ``current`` can and will differ once VyOS makes
move towards Debian (10) Buster. the move towards Debian (10) Buster.
Build ISO inside container Build ISO inside container
-------------------------- --------------------------
@ -84,7 +84,7 @@ image:
* For our VyOS rolling release you should use ``vyos/vyos-build`` which will * For our VyOS rolling release you should use ``vyos/vyos-build`` which will
always refer to the latest image. always refer to the latest image.
This ISO can be customized with the following list of configure options. This ISO can be customized with the following list of configure options.
The full and current list can be generated with ``./configure --help``: The full and current list can be generated with ``./configure --help``:
.. code-block:: sh .. code-block:: sh
@ -112,11 +112,12 @@ The full and current list can be generated with ``./configure --help``:
--custom-apt-key CUSTOM_APT_KEY --custom-apt-key CUSTOM_APT_KEY
Custom APT key file Custom APT key file
The successfully built ISO should now be in the `build/` directory. The successfully built ISO should now be in the `build/` directory.
Good luck! Good luck!
.. note: The build process does not differentiate when building a ``crux`` ISO or ``rolling`` .. note:: The build process does not differentiate when building a ``crux`` ISO
image. Make sure to choose the matching container for the version of VyOS that is being built. or ``rolling`` image. Make sure to choose the matching container for the
version of VyOS that is being built.
.. _Docker: https://www.docker.com .. _Docker: https://www.docker.com