Generate a new Master Key and re-encrypt all the sensitive data. This option was added in Octopus 2022.4.
Before using this command, we recommend taking a look at our guide on rotating the Master Key.
Usage: octopus.server rotate-master-key [<options>] Where [<options>] is any of: --instance=VALUE Name of the instance to use --config=VALUE Configuration file to use --iReallyWantToRotateMyMasterKey Confirm you really want to generate a new Master Key and re-encrypt all your sensitive data. --iHaveBackedUpMyDatabase Confirm you have taken a backup of your database in its current state. If something goes wrong at least you can start again from that point in time. --upgradeDatabase Confirm you are willing to let Octopus upgrade the schema of your database so it can safely load and save data in the expected format. --skipLicenseCheck Skips the license check when performing a schema upgrade --masterKey=VALUE The new master key that should be used Or one of the common options: --help Show detailed help for this command
This example will rotate the master key for the instance named
Please note: The command below will replace the existing Master Key with a newly generated Master Key, and re-encrypt all sensitive data in the Octopus instance - be sure you have taken a database backup before running this.
octopus.server rotate-master-key --instance="OctopusServer" --iReallyWantToRotateMyMasterKey --iHaveBackedUpMyDatabase
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Sunday, January 1, 2023