From 4c349f96b781c1e4ea9b696242ff11a8e76eb1ff Mon Sep 17 00:00:00 2001 From: hmsayem Date: Mon, 9 Oct 2023 19:08:57 +0600 Subject: [PATCH] Update Signed-off-by: hmsayem --- docs/guides/cli/kubectl-plugin/index.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/guides/cli/kubectl-plugin/index.md b/docs/guides/cli/kubectl-plugin/index.md index 7af80e8e..e7b8a7e8 100644 --- a/docs/guides/cli/kubectl-plugin/index.md +++ b/docs/guides/cli/kubectl-plugin/index.md @@ -389,7 +389,7 @@ $ kubectl stash resume backup --namespace=demo --backupconfig==my-config `kubectl stash debug` command is used to debug stash resources. This command describes the necessary resources and shows logs from the related pods which makes the debugging process quicker and easier. ### Debug Backup -To debug a backup you have to provide the BackupConfiguration name or BackupBatch name by using flags. The available flags are: +This command is used to debug a backup. You have to provide the BackupConfiguration name or BackupBatch name by using flags. The available flags are: | Flag | Description | |------------------|-----------------------------------------------------------------------------------| @@ -412,7 +412,7 @@ $ kubectl stash debug backup --namespace=demo --backupconfig=my-config ### Debug Restore -To debug a restore you have to provide the `RestoreSession` name or `RestoreBatch` name by using flags. The available flags are: +This command is used to debug a restore. You have to provide the `RestoreSession` name or `RestoreBatch` name by using flags. The available flags are: | Flag | Description | |--------------------|--------------------------------------------------------------------------------| @@ -435,7 +435,7 @@ $ kubectl stash debug restore --namespace=demo --restoresession=my-restore ### Debug Operator -To show version related information and operator logs +This command is used to show version related information and operator logs. **Example:** @@ -443,13 +443,13 @@ To show version related information and operator logs $ kubectl stash debug operator ``` -### Key Command +## Key Command -`kubectl stash key` command is used to manage keys (passwords) for a restic repository. +`kubectl stash key` command is used to manage keys (passwords) of a restic repository. ### Key List -To list restic keys (passwords) of a restic repository. +This command is used to list restic keys (passwords) of a restic repository. **Format:** @@ -465,7 +465,7 @@ $ kubectl stash key list my-repo --namespace=demo ### Key Add -To add a new key (password) to a restic repository. You will provide the information of the new key by using flags. The available flags are: +This command is used to add a new key (password) to a restic repository. You have to provide the information of the new key by using flags. The available flags are: | Flag | Description | |-----------------------|--------------------------------------------------------------------------------| @@ -488,7 +488,7 @@ $ kubectl stash key list my-repo --namespace=demo --user root --host my-host --n ### Key Update -To update the current key (password) of a restic repository. You will provide the updated key by using flag. The available flags are: +This command is used to update the current key (password) of a restic repository. You have to provide the updated key by using a flag. The available flags are: | Flag | Description | |-----------------------|--------------------------------------------------------------------------------| @@ -509,7 +509,7 @@ $ kubectl stash key list my-repo --namespace=demo --new-password-file password.t ### Key Remove -To remove a key (password) of a restic repository. You will provide the ID of the key to remove by using flag. The available flags are: +This command is used to remove a key (password) of a restic repository. You have to provide the ID of the key to remove by using flag. The available flags are: | Flag | Description | |---------------|--------------------------------------------------------|