From 057a6aa72bca6069cc4b0b1c40d08a6d9c8ce8d8 Mon Sep 17 00:00:00 2001 From: Michael Richardson Date: Thu, 7 May 2026 15:24:02 +1000 Subject: [PATCH 1/6] Explicit support for SQL Server on Linux --- src/pages/docs/installation/requirements.mdx | 2 ++ .../docs/installation/sql-database/index.mdx | 17 ----------- .../installation/sql.include.md | 30 +++++++++++++++---- 3 files changed, 26 insertions(+), 23 deletions(-) diff --git a/src/pages/docs/installation/requirements.mdx b/src/pages/docs/installation/requirements.mdx index 4c9f5bf4d4..f14e2cb289 100644 --- a/src/pages/docs/installation/requirements.mdx +++ b/src/pages/docs/installation/requirements.mdx @@ -53,6 +53,8 @@ Requirements for the [Octopus Server Linux Container](/docs/installation/octopus You can also run the Octopus Server Linux Container using a platform such as [AWS ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html). +## SQL Server Database + ### Hypervisors diff --git a/src/pages/docs/installation/sql-database/index.mdx b/src/pages/docs/installation/sql-database/index.mdx index 779b191983..a64913f67a 100644 --- a/src/pages/docs/installation/sql-database/index.mdx +++ b/src/pages/docs/installation/sql-database/index.mdx @@ -11,29 +11,12 @@ hideInThisSection: true --- import Sql from 'src/shared-content/installation/sql.include.md'; -Octopus Deploy stores projects, environments, and deployment history in a Microsoft SQL Server Database. - ## Using SQL Server Express \{#SQLServerDatabaseRequirements-UsingSQLServerExpress} The easiest and cheapest way to get started is with [SQL Server Express](https://oc.to/downloadsqlserverexpress) and install the Octopus Server and SQL Server Express side-by-side on your server. This is a great way to test Octopus for a proof of concept. Depending on your needs, you might decide to use SQL Server Express, or upgrade to another supported edition. -## Configuration Guidelines - -The SQL Database Octopus Deploy uses can be hosted on a local SQL Server, or one of the many cloud providers. The requirements are: - -- Must be running SQL Server 2016+ or Azure SQL -- Be located in the same data center as the servers/container hosts that host Octopus Deploy. - -This section provides configuration walkthroughs for the popular storage options our customers use. - -- [Self-Managed SQL Server](/docs/installation/sql-database/self-managed-sql-server) -- [AWS RDS](/docs/installation/sql-database/aws-rds) -- [Azure SQL](/docs/installation/sql-database/azure-sql) -- [GCP SQL](/docs/installation/sql-database/gcp-cloud-sql) - - ## Database administration and maintenance For more information about maintaining your Octopus database, please read our [database administrators guide](/docs/administration/data/octopus-database). diff --git a/src/shared-content/installation/sql.include.md b/src/shared-content/installation/sql.include.md index 5dc01ecf37..8a9545edc9 100644 --- a/src/shared-content/installation/sql.include.md +++ b/src/shared-content/installation/sql.include.md @@ -1,17 +1,26 @@ ## SQL Server Database +Octopus Deploy requires a Microsoft SQL Server database to store configuration and history. + Octopus works with a wide range of versions and editions of SQL Server, from a local SQL Server Express instance, all the way to an Enterprise Edition [SQL Server Failover Cluster](https://docs.microsoft.com/en-us/sql/sql-server/failover-clusters/high-availability-solutions-sql-server) or [SQL Server AlwaysOn Availability Group](https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/overview-of-always-on-availability-groups-sql-server), or even one of the hosted database-as-a-service offerings. Octopus supports versions of SQL Server that have at least 2 years of active support remaining from Microsoft. Versions approaching or past end-of-support are not supported. -### Legacy release requirements +### SQL Server Hosting Options -The following table outlines the minimum SQL Server version required by older Octopus Server releases. +SQL Server can be hosted on [Linux](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-overview) (including in a [container](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-docker-container-deployment)), [Windows](https://learn.microsoft.com/en-us/sql/database-engine/install-windows/install-sql-server), or in one of many managed offerings from Cloud Providers. -| Octopus Server | Minimum SQL Server version | Azure SQL | -| -------------- | ----------------------------------- |---------- | -| 2020.2.x | SQL Server 2016+ | Supported | -| 3.0 ➜ 2019.13 | SQL Server 2008+ | Supported | +The requirements are: + +- Must be running SQL Server 2016+ or Azure SQL +- Be located in the same data center as the servers/container hosts that host Octopus Deploy. + +Below are some configuration guidelines for various options: + +- [Self-managed on Linux or Windows](/docs/installation/sql-database/self-managed-sql-server) +- [AWS RDS](/docs/installation/sql-database/aws-rds) +- [Azure SQL](/docs/installation/sql-database/azure-sql) +- [GCP SQL](/docs/installation/sql-database/gcp-cloud-sql) Supported editions: @@ -26,3 +35,12 @@ Supported editions: :::div{.warning} **Warning:** Octopus does not support database mirroring or SQL Server replication. Having these features turned on may cause errors during configuration. [More information](/docs/administration/data#high-availability). ::: + +### Legacy Octopus version requirements + +The following table outlines the minimum SQL Server version required by older Octopus Server releases. + +| Octopus Server | Minimum SQL Server version | Azure SQL | +| -------------- | ----------------------------------- |---------- | +| 2020.2.x ➜ latest | SQL Server 2016+ | Supported | +| 3.0 ➜ 2019.13 | SQL Server 2008+ | Supported | \ No newline at end of file From 8d0e31abad024ec5f2322e8f0d3e0f93971e3e67 Mon Sep 17 00:00:00 2001 From: Michael Richardson Date: Thu, 7 May 2026 16:20:48 +1000 Subject: [PATCH 2/6] markdown linting fixes --- src/pages/docs/installation/sql-database/index.mdx | 2 +- src/shared-content/installation/sql.include.md | 10 ++++------ 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/src/pages/docs/installation/sql-database/index.mdx b/src/pages/docs/installation/sql-database/index.mdx index a64913f67a..b15df83d5b 100644 --- a/src/pages/docs/installation/sql-database/index.mdx +++ b/src/pages/docs/installation/sql-database/index.mdx @@ -23,4 +23,4 @@ For more information about maintaining your Octopus database, please read our [d ## Learn more - - [Octopus installation](/docs/installation) \ No newline at end of file +- [Octopus installation](/docs/installation) \ No newline at end of file diff --git a/src/shared-content/installation/sql.include.md b/src/shared-content/installation/sql.include.md index 8a9545edc9..5fbe244075 100644 --- a/src/shared-content/installation/sql.include.md +++ b/src/shared-content/installation/sql.include.md @@ -1,5 +1,3 @@ -## SQL Server Database - Octopus Deploy requires a Microsoft SQL Server database to store configuration and history. Octopus works with a wide range of versions and editions of SQL Server, from a local SQL Server Express instance, all the way to an Enterprise Edition [SQL Server Failover Cluster](https://docs.microsoft.com/en-us/sql/sql-server/failover-clusters/high-availability-solutions-sql-server) or [SQL Server AlwaysOn Availability Group](https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/overview-of-always-on-availability-groups-sql-server), or even one of the hosted database-as-a-service offerings. @@ -8,16 +6,16 @@ Octopus supports versions of SQL Server that have at least 2 years of active sup ### SQL Server Hosting Options -SQL Server can be hosted on [Linux](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-overview) (including in a [container](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-docker-container-deployment)), [Windows](https://learn.microsoft.com/en-us/sql/database-engine/install-windows/install-sql-server), or in one of many managed offerings from Cloud Providers. +SQL Server can be hosted on [Linux](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-overview) (including in a [container](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-docker-container-deployment)), [Windows](https://learn.microsoft.com/en-us/sql/database-engine/install-windows/install-sql-server), or in one of many managed offerings from Cloud Providers. -The requirements are: +The requirements are: - Must be running SQL Server 2016+ or Azure SQL - Be located in the same data center as the servers/container hosts that host Octopus Deploy. -Below are some configuration guidelines for various options: +Below are some configuration guidelines for various options: -- [Self-managed on Linux or Windows](/docs/installation/sql-database/self-managed-sql-server) +- [Self-managed on Linux or Windows](/docs/installation/sql-database/self-managed-sql-server) - [AWS RDS](/docs/installation/sql-database/aws-rds) - [Azure SQL](/docs/installation/sql-database/azure-sql) - [GCP SQL](/docs/installation/sql-database/gcp-cloud-sql) From 4d2abd63d56e90336e527f9bf2d4db2bc129ba4e Mon Sep 17 00:00:00 2001 From: Michael Richardson Date: Thu, 7 May 2026 16:32:52 +1000 Subject: [PATCH 3/6] Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- src/pages/docs/installation/sql-database/index.mdx | 2 ++ src/shared-content/installation/sql.include.md | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/installation/sql-database/index.mdx b/src/pages/docs/installation/sql-database/index.mdx index b15df83d5b..a2b0a55534 100644 --- a/src/pages/docs/installation/sql-database/index.mdx +++ b/src/pages/docs/installation/sql-database/index.mdx @@ -11,6 +11,8 @@ hideInThisSection: true --- import Sql from 'src/shared-content/installation/sql.include.md'; +## SQL Database requirements + ## Using SQL Server Express \{#SQLServerDatabaseRequirements-UsingSQLServerExpress} diff --git a/src/shared-content/installation/sql.include.md b/src/shared-content/installation/sql.include.md index 5fbe244075..0467450818 100644 --- a/src/shared-content/installation/sql.include.md +++ b/src/shared-content/installation/sql.include.md @@ -4,14 +4,14 @@ Octopus works with a wide range of versions and editions of SQL Server, from a l Octopus supports versions of SQL Server that have at least 2 years of active support remaining from Microsoft. Versions approaching or past end-of-support are not supported. -### SQL Server Hosting Options +### SQL Server Hosting Options SQL Server can be hosted on [Linux](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-overview) (including in a [container](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-docker-container-deployment)), [Windows](https://learn.microsoft.com/en-us/sql/database-engine/install-windows/install-sql-server), or in one of many managed offerings from Cloud Providers. The requirements are: - Must be running SQL Server 2016+ or Azure SQL -- Be located in the same data center as the servers/container hosts that host Octopus Deploy. +- Must be located in the same data center as the servers/container hosts that host Octopus Deploy. Below are some configuration guidelines for various options: From c99cdadc6276123448357f9c940baf3182425f9f Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Thu, 7 May 2026 07:34:45 +0100 Subject: [PATCH 4/6] Lint fixes --- src/pages/docs/installation/sql-database/index.mdx | 2 +- src/shared-content/installation/sql.include.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/pages/docs/installation/sql-database/index.mdx b/src/pages/docs/installation/sql-database/index.mdx index a2b0a55534..ff232ea34b 100644 --- a/src/pages/docs/installation/sql-database/index.mdx +++ b/src/pages/docs/installation/sql-database/index.mdx @@ -25,4 +25,4 @@ For more information about maintaining your Octopus database, please read our [d ## Learn more -- [Octopus installation](/docs/installation) \ No newline at end of file +- [Octopus installation](/docs/installation) diff --git a/src/shared-content/installation/sql.include.md b/src/shared-content/installation/sql.include.md index 0467450818..cb7f248ef5 100644 --- a/src/shared-content/installation/sql.include.md +++ b/src/shared-content/installation/sql.include.md @@ -38,7 +38,7 @@ Supported editions: The following table outlines the minimum SQL Server version required by older Octopus Server releases. -| Octopus Server | Minimum SQL Server version | Azure SQL | -| -------------- | ----------------------------------- |---------- | -| 2020.2.x ➜ latest | SQL Server 2016+ | Supported | -| 3.0 ➜ 2019.13 | SQL Server 2008+ | Supported | \ No newline at end of file +| Octopus Server | Minimum SQL Server version | Azure SQL | +| ----------------- | -------------------------- | --------- | +| 2020.2.x ➜ latest | SQL Server 2016+ | Supported | +| 3.0 ➜ 2019.13 | SQL Server 2008+ | Supported | From 779df68371977ce60ee6863ed7a1e6b4489acf4a Mon Sep 17 00:00:00 2001 From: Michael Richardson Date: Thu, 7 May 2026 16:39:24 +1000 Subject: [PATCH 5/6] moved h3 section under correct h2 --- src/pages/docs/installation/requirements.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/pages/docs/installation/requirements.mdx b/src/pages/docs/installation/requirements.mdx index f14e2cb289..8a2a60d7bc 100644 --- a/src/pages/docs/installation/requirements.mdx +++ b/src/pages/docs/installation/requirements.mdx @@ -53,10 +53,6 @@ Requirements for the [Octopus Server Linux Container](/docs/installation/octopus You can also run the Octopus Server Linux Container using a platform such as [AWS ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/Welcome.html). -## SQL Server Database - - - ### Hypervisors Windows Server can be installed on a bare-metal machine or on a virtual machine (VM) hosted by any popular type-1 hypervisor or virtual private server (cloud) technology. Type-2 hypervisors can work for demos and POCs, but because they are typically installed on desktop operating systems, aren't recommended. @@ -87,6 +83,10 @@ The list of hypervisors and virtual private servers include (but not limited to) Most, if not all, of those tools include documentation or pre-built images for Windows Server 2012 R2, 2016 and 2019. Please refer to their documentation on how to install and configure a Windows Server VM. +## SQL Server Database + + + ## .NET \{#dotnet-requirements} Octopus Server is a .NET application distributed as a [self-contained deployment](https://docs.microsoft.com/en-us/dotnet/core/deploying/#publish-self-contained) that has all the components required to run, including the .NET runtime. Older versions of Octopus Server require the .NET Framework: From 161b6b94c98857b850ab6b84c996c7f72b8af2ad Mon Sep 17 00:00:00 2001 From: Michael Richardson Date: Thu, 7 May 2026 16:57:11 +1000 Subject: [PATCH 6/6] Update casing based on review Co-authored-by: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> --- src/shared-content/installation/sql.include.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/shared-content/installation/sql.include.md b/src/shared-content/installation/sql.include.md index cb7f248ef5..1ac494d0e9 100644 --- a/src/shared-content/installation/sql.include.md +++ b/src/shared-content/installation/sql.include.md @@ -4,7 +4,7 @@ Octopus works with a wide range of versions and editions of SQL Server, from a l Octopus supports versions of SQL Server that have at least 2 years of active support remaining from Microsoft. Versions approaching or past end-of-support are not supported. -### SQL Server Hosting Options +### SQL Server hosting options SQL Server can be hosted on [Linux](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-overview) (including in a [container](https://learn.microsoft.com/en-us/sql/linux/sql-server-linux-docker-container-deployment)), [Windows](https://learn.microsoft.com/en-us/sql/database-engine/install-windows/install-sql-server), or in one of many managed offerings from Cloud Providers.