Redgate’s SQL change automation is one of many database deployment tooling Octopus Deploy integrates with. This guide walks through configuring Octopus Deploy to leverage Redgate’s SQL change automation.
In addition to Octopus Deploy, the following items are required. This guide provides examples using Azure DevOps and TeamCity as the CI too, however, the core concepts are the same with all the tools.
- Redgate SQL Toolbelt:
- CI Tool (pick one):
- SQL Server Management Studio (SSMS):
- SQL Server (pick one):
Octopus Deploy preparation work
The following preparation needs to be completed prior to creating and configuring projects in Octopus Deploy:
- Configure a worker pool for Redgate SQL change automation to run on.
- Install a Tentacle on a Windows VM.
- Install the Redgate step template.
Configure a worker pool
This documentation assumes a Windows VM already has the Tentacle installed on it. This guide will start with the worker pool creation and how to register that Tentacle as a worker.
- To configure a worker pool in the Octopus Web portal, go to Infrastructure ➜ Worker Pools, and click Add Worker Pool.
- When the modal window appears, enter a name, and if you see the Static and Dynamic options, select Static as the worker pool type:
- Next, add the VM the Tentacle was installed on by clicking Add Worker.
- Select Windows and the Tentacle communication mode you plan to use. It is up to you on which communication mode the worker will use. There are pros and cons to each mode:
Install the Tentacle on a Windows server
Next, install the Tentacle on a Windows server. Aside from the latest version of .NET, no other software is required. The Redgate tooling will be automatically downloaded during the deployment.
The server needs to access the PowerShell gallery to download the Redgate tooling.
Use the Octopus Web Portal to register a Listening Tentacle. You will need to download the Tentacle onto the server and select Listening as the communication mode.
Follow the wizard. The thumbprint for the server for this form can be found on the add worker screen or in Configuration ➜ Thumbprint. This is the thumbprint of the server’s certificate. The server and the Tentacle will exchange the certificates to ensure a two-way trust is established.
The thumbprint in this screenshot is from a sample instance of Octopus Deploy. Your thumbprint will be different.
After the Tentacle is configured, enter in the IP address or the host name.
If you enter the host name of a private server, the Octopus Server will need to connect to your DNS server to find that host.
By default, the Listening Tentacle will listen on port
10933. If you configured a different port, enter the port on this form, and click Next.
The Octopus Server will attempt to connect to the Tentacle. The listening Tentacle will only accept a connection if it the server’s thumbprint matches. After the communication is successful, provide a display name for the worker. Depending on the screen this wizard was started from, the worker pool may or may not be pre-populated. Click Save to save the worker to the database.
The process to register Polling Tentacles as workers takes place in the Tentacle Manager on the server hosting the Tentacle. Select the polling Tentacle to get started with the wizard.
On the credentials screen enter a username and password or the API key of a user who has permissions to add worker pools. This account will only be used for registration.
The registration process will connect to the RESTful API of the Octopus Server. It will connect over port 80 or 443 using the http/https protocol. After registration the default port the Tentacle will connect to is port 10943.
After the credentials have been verified, select the worker option on the next screen.
Under the covers, there is nothing different between a worker and a target. They are both Tentacles. The difference is in how the Tentacle is registered with Octopus. The Octopus Server treats workers differently than targets.
Select the space, give the worker a display name, and select the worker pool.
Press Install to create the Tentacle and register it with the Octopus Server.
Install step templates
For this guide the following step templates will be used:
- Redgate - Create Database Release (Worker Friendly)
- Redgate - Deploy from Database Release (Worker Friendly)
To install the steps from the library, navigate to Library ➜ Step Templates and click Browse.
The list of categories is alphabetical. Find the Redgate category, and select the first template, Redgate - Create Database Release (Worker Friendly).
Repeat the same process for Redgate - Deploy Database Release (Worker Friendly).
The non-worker friendly version of these step templates are there for customers using a version of Octopus Deploy older than 2019.10.0. That version added the ability to provide a package variable in a step template.
A build server, such as Jenkins, TeamCity, Azure DevOps, Bamboo, Bitbucket Pipelines, CircleCI, or GitHub actions is required. A link to a number of build tools were provided at the start of this guide. The build server will take the database which was saved to source control and create a .NuGet package for Octopus Deploy to consume.
Octopus Deploy and Redgate provide a number of plugins for several build servers.
In Azure DevOps there are three steps to this process.
The first step builds the database package from source control. The plugin provided by Redgate offers multiple operations, but for this step, select Build a SQL Source Control project. The sub folder path is a relative path. It needs to be the same directory configured in SQL Source Control. Finally, configure the build number, we recommend specifying the build number using a SemVer versioning strategy.
The push package to Octopus step can be a little tricky. The folder where the package is saved is not very apparent in the previous step. In this example, the package was saved in
The full path for this example is:
The Octopus Server must be configured in Azure DevOps. The steps to do that are detailed in this documentation.
The last step is to create a release in Octopus Deploy and deploy it to dev using the plugin. Select the project from the drop-down list, and enter the same build number as the package. Expand the Deployment section and select an environment to deploy to. Clicking Show Deployment Progress will stop the build and force it to wait for Octopus to complete.
The TeamCity setup is very similar to the Azure DevOps. Only three steps are needed.
The first step is the build database package step. This step has similar options to Azure DevOps; provide the folder where the database is stored as well as the package version:
The package version only appears in the advanced options, and not setting it could result in
Invalid package version number errors:
The publish package step requires all three of the options to be populated. By default, the Redgate tool will create the NuGet package in the root working directory.
The final step is creating and deploying the release. Very similar to before, provide the name of the project, the release number and the environment to deploy to:
Create and configure the Octopus Deploy project
This guide will follow the manual approvals process.
The deployment process will be:
- Create delta script using Redgate’s tooling.
- In Staging and Production notify DBAs of pending script.
- In Staging and Production pause for manual approval of delta script.
- Run delta script using Redgate’s tooling.
- Notify the team of the deployment status.
- On failure, page the DBAs.
In Octopus Deploy, that process will look like the following screenshot. This example uses Slack as the notification technology. Octopus Deploy supports a number of different mechanisms to notify users, including email, Slack, Microsoft Teams, and Twilio to name a few.
Before adding steps to the process, a number of variables need to be created. We recommend namespacing the variables using [ProjectName].[Component].[Sub-component].
- Project.Database.Name: The name of the database on the SQL Server to deploy to.
- Project.Database.Password: The password of the user account who has permissions to deploy. This is not required if you’re using integrated security.
- Project.Database.Server: The SQL Server name or IP address to deploy to.
- Project.Database.UserName: The username of the user account who has permissions to deploy. This is not required if you’re using integrated security.
- Project.Redgate.ExportPath: Where the tooling will create and export the database release to. Because this process uses workers, you need to save the files to a file share (or have one worker).
The first step in the deployment process, Redgate - Create Database Release will compare what is in the NuGet package and generate a delta script. Only the highlighted parameters are required.
Configuring the notification step is dependent on the choice of technology. That isn’t covered for the guide. For the manual intervention step, provide instructions, as well as the teams allowed to approve this release.
The choice of two teams in this example was intentional. The DBAs are the ones who should approve it. The Octopus Manager team is there in the event of an emergency and the Octopus Manager needs to fix it.
The final step for this guide is Redgate - Deploy Database Release. It takes the delta script created in the first step and runs it on the specified server. The number of options on this step are limited compared to the create release step.
An example of this process has been configured on the Octopus samples instance.
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Sunday, January 1, 2023