diff --git a/Docs/Content/installation/upgrading.md b/Docs/Content/installation/upgrading.md new file mode 100644 index 0000000000..c3ab96f85d --- /dev/null +++ b/Docs/Content/installation/upgrading.md @@ -0,0 +1,22 @@ +````markdown +# Upgrading OneUptime + +This guide covers how to safely upgrade your self-hosted OneUptime installation. + +## General Guidance + +- Upgrade step-by-step across major versions (for example, 6 → 7 → 8). Do not skip major versions. +- You can leapfrog minor/patch versions (for example, 8.1 → 8.4) as long as you follow the release notes. +- Always take backups before upgrading, and validate you can restore them. + +## Upgrading from OneUptime 7 → 8 + +If you're running on Kubernetes, there are important breaking changes: + +- We no longer use Bitnami charts for Postgres, Redis, and ClickHouse. +- These changes are not backward compatible. You must follow the new structure in the Helm chart `values.yaml`. +- Backup your data (Postgres, ClickHouse, and any persistent volumes) before upgrading. + + +> Tip: Test the upgrade in a staging environment first. Confirm your workloads are healthy and data is intact before upgrading production. +```` \ No newline at end of file diff --git a/Docs/Utils/Nav.ts b/Docs/Utils/Nav.ts index f841dc0c55..e28fc7aa73 100644 --- a/Docs/Utils/Nav.ts +++ b/Docs/Utils/Nav.ts @@ -33,6 +33,10 @@ const DocsNav: NavGroup[] = [ title: "Docker Compose", url: "/docs/installation/docker-compose", }, + { + title: "Upgrading", + url: "/docs/installation/upgrading", + }, { title: "Kubernetes and Helm", url: "https://artifacthub.io/packages/helm/oneuptime/oneuptime", diff --git a/README.md b/README.md index 4f6690a575..82a1b6dddc 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ If you need advanced features, such as API Access, Advanced Workflows, or Advanc - [Install on Kubernetes with Helm](https://artifacthub.io/packages/helm/oneuptime/oneuptime) (recommended for production) - [Install with Docker Compose](/Docs/Content/installation/docker-compose.md) (single-node install, not recommended for production) - [Install for Local Development](/Docs/Content/installation/local-development.md) +- [Upgrade OneUptime](/Docs/Content/installation/upgrading.md) ## Philosophy