Skip to content

Commit d9ff173

Browse files
Remove outdated docs (#1895)
* I will remove the outdated OADP 1.1.x and 1.2.x documentation. * restore upgrade notes from 1.1 through * keep restic troubleshooting --------- Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
1 parent 164bf42 commit d9ff173

File tree

8 files changed

+4
-625
lines changed

8 files changed

+4
-625
lines changed

docs/TROUBLESHOOTING.md

Lines changed: 2 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ If you need help, first search if there is [already an issue filed](https://issu
1212
1. [Debugging OpenShift Virtualization backup/restore](virtualization_troubleshooting.md)
1313
1. [Debugging OADP Self Service](self-service_troubleshooting.md)
1414
1. [Deleting Backups](#deleting-backups)
15-
1. [Debugging Data Mover (OADP 1.2 or below)](https://github.com/migtools/volume-snapshot-mover/blob/master/docs/troubleshooting.md)
1615
1. [OpenShift ROSA STS and OADP installation](https://github.com/rh-mobb/documentation/blob/main/content/docs/misc/oadp/rosa-sts/_index.md)
1716
1. [Common Issues and Misconfigurations](#common-issues-and-misconfigurations)
1817
- [Credentials Not Properly Formatted](#credentials-secret-not-properly-formatted)
@@ -36,10 +35,6 @@ If you need help, first search if there is [already an issue filed](https://issu
3635
```
3736
oc logs -f deploy/velero -n openshift-adp
3837
```
39-
- If Data Mover (OADP 1.2 or below) is enabled, check the volume-snapshot-logs
40-
```
41-
oc logs -f deployment.apps/volume-snapshot-mover -n openshift-adp
42-
```
4338
4439
1. Velero commands
4540
- Alias the velero command:
@@ -77,10 +72,6 @@ This section includes how to debug a failed restore. For more specific issues re
7772
```
7873
oc logs -f deployment.apps/velero -n openshift-adp
7974
```
80-
If Data Mover (OADP 1.2 or below) is enabled, check the volume-snapshot-logs
81-
```
82-
oc logs -f deployment.apps/volume-snapshot-mover -n openshift-adp
83-
```
8475
8576
1. Velero commands
8677
- Alias the velero command:
@@ -250,40 +241,11 @@ oc delete backuprepository <backupRepositoryName> -n openshift-adp
250241
251242
### Issue with Backup/Restore of DeploymentConfig with volumes or restore hooks
252243
253-
- (OADP 1.3+) **Error:** `DeploymentConfigs restore with spec.Replicas==0 or DC pods fail to restart if they crash if using DC with volumes or restore hooks`
254-
255-
**Solution:**
256-
257-
Solution is the same as in the (OADP 1.1+), except it applies to the use case if you are restoring DeploymentConfigs and have either volumes or post-restore hooks regardless of the backup method.
258-
259-
- (OADP 1.1+) **Error:** `DeploymentConfigs restore with spec.Replicas==0 or DC pods fail to restart if they crash if using Restic/Kopia restores or restore hooks`
260-
261-
**Solution:**
262-
263-
This is expected behavior on restore if you are restoring DeploymentConfigs and are either using Restic or Kopia for volume restore or you have post-restore hooks. The pod and DC plugins make these modifications to ensure that Restic or Kopia and hooks work properly, and [dc-post-restore.sh](../docs/scripts/dc-post-restore.sh) should have been run immediately after a successful restore. Usage for this script is `dc-post-restore.sh <restore-name>`
264-
265-
- (OADP 1.0.z) **Error:** `Using Restic as backup method causes PartiallyFailed/Failed errors in the Restore or post-restore hooks fail to execute`
244+
- **Error:** `DeploymentConfigs restore with spec.Replicas==0 or DC pods fail to restart if they crash if using DC with volumes or restore hooks`
266245
267246
**Solution:**
268247
269-
The changes in the backup/restore process for mitigating this error would be a two step restore process where, in the first step we would perform a restore excluding the replicationcontroller and deploymentconfig resources, and the second step would involve a restore including these resources. The backup and restore commands are given below for more clarity. (The examples given below are a use case for backup/restore of a target namespace, for other cases a similar strategy can be followed).
270-
271-
Please note that this is a temporary fix for this issue and there are ongoing discussions to solve it.
272-
273-
Step 1: Initiate the backup as any normal backup for restic.
274-
```
275-
velero create backup <backup-name> -n openshift-adp --include-namespaces=<TARGET_NAMESPACE>
276-
```
277-
278-
Step 2: Initiate a restore excluding the replicationcontroller and deploymentconfig resources.
279-
```
280-
velero restore create --from-backup=<BACKUP_NAME> -n openshift-adp --include-namespaces <TARGET_NAMESPACE> --exclude-resources replicationcontroller,deploymentconfig,templateinstances.template.openshift.io --restore-volumes=true
281-
```
282-
283-
Step 3: Initiate a restore including the replicationcontroller and deploymentconfig resources.
284-
```
285-
velero restore create --from-backup=<BACKUP_NAME> -n openshift-adp --include-namespaces <TARGET_NAMESPACE> --include-resources replicationcontroller,deploymentconfig,templateinstances.template.openshift.io --restore-volumes=true
286-
```
248+
This is expected behavior on restore if you are restoring DeploymentConfigs and have either volumes or post-restore hooks. The pod and DC plugins make these modifications to ensure that Restic or Kopia and hooks work properly, and [dc-post-restore.sh](../docs/scripts/dc-post-restore.sh) should have been run immediately after a successful restore. Usage for this script is `dc-post-restore.sh <restore-name>`
287249
288250
### New Restic Backup Partially Failing After Clearing Bucket
289251

docs/config/plugins.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ installing Velero:
1818
- `OpenShift` [OpenShift Velero Plugin](https://github.com/openshift/openshift-velero-plugin)
1919
- `CSI` [Plugins for CSI](https://github.com/vmware-tanzu/velero-plugin-for-csi)
2020
- `kubevirt` [Plugins for Kubevirt](https://github.com/kubevirt/kubevirt-velero-plugin)
21-
- `VSM (OADP 1.2 or below)` [Plugin for Volume-Snapshot-Mover](https://github.com/migtools/velero-plugin-for-vsm)
2221

2322
Note that only one of `AWS` and `Legacy AWS` may be installed at the same time. `Legacy AWS` is intended for use with certain S3 providers that do not support the V2 AWS SDK APIs used in the `AWS` plugin.
2423

docs/credentials.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
1. [BSL and VSL share credentials for one provider](#backupstoragelocation-and-volumesnapshotlocation-share-credentials-for-one-provider)
1111
2. [BSL and VSL use the same provider but use different credentials](#backupstoragelocation-and-volumesnapshotlocation-use-the-same-provider-but-use-different-credentials)
1212
3. [No BSL specified but the plugin for the provider exists](#no-backupstoragelocation-specified-but-the-plugin-for-the-provider-exists)
13-
5. [Creating a Secret: OADP with VolumeSnapshotMover](#creating-a-secret-for-volumesnapshotmover)
1413

1514
### Creating a Secret for OADP
1615

@@ -214,22 +213,3 @@ spec:
214213
If you don't need volumesnapshotlocation, you will not need to create a VSL credentials.
215214
216215
If you need `VolumeSnapshotLocation`, regardless of the `noDefaultBackupLocation` setting, you will need a to create VSL credentials.
217-
218-
219-
### Creating a Secret for volumeSnapshotMover (OADP 1.2 or below)
220-
221-
VolumeSnapshotMover requires a restic secret. It can be configured as so:
222-
223-
```
224-
apiVersion: v1
225-
kind: Secret
226-
metadata:
227-
name: <secret-name>
228-
type: Opaque
229-
stringData:
230-
# The repository encryption key
231-
RESTIC_PASSWORD: my-secure-restic-password
232-
```
233-
234-
- *Note:* `dpa.spec.features.dataMover.credentialName` must match the name of the secret.
235-
Otherwise it will default to the name `dm-credential`.

docs/examples/data_mover.md

Lines changed: 0 additions & 141 deletions
This file was deleted.

0 commit comments

Comments
 (0)