summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorerkin <e.altunbas@vyos.io>2021-11-03 19:39:25 +0300
committererkin <e.altunbas@vyos.io>2021-11-03 19:39:25 +0300
commitdb3954a20f35ec77cba09557f43df8e1468509a0 (patch)
tree4cccca3cab1db44b02765a334fd0551ba47a3671
parent7de1cd016e3643431cb85fa3ea2443618ebd69f9 (diff)
downloadvyos-documentation-db3954a20f35ec77cba09557f43df8e1468509a0.tar.gz
vyos-documentation-db3954a20f35ec77cba09557f43df8e1468509a0.zip
Add image release comparison table
-rw-r--r--docs/installation/install.rst35
1 files changed, 33 insertions, 2 deletions
diff --git a/docs/installation/install.rst b/docs/installation/install.rst
index 7cd582f4..83bd7e8c 100644
--- a/docs/installation/install.rst
+++ b/docs/installation/install.rst
@@ -9,6 +9,37 @@ 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
+
+ +--------------+---------------------------------------------------+-------------------+---------------------------------------+-----------------------+------------------+
+ | Release Type | Description | Release Cycle | Intended Use | Access to Images | Access to Source |
+ +==============+===================================================+===================+=======================================+=======================+==================+
+ | **Nightly | Automatically built from the current branch. | Every night | Developing VyOS, testing new | Everyone | Everyone |
+ | (Current)** | Always up to date with cutting edge development | | features, experimenting. | | |
+ | | but guaranteed to contain bugs. | | | | |
+ +--------------+---------------------------------------------------+-------------------+---------------------------------------+-----------------------+------------------+
+ | **Nightly | Automatically built from the development branch | Every night | Developing and testing the latest | Everyone | Everyone |
+ | (Beta)** | and released alongside snapshots. Most likely | | major version under development. | | |
+ | | contains bugs. | | | | |
+ +--------------+---------------------------------------------------+-------------------+---------------------------------------+-----------------------+------------------+
+ | **Snapshot** | A particularly stable release frozen from nightly | Every month until | Home labs and simple networks that | Everyone | Everyone |
+ | | each month after manual testing. Still contains | RC comes out | call for new features. | | |
+ | | experimental code. | | | | |
+ +--------------+---------------------------------------------------+-------------------+---------------------------------------+-----------------------+------------------+
+ | **Release | Rather stable. All development focuses on testing | Irregularly until | Labs, small offices and non-critical | Everyone | Everyone |
+ | Candidate** | and hunting down remaining bugs following the | EPA comes out | production systems backed by a | | |
+ | | feature freeze. | | high-availability setup. | | |
+ +--------------+---------------------------------------------------+-------------------+---------------------------------------+-----------------------+------------------+
+ | **Early | Highly stable with no known bugs. Needs to be | Irregularly until | Non-critical production environments, | Everyone | Everyone |
+ | Production | tested repeatedly under different conditions | LTS comes out | preparing for the LTS release. | | |
+ | Access** | before it can become the final release. | | | | |
+ +--------------+---------------------------------------------------+-------------------+---------------------------------------+-----------------------+------------------+
+ | **Long-Term | Guaranteed to be stable and carefully maintained | Every major | Large-scale enterprise networks, | Subscribers, | Everyone |
+ | Support** | for several years after the release. No features | version | internet service providers, | contributors, | |
+ | | are introduced but security updates are released | | critical production environments | non-profits, | |
+ | | in a timely manner. | | that call for minimum downtime. | emergency services, | |
+ | | | | | academic institutions | |
+ +--------------+---------------------------------------------------+-------------------+---------------------------------------+-----------------------+------------------+
Hardware requirements
=====================
@@ -25,14 +56,14 @@ Registered Subscribers
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
+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.
Instructions can be found in the :ref:`build` section of this manual. VyOS