diff options
Diffstat (limited to 'docs/installation')
| -rw-r--r-- | docs/installation/bare-metal.rst | 55 | ||||
| -rw-r--r-- | docs/installation/cloud/aws.rst | 16 | ||||
| -rw-r--r-- | docs/installation/cloud/azure.rst | 12 | ||||
| -rw-r--r-- | docs/installation/cloud/gcp.rst | 10 | ||||
| -rw-r--r-- | docs/installation/install.rst | 2 | ||||
| -rw-r--r-- | docs/installation/secure-boot.rst | 14 | ||||
| -rw-r--r-- | docs/installation/virtual/gns3.rst | 42 | ||||
| -rw-r--r-- | docs/installation/virtual/libvirt.rst | 22 |
8 files changed, 87 insertions, 86 deletions
diff --git a/docs/installation/bare-metal.rst b/docs/installation/bare-metal.rst index be5f9342..5b6f24a4 100644 --- a/docs/installation/bare-metal.rst +++ b/docs/installation/bare-metal.rst @@ -37,39 +37,39 @@ motherboard). Pictures -------- -.. figure:: /_static/images/1u_vyos_back.jpg +.. figure:: /_static/images/1u_vyos_back.* :scale: 25 % :alt: CSE-505-203B Back -.. figure:: /_static/images/1u_vyos_front.jpg +.. figure:: /_static/images/1u_vyos_front.* :scale: 25 % :alt: CSE-505-203B Front -.. figure:: /_static/images/1u_vyos_front_open_1.jpg +.. figure:: /_static/images/1u_vyos_front_open_1.* :scale: 25 % :alt: CSE-505-203B Open 1 -.. figure:: /_static/images/1u_vyos_front_open_2.jpg +.. figure:: /_static/images/1u_vyos_front_open_2.* :scale: 25 % :alt: CSE-505-203B Open 2 -.. figure:: /_static/images/1u_vyos_front_open_3.jpg +.. figure:: /_static/images/1u_vyos_front_open_3.* :scale: 25 % :alt: CSE-505-203B Open 3 -.. figure:: /_static/images/1u_vyos_front_10ge_open_1.jpg +.. figure:: /_static/images/1u_vyos_front_10ge_open_1.* :scale: 25 % :alt: CSE-505-203B w/ 10GE Open 1 -.. figure:: /_static/images/1u_vyos_front_10ge_open_2.jpg +.. figure:: /_static/images/1u_vyos_front_10ge_open_2.* :scale: 25 % :alt: CSE-505-203B w/ 10GE Open 2 -.. figure:: /_static/images/1u_vyos_front_10ge_open_3.jpg +.. figure:: /_static/images/1u_vyos_front_10ge_open_3.* :scale: 25 % :alt: CSE-505-203B w/ 10GE Open 3 -.. figure:: /_static/images/1u_vyos_front_10ge_open_4.jpg +.. figure:: /_static/images/1u_vyos_front_10ge_open_4.* :scale: 25 % :alt: CSE-505-203B w/ 10GE Open @@ -202,49 +202,49 @@ Pictures Rack Mount ^^^^^^^^^^ -.. figure:: /_static/images/apu4_rack_1.jpg +.. figure:: /_static/images/apu4_rack_1.* :scale: 25 % :alt: APU4 rack closed -.. figure:: /_static/images/apu4_rack_2.jpg +.. figure:: /_static/images/apu4_rack_2.* :scale: 25 % :alt: APU4 rack front -.. figure:: /_static/images/apu4_rack_3.jpg +.. figure:: /_static/images/apu4_rack_3.* :scale: 25 % :alt: APU4 rack module #1 -.. figure:: /_static/images/apu4_rack_4.jpg +.. figure:: /_static/images/apu4_rack_4.* :scale: 25 % :alt: APU4 rack module #2 -.. figure:: /_static/images/apu4_rack_5.jpg +.. figure:: /_static/images/apu4_rack_5.* :scale: 25 % :alt: APU4 rack module #3 with PSU VyOS custom print """"""""""""""""" -.. figure:: /_static/images/apu4_rack_vyos_print.jpg +.. figure:: /_static/images/apu4_rack_vyos_print.* :scale: 25 % :alt: APU4 custom VyOS powder coat Desktop / Bench Top ^^^^^^^^^^^^^^^^^^^ -.. figure:: /_static/images/apu4_desk_1.jpg +.. figure:: /_static/images/apu4_desk_1.* :scale: 25 % :alt: APU4 desktop closed -.. figure:: /_static/images/apu4_desk_2.jpg +.. figure:: /_static/images/apu4_desk_2.* :scale: 25 % :alt: APU4 desktop closed -.. figure:: /_static/images/apu4_desk_3.jpg +.. figure:: /_static/images/apu4_desk_3.* :scale: 25 % :alt: APU4 desktop back -.. figure:: /_static/images/apu4_desk_4.jpg +.. figure:: /_static/images/apu4_desk_4.* :scale: 25 % :alt: APU4 desktop back @@ -304,7 +304,7 @@ HDMI mode. Partaker i5 =========== -.. figure:: ../_static/images/600px-Partaker-i5.jpg +.. figure:: ../_static/images/600px-Partaker-i5.* I believe this is actually the same hardware as the Protectli. I purchased it in June 2018. It came pre-loaded with pfSense. @@ -330,9 +330,9 @@ port is eth0 and the right-most "LAN1" port is eth3. Acrosser AND-J190N1 =================== -.. figure:: ../_static/images/480px-Acrosser_ANDJ190N1_Front.jpg +.. figure:: ../_static/images/480px-Acrosser_ANDJ190N1_Front.* -.. figure:: ../_static/images/480px-Acrosser_ANDJ190N1_Back.jpg +.. figure:: ../_static/images/480px-Acrosser_ANDJ190N1_Back.* This microbox network appliance was build to create OpenVPN bridges. It can saturate a 100Mbps link. It is a small (serial console only) PC with 6 Gb LAN @@ -403,18 +403,19 @@ Optional (WiFi + WWAN) Pictures -------- -.. figure:: ../_static/images/gowin-01.png +.. figure:: ../_static/images/gowin-01.* -.. figure:: ../_static/images/gowin-02.png +.. figure:: ../_static/images/gowin-02.* -.. figure:: ../_static/images/gowin-03.png +.. figure:: ../_static/images/gowin-03.* -.. figure:: ../_static/images/gowin-04.png +.. figure:: ../_static/images/gowin-04.* Cooling ------- -The device itself is passivly cooled, whereas the power supply has an active fan. +The device itself is passivly cooled, whereas the power supply has an +active fan. Even if the main processor is powered off, the power supply fan is operating and the entire chassis draws 7.5W. During operation the chassis drew arround 38W. diff --git a/docs/installation/cloud/aws.rst b/docs/installation/cloud/aws.rst index 2901b6d1..89f4a152 100644 --- a/docs/installation/cloud/aws.rst +++ b/docs/installation/cloud/aws.rst @@ -11,38 +11,38 @@ Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)`. 1. Click **Instances** and then click **Launch Instance**. -.. figure:: /_static/images/cloud-aws-01.png +.. figure:: /_static/images/cloud-aws-01.* 2. Search for "VyOS" in the Marketplace. -.. figure:: /_static/images/cloud-aws-02.png +.. figure:: /_static/images/cloud-aws-02.* 3. Choose the instance type. The recommended minimum is ``m3.medium``. -.. figure:: /_static/images/cloud-aws-03.png +.. figure:: /_static/images/cloud-aws-03.* 4. Configure the instance for your requirements. Select the number of instances, network, and subnet. -.. figure:: /_static/images/cloud-aws-04.png +.. figure:: /_static/images/cloud-aws-04.* 5. Configure additional storage. You can remove the additional storage ``/dev/sdb``. The root device will be ``/dev/xvda``. You can skip this step. -.. figure:: /_static/images/cloud-aws-05.png +.. figure:: /_static/images/cloud-aws-05.* 6. Configure the security group. We recommend configuring SSH access only from specific sources, or you can permit any IP address (the default). -.. figure:: /_static/images/cloud-aws-06.png +.. figure:: /_static/images/cloud-aws-06.* 7. Select the SSH key pair and click **Launch Instances**. -.. figure:: /_static/images/cloud-aws-07.png +.. figure:: /_static/images/cloud-aws-07.* 8. Note your public IP address. -.. figure:: /_static/images/cloud-aws-08.png +.. figure:: /_static/images/cloud-aws-08.* 9. Connect to the instance using your SSH key. diff --git a/docs/installation/cloud/azure.rst b/docs/installation/cloud/azure.rst index 77d00814..f77c9bee 100644 --- a/docs/installation/cloud/azure.rst +++ b/docs/installation/cloud/azure.rst @@ -14,28 +14,28 @@ Deploy VyOS on Azure. 2. Choose a VM name, resource group, and region, then click **Browse all public and private images**. -.. figure:: /_static/images/cloud-azure-01.png +.. figure:: /_static/images/cloud-azure-01.* 3. Search for "VyOS" in the marketplace and choose the appropriate subscription. -.. figure:: /_static/images/cloud-azure-02.png +.. figure:: /_static/images/cloud-azure-02.* 4. Generate new SSH key pair or use existing. -.. figure:: /_static/images/cloud-azure-03.png +.. figure:: /_static/images/cloud-azure-03.* 5. Configure the network, subnet, and public IP. Or use the defaults. -.. figure:: /_static/images/cloud-azure-04.png +.. figure:: /_static/images/cloud-azure-04.* 6. Click **Review + create**. Your deployment completes in a few seconds. -.. figure:: /_static/images/cloud-azure-05.png +.. figure:: /_static/images/cloud-azure-05.* 7. Select your new VM and note your public IP address. -.. figure:: /_static/images/cloud-azure-06.png +.. figure:: /_static/images/cloud-azure-06.* 8. Connect to the instance with your SSH key. diff --git a/docs/installation/cloud/gcp.rst b/docs/installation/cloud/gcp.rst index f6b6732b..7d70e007 100644 --- a/docs/installation/cloud/gcp.rst +++ b/docs/installation/cloud/gcp.rst @@ -25,27 +25,27 @@ To deploy VyOS on Google Cloud Platform (GCP): 2. Open the GCP Console and navigate to **Metadata**. Select **SSH Keys** and click **Edit**. -.. figure:: /_static/images/cloud-gcp-01.png +.. figure:: /_static/images/cloud-gcp-01.* Click **Add item**, paste your public SSH key, and click **Save**. -.. figure:: /_static/images/cloud-gcp-02.png +.. figure:: /_static/images/cloud-gcp-02.* 3. Search for "VyOS" in the Marketplace. 4. Configure the deployment name, zone, and machine type, then click **Deploy**. -.. figure:: /_static/images/cloud-gcp-03.png +.. figure:: /_static/images/cloud-gcp-03.* 5. After a few seconds, select your **instance**. -.. figure:: /_static/images/cloud-gcp-04.png +.. figure:: /_static/images/cloud-gcp-04.* 6. Note your external IP address. -.. figure:: /_static/images/cloud-gcp-05.png +.. figure:: /_static/images/cloud-gcp-05.* 7. Connect to the instance using the SSH key you generated in step 1. diff --git a/docs/installation/install.rst b/docs/installation/install.rst index 4071af64..7b38a06b 100644 --- a/docs/installation/install.rst +++ b/docs/installation/install.rst @@ -93,7 +93,7 @@ downloads. used to deploy VyOS on KVM environments. This image includes cloud-init support. See :ref:`cloud-init` for more information. -.. figure:: /_static/images/vyosnew-downloads.png +.. figure:: /_static/images/vyosnew-downloads.* Building from source -------------------- diff --git a/docs/installation/secure-boot.rst b/docs/installation/secure-boot.rst index 1dd6713b..b0912f00 100644 --- a/docs/installation/secure-boot.rst +++ b/docs/installation/secure-boot.rst @@ -43,7 +43,7 @@ previously generated :abbr:`MOK (Machine Owner Key)` to the system. First, disable UEFI Secure Boot for the installation. -.. figure:: /_static/images/uefi_secureboot_01.png +.. figure:: /_static/images/uefi_secureboot_01.* :alt: Disable UEFI secure boot Proceed with the standard VyOS :ref:`installation <permanent_installation>` on @@ -61,30 +61,30 @@ password after reboot when MOK Manager launches to permanently install the keys. With the next reboot, MOK Manager will automatically launch -.. figure:: /_static/images/uefi_secureboot_02.png +.. figure:: /_static/images/uefi_secureboot_02.* :alt: Disable UEFI secure boot Select ``Enroll MOK`` -.. figure:: /_static/images/uefi_secureboot_03.png +.. figure:: /_static/images/uefi_secureboot_03.* :alt: Disable UEFI secure boot You can now view the key to be installed and continue with key installation. -.. figure:: /_static/images/uefi_secureboot_04.png +.. figure:: /_static/images/uefi_secureboot_04.* :alt: Disable UEFI secure boot -.. figure:: /_static/images/uefi_secureboot_05.png +.. figure:: /_static/images/uefi_secureboot_05.* :alt: Disable UEFI secure boot Now you need to enter the password you defined previously. -.. figure:: /_static/images/uefi_secureboot_06.png +.. figure:: /_static/images/uefi_secureboot_06.* :alt: Disable UEFI secure boot Now reboot and re-enable UEFI Secure Boot. -.. figure:: /_static/images/uefi_secureboot_07.png +.. figure:: /_static/images/uefi_secureboot_07.* :alt: Disable UEFI secure boot VyOS will now launch in UEFI Secure Boot mode. You can verify this by running diff --git a/docs/installation/virtual/gns3.rst b/docs/installation/virtual/gns3.rst index 31bb6887..2c0b5224 100644 --- a/docs/installation/virtual/gns3.rst +++ b/docs/installation/virtual/gns3.rst @@ -35,54 +35,54 @@ in GNS3. Go to the GNS3 **File** menu, click **New template**, and select **Manually create a new Template**. -.. figure:: /_static/images/gns3-01.png +.. figure:: /_static/images/gns3-01.* Select **Qemu VMs** and then click the ``New`` button. -.. figure:: /_static/images/gns3-02.png +.. figure:: /_static/images/gns3-02.* Write a name for your VM, such as "VyOS", and click ``Next``. -.. figure:: /_static/images/gns3-03.png +.. figure:: /_static/images/gns3-03.* Select **qemu-system-x86_64** as Quemu binary, then **512MB** of RAM and click ``Next``. -.. figure:: /_static/images/gns3-04.png +.. figure:: /_static/images/gns3-04.* Select **telnet** as your console type and click ``Next``. -.. figure:: /_static/images/gns3-05.png +.. figure:: /_static/images/gns3-05.* Select **New image** for the base disk image of your VM and click ``Create``. -.. figure:: /_static/images/gns3-06.png +.. figure:: /_static/images/gns3-06.* Use the defaults in the **Binary and format** window and click ``Next``. -.. figure:: /_static/images/gns3-07.png +.. figure:: /_static/images/gns3-07.* Use the defaults in the **Qcow2 options** window and click ``Next``. -.. figure:: /_static/images/gns3-08.png +.. figure:: /_static/images/gns3-08.* Set the disk size to 2000 MiB, and click ``Finish`` to end the **Quemu image creator**. -.. figure:: /_static/images/gns3-09.png +.. figure:: /_static/images/gns3-09.* Click ``Finish`` to end the **New QEMU VM template** wizard. -.. figure:: /_static/images/gns3-10.png +.. figure:: /_static/images/gns3-10.* Now you need to edit the VM settings. In the **Preferences** window, with **Qemu VMs** selected and your new VM selected, click the ``Edit`` button. -.. figure:: /_static/images/gns3-11.png +.. figure:: /_static/images/gns3-11.* In the **General settings** tab of your **QEMU VM template configuration**, do the following: @@ -92,17 +92,17 @@ configuration**, do the following: * In **Category** select in which group you want to find your VM. * Set the **Boot priority** to **CD/DVD-ROM**. -.. figure:: /_static/images/gns3-12.png +.. figure:: /_static/images/gns3-12.* At the **HDD** tab, change the Disk interface to **sata** to speed up the boot process. -.. figure:: /_static/images/gns3-13.png +.. figure:: /_static/images/gns3-13.* At the **CD/DVD** tab click on ``Browse...`` and locate the VyOS image you want to install. -.. figure:: /_static/images/gns3-14.png +.. figure:: /_static/images/gns3-14.* .. note:: You probably will want to accept to copy the .iso file to your default image directory when you are asked. @@ -111,17 +111,17 @@ In the **Network** tab, set the number of adapters to **0**, set the **Name format** to **eth{0}**, and set the **Type** to **Paravirtualized Network I/O (virtio-net-pci)**. -.. figure:: /_static/images/gns3-15.png +.. figure:: /_static/images/gns3-15.* In the **Advanced** tab, unmark the checkbox **Use as a linked base VM** and click ``OK``, which will save and close the **QEMU VM template configuration** window. -.. figure:: /_static/images/gns3-16.png +.. figure:: /_static/images/gns3-16.* At the general **Preferences** window, click ``OK`` to save and close. -.. figure:: /_static/images/gns3-17.png +.. figure:: /_static/images/gns3-17.* .. _vyos_installation: @@ -157,21 +157,21 @@ necessary as outlined below: **General settings** tab: Set the boot priority to **HDD** -.. figure:: /_static/images/gns3-20.png +.. figure:: /_static/images/gns3-20.* **CD/DVD** tab: Clear the **Image** entry field to unmount the installation image. -.. figure:: /_static/images/gns3-21.png +.. figure:: /_static/images/gns3-21.* Set the number of required network adapters. For example, set it to **4**. -.. figure:: /_static/images/gns3-215.png +.. figure:: /_static/images/gns3-215.* **Advanced** settings tab: Check the **Use as a linked base VM** checkbox and click ``OK`` to save the changes. -.. figure:: /_static/images/gns3-22.png +.. figure:: /_static/images/gns3-22.* The VyOS VM is now ready to be deployed. diff --git a/docs/installation/virtual/libvirt.rst b/docs/installation/virtual/libvirt.rst index 3aa665c0..7374e42c 100644 --- a/docs/installation/virtual/libvirt.rst +++ b/docs/installation/virtual/libvirt.rst @@ -123,28 +123,28 @@ Deploy from ISO 2. Choose ``Local install media`` (ISO) -.. figure:: /_static/images/virt-libvirt-01.png +.. 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.png +.. figure:: /_static/images/virt-libvirt-02.* 4. Choose Memory and CPU -.. figure:: /_static/images/virt-libvirt-03.png +.. figure:: /_static/images/virt-libvirt-03.* 5. Disk size -.. figure:: /_static/images/virt-libvirt-04.png +.. figure:: /_static/images/virt-libvirt-04.* 6. Name of VM and network selection -.. figure:: /_static/images/virt-libvirt-05.png +.. figure:: /_static/images/virt-libvirt-05.* 7. Then the system will be taken to the console. -.. figure:: /_static/images/virt-libvirt-06.png +.. figure:: /_static/images/virt-libvirt-06.* .. _libvirt:virt-manager_qcow2: @@ -163,24 +163,24 @@ Download the predefined VyOS ``.qcow2`` image. 2. Choose ``Import existing disk`` image -.. figure:: /_static/images/virt-libvirt-qc-01.png +.. 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.png +.. figure:: /_static/images/virt-libvirt-qc-02.* 4. Choose Memory and CPU -.. figure:: /_static/images/virt-libvirt-03.png +.. figure:: /_static/images/virt-libvirt-03.* 5. Name of VM and network selection -.. figure:: /_static/images/virt-libvirt-05.png +.. figure:: /_static/images/virt-libvirt-05.* 6. Then the system will be taken to the console. -.. figure:: /_static/images/virt-libvirt-qc-03.png +.. figure:: /_static/images/virt-libvirt-qc-03.* |