vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-15 18:12:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Proofreading about.rst and history.rst (#1709)

Browse Source 
* Proofreading About and History

* Apply suggestions from code review

Co-authored-by: Daniil Baturin <daniil@baturin.org>

* Addressed comments on the About and History sections.

---------

Co-authored-by: Daniil Baturin <daniil@baturin.org>
This commit is contained in:
LiudmylaNad 2025-12-09 15:19:01 +01:00 committed by GitHub
parent bc7512c2c7
commit b9560fe135
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 80 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/introducing/about.rst
View File

@ -4,24 +4,20 @@
About About
##### #####
VyOS is an open source network operating system based on Debian GNU/Linux. VyOS is an open-source network operating system that provides a single unified
CLI and API to manage routing protocols, firewall and NAT, QoS, load balancing,
DHCP and DNS servers, and many other features.
VyOS provides a free routing platform that competes directly with other VyOS runs on a wide variety of commodity hardware, virtual machines, and
commercially available solutions from well known network providers. Because multiple cloud environments.
VyOS runs on standard amd64, i586 and ARM systems, it is able to be used
as a router and firewall platform for cloud deployments.
We use multiple live versions of our manual, hosted thankfully by We provide a dedicated user guide for each major
https://readthedocs.org. We will provide one version of the manual for every VyOS release that receives long-term support (LTS). We maintain multiple user
VyOS major version starting with VyOS 1.2 which will receive Long-term support guide versions, all hosted at https://docs.vyos.io.
(LTS). To switch between versions, select the appropriate version in the bottom-right
corner.
The manual version is selected/specified by it's Git branch name. You can VyOS CLI syntax may vary between major and sometimes minor releases. Always
switch between versions of the documentation by selecting the appropriate refer to the documentation matching your current running installation. If
branch on the bottom left corner. a change in the CLI is required, VyOS provides a migration script to handle
the syntax adjustments. No user action is required.
VyOS CLI syntax may change between major (and sometimes minor) versions. Please
always refer to the documentation matching your current, running installation.
If a change in the CLI is required, VyOS will ship a so called migration script
which will take care of adjusting the syntax. No action needs to be taken by
you.

143
docs/introducing/history.rst
View File

@ -7,127 +7,116 @@ History
In the beginning... In the beginning...
=================== ===================
There once was a network operating system based on Debian GNU/Linux, There was a network operating system based on Debian GNU/Linux, called
called Vyatta. [*]_ 2006 onwards, it was a great free software Vyatta. [*]_ Introduced in 2006, it served as a great free-software alternative
alternative to Cisco IOS and Jupiter JUNOS. It came in two editions: to proprietary products. Vyatta came in two editions: Vyatta Core
Vyatta Core (previously Vyatta Community Edition) that was completely (formerly known as Vyatta Community Edition), which was free software, and
free software, and Vyatta Subscription Edition that had proprietary Vyatta Subscription Edition, which included proprietary features and was
features and was only available to paying customers. available only to paying customers.
Vyatta was acquired by Brocade Communication Systems in 2012. Shortly Brocade Communications Systems acquired Vyatta in 2012. Shortly after, Brocade
after, Brocade renamed Vyatta Subscription Edition to Brocade vRouter, renamed Vyatta Subscription Edition to Brocade vRouter, discontinued Vyatta
discontinued Vyatta Core and shut down the community forum without a Core, and shut down the community forum without notice. The bug tracker and Git
notice. The bug tracker and Git repositories followed next year. repositories were closed the following year.
It's worth noting that by the time Brocade acquired Vyatta, By the time Brocade acquired Vyatta, the development of Vyatta Core had
development of Vyatta Core was already stagnated. Vyatta Subscription already stagnated. The focus had shifted to Vyatta Subscription Edition,
Edition (and thus, Vyatta development as a whole) had been replacing where core components were replaced with proprietary software. As a result,
core components with proprietary software, meaning few features made Vyatta Core received fewer new features, and some of those added faced issues.
it to Vyatta Core, and those that did were bug-ridden and hamstrung.
In 2013, soon after Vyatta Core was abandoned, the community forked In 2013, shortly after Vyatta Core was discontinued, the community forked its
the last Vyatta Core version (6.6R1) and VyOS Project came into being. final version (6.6R1) to create the VyOS project. In 2014, the maintainers
`Sentrium SL <https://blog.vyos.io/sentrium-what-sentrium>`_ was established a company to fund VyOS development through technical support,
established by VyOS maintainers in 2014 to fund VyOS development by consulting services, and LTS release access subscriptions. The company was
selling support, consulting services and prebuilt long-term support originally named Sentrium and was later reorganized under the VyOS brand.
images. The company was later reorganized under the VyOS brand.
Brocade was acquired by Broadcom in 2016 and sold what remains of
erstwhile Vyatta to AT&T in 2017, who in turn sold it to Ciena in 2021.
Major releases Major releases
============== ==============
VyOS originally named its major versions after elements by atomic number.
VyOS major versions used to be named after elements in order of atomic Beginning with version 1.2, this naming scheme was changed. It now uses the
numbers. With 1.2, this naming scheme was replaced with the much Latin names of constellations recognized by the International Astronomical
cooler scheme of Latin names of `IAU Union (`IAU
<https://en.wikipedia.org/wiki/IAU_designated_constellations_by_area>`_ <https://en.wikipedia.org/wiki/IAU_designated_constellations_by_area>`_),
designated constellations by solid angle area, starting from the smallest. ordered by their solid angle area, beginning with the smallest.
Hydrogen (1.0) Hydrogen (1.0)
-------------- --------------
Released just in time for holidays on 22 December 2013, Hydrogen was Released just in time for the holidays on 22 December 2013, Hydrogen was
the first major VyOS release. It fixed features that were broken in the first major VyOS release. It fixed features that were broken in
Vyatta Core 6.6 (such as IPv4 BGP peer groups and DHCPv6 relay) and Vyatta Core 6.6, such as IPv4 BGP peer groups and DHCPv6 relay, and
introduced command scripting, a task scheduler and web proxy LDAP introduced command scripting, a task scheduler, and web proxy LDAP
authentication. authentication.
Helium (1.1) Helium (1.1)
------------ ------------
Helium, released on 9 October 2014, marked the first anniversary of the
VyOS Project. The release introduced an event handler, L2TPv3 support,
802.1ad (QinQ), and IGMP proxy, as well as experimental support for VXLAN
and DMVPN. Notably, DMVPN remained non-functional in Vyatta Core due to its
reliance on a proprietary NHRP implementation.
Helium was released on 9 October 2014, exactly on the day VyOS Project
first came into being in the previous year. Helium came with a lot of
new features, including an event handler and support for L2TPv3,
802.1ad QinQ and IGMP proxy, as well as experimental support for VXLAN
and DMVPN (the latter of which was also broken in Vyatta Core due to
its reliance on a proprietary NHRP implementation).
Crux (1.2) Crux (1.2)
---------- ----------
Crux (the Southern Cross) was released on 28 January 2019 and marked a
departure from legacy Vyatta codebase and the start of the migration from
Perl to Python as the primary language. The underlying base system was
upgraded from Debian 6 (Squeeze) to Debian 8 (Jessie).
Crux (the Southern Cross) came out on 28 January 2019 and was the Crux introduced many new features, some of the most noteworthy are:
first major release of VyOS as we know it today. The underlying an mDNS repeater, a broadcast relay, a high-performance PPPoE server,
Debian base was upgraded from Squeeze (6) to Jessie (8). an HFSC scheduler, and support for Wireguard, unicast VRRP, RPKI for BGP,
and fully 802.1ad-compliant QinQ ethertype. The telnet server and support
for P2P filtering were removed.
Although Crux came with too many new features to mention here, some Crux was the first VyOS release to feature a modular image build system.
noteworthy ones are: an mDNS repeater, a broadcast relay, CLI definitions were written using an XML syntax automatically checked
a high-performance PPPoE server, an HFSC scheduler, as well as support against a schema at build time. Python APIs were introduced for command
for Wireguard, unicast VRRP, RPKI for BGP and fully 802.1ad-compliant scripting and configuration migration. New Perl code and old-style (non-XML)
QinQ ethertype. The telnet server and support for P2P filtering were command definition were no longer accepted from that point.
removed.
Crux is the first version to feature the modular image build system. Crux reached the end of support in 2023.
CLI definitions began to be written in the modern, verifiable XML
templates. Python APIs were introduced for command scripting and
configuration migration. Introduction of new Perl and shell code was
proscribed and the rewriting of legacy Perl code in pure Python began
with Crux.
Crux reached end of support in 2023..
Equuleus (1.3) Equuleus (1.3)
-------------- --------------
The current long-term support version of VyOS, Equuleus (the Pony) Equuleus (the Little Horse) was a long-term support version released
came out on 21 December 2021, once again in time for the winter on 21 December 2021, just in time for the winter holidays.
holidays.
Equuleus brought many long-desired features with it, most notably Equuleus brought many long-awaited features, most notably an SSTP VPN
an SSTP VPN server, an IPoE server, an OpenConnect VPN server and server, an IPoE server, an OpenConnect VPN server, and a serial console
a serial console server, in addition to reworked support for WWAN server. It also introduced reworked support for WWAN interfaces, support
interfaces, support for GENEVE and MACSec interfaces, VRF, IS-IS for GENEVE and MACSec interfaces, VRF, IS-IS routing, and preliminary support
routing, preliminary support for MPLS and LDP, and many other for MPLS and LDP.
initialisms.
Equuleus reached end of support in 2025. Equuleus reached the end of support in 2025.
Sagitta (1.4) Sagitta (1.4)
------------- -------------
Sagitta (the Arrow) was released in 2024 and is currently a supported LTS release. Sagitta (the Arrow), released in 2024, is currently a supported LTS release.
Circinus (1.5) Circinus (1.5)
-------------- --------------
Circinus (the Compass) is the codename of the upcoming development Circinus (the Drawing Compass) is the codename for the upcoming development
branch, so there's no VyOS 1.5 yet. branch. VyOS 1.5 Circinus has not been released yet.
A note on copyright A note on copyright
=================== ===================
Unlike Vyatta, VyOS never had (nor will ever have) proprietary code. Unlike Vyatta, VyOS has never had closed-source code and never will.
The only proprietary material in VyOS is non-code assets, such as The only proprietary material in VyOS is non-code assets, such as
graphics and the trademark "VyOS". [*]_ This means you can build your graphics and the trademark "VyOS". [*]_
own long-term support images (as the entire toolchain we use is free
software) and even distribute them, given you rename it and remove Note that we do not provide support for images distributed by a third party.
such assets before building. Although note that we do not provide See the
support for images distributed by a third-party. See the
`artwork license <https://github.com/vyos/vyos-build/blob/current/LICENSE.artwork>`_ `artwork license <https://github.com/vyos/vyos-build/blob/current/LICENSE.artwork>`_
and the end-user license agreement at ``/usr/share/vyos/EULA`` in and the end-user license agreement at ``/usr/share/vyos/EULA`` in
any pre-built image for more precise information. any pre-built image for more information.
.. [*] From the Sanskrit adjective "Vyātta" (व्यात्त), meaning opened. .. [*] From the Sanskrit adjective "Vyātta" (व्यात्त), meaning opened.
.. [*] This is not unlike how Linus Torvalds owns the trademark "Linux". .. [*] This is similar to how Linus Torvalds owns the Linux trademark.