Restore Documentation [issue-1715]

changelogs/unreleased/1957-nainav

@@ -0,0 +1 @@
+Restore Documentation: Updated Restore Documentation with Clarification implications of removing restore object.

site/docs/master/restore-reference.md

@@ -1,4 +1,4 @@
-# Restore Reference
+# Restore Reference
 
 ## Restoring Into a Different Namespace
 
@@ -9,6 +9,29 @@ velero restore create RESTORE_NAME \
   --from-backup BACKUP_NAME \
   --namespace-mappings old-ns-1:new-ns-1,old-ns-2:new-ns-2
 ```
+## What happens when user removes restore objects
+A **restore** object represents the restore operation. There are two types of deletion for restore objects:
+### 1. Deleting with **`velero restore delete`**
+This command will delete the custom resource representing it, along with its individual log and results files. But, it will not delete any objects that were created by it from your cluster.
+### 2. Deleting with **`kubectl -n velero delete restore`**
+This command will delete the custom resource representing the restore, but will not delete log/results files from object storage, or any objects that were created during the restore in your cluster.
+
+## Restore command-line options
+To see all commands for restores, run : `velero restore --help`
+To see all options associated with a specific command, provide the --help flag to that command. For example,  **`velero restore create --help`** shows all options associated with the **create** command.
+
+### To List all options of restore use : **`velero restore --help`**
+
+```Usage:
+  velero restore [command]
+
+Available Commands:
+  create      Create a restore
+  delete      Delete restores
+  describe    Describe restores
+  get         Get restores
+  logs        Get restore logs
+```
 
 ## Changing PV/PVC Storage Classes