Skip to content

docs: cross-reference packer-vyos as related project - #38

Merged
robertoberto merged 1 commit into
mainfrom
docs/related-projects
May 19, 2026
Merged

robertoberto merged 1 commit into
mainfrom
docs/related-projects

Conversation

@robertoberto

Copy link
Copy Markdown
Member

Adds a small Related projects section to the main README pointing to vyos-contrib/packer-vyos, and mentions it in tests/pve/README.md as an alternative to the interactive install path in the e2e harness.

The two projects are complementary:

  • packer-vyos builds the appliance image (Packer / QEMU / Proxmox / AWS).
  • pyvyos drives the appliance once it is running.

Why

Neither project mentioned the other. Anyone trying to automate VyOS end-to-end is likely to want both, and the cross-reference makes that obvious.

Scope

Documentation only. No changes to pyvyos/, payloads, public API, tests, CI, or dependencies. Unit suite still 57 passed, 4 skipped.

Companion PR

A matching PR on vyos-contrib/packer-vyos will point back here, so the cross-reference is bidirectional.

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.
@robertoberto
robertoberto merged commit 1bb0a01 into main May 19, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant