diff --git a/docs/install_guides/_includes/install-guide-rhel-derivatives.rst b/docs/install_guides/_includes/install-guide-rhel-derivatives.rst index 88d479072..8f64ce014 100644 --- a/docs/install_guides/_includes/install-guide-rhel-derivatives.rst +++ b/docs/install_guides/_includes/install-guide-rhel-derivatives.rst @@ -1,3 +1,5 @@ +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/_includes/supported-arch-aarch64+armv7l.rst b/docs/install_guides/_includes/supported-arch-aarch64+armv7l.rst new file mode 100644 index 000000000..5d325ae8d --- /dev/null +++ b/docs/install_guides/_includes/supported-arch-aarch64+armv7l.rst @@ -0,0 +1,2 @@ +| We support hosting Red on computers running an **aarch64** or **armv7l** version of this system. +| You can read more about systems and processor architectures we support in our `end-user-guarantees`. diff --git a/docs/install_guides/_includes/supported-arch-armv7l.rst b/docs/install_guides/_includes/supported-arch-armv7l.rst new file mode 100644 index 000000000..c32107df8 --- /dev/null +++ b/docs/install_guides/_includes/supported-arch-armv7l.rst @@ -0,0 +1,2 @@ +| We support hosting Red on computers running an **armv7l** version of this system. +| You can read more about systems and processor architectures we support in our `end-user-guarantees`. diff --git a/docs/install_guides/_includes/supported-arch-x64+aarch64+armv7l.rst b/docs/install_guides/_includes/supported-arch-x64+aarch64+armv7l.rst new file mode 100644 index 000000000..7bc24c31a --- /dev/null +++ b/docs/install_guides/_includes/supported-arch-x64+aarch64+armv7l.rst @@ -0,0 +1,2 @@ +| We support hosting Red on computers running an **x86-64**, **aarch64**, or **armv7l** version of this system. +| You can read more about systems and processor architectures we support in our `end-user-guarantees`. diff --git a/docs/install_guides/_includes/supported-arch-x64+aarch64.rst b/docs/install_guides/_includes/supported-arch-x64+aarch64.rst new file mode 100644 index 000000000..11f16b0d6 --- /dev/null +++ b/docs/install_guides/_includes/supported-arch-x64+aarch64.rst @@ -0,0 +1,2 @@ +| We support hosting Red on computers running an **x86-64** or **aarch64** version of this system. +| You can read more about systems and processor architectures we support in our `end-user-guarantees`. diff --git a/docs/install_guides/_includes/supported-arch-x64.rst b/docs/install_guides/_includes/supported-arch-x64.rst new file mode 100644 index 000000000..683d11a8d --- /dev/null +++ b/docs/install_guides/_includes/supported-arch-x64.rst @@ -0,0 +1,2 @@ +| We support hosting Red on computers running an **x86-64** version of this system. +| You can read more about systems and processor architectures we support in our `end-user-guarantees`. diff --git a/docs/install_guides/arch.rst b/docs/install_guides/arch.rst index fbc6fb221..f69adf257 100644 --- a/docs/install_guides/arch.rst +++ b/docs/install_guides/arch.rst @@ -4,6 +4,8 @@ Installing Red on Arch Linux ============================ +.. include:: _includes/supported-arch-x64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/centos-7.rst b/docs/install_guides/centos-7.rst index 3f78a5cc6..2ecc2012b 100644 --- a/docs/install_guides/centos-7.rst +++ b/docs/install_guides/centos-7.rst @@ -4,6 +4,8 @@ Installing Red on CentOS 7 ========================== +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/debian-10.rst b/docs/install_guides/debian-10.rst index a532841f9..d71d105c9 100644 --- a/docs/install_guides/debian-10.rst +++ b/docs/install_guides/debian-10.rst @@ -4,6 +4,8 @@ Installing Red on Debian 10 Buster ================================== +.. include:: _includes/supported-arch-x64+aarch64+armv7l.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/debian-11.rst b/docs/install_guides/debian-11.rst index 3450717a2..19488943a 100644 --- a/docs/install_guides/debian-11.rst +++ b/docs/install_guides/debian-11.rst @@ -4,6 +4,8 @@ Installing Red on Debian 11 Bullseye ==================================== +.. include:: _includes/supported-arch-x64+aarch64+armv7l.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/fedora.rst b/docs/install_guides/fedora.rst index 9358a62b3..958ce45be 100644 --- a/docs/install_guides/fedora.rst +++ b/docs/install_guides/fedora.rst @@ -4,6 +4,8 @@ Installing Red on Fedora Linux ============================== +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/mac.rst b/docs/install_guides/mac.rst index e5c49d075..4d0b69285 100644 --- a/docs/install_guides/mac.rst +++ b/docs/install_guides/mac.rst @@ -4,6 +4,8 @@ Installing Red on macOS ======================= +.. include:: _includes/supported-arch-x64+aarch64.rst + ------------------------------- Installing the pre-requirements ------------------------------- diff --git a/docs/install_guides/opensuse-leap-15.rst b/docs/install_guides/opensuse-leap-15.rst index 7aa681123..9970f7b33 100644 --- a/docs/install_guides/opensuse-leap-15.rst +++ b/docs/install_guides/opensuse-leap-15.rst @@ -4,6 +4,8 @@ Installing Red on openSUSE Leap 15.2+ ===================================== +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/opensuse-tumbleweed.rst b/docs/install_guides/opensuse-tumbleweed.rst index 018126ab7..588789360 100644 --- a/docs/install_guides/opensuse-tumbleweed.rst +++ b/docs/install_guides/opensuse-tumbleweed.rst @@ -4,6 +4,8 @@ Installing Red on openSUSE Tumbleweed ===================================== +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/raspberry-pi-os-10.rst b/docs/install_guides/raspberry-pi-os-10.rst index c1337fe76..5d28a4914 100644 --- a/docs/install_guides/raspberry-pi-os-10.rst +++ b/docs/install_guides/raspberry-pi-os-10.rst @@ -4,6 +4,8 @@ Installing Red on Raspberry Pi OS (Legacy) 10 Buster ==================================================== +.. include:: _includes/supported-arch-armv7l.rst + .. note:: While we do provide support and install instructions for running Red diff --git a/docs/install_guides/raspberry-pi-os-11.rst b/docs/install_guides/raspberry-pi-os-11.rst index 92f4eaac0..1882d2eb6 100644 --- a/docs/install_guides/raspberry-pi-os-11.rst +++ b/docs/install_guides/raspberry-pi-os-11.rst @@ -4,6 +4,8 @@ Installing Red on Raspberry Pi OS 11 Bullseye ============================================= +.. include:: _includes/supported-arch-aarch64+armv7l.rst + .. note:: This guide can only be used with Raspberry Pi OS 11 Bullseye, diff --git a/docs/install_guides/ubuntu-1804.rst b/docs/install_guides/ubuntu-1804.rst index 8edcb5582..9cd4d6016 100644 --- a/docs/install_guides/ubuntu-1804.rst +++ b/docs/install_guides/ubuntu-1804.rst @@ -4,6 +4,8 @@ Installing Red on Ubuntu 18.04 LTS ================================== +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/ubuntu-2004.rst b/docs/install_guides/ubuntu-2004.rst index 15d446a35..074973e61 100644 --- a/docs/install_guides/ubuntu-2004.rst +++ b/docs/install_guides/ubuntu-2004.rst @@ -4,6 +4,8 @@ Installing Red on Ubuntu 20.04 LTS ================================== +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/ubuntu-non-lts.rst b/docs/install_guides/ubuntu-non-lts.rst index 527f8583b..b12365279 100644 --- a/docs/install_guides/ubuntu-non-lts.rst +++ b/docs/install_guides/ubuntu-non-lts.rst @@ -4,6 +4,8 @@ Installing Red on Ubuntu non-LTS versions ========================================= +.. include:: _includes/supported-arch-x64+aarch64.rst + .. include:: _includes/linux-preamble.rst ------------------------------- diff --git a/docs/install_guides/windows.rst b/docs/install_guides/windows.rst index 9c3ad218d..cb2ed5035 100644 --- a/docs/install_guides/windows.rst +++ b/docs/install_guides/windows.rst @@ -4,6 +4,8 @@ Installing Red on Windows ========================= +.. include:: _includes/supported-arch-x64.rst + ------------------------------- Installing the pre-requirements ------------------------------- diff --git a/docs/version_guarantees.rst b/docs/version_guarantees.rst index f7e3b7505..e9bc30a7a 100644 --- a/docs/version_guarantees.rst +++ b/docs/version_guarantees.rst @@ -10,16 +10,19 @@ While this is very similar to SemVer, we have our own set of guarantees. Major versions are for project wide rewrites and are not expected in the foreseeable future. +.. _end-user-guarantees: + =================== End-user Guarantees =================== Red `provides support for wide variety of operating systems `. -Support for an entire operating system may only be dropped in a minor or major version bump. +Support for an entire operating system (including support for any single architecture on that system) +may only be dropped in a minor or major version bump. Red will continue to, at the very least, support current latest stable version of -each operating system that was supported by previous micro versions. +each operating system + architecture that were supported by previous micro versions. In addition to that, we strive (but do not guarantee) to provide support for all versions that are currently supported by operating system's developers per the table below. @@ -30,36 +33,49 @@ their end-of-life date. We recommend to always use the latest OS version supported by Red. -================================ ============================================================ -Operating system version Ideally supported until -================================ ============================================================ -Windows 10 `End/Retirement Date `__ -Windows 11 `Retirement Date `__ -macOS 10.15 (Catalina) ~2022-10 -macOS 11 (Big Sur) ~2023-10 -macOS 12 (Monterey) ~2024-10 -Alma Linux 8 2029-05-31 (`How long will CloudLinux support AlmaLinux? `__) -Arch Linux forever (support is only provided for an up-to-date system) -CentOS 7 2024-06-30 (`end of Maintenance Updates `__) -CentOS Stream 8 2024-05-31 (`end of Maintenance Updates `__) -CentOS Stream 9 2027-05-31 (`expected EOL `__) -Debian 10 Buster 2022-08-14 (`End of life `__) -Debian 11 Bullseye ~2024-09 (`End of life `__) -Fedora Linux 34 2022-05-17 (`End of Life `__) -Fedora Linux 35 ~2022-11 (`End of Life `__) -openSUSE Leap 15.2 2021-12-31 (`end of maintenance life cycle `__) -openSUSE Leap 15.3 2022-11-30 (`end of maintenance life cycle `__) -openSUSE Tumbleweed forever (support is only provided for an up-to-date system) -Oracle Linux 8 2029-07-31 (`End of Premier Support `__) -Raspberry Pi OS (Legacy) 10 2022-08-14 (`End of life for Debian 10 `__) -Raspberry Pi OS 11 ~2023-12 (approximate date of release of Raspberry Pi OS 12) -RHEL 8 (latest) 2029-05-31 (`End of Maintenance Support `__) -RHEL 8.4 2023-05-30 (`End of Extended Update Support `__) -Rocky Linux 8 2029-05-31 (`end-of-life `__) -Ubuntu 18.04 LTS 2023-04-30 (`End of Standard Support `__) -Ubuntu 20.04 LTS 2025-04-30 (`End of Standard Support `__) -Ubuntu 21.10 2022-07-31 (`End of Standard Support `__) -================================ ============================================================ +.. tip:: + + The meaning of architecture names: + + - **x86-64** (also known as amd64) refers to computers running a 64-bit version of the operating system + on standard Intel and AMD 64-bit processors. + - **aarch64** (also known as arm64) refers to computers running an ARM 64-bit version of the operating system + on 64-bit ARM processors (ARMv8-A and ARMv9-A) such as Apple M1 devices or Raspberry Pi computers + (Raspberry Pi 3B and above, excluding Pi Zero (W/WH) model). + - **armv7l** (also known as armhf) refers to computers running an ARMv7 version of the operating system + on 32-bit or 64-bit ARM processors (ARMv7-A, ARMv8-A, ARMv9-A) such as Raspberry Pi computers + (2B and above, excluding Pi Zero (W/WH) model). + +================================ ======================= ============================================================ +Operating system version Supported architectures Ideally supported until +================================ ======================= ============================================================ +Windows 10 x86-64 `End/Retirement Date `__ +Windows 11 x86-64 `Retirement Date `__ +macOS 10.15 (Catalina) x86-64 ~2022-10 +macOS 11 (Big Sur) x86-64, aarch64 ~2023-10 +macOS 12 (Monterey) x86-64, aarch64 ~2024-10 +Alma Linux 8 x86-64, aarch64 2029-05-31 (`How long will CloudLinux support AlmaLinux? `__) +Arch Linux x86-64 forever (support is only provided for an up-to-date system) +CentOS 7 x86-64, aarch64 2024-06-30 (`end of Maintenance Updates `__) +CentOS Stream 8 x86-64, aarch64 2024-05-31 (`end of Maintenance Updates `__) +CentOS Stream 9 x86-64, aarch64 2027-05-31 (`expected EOL `__) +Debian 10 Buster x86-64, aarch64, armv7l 2022-08-14 (`End of life `__) +Debian 11 Bullseye x86-64, aarch64, armv7l ~2024-09 (`End of life `__) +Fedora Linux 34 x86-64, aarch64 2022-05-17 (`End of Life `__) +Fedora Linux 35 x86-64, aarch64 ~2022-11 (`End of Life `__) +openSUSE Leap 15.2 x86-64, aarch64 2021-12-31 (`end of maintenance life cycle `__) +openSUSE Leap 15.3 x86-64, aarch64 2022-11-30 (`end of maintenance life cycle `__) +openSUSE Tumbleweed x86-64, aarch64 forever (support is only provided for an up-to-date system) +Oracle Linux 8 x86-64, aarch64 2029-07-31 (`End of Premier Support `__) +Raspberry Pi OS (Legacy) 10 armv7l 2022-08-14 (`End of life for Debian 10 `__) +Raspberry Pi OS 11 aarch64, armv7l ~2023-12 (approximate date of release of Raspberry Pi OS 12) +RHEL 8 (latest) x86-64, aarch64 2029-05-31 (`End of Maintenance Support `__) +RHEL 8.4 x86-64, aarch64 2023-05-30 (`End of Extended Update Support `__) +Rocky Linux 8 x86-64, aarch64 2029-05-31 (`end-of-life `__) +Ubuntu 18.04 LTS x86-64, aarch64 2023-04-30 (`End of Standard Support `__) +Ubuntu 20.04 LTS x86-64, aarch64 2025-04-30 (`End of Standard Support `__) +Ubuntu 21.10 x86-64, aarch64 2022-07-31 (`End of Standard Support `__) +================================ ======================= ============================================================ ==================== Developer Guarantees