summaryrefslogtreecommitdiff
path: root/docs/appendix/vyos-on-baremetal.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-06-28 23:50:13 +0200
committerChristian Poessinger <christian@poessinger.com>2019-06-28 23:50:16 +0200
commit1975f09bb0f982374a09e36166e75c8997a89874 (patch)
tree55e15416bff2d9cb1d5d8e76453c23ced7dcd6ff /docs/appendix/vyos-on-baremetal.rst
parente9c46d5772b1c2381b392e098e077b006a5b94fd (diff)
downloadvyos-documentation-1975f09bb0f982374a09e36166e75c8997a89874.tar.gz
vyos-documentation-1975f09bb0f982374a09e36166e75c8997a89874.zip
VyOS on baremetal - adjust to 80 character line breaks
this makes diff-ing and reading on a console much easier.
Diffstat (limited to 'docs/appendix/vyos-on-baremetal.rst')
-rw-r--r--docs/appendix/vyos-on-baremetal.rst114
1 files changed, 82 insertions, 32 deletions
diff --git a/docs/appendix/vyos-on-baremetal.rst b/docs/appendix/vyos-on-baremetal.rst
index 41f44912..66b68c09 100644
--- a/docs/appendix/vyos-on-baremetal.rst
+++ b/docs/appendix/vyos-on-baremetal.rst
@@ -241,36 +241,78 @@ Desktop
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.
+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.
Hardware
--------
-There are a number of other options, but they all seem to be close to Intel reference designs, with added features like more serial ports, more network interfaces and the likes. Because they don't deviate too much from standard designs all the hardware is well-supported by mainline. It accepts one LPDDR3 SO-DIMM, but chances are that if you need more than that, you'll also want something even beefier than an i5. There are options for antenna holes, and SIM 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. 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 on-board 12V input header as well, the molex locking style.
-
-There are WDT options and auto-boot on power enable, which is great for remote setups. Firmware is reasonably secure (no backdoors found, BootGuard is enabled in enforcement mode, which is good but also means no coreboot option), yet has most options available to configure (so it's not locked out like most firmwares are).
-
-An external RS232 serial port is available, internally a GPIO header as well. It does have Realtek based audio on board for some reason, but you can disable that. Booting works on both USB2 and USB3 ports. Switching between serial BIOS mode and HDMI BIOS mode depends on what is connected at startup; it goes into serial mode if you disconnect HDMI and plug in serial, in all other cases it's HDMI mode.
-
+There are a number of other options, but they all seem to be close to Intel
+reference designs, with added features like more serial ports, more network
+interfaces and the likes. Because they don't deviate too much from standard
+designs all the hardware is well-supported by mainline. It accepts one LPDDR3
+SO-DIMM, but chances are that if you need more than that, you'll also want
+something even beefier than an i5. There are options for antenna holes, and SIM
+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.
+
+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
+on-board 12V input header as well, the molex locking style.
+
+There are WDT options and auto-boot on power enable, which is great for remote
+setups. Firmware is reasonably secure (no backdoors found, BootGuard is enabled
+in enforcement mode, which is good but also means no coreboot option), yet has
+most options available to configure (so it's not locked out like most firmwares
+are).
+
+An external RS232 serial port is available, internally a GPIO header as well.
+It does have Realtek based audio on board for some reason, but you can disable
+that. Booting works on both USB2 and USB3 ports. Switching between serial BIOS
+mode and HDMI BIOS mode depends on what is connected at startup; it goes into
+serial mode if you disconnect HDMI and plug in serial, in all other cases it's
+HDMI mode.
Partaker i5
***********
+
.. figure:: ../_static/images/600px-Partaker-i5.jpg
-I believe this is actually the same hardware as the Protectli. I purchased it from `Amazon <https://www.amazon.com/gp/product/B073F9GHKL/>`_ in June 2018. It came pre-loaded with pfSense. `Manufacturer product page <http://www.inctel.com.cn/product/detail/338.html>`_.
+I believe this is actually the same hardware as the Protectli. I purchased it
+from `Amazon <https://www.amazon.com/gp/product/B073F9GHKL/>`_ in June 2018.
+It came pre-loaded with pfSense.
+
+`Manufacturer product page <http://www.inctel.com.cn/product/detail/338.html>`_.
Installation
------------
-* Write the official ISO to a USB drive of some sort.
-* Plug in VGA, power, USB keyboard, and USB drive.
-* Press the "SW" button on the front (this is the power button; I don't know what "SW" is supposed to mean).
-* Begin rapidly pressing Delete on the keyboard. The boot prompt is very quick, but with a few tries you should be able to get into the BIOS.
-* Chipset > South Bridge > USB Configuration: set XHCI to Disabled and USB 2.0 (EHCI) to Enabled. Without doing this, the USB drive won't boot.
+
+* Write VyOS ISO to USB drive of some sort
+* Plug in VGA, power, USB keyboard, and USB drive
+* Press "SW" button on the front (this is the power button; I don't know what
+ "SW" is supposed to mean).
+* Begin rapidly pressing delete on the keyboard. The boot prompt is very quick,
+ but with a few tries you should be able to get into the BIOS.
+* Chipset > South Bridge > USB Configuration: set XHCI to Disabled and USB 2.0
+ (EHCI) to Enabled. Without doing this, the USB drive won't boot.
* Boot to the VyOS installer and install as usual.
-Warning the interface labels on my device are backwards; the left-most "LAN4" port is eth0 and the right-most "LAN1" port is eth3.
+Warning the interface labels on my device are backwards; the left-most "LAN4"
+port is eth0 and the right-most "LAN1" port is eth3.
Acrosser AND-J190N1
*******************
@@ -279,44 +321,52 @@ Acrosser AND-J190N1
.. figure:: ../_static/images/480px-Acrosser_ANDJ190N1_Back.jpg
-11/22/2016. This microbox network appliance was build to create OpenVPN bridges. It can saturate a 100Mbps link.
+11/22/2016. 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 http://www.acrosser.com/upload/AND-J190_J180N1-2.pdf
+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).
+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).
BIOS Settings:
--------------
-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.
+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.
+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.
-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:
* Terminal Type : VT100+
* Bits per second : 9600
-Then save, reboot and change serial speed to 9600 on your client.
-
+Save, reboot and change serial speed to 9600 on your client.
-Some options have to be changed for VyOS to boot correctly. With XHCI enabled the installer can’t access the USB key. Enable EHCI instead.
+Some options have to be changed for VyOS to boot correctly. With XHCI enabled
+the installer can’t access the USB key. Enable EHCI instead.
-Reboot inside the BIOS,
-
-Chipset > South Bridge > USB Configuration:
+Reboot into BIOS, Chipset > South Bridge > USB Configuration:
* Disable XHCI
* Enable USB 2.0 (EHCI) Support
Install VyOS:
-------------
-Create a VyOS bootable USB key. I Used the 64bits iso (VyOS 1.1.7) and live usb installer (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.
+Create a VyOS bootable USB key. I Used the 64bits iso (VyOS 1.1.7) and live USB
+installer (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.
-I connected the key to one black USB port on the back and powered on. The first VyOS screen has some readability issues. Press enter to continue.
+I connected the key to one black USB port on the back and powered on. The first
+VyOS screen has some readability issues. Press enter to continue.
-Then VyOS should boot and you can perform the "install image"
+Then VyOS should boot and you can perform the ``install image``