From c9bce3fc0a3df1e340808305843582092d394792 Mon Sep 17 00:00:00 2001 From: Haiyan Meng Date: Tue, 4 Feb 2020 10:21:11 -0800 Subject: [PATCH] Add comments on backup and restore --- api/internal/crawl/config/elastic/esbackup.yaml | 4 +++- api/internal/crawl/config/elastic/esrestore.yaml | 1 + api/internal/crawl/config/elastic/essnaptshot.yaml | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/api/internal/crawl/config/elastic/esbackup.yaml b/api/internal/crawl/config/elastic/esbackup.yaml index c509ba206..a3b5e6da8 100644 --- a/api/internal/crawl/config/elastic/esbackup.yaml +++ b/api/internal/crawl/config/elastic/esbackup.yaml @@ -1,6 +1,8 @@ # Creating `esbackup/kustomize-backbup` will create the `kustomize-backup` snapshot repository. -# Deleting `esbackup/kustomize-backbup` will delete the `kustomize-backup` snapshot repository and all the snapshots in the repository. +# Deleting `esbackup/kustomize-backbup` will delete the `kustomize-backup` snapshot repository. +# Deleting `esbackup/kustomize-backbup` will NOT delete the snapshots in the `kustomize-backup` snapshot repository, instead makes all the snapshots in the repository inaccessible. # Deleting `esbackup/kustomize-backbup` will NOT delete essnapshot and esrestore objects. +# If you delete the `kustomize-backup` snapshot repository directly without deleting `esbackup/kustomize-backbup`, the ESBackup object will not recreate the snapshot repository. apiVersion: elasticsearch.cloud.google.com/v1alpha1 kind: ESBackup metadata: diff --git a/api/internal/crawl/config/elastic/esrestore.yaml b/api/internal/crawl/config/elastic/esrestore.yaml index 0d77bed93..4490d8248 100644 --- a/api/internal/crawl/config/elastic/esrestore.yaml +++ b/api/internal/crawl/config/elastic/esrestore.yaml @@ -1,6 +1,7 @@ # Creating `esrestore/kustomize-restore` will restore the `kuostmize` index in the `kustomize-snapshot` snapshot to a new index named `kusotmize-restore`. # Deleting `esrestore/kustomize-restore` will not delete the restored index. # Deleting `esrestore/kustomize-restore` should happen before deleting `essnapshot/kustomize-snapshot`. +# If the `kusotmize-restore` index is deleted manually, the ESRestore object will restore the `kustomize` index to it again. apiVersion: elasticsearch.cloud.google.com/v1alpha1 kind: ESRestore metadata: diff --git a/api/internal/crawl/config/elastic/essnaptshot.yaml b/api/internal/crawl/config/elastic/essnaptshot.yaml index 2a9468960..46b7c95eb 100644 --- a/api/internal/crawl/config/elastic/essnaptshot.yaml +++ b/api/internal/crawl/config/elastic/essnaptshot.yaml @@ -1,6 +1,7 @@ # Creating `essnapshot/kustomize-snapshot` will create a snapshot named `kustomize-snapshot` in the `kustomize-backup` snapshot repository. # Deleting `essnapshot/kustomize-snapshot` will delete the snapshot. # Deleting `essnapshot/kustomize-snapshot` should happen before deleting `esbackup/kustomize-backup`. +# If the `kustomize-snapshot` snapshot is deleted directly without deleting `essnapshot/kustomize-snapshot`, the ESSnapshot object will recreate the snapshot. apiVersion: elasticsearch.cloud.google.com/v1alpha1 kind: ESSnapshot metadata: