diff options
Diffstat (limited to 'docs/installation')
| -rw-r--r-- | docs/installation/cloud/aws.rst | 9 | ||||
| -rw-r--r-- | docs/installation/cloud/azure.rst | 11 | ||||
| -rw-r--r-- | docs/installation/cloud/gcp.rst | 9 | ||||
| -rw-r--r-- | docs/installation/install.rst | 29 | ||||
| -rw-r--r-- | docs/installation/update.rst | 9 | ||||
| -rw-r--r-- | docs/installation/virtual/libvirt.rst | 32 | ||||
| -rw-r--r-- | docs/installation/virtual/vmware.rst | 32 | ||||
| -rw-r--r-- | docs/installation/vyos-on-baremetal.rst | 11 | 
8 files changed, 95 insertions, 47 deletions
| diff --git a/docs/installation/cloud/aws.rst b/docs/installation/cloud/aws.rst index 33684bb0..d64aca82 100644 --- a/docs/installation/cloud/aws.rst +++ b/docs/installation/cloud/aws.rst @@ -19,15 +19,18 @@ Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)`  .. figure:: /_static/images/cloud-aws-03.png -4. Configure instance for your requirements. Select number of instances / network / subnet +4. Configure instance for your requirements. Select number of +   instances / network / subnet  .. figure:: /_static/images/cloud-aws-04.png -5. Additional storage. You can remove additional storage ``/dev/sdb``. First root device will be ``/dev/xvda``. You can skeep this step. +5. Additional storage. You can remove additional storage ``/dev/sdb``. First +   root device will be ``/dev/xvda``. You can skeep this step.  .. figure:: /_static/images/cloud-aws-05.png -6. Configure Security Group. It's recommended that you configure ssh access only from certain address sources. Or permit any (by default). +6. Configure Security Group. It's recommended that you configure ssh access +   only from certain address sources. Or permit any (by default).  .. figure:: /_static/images/cloud-aws-06.png diff --git a/docs/installation/cloud/azure.rst b/docs/installation/cloud/azure.rst index 39206f3b..fe6a25bd 100644 --- a/docs/installation/cloud/azure.rst +++ b/docs/installation/cloud/azure.rst @@ -9,7 +9,8 @@ Deploy VyOS on Azure.  1. Go to the Azure services and Click to **Add new Virtual machine** -2. Choose vm name, resource group, region and click **Browse all public and private images** +2. Choose vm name, resource group, region and click **Browse all public and +   private images**  .. figure:: /_static/images/cloud-azure-01.png @@ -43,10 +44,12 @@ Deploy VyOS on Azure.  Add interface  ------------- -If instance was deployed with one **eth0** ``WAN`` interface and want to add new one. -To add new interface an example **eth1** ``LAN`` you need shutdown the instance. Attach the interface in the Azure portal and then start the instance. +If instance was deployed with one **eth0** ``WAN`` interface and want to add +new one. To add new interface an example **eth1** ``LAN`` you need shutdown the +instance. Attach the interface in the Azure portal and then start the instance. -.. NOTE:: Azure does not allow you attach interface when the instance in the **Running** state. +.. note:: Azure does not allow you attach interface when the instance in the +   **Running** state.  References  ---------- diff --git a/docs/installation/cloud/gcp.rst b/docs/installation/cloud/gcp.rst index 66e75704..07aecdbe 100644 --- a/docs/installation/cloud/gcp.rst +++ b/docs/installation/cloud/gcp.rst @@ -7,7 +7,8 @@ Deploy VM  To deploy VyOS on GCP (Google Cloud Platform) -1. Generate SSH key pair type **ssh-rsa** from the host that will connect to VyOS. +1. Generate SSH key pair type **ssh-rsa** from the host that will connect to +   VyOS.    Example: @@ -16,10 +17,12 @@ To deploy VyOS on GCP (Google Cloud Platform)      ssh-keygen -t rsa -f ~/.ssh/vyos_gcp -C "vyos@mypc" -.. NOTE:: In name "vyos@mypc" The first value must be "**vyos**". Because default user is vyos and google api uses this option. +.. note:: In name "vyos@mypc" The first value must be "**vyos**". Because +   default user is vyos and google api uses this option. -2. Open GCP console and navigate to the menu **Metadata**. Choose **SSH Keys** and click ``edit``. +2. Open GCP console and navigate to the menu **Metadata**. Choose +   **SSH Keys** and click ``edit``.  .. figure:: /_static/images/cloud-gcp-01.png diff --git a/docs/installation/install.rst b/docs/installation/install.rst index 11d0fc88..b5472f64 100644 --- a/docs/installation/install.rst +++ b/docs/installation/install.rst @@ -247,7 +247,8 @@ file.  Permanent installation  ====================== -.. note:: Before a permanent installation, VyOS requires a :ref:`live_installation`. +.. note:: Before a permanent installation, VyOS requires a +   :ref:`live_installation`.  Unlike general purpose Linux distributions, VyOS uses "image installation" that  mimics the user experience of traditional hardware routers and allows keeping @@ -351,7 +352,8 @@ installation method which allows deploying VyOS through the network.  * :ref:`tftp-server`  * Webserver (HTTP) - optional, but we will use it to speed up installation  * VyOS ISO image to be installed (do not use images prior to VyOS 1.2.3) -* Files *pxelinux.0* and *ldlinux.c32* `from the Syslinux distribution <https://kernel.org/pub/linux/utils/boot/syslinux/>`_ +* Files *pxelinux.0* and *ldlinux.c32* `from the Syslinux distribution +  <https://kernel.org/pub/linux/utils/boot/syslinux/>`_  Configuration  ------------- @@ -402,9 +404,6 @@ Configure a TFTP server so that it serves the following:    file. We will use the configuration_ file shown below, which we named    default_. -.. _configuration: https://wiki.syslinux.org/wiki/index.php?title=Config -.. _default: https://wiki.syslinux.org/wiki/index.php?title=PXELINUX#Configuration -  In the example we configured our existent VyOS as the TFTP server too:  .. code-block:: none @@ -473,7 +472,7 @@ TFTP Server, you can restart the service with     and HTTP server have the right permissions to be accessed from the     booting clients. -.. _`Python's SimpleHTTPServer`: https://docs.python.org/2/library/simplehttpserver.html +  Client Boot  ----------- @@ -496,11 +495,13 @@ This is a list of known issues that can arise during installation.  Black screen on install  ----------------------- -GRUB attempts to redirect all output to a serial port for ease of installation on headless hosts. -This appears to cause an hard lockup on some hardware that lacks a serial port, with the result being a -black screen after selecting the `Live system` option from the installation image. +GRUB attempts to redirect all output to a serial port for ease of installation +on headless hosts. This appears to cause an hard lockup on some hardware that +lacks a serial port, with the result being a black screen after selecting the +`Live system` option from the installation image. -The workaround is to type `e` when the boot menu appears and edit the GRUB boot options.  Specifically, remove the: +The workaround is to type `e` when the boot menu appears and edit the GRUB boot +options.  Specifically, remove the:  `console=ttyS0,115200` @@ -508,7 +509,15 @@ option, and type CTRL-X to boot.  Installation can then continue as outlined above. + +.. stop_vyoslinter +  .. _SYSLINUX: http://www.syslinux.org/  .. _balenaEtcher: https://www.balena.io/etcher/  .. _Rufus: https://rufus.ie/  .. _many others: https://en.wikipedia.org/wiki/List_of_tools_to_create_Live_USB_systems +.. _configuration: https://wiki.syslinux.org/wiki/index.php?title=Config +.. _default: https://wiki.syslinux.org/wiki/index.php?title=PXELINUX#Configuration +.. _`Python's SimpleHTTPServer`: https://docs.python.org/2/library/simplehttpserver.html + +.. start_vyoslinter
\ No newline at end of file diff --git a/docs/installation/update.rst b/docs/installation/update.rst index a3a887f0..5bcd5b8a 100644 --- a/docs/installation/update.rst +++ b/docs/installation/update.rst @@ -10,7 +10,8 @@ for the new image to boot using the current configuration.  .. note:: Only LTS releases are PGP-signed. -.. opcmd:: add system image <url | path> [vrf name] [username user [password pass]] +.. opcmd:: add system image <url | path> [vrf name] +   [username user [password pass]]     Use this command to install a new system image. You can reach the     image from the web (http://, https://) or from your local system, @@ -72,8 +73,10 @@ Example       OK.  This image will be named: vyos-1.3-rolling-201912201452 -.. hint:: | The most up-do-date Rolling Release for AMD64 can be accessed using the following URL: -   | https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso +.. hint:: The most up-do-date Rolling Release for AMD64 can be accessed using +   the following URL: +    +   https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso  After reboot you might want to verify the version you are running with  the :opcmd:`show version` command.
\ No newline at end of file diff --git a/docs/installation/virtual/libvirt.rst b/docs/installation/virtual/libvirt.rst index 0d624b94..ff896d07 100644 --- a/docs/installation/virtual/libvirt.rst +++ b/docs/installation/virtual/libvirt.rst @@ -4,9 +4,10 @@  Running on 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. +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  === @@ -14,8 +15,9 @@ 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. +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 @@ -46,11 +48,13 @@ Connect to VM  with command ``virsh console vyos_r1``    vyos@vyos:~$ install image -After installation - exit from the console using the key combination ``Ctrl + ]`` and reboot the system. +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. +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 @@ -92,13 +96,15 @@ 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)`. +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)` +1. Open :abbr:`VMM (Virtual Machine Manager)` and Create a new +   :abbr:`VM (Virtual Machine)`  2. Choose ``Local install media`` (ISO) @@ -134,13 +140,15 @@ Download predefined VyOS.qcow2 image for ``KVM``    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)` +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. +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 diff --git a/docs/installation/virtual/vmware.rst b/docs/installation/virtual/vmware.rst index c4299cbf..28614573 100644 --- a/docs/installation/virtual/vmware.rst +++ b/docs/installation/virtual/vmware.rst @@ -6,20 +6,31 @@ Running on VMware ESXi  ESXi 5.5 or later
  *****************
 -.ova files are available for supporting users, and a VyOS can also be stood up using a generic Linux instance, and attaching the bootable ISO file and installing from the ISO 
 -using the normal process around `install image`.
 +.ova files are available for supporting users, and a VyOS can also be stood up
 +using a generic Linux instance, and attaching the bootable ISO file and
 +installing from the ISO using the normal process around `install image`.
 -.. NOTE:: There have been previous documented issues with GRE/IPSEC tunneling using the E1000 adapter on the VyOS guest, and use of the VMXNET3 has been advised.
 +.. NOTE:: There have been previous documented issues with GRE/IPSEC tunneling
 +   using the E1000 adapter on the VyOS guest, and use of the VMXNET3 has been
 +   advised.
  Memory Contention Considerations
  --------------------------------
 -When the underlying ESXi host is approaching ~92% memory utilisation it will start the balloon process in s a 'soft' state to start reclaiming memory from guest operating systems. 
 -This causes an artificial pressure using the vmmemctl driver on memory usage on the virtual guest. As VyOS by default does not have a swap file, this vmmemctl pressure is unable to
 -force processes to move in memory data to the paging file, and blindly consumes memory forcing the virtual guest into a low memory state with no way to escape. The balloon can expand to 65% of 
 -guest allocated memory, so a VyOS guest running >35% of memory usage, can encounter an out of memory situation, and trigger the kernel oom_kill process. At this point a weighted 
 -lottery favouring memory hungry processes will be run with the unlucky winner being terminated by the kernel.
 +When the underlying ESXi host is approaching ~92% memory utilisation it will
 +start the balloon process in s a 'soft' state to start reclaiming memory from
 +guest operating systems. This causes an artificial pressure using the vmmemctl
 +driver on memory usage on the virtual guest. As VyOS by default does not have
 +a swap file, this vmmemctl pressure is unable to force processes to move in
 +memory data to the paging file, and blindly consumes memory forcing the
 +virtual guest into a low memory state with no way to escape. The balloon
 +can expand to 65% of guest allocated memory, so a VyOS guest running >35% of
 +memory usage, can encounter an out of memory situation, and trigger the kernel
 +oom_kill process. At this point a weighted lottery favouring memory hungry
 +processes will be run with the unlucky winner being terminated by the kernel.
 -It is advised that VyOS routers are configured in a resource group with adequate memory reservations so that ballooning is not inflicted on virtual VyOS guests.
 +It is advised that VyOS routers are configured in a resource group with
 +adequate memory reservations so that ballooning is not inflicted on
 +virtual VyOS guests.
 @@ -28,5 +39,8 @@ It is advised that VyOS routers are configured in a resource group with adequate  References
  ----------
 +.. stop_vyoslinter
 +
  https://muralidba.blogspot.com/2018/03/how-does-linux-out-of-memory-oom-killer.html
 +.. start_vyoslinter
\ No newline at end of file diff --git a/docs/installation/vyos-on-baremetal.rst b/docs/installation/vyos-on-baremetal.rst index db618431..81d04f0d 100644 --- a/docs/installation/vyos-on-baremetal.rst +++ b/docs/installation/vyos-on-baremetal.rst @@ -109,8 +109,8 @@ Extension Modules  WiFi  """" -Refer to :ref:`wireless-interface` for additional information, below listed modules -have been tested successfully on this Hardware platform: +Refer to :ref:`wireless-interface` for additional information, below listed +modules have been tested successfully on this Hardware platform:  * Compex WLE900VX mini-PCIe WiFi module, only supported in mPCIe slot 1. @@ -118,7 +118,8 @@ WWAN  """"  Refer to :ref:`wwan-interface` for additional information, below listed modules -have been tested successfully on this Hardware platform using VyOS 1.3 (equuleus): +have been tested successfully on this Hardware platform using VyOS 1.3 +(equuleus):  * Sierra Wireless AirPrime MC7304 miniPCIe card (LTE)  * Sierra Wireless AirPrime MC7430 miniPCIe card (LTE) @@ -137,6 +138,7 @@ Create a bootable USB pendrive using e.g. Rufus_ on a Windows machine.  Connect serial port to a PC through null modem cable (RXD / TXD crossed over).  Set terminal emulator to 115200 8N1. +.. stop_vyoslinter  .. code-block:: none    PC Engines apu4 @@ -154,6 +156,9 @@ Set terminal emulator to 115200 8N1.    3. Payload [memtest]    4. Payload [setup] +.. start_vyoslinter + +  Now boot from the ``USB MSC Drive Generic Flash Disk 8.07`` media by pressing  ``2``, the VyOS boot menu will appear, just wait 10 seconds or press ``Enter``  to continue. | 
