From 883ccf1327d4838f5b96d9b08021ec510c7730ef Mon Sep 17 00:00:00 2001 From: Donny Bell <63249187+donnybell@users.noreply.github.com> Date: Mon, 2 Oct 2023 16:21:46 +0100 Subject: [PATCH 1/4] Create upgrade-find-and-backup-master-key.md --- .../upgrade/upgrade-find-and-backup-master-key.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 src/shared-content/upgrade/upgrade-find-and-backup-master-key.md diff --git a/src/shared-content/upgrade/upgrade-find-and-backup-master-key.md b/src/shared-content/upgrade/upgrade-find-and-backup-master-key.md new file mode 100644 index 0000000000..7355e8e47c --- /dev/null +++ b/src/shared-content/upgrade/upgrade-find-and-backup-master-key.md @@ -0,0 +1,12 @@ +### Finding and backing up your Master Key + +When connecting an existing Octopus database to a "new" Octopus instance, either due to migration or for testing, you will need the Master Key to gain access to the database during the Octopus instance setup process. + +To obtain your existing Master Key from your source Octopus instance, you can simply open Octopus Manager then select "View master key" as shown below: + + +:::figure +![](/docs/upgrade/images/view-master-key.png) +::: + +Alternatively, you may also use the `show-master-key` command via the `Octopus.Server.exe` command-line tool. [You can find more information on this here](https://octopus.com/docs/octopus-rest-api/octopus.server.exe-command-line/show-master-key). From c7b9db4fb820e38e0dce1100f8f7f72f8b2c96f2 Mon Sep 17 00:00:00 2001 From: Donny Bell <63249187+donnybell@users.noreply.github.com> Date: Mon, 2 Oct 2023 16:26:28 +0100 Subject: [PATCH 2/4] Update creating-test-instance.mdx --- .../administration/upgrading/guide/creating-test-instance.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx b/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx index ec7879cec8..42062600cf 100644 --- a/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx +++ b/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx @@ -6,6 +6,7 @@ title: Creating a test instance description: A guide on how to create a test instance with Octopus Deploy navOrder: 8 --- +import UpgradeFindAndBackupMasterKey from 'src/shared-content/upgrade/upgrade-find-and-backup-master-key.md'; import UpgradeOctopusBackupDatabase from 'src/shared-content/upgrade/upgrade-octopus-backup-database.include.md'; import UpgradeTestingUpgradedInstance from 'src/shared-content/upgrade/upgrade-testing-upgraded-instance.include.md'; import UpgradeRestoreBackup from 'src/shared-content/upgrade/upgrade-restore-backup.include.md'; @@ -71,6 +72,7 @@ Configuring a clone typically takes much more time and compute resources. There Creating a clone of an existing instance involves: +1. Finding and backing up your Master Key. 1. Enabling maintenance mode on the main instance. 1. Backing up the database of the main instance. 1. Disabling maintenance mode on the main instance. @@ -83,6 +85,8 @@ Creating a clone of an existing instance involves: 1. Upgrade the test instance to the latest version of Octopus Deploy. 1. Test and verify the test instance. + + From 40d5dd0f5e5df9c7fa70d6257517d9e959a9e882 Mon Sep 17 00:00:00 2001 From: Donny Bell <63249187+donnybell@users.noreply.github.com> Date: Mon, 2 Oct 2023 16:40:19 +0100 Subject: [PATCH 3/4] Update upgrade-find-and-backup-master-key.md --- .../upgrade/upgrade-find-and-backup-master-key.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/shared-content/upgrade/upgrade-find-and-backup-master-key.md b/src/shared-content/upgrade/upgrade-find-and-backup-master-key.md index 7355e8e47c..b1c6892de2 100644 --- a/src/shared-content/upgrade/upgrade-find-and-backup-master-key.md +++ b/src/shared-content/upgrade/upgrade-find-and-backup-master-key.md @@ -10,3 +10,5 @@ To obtain your existing Master Key from your source Octopus instance, you can si ::: Alternatively, you may also use the `show-master-key` command via the `Octopus.Server.exe` command-line tool. [You can find more information on this here](https://octopus.com/docs/octopus-rest-api/octopus.server.exe-command-line/show-master-key). + +For Octopus Server instances hosted in Linux containers, you may use the `container exec` command [per the instructions here](https://octopus.com/docs/installation/octopus-server-linux-container#upgrading). From 36f8b753a985e85f22af8cb48e8d94616842d8b7 Mon Sep 17 00:00:00 2001 From: Steve Fenton <99181436+steve-fenton-octopus@users.noreply.github.com> Date: Tue, 3 Oct 2023 07:45:55 +0100 Subject: [PATCH 4/4] Update creating-test-instance.mdx --- .../administration/upgrading/guide/creating-test-instance.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx b/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx index 42062600cf..9b01a4fe3a 100644 --- a/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx +++ b/src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2023-10-02 title: Creating a test instance description: A guide on how to create a test instance with Octopus Deploy navOrder: 8