README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# vyos-1x: VyOS 1.2.0+ configuration scripts and data

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=vyos%3Avyos-1x&metric=coverage)](https://sonarcloud.io/component_measures?id=vyos%3Avyos-1x&metric=coverage)
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvyos%2Fvyos-1x.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvyos%2Fvyos-1x?ref=badge_shield)

VyOS 1.1.x had its codebase split into way too many submodules for no good reason, which made it hard
to navigate or write meaningful changelogs. As the code undergoes rewrite in the new style in VyOS 1.2.0+,
we consolidate the rewritten code in this package.

If you just want to build a VyOS image, the repository you want is [vyos-build](https://github.com/vyos/vyos-build).
If you also want to contribute to VyOS, read on.

## Package layout

```
interface-definitions  # Configuration interface (i.e. conf mode command) definitions
op-mode-definitions    # Operational command definitions
src
    conf_mode/  # Configuration mode scripts
    op_mode/    # Operational mode scripts
    completion/ # Completion helpers
    validators/ # Value validators
    helpers/    # Misc helpers
    migration-scripts # Migration scripts
    tests/      # Unit tests

python/  # Python modules

scripts/ # Build-time scripts
schema/  # XML schemas
```

## Interface/command definitions

Raw node.def files for the old backend are no longer written by hand or generated by custom sciprts.
They are all now produced from a unified XML format that supports a strict subset of the old backend
features. In particular, it intentionally does not support embedded shell scripts, default values,
and value "types", instead delegating those tasks to external scripts.

Configuration interface definitions must conform to the schema found in schema/interface_definition.rng
and operational command definitions must conform to schema/op-mode-definition.rng
Schema checks are performed at build time, so a package with malformed interface definitions will not build.

## Configuration scripts

The guidelines in a nutshell:

* Use separate functions for retrieving configuration data, validating it, and generating taret config
* Use a template processor when the format is more complex than just one line (jinja2 and pystache are acceptable options) 

## Tests

Tests are executed at build time, you can also execute them by hand with:

```
pipenv install
pipenv shell
make test
```


## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvyos%2Fvyos-1x.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvyos%2Fvyos-1x?ref=badge_large)