diff --git a/docs/reference/cli/kubectl-stash.md b/docs/reference/cli/kubectl-stash.md index 32183ccc..664fe387 100644 --- a/docs/reference/cli/kubectl-stash.md +++ b/docs/reference/cli/kubectl-stash.md @@ -53,6 +53,8 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https:// * [kubectl-stash create](/docs/reference/cli/kubectl-stash_create.md) - create stash resources * [kubectl-stash delete](/docs/reference/cli/kubectl-stash_delete.md) - Delete stash resources * [kubectl-stash download](/docs/reference/cli/kubectl-stash_download.md) - Download snapshots +* [kubectl-stash pause](/docs/reference/cli/kubectl-stash_pause.md) - Pause Stash backup temporarily +* [kubectl-stash resume](/docs/reference/cli/kubectl-stash_resume.md) - Resume stash resources * [kubectl-stash trigger](/docs/reference/cli/kubectl-stash_trigger.md) - Trigger a backup * [kubectl-stash unlock](/docs/reference/cli/kubectl-stash_unlock.md) - Unlock Restic Repository * [kubectl-stash version](/docs/reference/cli/kubectl-stash_version.md) - Prints binary version number. diff --git a/docs/reference/cli/kubectl-stash_pause.md b/docs/reference/cli/kubectl-stash_pause.md new file mode 100644 index 00000000..9b554a64 --- /dev/null +++ b/docs/reference/cli/kubectl-stash_pause.md @@ -0,0 +1,50 @@ +--- +title: Pause +menu: + docs_{{ .version }}: + identifier: kubectl-stash-pause + name: Pause + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash pause + +Pause Stash backup temporarily + +### Options + +``` + --backupbatch string Name of the BackupBatch to pause + --backupconfig string Name of the Backupconfiguration to pause + -h, --help help for pause +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --cache-dir string Default cache directory (default "/home/runner/.kube/cache") + --certificate-authority string Path to a cert file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") + -s, --server string The address and port of the Kubernetes API server + --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used + --token string Bearer token for authentication to the API server + --use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true) + --user string The name of the kubeconfig user to use +``` + +### SEE ALSO + +* [kubectl-stash](/docs/reference/cli/kubectl-stash.md) - kubectl plugin for Stash by AppsCode +* [kubectl-stash pause backup](/docs/reference/cli/kubectl-stash_pause_backup.md) - Pause backup + diff --git a/docs/reference/cli/kubectl-stash_pause_backup.md b/docs/reference/cli/kubectl-stash_pause_backup.md new file mode 100644 index 00000000..7c1e866a --- /dev/null +++ b/docs/reference/cli/kubectl-stash_pause_backup.md @@ -0,0 +1,65 @@ +--- +title: Pause Backup +menu: + docs_{{ .version }}: + identifier: kubectl-stash-pause-backup + name: Pause Backup + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash pause backup + +Pause backup + +### Synopsis + +Pause backup by setting "paused" field of BackupConfiguration/BackupBatch to "true" + +``` +kubectl-stash pause backup [flags] +``` + +### Examples + +``` + # Pause a BackupConfigration + stash pause backup --namespace= --backupconfig= + stash pause backup --backup-config=sample-mongodb -n demo +``` + +### Options + +``` + -h, --help help for backup +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --backupbatch string Name of the BackupBatch to pause + --backupconfig string Name of the Backupconfiguration to pause + --cache-dir string Default cache directory (default "/home/runner/.kube/cache") + --certificate-authority string Path to a cert file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") + -s, --server string The address and port of the Kubernetes API server + --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used + --token string Bearer token for authentication to the API server + --use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true) + --user string The name of the kubeconfig user to use +``` + +### SEE ALSO + +* [kubectl-stash pause](/docs/reference/cli/kubectl-stash_pause.md) - Pause Stash backup temporarily + diff --git a/docs/reference/cli/kubectl-stash_resume.md b/docs/reference/cli/kubectl-stash_resume.md new file mode 100644 index 00000000..e843eaae --- /dev/null +++ b/docs/reference/cli/kubectl-stash_resume.md @@ -0,0 +1,50 @@ +--- +title: Resume +menu: + docs_{{ .version }}: + identifier: kubectl-stash-resume + name: Resume + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash resume + +Resume stash resources + +### Options + +``` + --backupbatch string Name of the BackupBatch + --backupconfig string Name of the Backupconfiguration + -h, --help help for resume +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --cache-dir string Default cache directory (default "/home/runner/.kube/cache") + --certificate-authority string Path to a cert file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") + -s, --server string The address and port of the Kubernetes API server + --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used + --token string Bearer token for authentication to the API server + --use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true) + --user string The name of the kubeconfig user to use +``` + +### SEE ALSO + +* [kubectl-stash](/docs/reference/cli/kubectl-stash.md) - kubectl plugin for Stash by AppsCode +* [kubectl-stash resume backup](/docs/reference/cli/kubectl-stash_resume_backup.md) - Resume backup + diff --git a/docs/reference/cli/kubectl-stash_resume_backup.md b/docs/reference/cli/kubectl-stash_resume_backup.md new file mode 100644 index 00000000..43d054dd --- /dev/null +++ b/docs/reference/cli/kubectl-stash_resume_backup.md @@ -0,0 +1,65 @@ +--- +title: Resume Backup +menu: + docs_{{ .version }}: + identifier: kubectl-stash-resume-backup + name: Resume Backup + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash resume backup + +Resume backup + +### Synopsis + +Resume backup by setting "paused" field of BackupConfiguration/BackupBatch to "false" + +``` +kubectl-stash resume backup [flags] +``` + +### Examples + +``` + # Resume a BackupConfigration + stash resume backup --namespace= --backupconfig= + stash resume backup --backup-config=sample-mongodb -n demo +``` + +### Options + +``` + -h, --help help for backup +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --backupbatch string Name of the BackupBatch + --backupconfig string Name of the Backupconfiguration + --cache-dir string Default cache directory (default "/home/runner/.kube/cache") + --certificate-authority string Path to a cert file for the certificate authority + --client-certificate string Path to a client certificate file for TLS + --client-key string Path to a client key file for TLS + --cluster string The name of the kubeconfig cluster to use + --context string The name of the kubeconfig context to use + --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure + --kubeconfig string Path to the kubeconfig file to use for CLI requests. + --match-server-version Require server version to match client version + -n, --namespace string If present, the namespace scope for this CLI request + --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") + -s, --server string The address and port of the Kubernetes API server + --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used + --token string Bearer token for authentication to the API server + --use-kubeapiserver-fqdn-for-aks if true, uses kube-apiserver FQDN for AKS cluster to workaround https://github.com/Azure/AKS/issues/522 (default true) + --user string The name of the kubeconfig user to use +``` + +### SEE ALSO + +* [kubectl-stash resume](/docs/reference/cli/kubectl-stash_resume.md) - Resume stash resources +