diff --git a/docs/.custom_wordlist.txt b/docs/.custom_wordlist.txt index a65693a4..533f4115 100644 --- a/docs/.custom_wordlist.txt +++ b/docs/.custom_wordlist.txt @@ -28,6 +28,7 @@ autoremove Autoremovable amd backend +backported balancer backport Backport diff --git a/docs/explanation/landscape/self-hosted-landscape.md b/docs/explanation/landscape/self-hosted-landscape.md index 73e4d010..d8dc6215 100644 --- a/docs/explanation/landscape/self-hosted-landscape.md +++ b/docs/explanation/landscape/self-hosted-landscape.md @@ -1,86 +1,67 @@ --- myst: html_meta: - description: "Learn about self-hosted Landscape including release cycles, Ubuntu compatibility, LTS and latest stable PPAs, and installation options." + description: "About self-hosted Landscape: deployment options, supported versions, PPAs, system requirements, and network access." --- (explanation-about-self-hosted)= -# About Self-hosted Landscape +# About self-hosted Landscape -Self-hosted Landscape is the standalone edition of Landscape that you can install on premises or in a public cloud. +Self-hosted Landscape is the standalone edition of Landscape that you install and operate yourself, either on-premises or in a public cloud. -Feature enhancements are released in our scheduled release windows which occur twice per year, typically in April and October. Security patches and bug fixes will be provided outside of our scheduled release windows at the earliest possible opportunity. +Feature enhancements are released in scheduled release windows twice per year, typically in April and October. Security patches and bug fixes are provided outside of these windows at the earliest possible opportunity. -The following table applies to {ref}`Quickstart ` and {ref}`Manual ` installations of Landscape Server. +For a comparison of all Landscape editions, see {ref}`explanation-about-landscape`. -| **Major version** | **Release date** | **Standard Support** | **Expanded security maintenance (ESM)** | **Installs on Ubuntu LTS version** | -| ---------------------- | ---------------- | ------------------- | ------------------- | --------------------- | -| {ref}`reference-release-notes-24-04-lts` | 2024-Apr | **2029-Apr** | **2036-Apr** | 22.04 LTS or 24.04 LTS | -| {ref}`reference-release-notes-25-10` | 2025-Oct | **2026-Apr** | No ESM | 22.04 LTS or 24.04 LTS | -| {ref}`reference-release-notes-23-03` | 2023-Mar | **2025-Apr** | **2030-Apr** | 20.04 LTS or 22.04 LTS | +## Deployment options -The [Landscape Server charm](https://charmhub.io/landscape-server) typically follows the same release cycles, although there can be some differences. +We offer three installation options for self-hosted Landscape Server: -```{note} -For the most up-to-date information on what versions of Ubuntu the charms support, visit [Charmhub](https://charmhub.io/). -``` - -Landscape 23.03 manages all versions of Ubuntu 16.04 LTS (Xenial Xerus) onwards. Landscape 23.03 also manages two future Ubuntu releases, which includes the following interim release (Ubuntu 23.10) and LTS release (Ubuntu 24.04). +| Method | Use case | +|--------|----------| +| {ref}`Quickstart ` | Single-machine deployment, evaluation, or smaller environments. Not recommended for production at scale. | +| {ref}`Juju ` | Scalable, production-grade deployment with high availability. | +| {ref}`Manual ` | Scalable deployment without Juju. Suitable when a Juju environment is not available. | -Landscape 24.04 LTS manages the previous four Ubuntu LTS releases, from Ubuntu 16.04 LTS (Xenial Xerus) onwards. Landscape 24.04 LTS will also manage future Ubuntu releases, including Ubuntu 26.04 LTS, and interim releases Ubuntu 24.10, Ubuntu 25.04, and Ubuntu 25.10. +## Supported versions and release cycles -Compatibility beyond this range to older and newer versions of Ubuntu is on a best effort basis and is not guaranteed. +Landscape Server has the following active or ESM-supported releases: -```{note} -Landscape Client is available in the `main` repository in all Ubuntu releases, and is published independently of the self-hosted Landscape Server releases. For information on installing Landscape Client, see {ref}`how-to-install-landscape-client`. +```{include} ../../reference/_includes/landscape-versions-table.md ``` -## Landscape PPAs - -You can access self-hosted Landscape from one of our PPAs: - -- **Long Term Support (LTS)**: Our LTS PPA that comes with 10 years of support and aligns with the Ubuntu LTS release cadence. This is our most stable PPA and includes five point release updates after the initial release. These updates include bug fixes and security patches. We recommend using LTS versions for production deployments. New LTS releases are released every two years, usually in April of each even year, and the point releases are typically published in August and February of each year. -- **Latest Stable**: A stable rolling release for users who need access to the latest features. The latest stable PPA is suitable for production, but each version is only supported until the next latest stable release. Users on this PPA should always upgrade to the most recent release for continuous support. New latest stable versions are released every six months, usually around October and April. -- **Beta**: The newest beta features, mainly used for testing and development. You can explore the latest features here, but stability is not guaranteed. The beta PPA should not be used for production deployments. - -## Installation - -Self-hosted Landscape consists of two parts: +LTS versions are released every two years and are recommended for production deployments. Latest stable versions are released every six months; each is supported only until the next release. -- **Database server** -- **Application server** +The Landscape Server charm follows similar release cycles to the other installation methods, although the timing can vary slightly. For more details and the charm-specific Ubuntu compatibility, see the [Landscape Server charm page on Charmhub](https://charmhub.io/landscape-server). -Depending on your deployment method, these may exist on the same machine or different machines. Here is how you can get started: +For more information, see {ref}`reference-supported-versions-and-ppas`. -### Quickstart +## Package sources (PPAs) -- **{ref}`Quickstart installation `**, for when you don't have Juju but quickly want to check out self-hosted Landscape. Not recommended for production environments when having more than 500 clients. +Self-hosted Landscape is distributed via the following PPAs: -### Juju deployed - -- **{ref}`Juju installation `** for a truly scalable deployment. - -### Manual installation +```{include} ../../reference/_includes/landscape-ppas-table.md +``` -- **{ref}`Manual installation `**: for when you don't have a suitable Juju environment but need a scalable deployment. +## Ubuntu compatibility -## Installation requirements +Each Landscape Server release manages a specific range of Ubuntu versions, including selected older LTS releases and upcoming LTS and interim releases. Compatibility outside the documented range is on a best-effort basis and not guaranteed. -### System Requirements +For the version-by-version compatibility mapping, see {ref}`reference-supported-versions-and-ppas`. -The bare minimum compute power required to run Landscape is 4 GB of RAM and 20 GB of disk space. +Note that Landscape Client is available in the `main` repository for all Ubuntu releases and is published independently of Landscape Server. For information on installing Landscape Client, see {ref}`how-to-install-landscape-client`. -- The `landscape-server-quickstart` package requires 2 vCPUs or one dual core processor -- The Juju-based installation can be deployed on a single vCPU, but a minimum of 2 is recommended. +## System requirements -Our recommendation is to allocate 8 vCPUs or cores, 16GB RAM, and 512 GB of storage. When performing a manual or Juju based installation to address high availability requirements, each machine including the Juju controller should be allocated this many resources for the best outcome. If Landscape will be responsible for repository mirroring, it is advisable to mount an additional 2 TB of storage to the machine running the Landscape Server software. +Landscape Server runs on Ubuntu Server (amd64, arm64, s390x, or ppc64el). Supported Ubuntu versions are listed in {ref}`reference-supported-versions-and-ppas`. -One machine with these specifications will run the landscape-server-quickstart package. When using Juju or manually installing across multiple machines, none of the machines should be configured below these baseline compute power specifications. +```{include} ../../reference/_includes/landscape-sizing-table.md +``` -The operating system to run Landscape Server and its dependencies are Ubuntu Server 22.04 LTS or 24.04 LTS on amd64, arm64, s390x, or ppc64el CPU architectures. +In high-availability or other multi-node deployments (Juju or manual), apply the recommended allocation to each machine, including the Juju controller. (explanation-network-access)= -### Network access +## Network access Any client machines you manage with Landscape should be able to access your Landscape Server installation over network ports 80/TCP (HTTP) and 443/TCP (HTTPS). You can optionally open port 22/TCP (SSH) as well for maintenance of your Landscape Server. @@ -97,17 +78,3 @@ Your Landscape Server will also need the following external network access: - HTTPS access to `api.snapcraft.io`, `dashboard.snapcraft.io`, `login.ubuntu.com`, and `*.snapcraftcontent.com` if using or downloading snaps (e.g., `landscape-api`) If this external network access is unavailable, Canonical's professional services include assistance with setting up Landscape in a fully airgapped environment. - -## Unsupported Versions - -| **major version** | **Release date** | **Support expired on** | **Version of Ubuntu** | -| ---------------------- | ---------------- | ------------------------ | --------------------- | -| {ref}`reference-release-notes-25-04` | 2025-May | **2025-Oct** | 22.04 LTS or 24.04 LTS | -| {ref}`reference-release-notes-24-10` | 2024-Nov | **2025-Apr** | 22.04 LTS or 24.04 LTS | -| {ref}`reference-release-notes-23-10` | 2023-Oct | **2024-Apr** | 20.04 LTS or 22.04 LTS | -| {ref}`reference-release-notes-19-10` | 2019-Oct | **2023-May-31** | 18.04 LTS | -| {ref}`reference-release-notes-19-01` | 2019-Jan | **2020-Jan** | 18.04 LTS | -| {ref}`reference-release-notes-18-03` | 2018-Jun | **2019-Jun** | 16.04 LTS or 18.04 LTS | -| {ref}`reference-release-notes-17-03` | 2017-Mar | **2019-Mar** | 16.04 LTS | -| {ref}`reference-release-notes-16-06` | 2016-Jul | **2017-Dec** | 14.04 LTS or 16.04 LTS | -| {ref}`reference-release-notes-16-03` | 2016-Apr | **2017-Apr** | 14.04 LTS | diff --git a/docs/reference/_includes/landscape-ppas-table.md b/docs/reference/_includes/landscape-ppas-table.md new file mode 100644 index 00000000..0e53f609 --- /dev/null +++ b/docs/reference/_includes/landscape-ppas-table.md @@ -0,0 +1,5 @@ +| Release channel | PPA source to add | Support | Recommended for | +|-----------------|-------------------|---------|-----------------| +| LTS (versioned) | Pattern: `ppa:landscape/self-hosted-`
Example: `ppa:landscape/self-hosted-24.04` | 10 years; 5 point releases | Production | +| Latest stable | `ppa:landscape/landscape-latest-stable` | Until next release (~6 months) | Production (must stay current) | +| Beta | `ppa:landscape/landscape-beta` | None | Testing and development only | diff --git a/docs/reference/_includes/landscape-sizing-table.md b/docs/reference/_includes/landscape-sizing-table.md new file mode 100644 index 00000000..bcdfd055 --- /dev/null +++ b/docs/reference/_includes/landscape-sizing-table.md @@ -0,0 +1,14 @@ +**Recommended minimum (Quickstart/single-machine):** + +- **CPU:** 2 vCPUs (dual-core processor) +- **RAM:** 8 GB +- **Disk:** 20 GB + +**Recommended for production (per node):** + +- **CPU:** 8 vCPUs +- **RAM:** 16 GB +- **Disk:** 512 GB +- **Additional storage:** 2 TB or more if using repository mirroring + +Actual requirements depend on the number of managed clients, enabled features, and deployment method. These figures are starting points. You may need to adjust based on your environment. diff --git a/docs/reference/_includes/landscape-ubuntu-compatibility-table.md b/docs/reference/_includes/landscape-ubuntu-compatibility-table.md new file mode 100644 index 00000000..2ce34f7c --- /dev/null +++ b/docs/reference/_includes/landscape-ubuntu-compatibility-table.md @@ -0,0 +1,4 @@ +| Landscape Server version | Ubuntu versions managed | +|--------------------------|-------------------------| +| 24.04 LTS | 16.04 LTS and newer, including 24.10, 25.04, 25.10, and 26.04 LTS | +| 23.03 (ESM only) | 16.04 LTS and newer, including 23.10 and 24.04 LTS | diff --git a/docs/reference/_includes/landscape-versions-table.md b/docs/reference/_includes/landscape-versions-table.md new file mode 100644 index 00000000..353bc22e --- /dev/null +++ b/docs/reference/_includes/landscape-versions-table.md @@ -0,0 +1,5 @@ +| Version | Released | Standard support until | ESM until | Installs on Ubuntu | +|---------|----------|------------------------|-----------|---------------------| +| {ref}`reference-release-notes-24-04-lts` | 2024-Apr | 2029-Apr | 2036-Apr | 22.04 LTS or 24.04 LTS | +| {ref}`reference-release-notes-25-10` | 2025-Oct | 2026-Apr | — | 22.04 LTS or 24.04 LTS | +| {ref}`reference-release-notes-23-03` | 2023-Mar | 2025-Apr | 2030-Apr | 20.04 LTS or 22.04 LTS | diff --git a/docs/reference/index.md b/docs/reference/index.md index 1e3cf6b0..31577292 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -64,6 +64,17 @@ Definitions of key terms and concepts used in Landscape. terms/index ``` +## Supported versions and PPAs + +Version lifecycle, PPA locations, and Ubuntu compatibility for self-hosted Landscape. + +```{toctree} +:titlesonly: +:maxdepth: 1 + +supported-versions-and-ppas +``` + ## Other references Additional technical documentation and command-line tools. diff --git a/docs/reference/supported-versions-and-ppas.md b/docs/reference/supported-versions-and-ppas.md new file mode 100644 index 00000000..bf27ea39 --- /dev/null +++ b/docs/reference/supported-versions-and-ppas.md @@ -0,0 +1,53 @@ +--- +myst: + html_meta: + description: "Supported versions, lifecycle dates, and PPA details for self-hosted Landscape Server." +--- + +(reference-supported-versions-and-ppas)= +# Supported versions and PPAs + +This document is the reference for self-hosted Landscape Server version lifecycle and package sources. + +## Supported versions + +The following versions of Landscape Server are currently supported. This table applies to {ref}`Quickstart ` and {ref}`Manual ` installations. + +```{include} _includes/landscape-versions-table.md +``` + +**LTS releases** are published every two years, typically in April of even years. Five point releases follow, typically in February and August. Recommended for production. + +**Latest stable releases** are published every six months, typically in April and October. Support ends when the next release ships. Users must upgrade to maintain support. + +## PPAs + +```{include} _includes/landscape-ppas-table.md +``` + +## Ubuntu compatibility + +```{include} _includes/landscape-ubuntu-compatibility-table.md +``` + +Compatibility beyond the stated range is best-effort and not guaranteed. + +New Landscape features are typically not backported to Landscape Client packages in older Ubuntu releases. + +## Charm releases + +The [Landscape Server charm](https://charmhub.io/landscape-server) follows similar release cycles to the packages. Ubuntu compatibility for the charm may differ; always check [Charmhub](https://charmhub.io/) for current channel details. + +## Unsupported versions + +| Version | Released | Support ended | ESM until | Ubuntu | +|---------|----------|---------------|-----------|--------| +| {ref}`reference-release-notes-25-04` | 2025-May | 2025-Oct | — | 22.04 LTS or 24.04 LTS | +| {ref}`reference-release-notes-24-10` | 2024-Nov | 2025-Apr | — | 22.04 LTS or 24.04 LTS | +| {ref}`reference-release-notes-23-10` | 2023-Oct | 2024-Apr | — | 20.04 LTS or 22.04 LTS | +| {ref}`reference-release-notes-19-10` | 2019-Oct | 2023-May-31 | — | 18.04 LTS | +| {ref}`reference-release-notes-19-01` | 2019-Jan | 2020-Jan | — | 18.04 LTS | +| {ref}`reference-release-notes-18-03` | 2018-Jun | 2019-Jun | — | 16.04 LTS or 18.04 LTS | +| {ref}`reference-release-notes-17-03` | 2017-Mar | 2019-Mar | — | 16.04 LTS | +| {ref}`reference-release-notes-16-06` | 2016-Jul | 2017-Dec | — | 14.04 LTS or 16.04 LTS | +| {ref}`reference-release-notes-16-03` | 2016-Apr | 2017-Apr | — | 14.04 LTS |