summaryrefslogtreecommitdiff
path: root/docs/installation/virtual/libvirt.rst
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 20:42:32 +0300
commit5d6fa52b8985f8068314aba26878a1d7d5cb84e5 (patch)
tree99359ff282846e26b5c5fa2b9b176b35b172809f /docs/installation/virtual/libvirt.rst
parent631e454d674ad5111d2b56a6964ead461894a1f6 (diff)
downloadvyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.tar.gz
vyos-documentation-5d6fa52b8985f8068314aba26878a1d7d5cb84e5.zip
feat: flip swap mechanism — MD as primary, RST as override (Phase 1)
This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-<stem>.md to docs/**/<stem>.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/<stem>.rst to docs/**/rst-<stem>.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io
Diffstat (limited to 'docs/installation/virtual/libvirt.rst')
-rw-r--r--docs/installation/virtual/libvirt.rst186
1 files changed, 0 insertions, 186 deletions
diff --git a/docs/installation/virtual/libvirt.rst b/docs/installation/virtual/libvirt.rst
deleted file mode 100644
index 7374e42c..00000000
--- a/docs/installation/virtual/libvirt.rst
+++ /dev/null
@@ -1,186 +0,0 @@
-:lastproofread: 2026-02-02
-
-.. _libvirt:
-
-############################
-Run VyOS on Libvirt QEMU/KVM
-############################
-
-Libvirt is an open-source API, daemon, and management tool for managing platform
-virtualization. You can deploy VyOS on libvirt KVM in several ways:
-using Virt-Manager or the native CLI. This example uses 4 gigabytes
-of memory, 2 CPU cores, and the default network ``virbr0``.
-
-CLI
-===
-
-Deploy from ISO
----------------
-
-Create VM name ``vyos_r1``. You must specify the path to the ``ISO`` image,
-the disk ``qcow2`` will be created automatically. The ``default`` network is
-the virtual network (type Virtio) created by the hypervisor with NAT.
-
-.. code-block:: none
-
- $ virt-install -n vyos_r1 \
- --ram 4096 \
- --vcpus 2 \
- --cdrom /var/lib/libvirt/images/vyos.iso \
- --os-variant debian10 \
- --network network=default \
- --graphics vnc \
- --hvm \
- --virt-type kvm \
- --disk path=/var/lib/libvirt/images/vyos_r1.qcow2,bus=virtio,size=8 \
- --noautoconsole
-
-Connect to the VM with the command ``virsh console vyos_r1``
-
-.. code-block:: none
-
- $ virsh console vyos_r1
-
- Connected to domain vyos_r1
- Escape character is ^]
-
- vyos login: vyos
- Password:
-
- vyos@vyos:~$ install image
-
-After installation, exit the console using the key combination
-``Ctrl + ]`` and reboot the system.
-
-Deploy from qcow2
------------------
-The benefit of using :abbr:`KVM (Kernel-based Virtual Machine)`
-images is that they don't require installation.
-Download the predefined VyOS ``.qcow2`` image.
-
-.. code-block:: none
-
- curl --url link_to_vyos_kvm.qcow2 --output /var/lib/libvirt/images/vyos_kvm.qcow2
-
-Create VM with ``import`` qcow2 disk option.
-
-.. code-block:: none
-
- $ virt-install -n vyos_r2 \
- --ram 4096 \
- --vcpus 2 \
- --os-variant debian10 \
- --network network=default \
- --graphics vnc \
- --hvm \
- --virt-type kvm \
- --disk path=/var/lib/libvirt/images/vyos_kvm.qcow2,bus=virtio \
- --import \
- --noautoconsole
-
-Connect to the VM with the command ``virsh console vyos_r2``
-
-.. code-block:: none
-
- $ virsh console vyos_r2
-
- Connected to domain vyos_r2
- Escape character is ^]
-
- vyos login: vyos
- Password:
-
- vyos@vyos:~$
-
-If you cannot access the login screen, the KVM console may be set as the
-default boot option.
-
-Open a secondary session and run this command to reboot the VM:
-
-.. code-block:: none
-
- $ virsh reboot vyos_r2
-
-Then go to the first session where you opened the console.
-Select ``VyOS 1.4.x for QEMU (Serial console)`` and press ``Enter``.
-
-The system is fully operational.
-
-Virt-Manager
-============
-
-The Virt-Manager application is a desktop user interface for managing virtual
-machines through libvirt. On Linux, open the
-:abbr:`VMM (Virtual Machine Manager)`.
-
-.. _libvirt:virt-manager_iso:
-
-Deploy from ISO
----------------
-
-1. Open :abbr:`VMM (Virtual Machine Manager)` and create a new
- :abbr:`VM (Virtual Machine)`
-
-2. Choose ``Local install media`` (ISO)
-
-.. figure:: /_static/images/virt-libvirt-01.*
-
-3. Choose the path to the VyOS ISO image. Select any Debian-based operating
- system.
-
-.. figure:: /_static/images/virt-libvirt-02.*
-
-4. Choose Memory and CPU
-
-.. figure:: /_static/images/virt-libvirt-03.*
-
-5. Disk size
-
-.. figure:: /_static/images/virt-libvirt-04.*
-
-6. Name of VM and network selection
-
-.. figure:: /_static/images/virt-libvirt-05.*
-
-7. Then the system will be taken to the console.
-
-.. figure:: /_static/images/virt-libvirt-06.*
-
-.. _libvirt:virt-manager_qcow2:
-
-Deploy from qcow2
------------------
-
-Download the predefined VyOS ``.qcow2`` image.
-
-.. code-block:: none
-
- curl --url link_to_vyos_kvm.qcow2 --output /var/lib/libvirt/images/vyos_kvm.qcow2
-
-
-1. Open :abbr:`VMM (Virtual Machine Manager)` and create a new
- :abbr:`VM (Virtual Machine)`
-
-2. Choose ``Import existing disk`` image
-
-.. figure:: /_static/images/virt-libvirt-qc-01.*
-
-3. Choose the path to the ``vyos_kvm.qcow2`` image that you downloaded.
- Select any Debian-based operating system.
-
-.. figure:: /_static/images/virt-libvirt-qc-02.*
-
-4. Choose Memory and CPU
-
-.. figure:: /_static/images/virt-libvirt-03.*
-
-5. Name of VM and network selection
-
-.. figure:: /_static/images/virt-libvirt-05.*
-
-6. Then the system will be taken to the console.
-
-.. figure:: /_static/images/virt-libvirt-qc-03.*
-
-
-