ReadyRoll - Deploy Database Package

Octopus.TentaclePackage exported 11/15/2023 by harrisonmeister belongs to 'ReadyRoll' category.

Deploy database changes packaged with Redgate's ReadyRoll. Requires the Microsoft SQL Command Line Utilities 11 or later to be installed on the tentacle.

Version date: 14th January, 2016

Parameters

When steps based on the template are included in a project's deployment process, the parameters below can be set.

Package to deploy

PackageName

The package you want to deploy. If using NuGet, this matches the package ID from the NuSpec file in your ReadyRoll project.

Target SQL Server instance

DatabaseServer

The fully qualified SQL Server instance name for the target database.

Target database name

DatabaseName

The name of the database to deploy to. ReadyRoll will create a new database if it does not exist.

Use Windows Authentication

UseWindowsAuth = True

If you check this field, Windows authentication will be used to connect, using the account that runs the Tentacle service. Otherwise, SQL Server authentication will be used and you will need to specify a username and password below.

Username

DatabaseUsername

The SQL Server username used to connect to the database.

Password

DatabasePassword

The SQL Server password used to connect to the database.

To use this template in Octopus Deploy, copy the JSON below and paste it into the Library → Step templates → Import dialog.

Show JSON
{
  "Id": "14e87c33-b34a-429f-be2c-e44d3d631649",
  "Name": "ReadyRoll - Deploy Database Package",
  "Description": "Deploy database changes packaged with Redgate's [ReadyRoll](http://www.ready-roll.com/). Requires the Microsoft SQL Command Line Utilities 11 or later to be installed on the tentacle.\n\n*Version date: 14th January, 2016*",
  "Version": 3,
  "ExportedAt": "2023-11-15T14:12:59.832Z",
  "ActionType": "Octopus.TentaclePackage",
  "Author": "harrisonmeister",
  "Packages": [
    {
      "Id": "536b0ad2-6439-4e6a-aff0-64ba07a33733",
      "Name": "",
      "PackageId": null,
      "FeedId": null,
      "AcquisitionLocation": "Server",
      "Properties": {
        "SelectionMode": "deferred",
        "PackageParameterName": "PackageName"
      }
    }
  ],
  "Parameters": [
    {
      "Id": "43af2bc5-668d-482f-a23b-1e46189fcd69",
      "Name": "PackageName",
      "Label": "Package to deploy",
      "HelpText": "The package you want to deploy. If using NuGet, this matches the package ID from the NuSpec file in your ReadyRoll project.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Package"
      }
    },
    {
      "Id": "c7d2a8f5-0b33-4b1d-94cd-0f0f11ecf9d1",
      "Name": "DatabaseServer",
      "Label": "Target SQL Server instance",
      "HelpText": "The fully qualified SQL Server instance name for the target database.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "a0c8e52f-e7f2-4859-9769-f749f6705a08",
      "Name": "DatabaseName",
      "Label": "Target database name",
      "HelpText": "The name of the database to deploy to. ReadyRoll will create a new database if it does not exist.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "8c448c0e-27c8-4572-8a96-0e9dad5c8091",
      "Name": "UseWindowsAuth",
      "Label": "Use Windows Authentication",
      "HelpText": "If you check this field, Windows authentication will be used to connect, using the account that runs the Tentacle service. Otherwise, SQL Server authentication will be used and you will need to specify a username and password below.",
      "DefaultValue": "True",
      "DisplaySettings": {
        "Octopus.ControlType": "Checkbox"
      }
    },
    {
      "Id": "53358be8-b6fb-4dce-b107-a501c5ef5b1e",
      "Name": "DatabaseUsername",
      "Label": "Username",
      "HelpText": "The SQL Server username used to connect to the database.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "SingleLineText"
      }
    },
    {
      "Id": "60688c6e-db91-4a6f-971f-e52901d7b732",
      "Name": "DatabasePassword",
      "Label": "Password",
      "HelpText": "The SQL Server password used to connect to the database.",
      "DefaultValue": "",
      "DisplaySettings": {
        "Octopus.ControlType": "Sensitive"
      }
    }
  ],
  "Properties": {
    "Octopus.Action.Package.DownloadOnTentacle": "False"
  },
  "Category": "ReadyRoll",
  "HistoryUrl": "https://github.com/OctopusDeploy/Library/commits/master/step-templates/readyroll-deploy-database-package.json",
  "Website": "/step-templates/14e87c33-b34a-429f-be2c-e44d3d631649",
  "Logo": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAMAAACahl6sAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAD9QTFRF99LS4V9e76mp2C8uzgAA////65ST++rq/fT00xcW0AkI/vn5/vz888C/20FB5np50RAP1CAg+d/f/PDv/vf3Ssim1wAABgRJREFUeNrsnWmTmzAMhn0Qg41v+P+/tUCmnZgYcwSM6Uj9sNvZWeBZ+ZD0Khi9/hNDAAIgAAIgAAIgAAIgAAIgAAIgAAIgAAIgAAIgAPK2tkZIKULYYIaZwYYvgxFCFEJ1Uz5IgxQzWGtKnePcWiEqUU02fCOs5c45SrXGhhFUlwciOz8QYO2qXcY1HnhQ3ZYB4hUxuxk+aOjgHuXbm0EQw9RZUf1m1lHNVHsTSIMIdtWJZjFTtcwM0o6uqE43js1RxxwDIZja6hKzTpMuE4hUurrUOOuvB2k9uxhjNGpQey1InQNjNGeQvBBEaVtlMkHZZSCdyYYxGfYXgXidlaNyCkAABEAABEAAZHnvHvL3MX03hjFjIuH0E0D4WH9QyjdStvIlh7DKM/c0EKENQb77igmVfRAIp1iNZSAZC22JeAqIG/IMKTdfv1QQaki6xtiaJ4Botp70MVE6iMNkyw2YLRtkwNhUt5ZlDy2BVXPs+kWBWL35DnOHFAVC2WbxoJ1vIyWB4O3lqdrwYkMUTdoVYctPytaoa2FRbPQrcPLab22L8uLDeMsSVSlkNHWrqkoRIFQtxFQdIvifslg8iNALlduamO3iUAEg2Ec5OpacE8WBcBPD6JHhO0Obm0FcVHJCZrdUdzMIj23mrcL7pd+bQVjEH94c0X9vBbFMRmSuYzL2nSDcdOdpp3eCfHO8mBPPA8HzcSU9fmLJVH/tgz9J8reBfMdX6qdmlbtA7Py+PePVA0GEmc8P9mPz0E0ger6hb/SHcE7raOPaPSDzakmzymGdxkz9Tb8QtmWAELnPHxQz1IXkJVRRhJ7VGRRPV7uI79dq2LeAUDQLS1yqXcbUpVYaBWs3D0K9WJVo7q/90tmfeDkusSbRGXu/rDCL3dViO5RLllBvlxVmM10tJbUWJ/su5d0esaGKg7RYcke6f7TGN8+RcE9vzBLHWkvvfETmBqGhQ4g92Njn6b37iAizwoYucayU5r9Tl8wgs9uxBY7l1Up23qtYn31mEBxej8Ylhmj3fu8Vw1QUEsYHV+jjM13H5kdDTLqNOC8IlesOoT6GsfrhmawggiWF2WgAM8kLGyrBWUHCsLfm0aL2946Bt/R0ZwUJgw62ITIeixLbkvmcIDZIDGsaXXjDBUuirbWunCDhyCKRkSXmd1CbdZKcIPgzYW1iGojpQ4egMjVElgyWxoeZ5cB+h26VEyQcWSISiDUH9dS8IE6uJLjzZ9klwGUECWWEyOjH4dJLdkklGUFYsKxGnsX/UpzPBxLW3yO7oZZhKisKBQl3kcg8Zptyx/tBguw1srCGoO3ejoGMIH16AoSBGClWHxFBXY7ZtPTTa1EqSFjPMisPsl9PzAYSFKo6nE6oWiPKBfn85VqnVfd6v1CdDYR+ZhqRRSto20K8XBDdpcPzzynU7l6zcoK0aa0t6Gs0JYMEi9L3g3Qr+34xIHgFJAi06FNAvueACH5ZPBeEB79ccguHSYO4oEJaNIhMgtAgF3mKR+SjQcAj4BHwCHgEPAIeAY+AR8Aj4BHwCHgEPAIeAY+AR8Aj4JEHggS1X5YumZYMEn6uKtIa9Nnh5Ev2iPuQpNqI+EySU6iohoE2pfN8Nj40uGSQjzv5WFuD/QcqiS0apOJkUqj7hU97CzN9Lrz1x95BnbXvFzNC2PKrKfT046OvfMva5C84T/65V35cDsiFBiAAAiAAAiCTdVhkBdHoIhBZs4wkYuH9byeAvOTLn3tQUiIg0DtPHdp9tI264rSkr9mB2cVH24wzBbGLUbhR+8+BO3L8U4fMhQOMY+UPPNShc6zkNML4+RDWYdK/DtnxI9I8MfpUFqExQ+3RM9J+ObSu94idtYpZzZT/5cTH307fk8M/RMZXxR7OnoSjoyf68WKv20D+0rzPRKR8337J6XRUBOpfJ9hJR21KKZvxoNDpjMdVHPE+7AIh37UvKV8Fgcwnz/iCaGMMxhrryYZvMDaGEaJ8N+yr8nUWwZUg7wE3PG7438+vpxucqwsgAAIgAAIgAAIgAAIgAAIgAAIgAAIgAAIgT7Q/AgwAsUEH1vyNmgwAAAAASUVORK5CYII=",
  "$Meta": {
    "Type": "ActionTemplate"
  }
}

History »