README.md

VyOS Module

Open-source module to configure VyOS network devices.

Usage

In order to get started with using this module, we have prepared a bunch of YouTube videos to walk you through the entire process. The links to these videos are mentioned below.

1. OSPF configuration - Flat model
2. OSPF configuration - Enhanced model
3. Contributing to VyOS module - OSPFv3

Running tests

Python 3.9+ is required to run tests. If your system does not ship with that version installed, pyenv can be used to install additional Python versions.

1. Create a virtual environment:

   python3.9 -m venv ~/.virtualenvs/vyos

2. Install the dependencies:

   source ~/.virtualenvs/vyos/bin/activate
   pip install -r requirements.txt
   pip install -r requirements.dev.txt

3. Set up the test environment by following this guide.

4. Make a clean-slate configuration file by connecting to the VyOS device and running the following command:

   configure
   save /config/clear.config

   This clear.config file is used in the tests to automatically clear the configuration, avoiding potential conflicts.

5. Run the tests:

   export VY_TEST_HOST="10.11.12.100"
   pytest tests

Contributing

All contributions are welcome by following this guide. We have a video for that as well!