Merge pull request #266 from sever-sever/virt-env

Add section Virtual Environments

11 files changed, 169 insertions, 0 deletions

diff --git a/docs/_static/images/virt-libvirt-01.png b/docs/_static/images/virt-libvirt-01.png
new file mode 100644
index 00000000..06baea8e
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-01.png
diff --git a/docs/_static/images/virt-libvirt-02.png b/docs/_static/images/virt-libvirt-02.png
new file mode 100644
index 00000000..b6c4b379
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-02.png
diff --git a/docs/_static/images/virt-libvirt-03.png b/docs/_static/images/virt-libvirt-03.png
new file mode 100644
index 00000000..ac3891f0
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-03.png
diff --git a/docs/_static/images/virt-libvirt-04.png b/docs/_static/images/virt-libvirt-04.png
new file mode 100644
index 00000000..b1218597
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-04.png
diff --git a/docs/_static/images/virt-libvirt-05.png b/docs/_static/images/virt-libvirt-05.png
new file mode 100644
index 00000000..5579c281
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-05.png
diff --git a/docs/_static/images/virt-libvirt-06.png b/docs/_static/images/virt-libvirt-06.png
new file mode 100644
index 00000000..e0983d23
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-06.png
diff --git a/docs/_static/images/virt-libvirt-qc-01.png b/docs/_static/images/virt-libvirt-qc-01.png
new file mode 100644
index 00000000..49867bd0
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-qc-01.png
diff --git a/docs/_static/images/virt-libvirt-qc-02.png b/docs/_static/images/virt-libvirt-qc-02.png
new file mode 100644
index 00000000..a71b8f64
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-qc-02.png
diff --git a/docs/_static/images/virt-libvirt-qc-03.png b/docs/_static/images/virt-libvirt-qc-03.png
new file mode 100644
index 00000000..4eefaa58
--- /dev/null
+++ b/docs/_static/images/virt-libvirt-qc-03.png
diff --git a/docs/appendix/vyos-on-virtual-environments.rst b/docs/appendix/vyos-on-virtual-environments.rst
new file mode 100644
index 00000000..59edcfda
--- /dev/null
+++ b/docs/appendix/vyos-on-virtual-environments.rst
@@ -0,0 +1,168 @@
+.. _vyos-on-virtual-environments:
+
+Running in Virtual Environments
+######################
+
+Libvirt Qemu/KVM
+*****************
+
+Libvirt is an open-source API, daemon and management tool for managing platform virtualization.
+There are several ways to deploy VyOS on libvirt kvm. Use Virt-manager and native CLI.
+In an example we will be use use 4 gigabytes of memory, 2 cores CPU and 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-type linux \
+    --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 VM  with 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 from the console using the key combination ``Ctrl + ]`` and reboot the system.
+
+Deploy from qcow2
+-----------------
+The convenience of using :abbr:`KVM (Kernel-based Virtual Machine)` images is that they don't need to be installed.
+Download predefined VyOS.qcow2 image for ``KVM``
+
+.. 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-type linux \
+     --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 VM  with 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:~$
+
+The system is fully operational.
+
+Virt-manager
+============
+The virt-manager application is a desktop user interface for managing virtual machines through libvirt.
+On the linux open :abbr:`VMM (Virtual Machine Manager)`.
+
+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.png
+
+3. Choose path to iso vyos.iso. Operating System can be any Debian based.
+
+.. figure:: /_static/images/virt-libvirt-02.png
+
+4. Choose Memory and CPU
+
+.. figure:: /_static/images/virt-libvirt-03.png
+
+5. Disk size
+
+.. figure:: /_static/images/virt-libvirt-04.png
+
+6. Name of VM and network selection
+
+.. figure:: /_static/images/virt-libvirt-05.png
+
+7. Then you will be taken to the console.
+
+.. figure:: /_static/images/virt-libvirt-06.png
+
+Deploy from qcow2
+-----------------
+
+Download predefined VyOS.qcow2 image for ``KVM``
+
+.. 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.png
+
+3. Choose the path to the image ``vyos_kvm.qcow2`` that was previously downloaded . Operation System can be any Debian based.
+
+.. figure:: /_static/images/virt-libvirt-qc-02.png
+
+4. Choose Memory and CPU
+
+.. figure:: /_static/images/virt-libvirt-03.png
+
+5. Name of VM and network selection
+
+.. figure:: /_static/images/virt-libvirt-05.png
+
+6. Then you will be taken to the console.
+
+.. figure:: /_static/images/virt-libvirt-qc-03.png
+
+
+Proxmox
+*****************
+
+References
+----------
+https://www.proxmox.com/en/proxmox-ve
+
diff --git a/docs/index.rst b/docs/index.rst
index edb50f77..8b5c4e5d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -59,6 +59,7 @@ VyOS User Guide
    appendix/vyos-on-vmware
    appendix/vyos-on-baremetal
    appendix/vyos-on-clouds
+   appendix/vyos-on-virtual-environments
    appendix/migrate-from-vyatta
    appendix/command-scripting
    appendix/http-api