Use common warning message for enterprise features (#84)

Signed-off-by: Emruz Hossain <[email protected]> Tasks: - [x] Use common warning message for enterprise features - [x] Improve restore flow doc for RestoreBatch
stashed · Aug 25, 2020 · 2958b8f · 2958b8f
1 parent 74dc27c
commit 2958b8f
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 12 deletions.
diff --git a/docs/concepts/crds/backupbatch.md b/docs/concepts/crds/backupbatch.md
@@ -11,7 +11,7 @@ menu_name: product_stash_{{ .version }}
 section_menu_id: concepts
 ---
 
-{{< notice type="warning" message="BackupBatch is an enterprise feature. You must install Stash Enterprise operator to use BackupBatch." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # BackupBatch
 

diff --git a/docs/concepts/crds/restorebatch.md b/docs/concepts/crds/restorebatch.md
@@ -10,7 +10,7 @@ menu_name: docs_{{ .version }}
 section_menu_id: concepts
 ---
 
-{{< notice type="warning" message="RestoreBatch is an enterprise feature. You must install Stash Enterprise operator to use RestoreBatch." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # RestoreBatch
 

diff --git a/docs/concepts/crds/snapshot.md b/docs/concepts/crds/snapshot.md
@@ -98,8 +98,12 @@ Here, we are going to describe the various sections of a `Snapshot` object.
 
 ## Working with Snapshot
 
+In this section, we are going to show different types of operations you can perform on the Snapshots.
+
 **Listing Snapshots:**
 
+Stash lists Snapshots directly from the backend. This operation can take more time than the default request timeout of `kubectl`. So, we are going to increase the request timeout through the `--request-timeout` flag for get/list commands.
+
 ```bash
 # List Snapshots of all Repositories in the current namespace
 $ kubectl get snapshot --request-timeout=300s

diff --git a/docs/guides/latest/auto-backup/database.md b/docs/guides/latest/auto-backup/database.md
@@ -12,7 +12,7 @@ menu_name: docs_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Auto-Backup is an enterprise feature. You must install Stash Enterprise operator to use auto-backup." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Auto Backup for Database
 

diff --git a/docs/guides/latest/auto-backup/overview.md b/docs/guides/latest/auto-backup/overview.md
@@ -12,7 +12,7 @@ menu_name: docs_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Auto-Backup is an enterprise feature. You must install Stash Enterprise operator to use auto-backup." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Auto Backup with Stash
 

diff --git a/docs/guides/latest/auto-backup/pvc.md b/docs/guides/latest/auto-backup/pvc.md
@@ -12,7 +12,7 @@ menu_name: docs_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Auto-Backup is an enterprise feature. You must install Stash Enterprise operator to use auto-backup." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Auto Backup for PVC
 

diff --git a/docs/guides/latest/auto-backup/workload.md b/docs/guides/latest/auto-backup/workload.md
@@ -12,7 +12,7 @@ menu_name: docs_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Auto-Backup is an enterprise feature. You must install Stash Enterprise operator to use auto-backup." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Auto Backup for Workloads
 

diff --git a/docs/guides/latest/backends/local.md b/docs/guides/latest/backends/local.md
@@ -12,7 +12,7 @@ menu_name: docs_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Local backend is an enterprise feature. You must install Stash Enterprise operator to use local backend." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Local Backend
 

diff --git a/docs/guides/latest/batch-backup/batch-backup.md b/docs/guides/latest/batch-backup/batch-backup.md
@@ -12,7 +12,7 @@ menu_name: product_stash_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Batch backup is an enterprise feature. You must install Stash Enterprise operator to use batch backup." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Backup & Restore a WordPress Site Using Batch Backup
 

diff --git a/docs/guides/latest/batch-backup/overview.md b/docs/guides/latest/batch-backup/overview.md
@@ -12,7 +12,7 @@ menu_name: product_stash_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Batch backup is an enterprise feature. You must install Stash Enterprise operator to use batch backup." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Batch Backup and Restore Overview
 
@@ -64,8 +64,10 @@ The batch restore process consists of the following steps:
 
 1. At first, the user creates a `RestoreBatch` CR specifying the targets and the respective Repository where the backed up data has been stored.
 2. The Stash operator watches for the `RestoreBatch` CR.
-3. When the Stash operator finds a `RestoreBatch` CR, it injects an init-container into the target that follows the sidecar model and creates a restore job for the targets that follow the job model.
-4. The restore init-container/job restore their respective data. Stash operator enforces the restore order if the `executionOrder` is set to `Sequential`.
+3. When the Stash operator finds a `RestoreBatch` CR, it executes the global `PreRestore` hooks. If there is no global `PreRestore` hook, Stash will skip this step.
+4. Then, it injects an init-container into the target that follows the sidecar model and creates a restore job for the targets that follow the job model. Stash operator enforces the restore order in this step if the `executionOrder` is set to `Sequential`.
+5. The restore init-container/job first execute their local `PreRestore` hooks. Then, restore their data and finally execute their `PostRestore` hooks.
+6. Finally, Stash operator executes the global `PostRestore` hooks. If there is not global `PostRestore` hook configured for this RestoreBatch, Stash will skip this step.
 
 ## Next Steps
 

diff --git a/docs/guides/latest/hooks/batch-backup-hooks.md b/docs/guides/latest/hooks/batch-backup-hooks.md
@@ -11,7 +11,7 @@ menu_name: docs_{{ .version }}
 section_menu_id: guides
 ---
 
-{{< notice type="warning" message="Batch backup is an enterprise feature. You must install Stash Enterprise operator to use batch backup." >}}
+{{< notice type="warning" message="This is an Enterprise-only feature. Please install [Stash Enterprise Edition](/docs/setup/install/enterprise.md) to try this feature." >}}
 
 # Hooks in Batch Backup