Skip to content

Commit 93faf95

Browse files
authored
Merge pull request #847 from ritza-co/1011-backup
1011: document test & standby instances; setting-up-backup-device42-a…
2 parents 270b167 + 4b56bb7 commit 93faf95

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

docs/administration/appliance-manager/setting-up-backup-device42-appliance-manager.mdx

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ Configure the backup options for the Main Appliance and Remote Collectors (RCs).
4141

4242
![Run the backup](/assets/images/setting-up-backup-device42-appliance-manager/backup-now-form.png)
4343

44+
### For Standby Instances
45+
46+
Select the **Backup Meta Data** option when creating a Device42 instance for recovery or failover purposes. Selecting the metadata option copies all system identifiers, passphrases, certificates, and configuration settings – preparing the standby instance to fully replace your production instance when needed.
47+
48+
The standby instance will have the same system identifiers as the production instance, which means it will connect as the primary instance. For this reason, keep one instance with the identifier data active at a time. See the [Warm HA Setup documentation](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) for failover procedures.
49+
50+
### For Test Instances
51+
52+
Do not select the **Backup Meta Data** option when creating test or development environments. Backing up and restoring this way is useful when you just want to recover your data, rather than replacing your production instance. The GUIDs will not be copied without the metadata option selected, and without these GUIDs, the machine cannot connect to external services or be used to replace the production instance.
53+
4454
### Remote Collector Options
4555

4656
The following table summarizes the backup settings for the selected RC(s):
@@ -69,7 +79,7 @@ The following table summarizes the backup settings for the selected RC(s):
6979
</tr>
7080
<tr>
7181
<td>**Backup TLS Key Pair**</td>
72-
<td>Backs up the TLS certificate and key</td>
82+
<td>Backs up the TLS certificate and key.</td>
7383
<td>
7484
<ul>
7585
<li>`/etc/nginx/ssl.crt/server.crt`</li>
@@ -99,19 +109,19 @@ The following table summarizes the backup settings for the selected RC(s):
99109
</table>
100110

101111

102-
## Back up to an SFTP Server
112+
## Back Up to an SFTP Server
103113

104-
The backup file can be scheduled to be sent to a SFTP server. All fields are required.
114+
The backup file can be scheduled to be sent to an SFTP server. All fields are required.
105115

106116
![Backup to an SFTP server](/assets/images/setting-up-backup-device42-appliance-manager/sftp-server-settings.png)
107117

108-
## Back up to an NFS server
118+
## Back Up to an NFS Server
109119

110-
The backup file can be scheduled to be sent to an NFS server. All fields are required. The IP address should be the address of the target NFS server, and the folder path should be the path to the directory where the backups will be stored. This folder should be writeable by a user with `uid=1000`.
120+
The backup file can be scheduled to be sent to an NFS server. All fields are required. The IP address should be the address of the target NFS server, and the folder path should be the path to the directory where the backups will be stored. This folder should be writable by a user with `uid=1000`.
111121

112122
![Backup to an NFS server](/assets/images/setting-up-backup-device42-appliance-manager/nfs-server-settings.png)
113123

114-
## Back up Using Amazon S3
124+
## Back Up Using Amazon S3
115125

116126
The backup file can be scheduled to be sent to Amazon S3 as well. All fields are required.
117127

@@ -141,15 +151,15 @@ If your **Current System Time** is incorrect, change it in your VM system config
141151
}}
142152
/>
143153

144-
## Important Note for Scheduled Backups
154+
### Important Note for Scheduled Backups
145155

146156
If you intend to use a backup schedule for an auto-restore configuration to a stand-by appliance, as described in the Device42 [Warm HA Configuration](administration/appliance-manager/warm-ha-setup-failover-and-automated-backups.mdx) documentation, it's critical that you select the **Backup Meta Data** option for the backup schedule.
147157

148158
Without the metadata for scheduled backups, the restore and passphrase settings will not be in the backup archive, and the appliance will have no reference for how to use the data when attempting to restore it.
149159

150160
A backup file without metadata can still be used for an on-demand restore.
151161

152-
### Limit Backup Retention
162+
## Limit Backup Retention
153163

154164
You may want to limit the duration for which backups will be retained.
155165

0 commit comments

Comments
 (0)