Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create upgrade-find-and-backup-master-key.md #2019

Merged
merged 4 commits into from
Oct 3, 2023
Merged

Create upgrade-find-and-backup-master-key.md #2019

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
883ccf1
Create upgrade-find-and-backup-master-key.md
donnybell Oct 2, 2023
c7b9db4
Update creating-test-instance.mdx
donnybell Oct 2, 2023
40d5dd0
Update upgrade-find-and-backup-master-key.md
donnybell Oct 2, 2023
36f8b75
Update creating-test-instance.mdx
steve-fenton-octopus Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/pages/docs/administration/upgrading/guide/creating-test-instance.mdx
View file
Open in desktop
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
View file
Open in desktop
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).
donnybell marked this conversation as resolved.
Show resolved Hide resolved

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