diff options
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/build-vyos.rst | 13 | ||||
| -rw-r--r-- | docs/contributing/development.rst | 10 |
2 files changed, 15 insertions, 8 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index cb97e418..935f73b5 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -95,9 +95,9 @@ The container can also be built directly from source: $ docker build -t vyos/vyos-build:crux docker # For VyOS 1.2 $ docker build -t vyos/vyos-build:current docker # For rolling release -.. note:: Since VyOS has switched to Debian (10) Buster in its ``current`` - branch, you will require individual container for `current` and `crux` - builds. +.. note:: Since VyOS has switched to Debian (11) Bullseye in its ``current`` + branch, you will require individual container for `current`, `equuleus` and + `crux` builds. Tips and Tricks --------------- @@ -129,6 +129,13 @@ per release train (`current` or `crux`) - container. Add the following to your Now you are prepared with two new aliases ``vybld`` and ``vybld_crux`` to spawn your development containers in your current working directory. +.. note:: Some VyOS packages (namely vyos-1x) come with build-time tests which + verify some of the internal library calls that they work as expected. Those + tests are carried out through the Python Unittest module. If you wan't to + build the ``vyos-1x`` package (which is our main development package) you need + to start your Docker container using the following argument: + ``--sysctl net.ipv6.conf.lo.disable_ipv6=0``, otherwise those tests will fail. + .. _build_native: Native Build diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index cf274a33..591deedf 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -295,7 +295,7 @@ device if you happen to be a crazy scientist. conf = config else: conf = Config() - + # Base path to CLI nodes base = ['...', '...'] # Convert the VyOS config to an abstract internal representation @@ -320,7 +320,7 @@ device if you happen to be a crazy scientist. c = get_config() verify(c) generate(c) - apply(c) + apply(c) except ConfigError as e: print(e) sys.exit(1) @@ -685,9 +685,9 @@ Migrating old CLI Continuous Integration ====================== -VyOS makes use of Jenkins_ as our Continuous Integration (CI) service. Our CI -server is publicly accessible here: https://ci.vyos.net. You can get a brief -overview of all required components shipped in a VyOS ISO. +VyOS makes use of Jenkins_ as our Continuous Integration (CI) service. Our +`VyOS CI`_ server is publicly accessible here: https://ci.vyos.net. You can get +a brief overview of all required components shipped in a VyOS ISO. To build our modules we utilize a CI/CD Pipeline script. Each and every VyOS component comes with it's own ``Jenkinsfile`` which is (more or less) a copy. |