Skip to content

Commit bb1ecb5

Browse files
authored
Merge pull request #3442 from replicatedhq/127664
Add air gap step for preparing velero images
2 parents 8ef23e4 + b522e20 commit bb1ecb5

File tree

1 file changed

+43
-6
lines changed

1 file changed

+43
-6
lines changed

docs/enterprise/snapshots-restoring-full.mdx

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,24 +45,36 @@ To restore using the CLI, see the corresponding procedure for your environment:
4545
### Existing Clusters {#existing}
4646

4747
:::note
48-
If you are restoring to a healthy cluster, you can skip reinstalling Velero and continue to running the `get backups` and `restore` commands in the last two steps.
48+
If you are restoring to a healthy online cluster, you can skip reinstalling Velero and continue to running the `get backups` and `restore` commands in the last two steps.
4949
:::
5050

5151
To restore a full backup in an existing cluster:
5252

53+
1. (Air Gap Only) For air-gapped environments, do the following to prepare the necessary Velero images so that you can install Velero in the target cluster:
54+
1. Download the following images to your local machine, tag them, then upload them to your local image registry:
55+
* The Velero image. See [Preparing the Velero Image](https://velero.io/docs/v1.16/on-premises/#preparing-the-velero-image).
56+
* The `velero/velero-plugin-for-aws:$PLUGIN_VERSION` plugin image. See [Preparing plugin images](https://velero.io/docs/v1.16/on-premises/#preparing-plugin-images).
57+
* The restore helper image. The restore helper is required for File System Backups. See [Preparing the restore helper image](https://velero.io/docs/v1.16/on-premises/#preparing-the-restore-helper-image-optional).
58+
59+
1. Create a ConfigMap in the Velero namespace to specify the location of the Velero restore helper image on your local registry. For more information about the requirements for this ConfigMap, see [Customize Restore Helper Container](https://velero.io/docs/v1.16/file-system-backup/#customize-restore-helper-container).
60+
5361
1. (New or Unhealthy Clusters Only) In the cluster where you will do the restore, install a version of Velero that is compatible with the version that was used to make the snapshot backup.
5462

55-
The Velero installation command varies depending on the storage destination for the backup. For the Velero installation command, see one of the following:
63+
The Velero installation command varies depending on the storage destination for the backup:
5664

57-
* **Host Path:** See [Configuring a Host Path Storage Destination](snapshots-configuring-hostpath)
58-
* **NFS:** See [Configuring an NFS Storage Destination](snapshots-configuring-nfs) or for the configuration steps and how to set up Velero.
59-
* **AWS, GCP, Azure, or other S3:** See [Configuring Other Storage Destinations](snapshots-storage-destinations).
65+
* **Host Path:** See [Configuring a Host Path Storage Destination](snapshots-configuring-hostpath)
66+
* **NFS:** See [Configuring an NFS Storage Destination](snapshots-configuring-nfs) or for the configuration steps and how to set up Velero.
67+
* **AWS, GCP, Azure, or other S3:** See [Configuring Other Storage Destinations](snapshots-storage-destinations).
68+
69+
:::note
70+
For air-gapped environments, be sure to point to the location of each image on your local image registry with the `velero install` command. For more information, see [Installing Velero](https://velero.io/docs/v1.16/on-premises/#installing-velero).
71+
:::
6072

6173
1. <GetBackups/>
6274

6375
1. <Restore/>
6476

65-
### Online Embedded kURL Clusters {#online}
77+
### Online kURL Clusters {#online}
6678

6779
:::note
6880
If you are restoring to a healthy cluster, you can skip the installation and configuration steps and continue to running the `get backups` and `restore` commands in the last two steps.
@@ -108,6 +120,31 @@ To restore a full backup in an air gap kURL cluster:
108120

109121
You can restore an application from a full or partial backup using the Admin Console.
110122

123+
### Prerequisite for Air-Gapped Environments
124+
125+
For existing cluster installations in air-gapped environments, ensure that Velero is installed on the cluster before proceeding with the restore.
126+
127+
To prepare the necessary Velero images and install Velero in air-gapped environments:
128+
129+
1. Download the following images to your local machine, tag them, then upload them to your local image registry:
130+
* The Velero image. See [Preparing the Velero Image](https://velero.io/docs/v1.16/on-premises/#preparing-the-velero-image).
131+
* The `velero/velero-plugin-for-aws:$PLUGIN_VERSION` plugin image. See [Preparing plugin images](https://velero.io/docs/v1.16/on-premises/#preparing-plugin-images).
132+
* The restore helper image. The restore helper is required for File System Backups. See [Preparing the restore helper image](https://velero.io/docs/v1.16/on-premises/#preparing-the-restore-helper-image-optional).
133+
134+
1. Create a ConfigMap in the Velero namespace to specify the location of the Velero restore helper image on your local registry. For more information about the requirements for this ConfigMap, see [Customize Restore Helper Container](https://velero.io/docs/v1.16/file-system-backup/#customize-restore-helper-container).
135+
136+
1. In the cluster where you will do the restore, install a version of Velero that is compatible with the version that was used to make the snapshot backup.
137+
138+
The Velero installation command varies depending on the storage destination for the backup:
139+
140+
* **Host Path:** See [Configuring a Host Path Storage Destination](snapshots-configuring-hostpath)
141+
* **NFS:** See [Configuring an NFS Storage Destination](snapshots-configuring-nfs) or for the configuration steps and how to set up Velero.
142+
* **AWS, GCP, Azure, or other S3:** See [Configuring Other Storage Destinations](snapshots-storage-destinations).
143+
144+
:::note
145+
For air-gapped environments, be sure to point to the location of each image on your local image registry with the `velero install` command. For more information, see [Installing Velero](https://velero.io/docs/v1.16/on-premises/#installing-velero).
146+
:::
147+
111148
### Restore an Application From a Full Backup
112149

113150
To restore an application from a full backup:

0 commit comments

Comments
 (0)