Octopus Database

Last updated

To store environments, projects, variables, releases, and deployment history, Octopus Deploy uses a Microsoft SQL Server database.

Installing Octopus Server

Octopus Server requires access to an SQL Server to use for storing relational data. You can create the database ahead of time, or you can let the installer create the database on your behalf. Refer to SQL Server Database Requirements for more information on the SQL Server editions supported by Octopus Deploy and installation instructions.

Routine Maintenance

You are responsible for the routine maintenance of your Octopus database. Performance problems with your SQL Server will make Octopus run and feel slow and sluggish. You should implement a routine maintenance plan for your Octopus database. Here is a sure guide (free e-book) for maintaining SQL Server.

Database Backups

You are responsible for taking database backups and testing your disaster recovery plans. Refer to Backup and restore for more information about backing up Octopus Deploy and recovering from failure.

Schema

Octopus should be given its own database - the database should not be shared with any other applications. Octopus Server maintains its own schema - it will create the initial database schema upon installation, and it will update the schema when you upgrade Octopus Server.

The System Integrity Check at Configuration ➜ Diagnostics will let you know if the database schema has drifted from its intended state.

Modifying the Schema

If you customize the Octopus database it may cause problems when upgrading Octopus Server, and make your installation difficult to support. There are certain scenarios where you can modify the schema safely (indexes, statistics), and other scenarios which will cause Octopus Server to fail (tables, views, stored procedures, functions).

Index Recommendations

Each installation of Octopus Deploy will have different data and usage patterns. Some of our customers have huge environments and a few projects, others have many projects deploying to small environments. Some customers may create hundreds of releases each day, whilst others deploy releases every few days. As a result, the Database Engine Tuning Advisor, or hosted offerings like Azure SQL Database, may suggest performance optimizations like creating additional indexes.

Feel free to create database indexes which suit your scenario, but please understand the impact of modifying the schema.

We make certain assumptions about the database schema when you upgrade Octopus Server, and the presence (or absence) of indexes may cause your upgrade to fail. To enable custom indexes, the upgrade process will automatically remove any "additional indexes", and then provide you with a script to re-add those indexes again.

If you feel like an index would benefit everyone using Octopus, please contact our support team so we can consider making that index part of the standard database schema.

Azure SQL Database automatic index management
To ensure that you are aware of which Indexes exist so that you can drop/recreate them between upgrades, we suggest disabling the Azure SQL feature to automatically apply performance recommendations, and apply the recommendations manually instead.

In This Section

The rest of this section covers these topics in some more detail, and explains how to implement them.