diff options
Diffstat (limited to 'docs/installation')
-rw-r--r-- | docs/installation/cloud/gcp.rst | 4 | ||||
-rw-r--r-- | docs/installation/image.rst | 2 | ||||
-rw-r--r-- | docs/installation/install.rst | 36 | ||||
-rw-r--r-- | docs/installation/update.rst | 2 | ||||
-rw-r--r-- | docs/installation/virtual/vmware.rst | 2 | ||||
-rw-r--r-- | docs/installation/vyos-on-baremetal.rst | 1 |
6 files changed, 23 insertions, 24 deletions
diff --git a/docs/installation/cloud/gcp.rst b/docs/installation/cloud/gcp.rst index 07aecdbe..7ae1a66e 100644 --- a/docs/installation/cloud/gcp.rst +++ b/docs/installation/cloud/gcp.rst @@ -38,7 +38,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 to ``instance`` .. figure:: /_static/images/cloud-gcp-04.png @@ -55,4 +55,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..77ca01f9 100644 --- a/docs/installation/image.rst +++ b/docs/installation/image.rst @@ -30,7 +30,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 diff --git a/docs/installation/install.rst b/docs/installation/install.rst index 3fda6d53..bfeb45d5 100644 --- a/docs/installation/install.rst +++ b/docs/installation/install.rst @@ -4,9 +4,9 @@ Installation ############ -VyOS installation requires to download a VyOS .iso file. That file is -a live install image that lets you boot a live VyOS. From that live -system you can proceed to the permanent installation on a hard drive or +VyOS installation requires a downloaded VyOS .iso file. That file is +a live install image that lets you boot a live VyOS. From the live +system, you can proceed to a permanent installation on a hard drive or any other type of storage. .. table:: Comparison of VyOS image releases @@ -45,7 +45,7 @@ Hardware requirements ===================== The minimum system requirements are 512 MiB RAM and 2 GiB storage. -Depending on your use you might need additional RAM and CPU resources e.g. +Depending on your use, you might need additional RAM and CPU resources e.g. when having multiple BGP full tables in your system. .. _download: @@ -56,19 +56,19 @@ Download Registered Subscribers ---------------------- -Registered subscribers can log into https://support.vyos.io/ to have access to -a variety of different downloads via the "Downloads" link. These downloads -include LTS (Long-Term-Support) and associated hot-fix releases, early public +Registered subscribers can log into https://support.vyos.io/ to access a +variety of different downloads via the "Downloads" link. These downloads +include LTS (Long-Term Support), the associated hot-fix releases, early public access releases, pre-built VM images, as well as device specific installation ISOs. .. figure:: /_static/images/vyos-downloads.png Building from source ----------------------- +-------------------- Non-subscribers can always get the LTS release by building it from source. -Instruction can be found in the :ref:`build` section of this manual. VyOS +Instructions can be found in the :ref:`build` section of this manual. VyOS source code repository is available for everyone at https://github.com/vyos/vyos-build. @@ -80,8 +80,8 @@ https://downloads.vyos.io/ .. note:: Rolling releases contain all the latest enhancements and fixes. This means that there will be new bugs of course. If you think you hit a bug - please follow the guide at :ref:`bug_report`. To improve VyOS we depend on - your feedback! + please follow the guide at :ref:`bug_report`. We depend on your feedback + to improve VyOS! The following link will always fetch the most recent VyOS build for AMD64 systems from the current branch: @@ -91,11 +91,11 @@ https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso Download Verification --------------------- -LTS images are signed by VyOS lead package-maintainer private key. With +LTS images are signed by the VyOS lead package-maintainer private key. With the official public key, the authenticity of the package can be verified. :abbr:`GPG (GNU Privacy Guard)` is used for verification. -.. note:: This subsection only applies e applies to LTS images, for +.. note:: This subsection only applies to LTS images, for Rolling images please jump to :ref:`live_installation`. Preparing for the verification @@ -245,7 +245,7 @@ an aesthetic problem, but we've had that process fail in the past. But, small key size of the Ed25519 algorithm allows passing public keys in command line arguments, so verification process can be completely stateless: -:vytask:`T2180` switched the validation system to prefer minisign over GPG keys. +:vytask:`T2108` switched the validation system to prefer minisign over GPG keys. To verify a VyOS image starting off with VyOS 1.3.0-rc6 you can run: @@ -271,12 +271,12 @@ Live installation .. note:: A permanent VyOS installation always requires to go first through a live installation. -VyOS, as other GNU+Linux distributions, can be tasted without installing +VyOS, as other GNU+Linux distributions, can be tested without installing it in your hard drive. **With your downloaded VyOS .iso file you can create a bootable USB drive that will let you boot into a fully functional VyOS system**. Once you have tested it, you can either decide to begin a :ref:`permanent_installation` in your hard drive or power -your system off, remove the USB drive, and leave everythng as it was. +your system off, remove the USB drive, and leave everything as it was. If you have a GNU+Linux system, you can create your VyOS bootable USB @@ -412,7 +412,7 @@ In order to proceed with a permanent installation: Done! - 3. After the installation is complete, remove the live USB stick or + 3. After the installation is completed, remove the live USB stick or CD. 4. Reboot the system. @@ -429,7 +429,7 @@ PXE Boot ======== VyOS can also be installed through PXE. This is a more complex -installation method which allows deploying VyOS through the network. +installation method that allows deploying VyOS through the network. **Requirements** diff --git a/docs/installation/update.rst b/docs/installation/update.rst index 5bcd5b8a..3e19100c 100644 --- a/docs/installation/update.rst +++ b/docs/installation/update.rst @@ -14,7 +14,7 @@ for the new image to boot using the current configuration. [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, + image from the web (``http://``, ``https://``) or from your local system, e.g. /tmp/vyos-1.2.3-amd64.iso. The `add system image` command also supports installing new versions diff --git a/docs/installation/virtual/vmware.rst b/docs/installation/virtual/vmware.rst index 28614573..a522dc78 100644 --- a/docs/installation/virtual/vmware.rst +++ b/docs/installation/virtual/vmware.rst @@ -17,7 +17,7 @@ installing from the ISO using the normal process around `install image`. 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
+start the balloon process in 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
diff --git a/docs/installation/vyos-on-baremetal.rst b/docs/installation/vyos-on-baremetal.rst index 7eca7250..5bd4fa20 100644 --- a/docs/installation/vyos-on-baremetal.rst +++ b/docs/installation/vyos-on-baremetal.rst @@ -369,7 +369,6 @@ Acrosser AND-J190N1 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 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 |