summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 07:01:10 +0000
committerRoberto Bertó <463349+robertoberto@users.noreply.github.com>2026-05-19 07:01:10 +0000
commit6786e67c809450926ef4f5a4c54afdb4c11e73a5 (patch)
treee9bcccb36c639c6255bfe867974445152c5b09e8 /README.md
parent5a64e952064b4e1c07019662114acbc3497498e5 (diff)
downloadpyvyos-docs/related-projects.tar.gz
pyvyos-docs/related-projects.zip
docs: cross-reference packer-vyos as related projectdocs/related-projects
Add a "Related projects" section in the main README pointing to vyos-contrib/packer-vyos, the Packer-based image builder that produces ready-to-deploy VyOS images. The two projects are complementary: packer-vyos builds the appliance, pyvyos drives it. Also mention packer-vyos in tests/pve/README.md as an alternative to the interactive install in phase 1 of the e2e harness — without making the harness depend on it. This commit is documentation only. It does not change pyvyos behaviour, payloads, or public API.
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1f9ce19..8686caa 100644
--- a/README.md
+++ b/README.md
@@ -255,6 +255,13 @@ local Proxmox host and runs `tests/e2e` against the real HTTPS API.
It is not part of the default GitHub Actions workflow. See the
harness README for setup.
+## Related projects
+
+- [`vyos-contrib/packer-vyos`](https://github.com/vyos-contrib/packer-vyos)
+ — Packer builder that produces ready-to-deploy VyOS images for QEMU,
+ Proxmox, AWS, and other targets. Complementary to `pyvyos`: build the
+ image with `packer-vyos`, then drive it from Python with `pyvyos`.
+
## Contributing
Bug reports and pull requests are welcome. Please open an issue first to