From 7d76c48360099435e31901ebdd4b5274fbed0cd1 Mon Sep 17 00:00:00 2001 From: Michael Haswell Date: Fri, 26 Jan 2024 10:28:15 -0800 Subject: [PATCH] Clarified arguments in command in README --- helm/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/helm/README.md b/helm/README.md index a7271266f..11d2b044b 100644 --- a/helm/README.md +++ b/helm/README.md @@ -29,9 +29,9 @@ To restore from a backup: 2. Find the `RELEASE_NAME` of the app you want to restore to. This should match the name of the PersistentVolumeClaim that contains the database backups, for example if your PVC is called `example-notifybc-dev-notify-bc-cronjob-mongodb-backup`, the `RELEASE_NAME` should be `example-notifybc-dev`. 3. Determine the `BACKUP_DATE`, the date of the backup you want to restore from. For example if you want to restore from a backup created on January 25th, 2024, the `BACKUP_DATE` should be `20240125`. - Depending on the backup schedule there may be multiple backups performed per day in which case the latest backup from the given `BACKUP_DATE` will be used. -4. From the root of this project, run the command: +4. From the root of this project, run the following command: ```bash - oc process -f helm/deployments/openshift/backup-restore.yaml -p RELEASE_NAME="{RELEASE_NAME}" -p BACKUP_DATE="{BACKUP_DATE}" | oc apply -f - + oc process -f helm/deployments/openshift/backup-restore.yaml -p RELEASE_NAME="example-notifybc-dev" -p BACKUP_DATE="20240125" | oc apply -f - ``` - (replacing `{RELEASE_NAME}` and `{BACKUP_DATE}` with the values found earlier) to run the database restore job. + (replacing the example values `example-notifybc-dev` and `20240125` with the values found earlier) to run the database restore job. 5. A Job and a Pod will be created to perform the restore process which can be monitored in OpenShift. Both will be cleaned up automatically a few minutes after the process is complete.