diff --git a/src/pages/docs/installation/requirements.mdx b/src/pages/docs/installation/requirements.mdx index 4c9f5bf4d4..8a2a60d7bc 100644 --- a/src/pages/docs/installation/requirements.mdx +++ b/src/pages/docs/installation/requirements.mdx @@ -53,8 +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). - - ### 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. @@ -85,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: diff --git a/src/pages/docs/installation/sql-database/index.mdx b/src/pages/docs/installation/sql-database/index.mdx index 779b191983..ff232ea34b 100644 --- a/src/pages/docs/installation/sql-database/index.mdx +++ b/src/pages/docs/installation/sql-database/index.mdx @@ -11,7 +11,7 @@ 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. +## SQL Database requirements @@ -19,25 +19,10 @@ Octopus Deploy stores projects, environments, and deployment history in a Micros 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). ## 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 5dc01ecf37..1ac494d0e9 100644 --- a/src/shared-content/installation/sql.include.md +++ b/src/shared-content/installation/sql.include.md @@ -1,17 +1,24 @@ -## 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. + +The requirements are: + +- Must be running SQL Server 2016+ or Azure SQL +- 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: -| Octopus Server | Minimum SQL Server version | Azure SQL | -| -------------- | ----------------------------------- |---------- | -| 2020.2.x | SQL Server 2016+ | Supported | -| 3.0 ➜ 2019.13 | SQL Server 2008+ | Supported | +- [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 +33,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 |