Update restore customization docs for using snapshot ID. (#188)

* Update restore customization docs for using snapshot ID. Signed-off-by: piyush1146115 <[email protected]> * Fix a broken link. Signed-off-by: piyush1146115 <[email protected]> Co-authored-by: Emruz Hossain <[email protected]>
stashed · Feb 1, 2022 · c649326 · c649326
1 parent 60effdd
commit c649326
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 40 deletions.
diff --git a/docs/addons/elasticsearch/customization/index.md b/docs/addons/elasticsearch/customization/index.md
@@ -270,22 +270,22 @@ spec:
 
 ### Restore specific snapshot
 
-You can also restore a specific snapshot. At first, list the available snapshot as bellow,
+You can also restore a specific snapshot. At first, list the available snapshots as below,
 
 ```bash
 ❯ kubectl get snapshots -n demo
-NAME                REPOSITORY   HOSTNAME   CREATED AT
-gcs-repo-4bc21d6f   gcs-repo     host-0     2021-02-12T14:54:27Z
-gcs-repo-f0ac7cbd   gcs-repo     host-0     2021-02-12T14:56:26Z
-gcs-repo-9210ebb6   gcs-repo     host-0     2021-02-12T14:58:27Z
-gcs-repo-0aff8890   gcs-repo     host-0     2021-02-12T15:00:28Z
+NAME                ID         REPOSITORY   HOSTNAME   CREATED AT
+gcs-repo-4bc21d6f   4bc21d6f   gcs-repo     host-0     2022-01-12T14:54:27Z
+gcs-repo-f0ac7cbd   f0ac7cbd   gcs-repo     host-0     2022-01-12T14:56:26Z
+gcs-repo-9210ebb6   9210ebb6   gcs-repo     host-0     2022-01-12T14:58:27Z
+gcs-repo-0aff8890   0aff8890   gcs-repo     host-0     2022-01-12T15:00:28Z
 ```
 
 >You can also filter the snapshots as shown in the guide [here](https://stash.run/docs/latest/concepts/crds/snapshot/#working-with-snapshot).
 
-Stash adds the Repository name as a prefix of the Snapshot. You have to remove the repository prefix and use only the last 8 characters as the snapshot name during restore.
+You can use the respective ID of the snapshot to restore a specific snapshot.
 
-The below example shows how you can pass a specific snapshot name through the `snapshots` filed of `rules` section.
+The below example shows how you can pass a specific snapshot ID through the `snapshots` field of `rules` section.
 
 ```yaml
 apiVersion: stash.appscode.com/v1beta1

diff --git a/docs/addons/etcd/customization/index.md b/docs/addons/etcd/customization/index.md
@@ -201,22 +201,22 @@ spec:
 
 ### Restore specific snapshot
 
-You can also restore a specific snapshot. At first, list the available snapshot as bellow,
+You can also restore a specific snapshot. At first, list the available snapshots as below,
 
 ```bash
 ❯ kubectl get snapshots -n demo
-NAME                REPOSITORY   HOSTNAME   CREATED AT
-gcs-repo-4bc21d6f   gcs-repo     host-0     2021-02-12T14:54:27Z
-gcs-repo-f0ac7cbd   gcs-repo     host-0     2021-02-12T14:56:26Z
-gcs-repo-9210ebb6   gcs-repo     host-0     2021-02-12T14:58:27Z
-gcs-repo-0aff8890   gcs-repo     host-0     2021-02-12T15:00:28Z
+NAME                ID         REPOSITORY   HOSTNAME   CREATED AT
+gcs-repo-4bc21d6f   4bc21d6f   gcs-repo     host-0     2022-01-12T14:54:27Z
+gcs-repo-f0ac7cbd   f0ac7cbd   gcs-repo     host-0     2022-01-12T14:56:26Z
+gcs-repo-9210ebb6   9210ebb6   gcs-repo     host-0     2022-01-12T14:58:27Z
+gcs-repo-0aff8890   0aff8890   gcs-repo     host-0     2022-01-12T15:00:28Z
 ```
 
 >You can also filter the snapshots as shown in the guide [here](https://stash.run/docs/latest/concepts/crds/snapshot/#working-with-snapshot).
 
-Stash adds the Repository name as a prefix of the Snapshot. You have to remove the repository prefix and use only the last 8 characters as the snapshot name during restore.
+You can use the respective ID of the snapshot to restore a specific snapshot.
 
-The below example shows how you can pass a specific snapshot name through the `snapshots` filed of `rules` section.
+The below example shows how you can pass a specific snapshot ID through the `snapshots` field of `rules` section.
 
 ```yaml
 apiVersion: stash.appscode.com/v1beta1

diff --git a/docs/addons/mariadb/customization/index.md b/docs/addons/mariadb/customization/index.md
@@ -192,22 +192,22 @@ spec:
 
 ### Restore specific snapshot
 
-You can also restore a specific snapshot. At first, list the available snapshot as bellow,
+You can also restore a specific snapshot. At first, list the available snapshots as below,
 
 ```bash
 ❯ kubectl get snapshots -n demo
-NAME                REPOSITORY   HOSTNAME   CREATED AT
-gcs-repo-4bc21d6f   gcs-repo     host-0     2021-02-12T14:54:27Z
-gcs-repo-f0ac7cbd   gcs-repo     host-0     2021-02-12T14:56:26Z
-gcs-repo-9210ebb6   gcs-repo     host-0     2021-02-12T14:58:27Z
-gcs-repo-0aff8890   gcs-repo     host-0     2021-02-12T15:00:28Z
+NAME                ID         REPOSITORY   HOSTNAME   CREATED AT
+gcs-repo-4bc21d6f   4bc21d6f   gcs-repo     host-0     2022-01-12T14:54:27Z
+gcs-repo-f0ac7cbd   f0ac7cbd   gcs-repo     host-0     2022-01-12T14:56:26Z
+gcs-repo-9210ebb6   9210ebb6   gcs-repo     host-0     2022-01-12T14:58:27Z
+gcs-repo-0aff8890   0aff8890   gcs-repo     host-0     2022-01-12T15:00:28Z
 ```
 
 >You can also filter the snapshots as shown in the guide [here](https://stash.run/docs/latest/concepts/crds/snapshot/#working-with-snapshot).
 
-Stash adds the Repository name as a prefix of the Snapshot. You have to remove the repository prefix and use only the last 8 characters as the snapshot name during restore.
+You can use the respective ID of the snapshot to restore a specific snapshot.
 
-The below example shows how you can pass a specific snapshot name through the `snapshots` filed of `rules` section.
+The below example shows how you can pass a specific snapshot ID through the `snapshots` field of `rules` section.
 
 ```yaml
 apiVersion: stash.appscode.com/v1beta1

diff --git a/docs/addons/nats/customization/index.md b/docs/addons/nats/customization/index.md
@@ -278,22 +278,22 @@ spec:
 
 ### Restore specific snapshot
 
-You can also restore a specific snapshot. At first, list the available snapshot as bellow,
+You can also restore a specific snapshot. At first, list the available snapshots as below,
 
 ```bash
 ❯ kubectl get snapshots -n demo
-NAME                REPOSITORY   HOSTNAME   CREATED AT
-gcs-repo-4bc21d6f   gcs-repo     host-0     2021-02-12T14:54:27Z
-gcs-repo-f0ac7cbd   gcs-repo     host-0     2021-02-12T14:56:26Z
-gcs-repo-9210ebb6   gcs-repo     host-0     2021-02-12T14:58:27Z
-gcs-repo-0aff8890   gcs-repo     host-0     2021-02-12T15:00:28Z
+NAME                ID         REPOSITORY   HOSTNAME   CREATED AT
+gcs-repo-4bc21d6f   4bc21d6f   gcs-repo     host-0     2022-01-12T14:54:27Z
+gcs-repo-f0ac7cbd   f0ac7cbd   gcs-repo     host-0     2022-01-12T14:56:26Z
+gcs-repo-9210ebb6   9210ebb6   gcs-repo     host-0     2022-01-12T14:58:27Z
+gcs-repo-0aff8890   0aff8890   gcs-repo     host-0     2022-01-12T15:00:28Z
 ```
 
 >You can also filter the snapshots as shown in the guide [here](https://stash.run/docs/latest/concepts/crds/snapshot/#working-with-snapshot).
 
-Stash adds the Repository name as a prefix of the Snapshot. You have to remove the repository prefix and use only the last 8 characters as the snapshot name during restore.
+You can use the respective ID of the snapshot to restore a specific snapshot.
 
-The below example shows how you can pass a specific snapshot name through the `snapshots` filed of `rules` section.
+The below example shows how you can pass a specific snapshot ID through the `snapshots` field of `rules` section.
 
 ```yaml
 apiVersion: stash.appscode.com/v1beta1

diff --git a/docs/addons/redis/customization/index.md b/docs/addons/redis/customization/index.md
@@ -188,22 +188,22 @@ spec:
 
 ### Restore specific snapshot
 
-You can also restore a specific snapshot. At first, list the available snapshot as bellow,
+You can also restore a specific snapshot. At first, list the available snapshots as below,
 
 ```bash
 ❯ kubectl get snapshots -n demo
-NAME                REPOSITORY   HOSTNAME   CREATED AT
-gcs-repo-4bc21d6f   gcs-repo     host-0     2021-02-12T14:54:27Z
-gcs-repo-f0ac7cbd   gcs-repo     host-0     2021-02-12T14:56:26Z
-gcs-repo-9210ebb6   gcs-repo     host-0     2021-02-12T14:58:27Z
-gcs-repo-0aff8890   gcs-repo     host-0     2021-02-12T15:00:28Z
+NAME                ID         REPOSITORY   HOSTNAME   CREATED AT
+gcs-repo-4bc21d6f   4bc21d6f   gcs-repo     host-0     2022-01-12T14:54:27Z
+gcs-repo-f0ac7cbd   f0ac7cbd   gcs-repo     host-0     2022-01-12T14:56:26Z
+gcs-repo-9210ebb6   9210ebb6   gcs-repo     host-0     2022-01-12T14:58:27Z
+gcs-repo-0aff8890   0aff8890   gcs-repo     host-0     2022-01-12T15:00:28Z
 ```
 
 >You can also filter the snapshots as shown in the guide [here](https://stash.run/docs/latest/concepts/crds/snapshot/#working-with-snapshot).
 
-Stash adds the Repository name as a prefix of the Snapshot. You have to remove the repository prefix and use only the last 8 characters as the snapshot name during restore.
+You can use the respective ID of the snapshot to restore a specific snapshot.
 
-The below example shows how you can pass a specific snapshot name through the `snapshots` filed of `rules` section.
+The below example shows how you can pass a specific snapshot ID through the `snapshots` field of `rules` section.
 
 ```yaml
 apiVersion: stash.appscode.com/v1beta1