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
|
# Copilot Review Instructions — vyos.vyos
This is the `vyos.vyos` Ansible network collection for managing VyOS devices.
Namespace `vyos`, name `vyos`, version `6.0.0`. All modules are prefixed `vyos_`.
## Commit and PR standards
- Every commit title must start with a Phorge task ID: `T<number>: description`.
- Every PR must have exactly one changelog fragment in `changelogs/fragments/`.
- PR descriptions that state a test count (e.g. "Add 8 unit tests") must match the actual number of test methods in the changed files. Flag mismatches.
## Changelog fragments
Fragments are YAML files under `changelogs/fragments/`. Valid top-level keys:
| Key | Use for |
|-----|---------|
| `trivial` | Developer tooling, CI, housekeeping, formatting-only changes |
| `bugfixes` | Bug fixes |
| `minor_changes` | New features or user-visible improvements |
| `major_changes` | Breaking changes |
| `security_fixes` | Security fixes |
| `doc_changes` | Documentation-only changes |
Flag any fragment that uses `minor_changes` for what is actually developer tooling (linting, formatting, gitignore, test scaffolding). Those should use `trivial`.
## Module architecture
Two module families:
**Resource modules** (`vyos_interfaces`, `vyos_firewall_rules`, `vyos_bgp_global`, etc.) follow a four-part structure under `plugins/module_utils/network/vyos/`:
- `argspec/{resource}/` — argument spec
- `config/{resource}/` — config builder
- `facts/{resource}/` — facts parser
- `rm_templates/{resource}.py` — regex/Jinja2 CLI templates
Resource modules support all states: `merged`, `replaced`, `overridden`, `deleted`, `rendered`, `gathered`, `parsed`.
**Legacy modules** (`vyos_vlan`, `vyos_config`, `vyos_command`, `vyos_user`, etc.) do not follow the resource module pattern.
## VyOS CLI conventions
- Set commands: `set interfaces ethernet eth0 address '192.0.2.1/24'`
- Delete commands: `delete interfaces ethernet eth0 address '192.0.2.1/24'`
- Quoting varies by context. In general, string values (descriptions, names, ELIN numbers) are single-quoted; boolean flags and bare keywords are not. However, address/prefix values may be quoted or unquoted depending on where they appear:
- Quoted: `address '192.0.2.1/24'`, `description 'my-iface'`, `elin '0000000911'`
- Unquoted: `address 192.0.2.1` (in firewall groups), `disable`, `mtu-ignore`, `vif 200`
- When reviewing tests and fixtures, align with the quoting style used by surrounding fixtures rather than flagging a missing quote as an error.
- Interface types: `ethernet`, `loopback`, `bonding`, `bridge`, `tunnel`, `wireguard`.
|
