Skip to content

Commit

Permalink
Merge pull request #2019 from OctopusDeploy/donnybell-patch-1
Browse files Browse the repository at this point in the history
Create upgrade-find-and-backup-master-key.md
  • Loading branch information
donnybell authored Oct 3, 2023
2 parents 2d11141 + 36f8b75 commit 0015403
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
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
---
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';
Expand Down Expand Up @@ -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.
Expand All @@ -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.

<UpgradeFindAndBackupMasterKey />

<UpgradeOctopusBackupDatabase />

<UpgradeRestoreBackup />
Expand Down
14 changes: 14 additions & 0 deletions src/shared-content/upgrade/upgrade-find-and-backup-master-key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### 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).

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).

0 comments on commit 0015403

Please sign in to comment.