diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installation/cloud/aws.rst | 4 | ||||
| -rw-r--r-- | docs/installation/cloud/azure.rst | 26 | ||||
| -rw-r--r-- | docs/installation/cloud/cloud-init.rst | 6 | ||||
| -rw-r--r-- | docs/installation/cloud/gcp.rst | 9 | ||||
| -rw-r--r-- | docs/installation/image.rst | 8 | ||||
| -rw-r--r-- | docs/installation/vyos-on-baremetal.rst | 69 |
6 files changed, 75 insertions, 47 deletions
diff --git a/docs/installation/cloud/aws.rst b/docs/installation/cloud/aws.rst index d64aca82..62821093 100644 --- a/docs/installation/cloud/aws.rst +++ b/docs/installation/cloud/aws.rst @@ -25,7 +25,7 @@ Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)` .. 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. + root device will be ``/dev/xvda``. You may skip this step. .. figure:: /_static/images/cloud-aws-05.png @@ -54,4 +54,4 @@ Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)` References ---------- -https://console.aws.amazon.com/
\ No newline at end of file +https://console.aws.amazon.com/ diff --git a/docs/installation/cloud/azure.rst b/docs/installation/cloud/azure.rst index e19df986..11240fb5 100644 --- a/docs/installation/cloud/azure.rst +++ b/docs/installation/cloud/azure.rst @@ -7,7 +7,7 @@ Deploy VM Deploy VyOS on Azure. -1. Go to the Azure services and Click to **Add new Virtual machine** +1. Go to the Azure services and Click on **Add new Virtual machine** 2. Choose vm name, resource group, region and click **Browse all public and private images** @@ -26,7 +26,8 @@ Deploy VyOS on Azure. .. figure:: /_static/images/cloud-azure-04.png -6. Click ``Review + create``. After a few seconds your deployment will be complete +6. Click ``Review + create``. After a few seconds your deployment will be + completed .. figure:: /_static/images/cloud-azure-05.png @@ -45,8 +46,8 @@ 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. +new one, like **eth1** ``LAN`` you need to shutdown the instance first. 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. @@ -54,18 +55,27 @@ instance. Attach the interface in the Azure portal and then start the instance. Absorbing Routes ---------------- -If using as a router, you will want your LAN interface to absorb some or all of the traffic from your VNET by using a route table applied to the subnet. +If using as a router, you will want your LAN interface to absorb some or all +of the traffic from your VNET by using a route table applied to the subnet. 1. Create a route table and browse to **Configuration** -2. Add one or more routes for networks you want to pass through the VyOS VM. Next hop type **Virtual Appliance** with the **Next Hop Address** of the VyOS ``LAN`` interface. +2. Add one or more routes for networks you want to pass through the VyOS VM. + Next hop type **Virtual Appliance** with the **Next Hop Address** of the + VyOS ``LAN`` interface. -.. note:: If you want to create a new default route for VMs on the subnet, use **Address Prefix** ``0.0.0.0/0`` Also note that if you want to use this as a typical edge device, you'll want masquerade NAT for the ``WAN`` interface. +.. note:: If you want to create a new default route for VMs on the subnet, use + **Address Prefix** ``0.0.0.0/0`` Also note that if you want to use this as + a typical edge device, you'll want to masquerade NAT for the ``WAN`` + interface. Serial Console -------------- -Azure has a way to access the serial console of a VM, but this needs to be configured on the VyOS. It's there by default, but keep it in mind if you are replacing config.boot and rebooting: ``set system console device ttyS0 speed '9600'`` +Azure has a way to access the serial console of a VM, but this needs to be +configured on the VyOS. It's there by default, but keep it in mind if you are +replacing config.boot and rebooting: ``set system console device ttyS0 speed +'9600'`` References ---------- diff --git a/docs/installation/cloud/cloud-init.rst b/docs/installation/cloud/cloud-init.rst index 1a5bda92..9e72a632 100644 --- a/docs/installation/cloud/cloud-init.rst +++ b/docs/installation/cloud/cloud-init.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-07-26 + .. _cloud-init: ################################ @@ -20,9 +22,9 @@ Commands requirements: ``set some option 'value'``, ``delete some option 'value'`` * a single-quote symbol is not allowed inside command or value -The commands list produced by the ``show configuration commands`` command on a +The commands' list produced by the ``show configuration commands`` command on a VyOS router should comply with all the requirements, so it is easy to get a -proper commands list by copying it from another router. +proper commands' list by copying it from another router. Usage example (User-Data content): diff --git a/docs/installation/cloud/gcp.rst b/docs/installation/cloud/gcp.rst index 07aecdbe..318c1872 100644 --- a/docs/installation/cloud/gcp.rst +++ b/docs/installation/cloud/gcp.rst @@ -1,3 +1,4 @@ + ##################### Google Cloud Platform ##################### @@ -17,8 +18,8 @@ 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:: For name, type "vyos@mypc" as 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 @@ -38,7 +39,7 @@ Click **Add item** and paste your public ssh key. Click ``Save``. .. figure:: /_static/images/cloud-gcp-03.png -4. After fiew seconds click to ``instance`` +4. After few seconds click on ``instance`` .. figure:: /_static/images/cloud-gcp-04.png @@ -55,4 +56,4 @@ Click **Add item** and paste your public ssh key. Click ``Save``. References ---------- -https://console.cloud.google.com/
\ No newline at end of file +https://console.cloud.google.com/ diff --git a/docs/installation/image.rst b/docs/installation/image.rst index 074a0245..8bf5b0dc 100644 --- a/docs/installation/image.rst +++ b/docs/installation/image.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-07-26 + .. _image-mgmt: ################ @@ -30,7 +32,7 @@ configured to be the default. .. opcmd:: show system image - List all available system images which can be bootet on the current system. + List all available system images which can be booted on the current system. .. code-block:: none @@ -46,7 +48,7 @@ configured to be the default. Delete no longer needed images from the system. You can specify an optional image name to delete, the image name can be retrieved via a list of available - images can be shown using the :opcmd:`show system image`. + images using the command :opcmd:`show system image`. .. code-block:: none @@ -111,5 +113,5 @@ Then reboot the system. so you don't need to worry about that. Each image has a unique copy of its configuration. -If you have access to the console, there is a another way to select +If you have access to the console, there is an another way to select your booting image: reboot and use the GRUB menu at startup. diff --git a/docs/installation/vyos-on-baremetal.rst b/docs/installation/vyos-on-baremetal.rst index 14ba2adf..ede50c6c 100644 --- a/docs/installation/vyos-on-baremetal.rst +++ b/docs/installation/vyos-on-baremetal.rst @@ -1,3 +1,5 @@ +:lastproofread: 2021-07-26 + .. _vyosonbaremetal: Running on Bare Metal @@ -14,23 +16,24 @@ Shopping Cart * 1x Supermicro CSE-505-203B (19" 1U chassis, inkl. 200W PSU) * 1x Supermicro MCP-260-00085-0B (I/O Shield for A2SDi-2C-HLN4F) -* 1x Supermicro A2SDi-2C-HLN4F (Intel Atom C3338, 2C/2T, 4MB cache, Quad LAN with - Intel C3000 SoC 1GbE) +* 1x Supermicro A2SDi-2C-HLN4F (Intel Atom C3338, 2C/2T, 4MB cache, Quad LAN + with Intel C3000 SoC 1GbE) * 1x Crucial CT4G4DFS824A (4GB DDR4 RAM 2400 MT/s, PC4-19200) * 1x SanDisk Ultra Fit 32GB (USB-A 3.0 SDCZ43-032G-G46 mass storage for OS) * 1x Supermicro MCP-320-81302-0B (optional FAN tray) Optional (10GE) --------------- -If you wan't to get additional ethernet ports or even 10GE connectivity +If you want to get additional ethernet ports or even 10GE connectivity the following optional parts will be required: * 1x Supermicro RSC-RR1U-E8 (Riser Card) * 1x Supermicro MCP-120-00063-0N (Riser Card Bracket) Latest VyOS rolling releases boot without any problem on this board. You also -receive a nice IPMI interface realized with an ASPEED AST2400 BMC (no information -about `OpenBMC <https://www.openbmc.org/>`_ so far on this motherboard). +receive a nice IPMI interface realized with an ASPEED AST2400 BMC (no +information about `OpenBMC <https://www.openbmc.org/>`_ so far on this +motherboard). Pictures -------- @@ -105,7 +108,7 @@ dual front cover. VyOS 1.2 (crux) --------------- -Depending on the VyOS versions you intend to install there is a difference in +Depending on the VyOS versions, you intend to install there is a difference in the serial port settings (T1327_). Create a bootable USB pendrive using e.g. Rufus_ on a Windows machine. @@ -113,6 +116,8 @@ 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 @@ -130,6 +135,8 @@ 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. @@ -175,8 +182,8 @@ Use the following command to adjust the :ref:`serial-console` settings: set system console device ttyS0 speed 115200 -.. note:: Once you ``commit`` the above changes access to the serial interface - is lost until you set your terminal emulator to 115200 8N1 again. +.. note:: Once you ``commit`` the above changes, the access to the serial + interface is lost until you set your terminal emulator to 115200 8N1 again. .. code-block:: none @@ -192,12 +199,14 @@ Installing the rolling release on an APU2 board does not require any change on the serial console from your host side as T1327_ was successfully implemented. -Simply proceed with a regular image installation as described in :ref:`installation`. +Simply proceed with a regular image installation as described in +:ref:`installation`. Pictures -------- -.. note:: Both device types operate without any moving parts and emit zero noise. +.. note:: Both device types operate without any moving parts and emit zero + noise. Rack Mount ^^^^^^^^^^ @@ -251,12 +260,13 @@ Qotom Q355G4 The install on this Q355G4 box is pretty much plug and play. The port numbering the OS does might differ from the labels on the outside, but the UEFI firmware -has a port blink test built in with MAC adresses so you can very quickly identify -which is which. MAC labels are on the inside as well, and this test can be done -from VyOS or plain Linux too. Default settings in the UEFI will make it boot, -but depending on your installation wishes (i.e. storage type, boot type, console -type) you might want to adjust them. This Qotom company seems to be the real -OEM/ODM for many other relabelling companies like Protectli. +has a port blink test built in with MAC adresses so you can very quickly +identify which is which. MAC labels are on the inside as well, and this test +can be done from VyOS or plain Linux too. Default settings in the UEFI will +make it boot, but depending on your installation wishes (i.e. storage type, +boot type, console type) you might want to adjust them. This Qotom company +seems to be the real OEM/ODM for many other relabelling companies like +Protectli. Hardware -------- @@ -271,12 +281,13 @@ slots, so you could in theory add an LTE/Cell modem (not tested so far). The chassis is a U-shaped alu extrusion with removable I/O plates and removable bottom plate. Cooling is completely passive with a heatsink on the SoC with -internal and external fins, a flat interface surface, thermal pad on top of that, -which then directly attaches to the chassis, which has fins as well. It comes -with mounting hardware and rubber feet, so you could place it like a desktop -model or mount it on a VESA mount, or even wall mount it with the provided -mounting plate. The closing plate doubles as internal 2.5" mounting place for -an HDD or SSD, and comes supplied with a small SATA cable and SATA power cable. +internal and external fins, a flat interface surface, thermal pad on top of +that, which then directly attaches to the chassis, which has fins as well. It +comes with mounting hardware and rubber feet, so you could place it like a +desktop model or mount it on a VESA mount, or even wall mount it with the +provided mounting plate. The closing plate doubles as internal 2.5" mounting +place for an HDD or SSD, and comes supplied with a small SATA cable and SATA +power cable. Power supply is a 12VDC barrel jack, and included switching power supply, which is why SATA power regulation is on-board. Internally it has a NUC-board-style @@ -336,7 +347,8 @@ It is a small (serial console only) PC with 6 Gb LAN http://www.acrosser.com/upload/AND-J190_J180N1-2.pdf You may have to add your own RAM and HDD/SSD. There is no VGA connector. But -Acrosser provides a DB25 adapter for the VGA header on the motherboard (not used). +Acrosser provides a DB25 adapter for the VGA header on the motherboard (not +used). BIOS Settings: -------------- @@ -345,10 +357,11 @@ First thing you want to do is getting a more user friendly console to configure BIOS. Default VT100 brings a lot of issues. Configure VT100+ instead. For practical issues change speed from 115200 to 9600. 9600 is the default speed -at which both linux kernel and VyOS will reconfigure the serial port when loading. +at which both linux kernel and VyOS will reconfigure the serial port when +loading. -Connect to serial (115200bps). Power on the appliance and press Del in the console -when requested to enter BIOS settings. +Connect to serial (115200bps). Power on the appliance and press Del in the +console when requested to enter BIOS settings. Advanced > Serial Port Console Redirection > Console Redirection Settings: @@ -368,8 +381,8 @@ Reboot into BIOS, Chipset > South Bridge > USB Configuration: Install VyOS: ------------- -Create a VyOS bootable USB key. I used the 64-bit ISO (VyOS 1.1.7) and `LinuxLive -USB Creator <http://www.linuxliveusb.com/>`_. +Create a VyOS bootable USB key. I used the 64-bit ISO (VyOS 1.1.7) and +`LinuxLive USB Creator <http://www.linuxliveusb.com/>`_. I'm not sure if it helps the process but I changed default option to live-serial (line “default xxxx”) on the USB key under syslinux/syslinux.cfg. |