From 4c8df5beb310f6688238d6d3be70d1483eb7d716 Mon Sep 17 00:00:00 2001 From: sofukong <130022807+sofukong@users.noreply.github.com> Date: Thu, 21 Dec 2023 15:20:54 +0800 Subject: [PATCH 1/4] Update Debian version Update Debian version --- docs/contributing/build-vyos.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 80f800c2c6..458a9d4640 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -24,8 +24,8 @@ also set up your own build machine and run a :ref:`build_native`. outlined in this chapter. This will guide you through the process of building a VyOS ISO using 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 Bullseye (11) and +Bookworm (12). .. _build_docker: From a470d746509adbe3d72cbfe2466f07ba27b9bea9 Mon Sep 17 00:00:00 2001 From: sofukong <130022807+sofukong@users.noreply.github.com> Date: Thu, 21 Dec 2023 15:43:42 +0800 Subject: [PATCH 2/4] Native Build update Changed the position of Native Build to make it easier to distinguish from containers, and updated some content. --- docs/contributing/build-vyos.rst | 78 ++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 34 deletions(-) diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 458a9d4640..d7c9ce3657 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -23,6 +23,50 @@ also set up your own build machine and run a :ref:`build_native`. The source code remains public and an ISO can be built using the process outlined in this chapter. +.. _build_native: + +Native Build +============ + +To build VyOS natively you require a properly configured build host with the +following Debian versions installed: + +- Debian Jessie for VyOS 1.2 (crux) +- Debian Buster for VyOS 1.3 (equuleus) +- Debian Bullseye for VyOS 1.4 (sagitta) +- Debian unknown for VyOS 1.5 (circinus, current) - aka the rolling release + +To start, clone the repository to your local machine: + +.. code-block:: none + + # For VyOS 1.2 (crux) + $ git clone -b crux --single-branch https://github.com/vyos/vyos-build + + # For VyOS 1.3 (equuleus) + $ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build + + # For VyOS 1.4 (sagitta) + $ git clone -b sagitta --single-branch https://github.com/vyos/vyos-build + + # For VyOS 1.5 (circinus, current) + $ git clone -b current --single-branch https://github.com/vyos/vyos-build + + $ cd vyos-build + + # For VyOS 1.2 (crux) and VyOS 1.3 (equuleus) + $ ./configure --architecture amd64 --build-by "j.randomhacker@vyos.io" + $ sudo make iso + + # For VyOS 1.4 (sagitta) + $ sudo make clean + $ sudo ./build-vyos-image iso --architecture amd64 --build-by "j.randomhacker@vyos.io" + +For the packages required, you can refer to the ``docker/Dockerfile`` file +in the repository_. The ``./build-vyos-image`` script will also warn you if any +dependencies are missing. + + This will guide you through the process of building a VyOS ISO using Docker_. This process has been tested on clean installs of Debian Bullseye (11) and Bookworm (12). @@ -141,40 +185,6 @@ your development containers in your current working directory. ``--sysctl net.ipv6.conf.lo.disable_ipv6=0``, otherwise those tests will fail. -.. _build_native: - -Native Build -============ - -To build VyOS natively you require a properly configured build host with the -following Debian versions installed: - -- Debian Jessie for VyOS 1.2 (crux) -- Debian Buster for VyOS 1.3 (equuleus) -- Debian Bullseye for VyOS 1.4 (sagitta, current) - aka the rolling release - -To start, clone the repository to your local machine: - -.. code-block:: none - - # For VyOS 1.2 (crux) - $ git clone -b crux --single-branch https://github.com/vyos/vyos-build - - # For VyOS 1.3 (equuleus) - $ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build - - # For VyOS 1.4 (sagitta, current) - $ git clone -b current --single-branch https://github.com/vyos/vyos-build - - -For the packages required, you can refer to the ``docker/Dockerfile`` file -in the repository_. The ``./build-vyos-image`` script will also warn you if any -dependencies are missing. - -Once you have the required dependencies installed, you may proceed with the -steps described in :ref:`build_iso`. - - .. _build_iso: ********* From fed2c7d25e243a391723e760e680745da67618d2 Mon Sep 17 00:00:00 2001 From: sofukong <130022807+sofukong@users.noreply.github.com> Date: Sat, 23 Dec 2023 10:16:52 +0800 Subject: [PATCH 3/4] Update Debian version corresponding to VyOS 1.4 Update Debian version corresponding to VyOS 1.4 --- docs/contributing/build-vyos.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index d7c9ce3657..9afd1fbb4a 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -33,8 +33,8 @@ following Debian versions installed: - Debian Jessie for VyOS 1.2 (crux) - Debian Buster for VyOS 1.3 (equuleus) -- Debian Bullseye for VyOS 1.4 (sagitta) -- Debian unknown for VyOS 1.5 (circinus, current) - aka the rolling release +- Debian Bookworm for VyOS 1.4 (sagitta) +- Debian Bookworm for VyOS 1.5 (circinus, current) - aka the rolling release To start, clone the repository to your local machine: From 2eb67240f4e9625e6932cfebe07c17732a6da344 Mon Sep 17 00:00:00 2001 From: sofukong <130022807+sofukong@users.noreply.github.com> Date: Sat, 23 Dec 2023 14:38:03 +0800 Subject: [PATCH 4/4] Some optimization adjustments Some optimization adjustments --- docs/contributing/build-vyos.rst | 28 ++++++++++------------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 9afd1fbb4a..9b15ddb13a 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -23,6 +23,10 @@ also set up your own build machine and run a :ref:`build_native`. The source code remains public and an ISO can be built using the process outlined in this chapter. + Due to changes in software versions, VyOS 1.3 and earlier versions are no + longer available below. Please refer to the instructions for previous + versions if needed. + .. _build_native: Native Build @@ -31,8 +35,6 @@ Native Build To build VyOS natively you require a properly configured build host with the following Debian versions installed: -- Debian Jessie for VyOS 1.2 (crux) -- Debian Buster for VyOS 1.3 (equuleus) - Debian Bookworm for VyOS 1.4 (sagitta) - Debian Bookworm for VyOS 1.5 (circinus, current) - aka the rolling release @@ -40,12 +42,6 @@ To start, clone the repository to your local machine: .. code-block:: none - # For VyOS 1.2 (crux) - $ git clone -b crux --single-branch https://github.com/vyos/vyos-build - - # For VyOS 1.3 (equuleus) - $ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build - # For VyOS 1.4 (sagitta) $ git clone -b sagitta --single-branch https://github.com/vyos/vyos-build @@ -54,11 +50,7 @@ To start, clone the repository to your local machine: $ cd vyos-build - # For VyOS 1.2 (crux) and VyOS 1.3 (equuleus) - $ ./configure --architecture amd64 --build-by "j.randomhacker@vyos.io" - $ sudo make iso - - # For VyOS 1.4 (sagitta) + # For VyOS 1.4 (sagitta) and For VyOS 1.5 (circinus, current) $ sudo make clean $ sudo ./build-vyos-image iso --architecture amd64 --build-by "j.randomhacker@vyos.io" @@ -67,15 +59,15 @@ in the repository_. The ``./build-vyos-image`` script will also warn you if any dependencies are missing. -This will guide you through the process of building a VyOS ISO using Docker_. -This process has been tested on clean installs of Debian Bullseye (11) and -Bookworm (12). - .. _build_docker: Docker ====== +This will guide you through the process of building a VyOS ISO using Docker_. +This process has been tested on clean installs of Debian Bullseye (11) and +Bookworm (12). + Installing Docker_ and prerequisites: .. code-block:: none @@ -846,7 +838,7 @@ information. .. stop_vyoslinter -.. _Docker: https://www.docker.com +.. _Docker: https://docs.docker.com/engine/install/debian/ .. _`Docker as non-root`: https://docs.docker.com/engine/install/linux-postinstall .. _VyOS DockerHub organisation: https://hub.docker.com/u/vyos .. _repository: https://github.com/vyos/vyos-build