diff options
| -rw-r--r-- | docs/about.rst | 4 | ||||
| -rw-r--r-- | docs/appendix/virtual/index.rst | 12 | ||||
| -rw-r--r-- | docs/appendix/virtual/libvirt.rst (renamed from docs/appendix/vyos-on-virtual-environments.rst) | 20 | ||||
| -rw-r--r-- | docs/appendix/virtual/vyos-on-gns3.rst (renamed from docs/appendix/vyos-on-gns3.rst) | 5 | ||||
| -rw-r--r-- | docs/appendix/virtual/vyos-on-vmware.rst (renamed from docs/appendix/vyos-on-vmware.rst) | 0 | ||||
| -rw-r--r-- | docs/contributing/build-vyos.rst | 8 | ||||
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/information.rst | 2 | ||||
| -rw-r--r-- | docs/install.rst | 14 | ||||
| -rw-r--r-- | docs/routing/bgp.rst | 2 | ||||
| -rw-r--r-- | docs/system/syslog.rst | 2 |
11 files changed, 36 insertions, 37 deletions
diff --git a/docs/about.rst b/docs/about.rst index 0411344b..383c95eb 100644 --- a/docs/about.rst +++ b/docs/about.rst @@ -8,7 +8,7 @@ VyOS is an open source network operating system based on Debian GNU/Linux. VyOS provides a free routing platform that competes directly with other commercially available solutions from well known network providers. Because -VyOS is run on standard amd64, i586 and ARM systems, it is able to be used +VyOS is run on standard amd64, i586 and ARM systems, it can be used as a router and firewall platform for cloud deployments. We use multiple live versions of our manual hosted thankfully by @@ -16,7 +16,7 @@ https://readthedocs.org. We will provide one version of the manual for every VyOS major version starting with VyOS 1.2 which will receive Long-term support (LTS). -The manual version is selected/specified by it's Git branch name. You can +The manual version is selected/specified by its Git branch name. You can switch between versions of the documentation by selecting the appropriate branch on the bottom left corner. diff --git a/docs/appendix/virtual/index.rst b/docs/appendix/virtual/index.rst new file mode 100644 index 00000000..7ede37b5 --- /dev/null +++ b/docs/appendix/virtual/index.rst @@ -0,0 +1,12 @@ +.. _virtual: + +Running on Virtual Environments +=============================== + + +.. toctree:: + :maxdepth: 2 + + libvirt + vyos-on-vmware + vyos-on-gns3 diff --git a/docs/appendix/vyos-on-virtual-environments.rst b/docs/appendix/virtual/libvirt.rst index eed82390..0d624b94 100644 --- a/docs/appendix/vyos-on-virtual-environments.rst +++ b/docs/appendix/virtual/libvirt.rst @@ -1,12 +1,8 @@ -.. _vyos-on-virtual-environments: +.. _libvirt: -############################### -Running in Virtual Environments -############################### - -**************** -Libvirt Qemu/KVM -**************** +*************************** +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. @@ -161,12 +157,4 @@ Download predefined VyOS.qcow2 image for ``KVM`` .. figure:: /_static/images/virt-libvirt-qc-03.png -******* -Proxmox -******* - -References -========== - -https://www.proxmox.com/en/proxmox-ve diff --git a/docs/appendix/vyos-on-gns3.rst b/docs/appendix/virtual/vyos-on-gns3.rst index f17715b2..93ea9ae2 100644 --- a/docs/appendix/vyos-on-gns3.rst +++ b/docs/appendix/virtual/vyos-on-gns3.rst @@ -1,7 +1,8 @@ .. _vyos-on-gns3: -VyOS on GNS3 -############ +############### +Running on GNS3 +############### Sometimes you may want to test VyOS in a lab environment. `GNS3 <http://www.gns3.com>`__ is a network emulation software you diff --git a/docs/appendix/vyos-on-vmware.rst b/docs/appendix/virtual/vyos-on-vmware.rst index c4299cbf..c4299cbf 100644 --- a/docs/appendix/vyos-on-vmware.rst +++ b/docs/appendix/virtual/vyos-on-vmware.rst diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 43c1e608..e8bb9f37 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -93,7 +93,7 @@ The container can also be built directly from source: $ cd vyos-build $ docker build -t vyos/vyos-build:crux docker # For VyOS 1.2 - $ docker build -t vyos/vyos-build docker # For rolling release + $ docker build -t vyos/vyos-build:current docker # For rolling release .. note:: Since VyOS has switched to Debian (10) Buster in its ``current`` branch, you will require individual container for `current` and `crux` builds. @@ -154,7 +154,7 @@ in the repository_. The ``./configure`` script will also warn you if any dependencies are missing. Once you have the required dependencies installed, you may proceed with the -steps descirbed in :ref:`build_iso`. +steps described in :ref:`build_iso`. .. _build_iso: @@ -184,7 +184,7 @@ Now a fresh build of the VyOS ISO can begin. Change directory to the ``vyos-buil $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:crux bash # For VyOS 1.3 (equuleus, current) - $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build bash + $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:current bash Start the build: @@ -348,7 +348,7 @@ Launch Docker container and build package .. code-block:: none # For VyOS 1.3 (equuleus, current) - $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build bash + $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:current bash # Change to source directory $ cd vyos-1x diff --git a/docs/index.rst b/docs/index.rst index bab4f930..ab9d3f66 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -65,14 +65,12 @@ VyOS User Guide appendix/release-notes appendix/examples/index - appendix/vyos-on-vmware appendix/vyos-on-baremetal + appendix/virtual/index appendix/vyos-on-clouds - appendix/vyos-on-virtual-environments appendix/migrate-from-vyatta appendix/command-scripting appendix/http-api - appendix/vyos-on-gns3 .. toctree:: diff --git a/docs/information.rst b/docs/information.rst index 5565163e..02d6f1ec 100644 --- a/docs/information.rst +++ b/docs/information.rst @@ -5,7 +5,7 @@ Information *********** VyOS features a rich set of operational level commands to retrieve arbitrary -infomration about your running system. +information about your running system. ######## Hardware diff --git a/docs/install.rst b/docs/install.rst index 26d7c7c8..3e31449f 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -217,12 +217,12 @@ stick with with the ``dd`` command: .. code-block:: none - # dd if=/path/to/vyos.iso of=/dev/sdX bs=8M + # dd if=/path/to/vyos.iso of=/dev/sdX bs=8M; sync 5. Wait until you get the outcome (bytes copied). Be patient, in some computers it might take more than one minute. - 6. Once ``dd`` has finished, plug the USB drive out and plug it into + 6. Once ``dd`` has finished, pull the USB drive out and plug it into the powered-off computer where you want to install (or test) VyOS. 7. Power the computer on, making sure it boots from the USB drive (you @@ -239,7 +239,7 @@ macOS and Windows), Rufus_ (for Windows) and `many others`_. You can follow their instructions to create a bootable USB drive from an .iso file. -.. hint:: The default username and password for the live system is ``vyos``. +.. hint:: The default username and password for the live system is *vyos*. .. _permanent_installation: @@ -357,7 +357,7 @@ Configuration ------------- Step 1: DHCP -"""""""""""" +^^^^^^^^^^^^ Configure a DHCP server to provide the client with: @@ -385,7 +385,7 @@ In this example we configured an existent VyOS as the DHCP server: .. _install_from_tftp: Step 2: TFTP -"""""""""""" +^^^^^^^^^^^^ Configure a TFTP server so that it serves the following: @@ -444,7 +444,7 @@ Example of simple (no menu) configuration file: APPEND initrd=initrd.img-4.19.54-amd64-vyos boot=live nopersistence noautologin nonetworking fetch=http://address:8000/filesystem.squashfs Step 3: HTTP -"""""""""""" +^^^^^^^^^^^^ As you can read in the configuration file, we are sending ``filesystem.squashfs`` through HTTP. As that is a heavy file, we choose HTTP to speed up the transfer @@ -455,7 +455,7 @@ First run a web server - you can use a simple one like file. The file can be found inside the ``/live`` directory of the extracted contents of the ISO file. -Second, edit the configuration file at the :ref:`install_from_tftp` so that it shows +Second, edit the configuration file of the :ref:`install_from_tftp` so that it shows the correct URL at ``fetch=http://<address_of_your_HTTP_server>/filesystem.squashfs``. And third, restart the TFTP service. If you are using VyOS as your TFTP Server, you can restart diff --git a/docs/routing/bgp.rst b/docs/routing/bgp.rst index 2c5e7089..c576d836 100644 --- a/docs/routing/bgp.rst +++ b/docs/routing/bgp.rst @@ -4,7 +4,7 @@ BGP ### -:abbr:`BGP (Border Gateway Protocol) is one of the Exterior Gateway Protocols +:abbr:`BGP (Border Gateway Protocol)` is one of the Exterior Gateway Protocols and the de facto standard interdomain routing protocol. The latest BGP version is 4. BGP-4 is described in :rfc:`1771` and updated by :rfc:`4271`. :rfc:`2858` adds multiprotocol support to BGP. diff --git a/docs/system/syslog.rst b/docs/system/syslog.rst index 3a8b344a..3449c15b 100644 --- a/docs/system/syslog.rst +++ b/docs/system/syslog.rst @@ -22,7 +22,7 @@ Console .. cfgcmd:: set system syslog console facility <keyword> level <keyword> -Log syslog messages to ``/dev/console``, for en explanation on +Log syslog messages to ``/dev/console``, for an explanation on :ref:`syslog_facilities` keywords and :ref:`syslog_severity_level` keywords see tables below. |