From 32d9e333b7516d311015531c68db30445d088266 Mon Sep 17 00:00:00 2001 From: Donald Sharp Date: Wed, 9 Sep 2020 00:09:38 -0400 Subject: [PATCH] doc: Update Documentation to note Solaris Unsupported status With the change of Solaris going from Supported -> UnSupported the documentation needed to be updated to reflect the reality on the ground. Signed-off-by: Donald Sharp --- README.md | 4 +- configure.ac | 2 +- doc/developer/building-frr-for-omnios.rst | 143 --------------------- doc/developer/building.rst | 1 - doc/developer/subdir.am | 1 - doc/user/basic.rst | 4 +- doc/user/overview.rst | 146 ++++++++++++---------- doc/user/pim.rst | 2 +- doc/user/zebra.rst | 4 +- 9 files changed, 86 insertions(+), 221 deletions(-) delete mode 100644 doc/developer/building-frr-for-omnios.rst diff --git a/README.md b/README.md index 937728c9e6..0724dae335 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ FRRouting ========= FRR is free software that implements and manages various IPv4 and IPv6 routing -protocols. It runs on nearly all distributions of Linux and BSD as well as -Solaris and supports all modern CPU architectures. +protocols. It runs on nearly all distributions of Linux and BSD and +supports all modern CPU architectures. FRR currently supports the following protocols: diff --git a/configure.ac b/configure.ac index f6c55f557b..d75637c0a7 100755 --- a/configure.ac +++ b/configure.ac @@ -1124,7 +1124,7 @@ is_linux=false AC_MSG_CHECKING([which operating system interface to use]) case "$host_os" in sunos* | solaris2*) - AC_MSG_FAILURE([Solaris support has been removed please see versions prior to 7.5]) + AC_MSG_FAILURE([Solaris support has been removed please see versions prior or equal to 7.5]) ;; linux*) AC_MSG_RESULT([Linux]) diff --git a/doc/developer/building-frr-for-omnios.rst b/doc/developer/building-frr-for-omnios.rst deleted file mode 100644 index 3a69279b0c..0000000000 --- a/doc/developer/building-frr-for-omnios.rst +++ /dev/null @@ -1,143 +0,0 @@ -OmniOS (OpenSolaris) -==================================================== - -OmniOS restrictions: --------------------- - -- MPLS is not supported on ``OmniOS`` or ``Solaris``. MPLS requires a - Linux Kernel (4.5 or higher). LDP can be built, but may have limited - use without MPLS - -Enable IP & IPv6 forwarding -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -:: - - routeadm -e ipv4-forwarding - routeadm -e ipv6-forwarding - -Install required packages -------------------------- - -Add packages: - -:: - - pkg install \ - developer/build/autoconf \ - developer/build/automake \ - developer/lexer/flex \ - developer/parser/bison \ - developer/object-file \ - developer/linker \ - developer/library/lint \ - developer/build/gnu-make \ - developer/gcc51 \ - library/idnkit \ - library/idnkit/header-idnkit \ - system/header \ - system/library/math/header-math \ - git libtool pkg-config - -Add additional Solaris packages: - -:: - - pkgadd -d http://get.opencsw.org/now - /opt/csw/bin/pkgutil -U - /opt/csw/bin/pkgutil -y -i texinfo - /opt/csw/bin/pkgutil -y -i perl - /opt/csw/bin/pkgutil -y -i libjson_c_dev - /opt/csw/bin/pkgutil -y -i python27 py_pip python27_dev - -Add libjson to Solaris equivalent of ld.so.conf - -:: - - crle -l /opt/csw/lib -u - -Add pytest: - -:: - - pip install "pytest<5" - -Install Sphinx::: - - pip install sphinx - -Select Python 2.7 as default (required for pytest) - -:: - - rm -f /usr/bin/python - ln -s /opt/csw/bin/python2.7 /usr/bin/python - -Fix PATH for all users and non-interactive sessions. Edit -``/etc/default/login`` and add the following default PATH: - -:: - - PATH=/usr/gnu/bin:/usr/bin:/usr/sbin:/sbin:/opt/csw/bin - -Edit ``~/.profile`` and add the following default PATH: - -:: - - PATH=/usr/gnu/bin:/usr/bin:/usr/sbin:/sbin:/opt/csw/bin - -.. include:: building-libyang.rst - -Get FRR, compile it and install it (from Git) ---------------------------------------------- - -**This assumes you want to build and install FRR from source and not -using any packages** - -Add frr group and user -^^^^^^^^^^^^^^^^^^^^^^ - -:: - - sudo groupadd -g 93 frr - sudo groupadd -g 94 frrvty - sudo useradd -g 93 -u 93 -G frrvty -c "FRR suite" \ - -d /nonexistent -s /bin/false frr - -(You may prefer different options on configure statement. These are just -an example) - -:: - - git clone https://github.com/frrouting/frr.git frr - cd frr - ./bootstrap.sh - export MAKE=gmake - export LDFLAGS="-L/opt/csw/lib" - export CPPFLAGS="-I/opt/csw/include" - export PKG_CONFIG_PATH=/opt/csw/lib/pkgconfig - ./configure \ - --sysconfdir=/etc/frr \ - --enable-exampledir=/usr/share/doc/frr/examples/ \ - --localstatedir=/var/run/frr \ - --sbindir=/usr/lib/frr \ - --enable-multipath=64 \ - --enable-user=frr \ - --enable-group=frr \ - --enable-vty-group=frrvty \ - --enable-configfile-mask=0640 \ - --enable-logfile-mask=0640 \ - --enable-fpm \ - --with-pkg-git-version \ - --with-pkg-extra-version=-MyOwnFRRVersion - gmake - gmake check - sudo gmake install - -Enable IP & IPv6 forwarding -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -:: - - routeadm -e ipv4-forwarding - routeadm -e ipv6-forwarding diff --git a/doc/developer/building.rst b/doc/developer/building.rst index fbe1f24d35..730741a8ef 100644 --- a/doc/developer/building.rst +++ b/doc/developer/building.rst @@ -20,7 +20,6 @@ Building FRR building-frr-for-freebsd9 building-frr-for-netbsd6 building-frr-for-netbsd7 - building-frr-for-omnios building-frr-for-openbsd6 building-frr-for-openwrt building-frr-for-ubuntu1404 diff --git a/doc/developer/subdir.am b/doc/developer/subdir.am index 03b4b5a3e2..57f885ecc1 100644 --- a/doc/developer/subdir.am +++ b/doc/developer/subdir.am @@ -16,7 +16,6 @@ dev_RSTFILES = \ doc/developer/building-frr-for-freebsd9.rst \ doc/developer/building-frr-for-netbsd6.rst \ doc/developer/building-frr-for-netbsd7.rst \ - doc/developer/building-frr-for-omnios.rst \ doc/developer/building-frr-for-openbsd6.rst \ doc/developer/building-frr-for-openwrt.rst \ doc/developer/building-frr-for-ubuntu1404.rst \ diff --git a/doc/user/basic.rst b/doc/user/basic.rst index 5b7786de18..e85e1842b3 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -159,8 +159,8 @@ Basic Config Commands use the ``log record-priority`` global configuration command. To disable this option, use the ``no`` form of the command. By default, the severity level is not included in logged messages. Note: some - versions of syslogd (including Solaris) can be configured to include - the facility and level in the messages emitted. + versions of syslogd can be configured to include the facility and + level in the messages emitted. .. index:: single: log timestamp precision (0-6) diff --git a/doc/user/overview.rst b/doc/user/overview.rst index 724d1d0b9c..07702cbdd1 100644 --- a/doc/user/overview.rst +++ b/doc/user/overview.rst @@ -139,7 +139,6 @@ of their original release (in case of GNU/Linux, this is since the kernel's release on https://kernel.org/) may need some work. Similarly, the following platforms may work with some effort: -- Solaris - MacOS Recent versions of the following compilers are well tested: @@ -148,6 +147,17 @@ Recent versions of the following compilers are well tested: - LLVM's Clang - Intel's ICC +.. _unsupported-platforms: + +UnSupported Platforms +--------------------- + +.. index:: UnSupported platforms + +In General if the platform you are attempting to use is not listed above then +FRR does not support being run on that platform. The only caveat here is that +version 7.5 and before Solaris was supported in a limited fashion. + .. _feature-matrix: Feature Matrix @@ -167,73 +177,73 @@ feature you're interested in, it should be supported on your platform. will look somewhat shoddy on other sphinx targets like PDF or info (but should still be readable.) -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| Daemon / Feature | Linux | OpenBSD | FreeBSD | NetBSD | Solaris | -+===================================+================+==============+============+============+============+ -| **FRR Core** | | | | | | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `zebra` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| VRF | :mark:`≥4.8` | :mark:`N` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| MPLS | :mark:`≥4.5` | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `pbrd` (Policy Routing) | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| **WAN / Carrier protocols** | | | | | | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `bgpd` (BGP) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| VRF / L3VPN | :mark:`≥4.8` | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | -| | :mark:`†4.3` | | | | | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| EVPN | :mark:`≥4.18` | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | -| | :mark:`†4.9` | | | | | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| VNC (Virtual Network Control) | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| Flowspec | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `ldpd` (LDP) | :mark:`≥4.5` | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| VPWS / PW | :mark:`N` | :mark:`≥5.8` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| VPLS | :mark:`N` | :mark:`≥5.8` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `nhrpd` (NHRP) | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| **Link-State Routing** | | | | | | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `ospfd` (OSPFv2) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| Segment Routing | :mark:`≥4.12` | :mark:`N` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `ospf6d` (OSPFv3) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `isisd` (IS-IS) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| **Distance-Vector Routing** | | | | | | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `ripd` (RIPv2) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `ripngd` (RIPng) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `babeld` (BABEL) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `eigrpd` (EIGRP) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| **Multicast Routing** | | | | | | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `pimd` (PIM) | :mark:`≥4.18` | :mark:`N` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| SSM (Source Specific) | :mark:`Y` | :mark:`N` | :mark:`Y` | :mark:`Y` | :mark:`Y` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| ASM (Any Source) | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| EVPN BUM Forwarding | :mark:`≥5.0` | :mark:`N` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ -| `vrrpd` (VRRP) | :mark:`≥5.1` | :mark:`N` | :mark:`N` | :mark:`N` | :mark:`N` | -+-----------------------------------+----------------+--------------+------------+------------+------------+ ++-----------------------------------+----------------+--------------+------------+------------+ +| Daemon / Feature | Linux | OpenBSD | FreeBSD | NetBSD | ++===================================+================+==============+============+============+ +| **FRR Core** | | | | | ++-----------------------------------+----------------+--------------+------------+------------+ +| `zebra` | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| VRF | :mark:`≥4.8` | :mark:`N` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| MPLS | :mark:`≥4.5` | :mark:`Y` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `pbrd` (Policy Routing) | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| **WAN / Carrier protocols** | | | | | ++-----------------------------------+----------------+--------------+------------+------------+ +| `bgpd` (BGP) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| VRF / L3VPN | :mark:`≥4.8` | :mark:`CP` | :mark:`CP` | :mark:`CP` | +| | :mark:`†4.3` | | | | ++-----------------------------------+----------------+--------------+------------+------------+ +| EVPN | :mark:`≥4.18` | :mark:`CP` | :mark:`CP` | :mark:`CP` | +| | :mark:`†4.9` | | | | ++-----------------------------------+----------------+--------------+------------+------------+ +| VNC (Virtual Network Control) | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | ++-----------------------------------+----------------+--------------+------------+------------+ +| Flowspec | :mark:`CP` | :mark:`CP` | :mark:`CP` | :mark:`CP` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `ldpd` (LDP) | :mark:`≥4.5` | :mark:`Y` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| VPWS / PW | :mark:`N` | :mark:`≥5.8` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| VPLS | :mark:`N` | :mark:`≥5.8` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `nhrpd` (NHRP) | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| **Link-State Routing** | | | | | ++-----------------------------------+----------------+--------------+------------+------------+ +| `ospfd` (OSPFv2) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| Segment Routing | :mark:`≥4.12` | :mark:`N` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `ospf6d` (OSPFv3) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `isisd` (IS-IS) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| **Distance-Vector Routing** | | | | | ++-----------------------------------+----------------+--------------+------------+------------+ +| `ripd` (RIPv2) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `ripngd` (RIPng) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `babeld` (BABEL) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `eigrpd` (EIGRP) | :mark:`Y` | :mark:`Y` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| **Multicast Routing** | | | | | ++-----------------------------------+----------------+--------------+------------+------------+ +| `pimd` (PIM) | :mark:`≥4.18` | :mark:`N` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| SSM (Source Specific) | :mark:`Y` | :mark:`N` | :mark:`Y` | :mark:`Y` | ++-----------------------------------+----------------+--------------+------------+------------+ +| ASM (Any Source) | :mark:`Y` | :mark:`N` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| EVPN BUM Forwarding | :mark:`≥5.0` | :mark:`N` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ +| `vrrpd` (VRRP) | :mark:`≥5.1` | :mark:`N` | :mark:`N` | :mark:`N` | ++-----------------------------------+----------------+--------------+------------+------------+ The indicators have the following semantics: diff --git a/doc/user/pim.rst b/doc/user/pim.rst index d30a5ed647..d5899ab455 100644 --- a/doc/user/pim.rst +++ b/doc/user/pim.rst @@ -15,7 +15,7 @@ network for optimizing forwarding of overlay BUM traffic. On Linux for PIM-SM operation you *must* have kernel version 4.18 or greater. To use PIM for EVPN BUM forwarding, kernels 5.0 or greater are required. - OpenBSD has no multicast support and FreeBSD, NetBSD and Solaris only + OpenBSD has no multicast support and FreeBSD, and NetBSD only have support for SSM. .. _starting-and-stopping-pimd: diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index a9ab162b40..98655e6cba 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -183,8 +183,8 @@ Standard Commands .. clicmd:: no link-detect Enable/disable link-detect on platforms which support this. Currently only - Linux and Solaris, and only where network interface drivers support - reporting link-state via the ``IFF_RUNNING`` flag. + Linux, and only where network interface drivers support reporting + link-state via the ``IFF_RUNNING`` flag. In FRR, link-detect is on by default. -- 2.39.5