diff --git a/docs/reference/cli/kubectl-stash.md b/docs/reference/cli/kubectl-stash.md index 72e132fa..59bd24d9 100644 --- a/docs/reference/cli/kubectl-stash.md +++ b/docs/reference/cli/kubectl-stash.md @@ -58,7 +58,9 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https:// * [kubectl-stash download](/docs/reference/cli/kubectl-stash_download.md) - Download snapshots * [kubectl-stash gen](/docs/reference/cli/kubectl-stash_gen.md) - generate stash resources * [kubectl-stash key](/docs/reference/cli/kubectl-stash_key.md) - manages restic keys (passwords) for accessing the repository +* [kubectl-stash migrate](/docs/reference/cli/kubectl-stash_migrate.md) - Migrate restic repository to v2 * [kubectl-stash pause](/docs/reference/cli/kubectl-stash_pause.md) - Pause Stash backup temporarily +* [kubectl-stash prune](/docs/reference/cli/kubectl-stash_prune.md) - Prune restic repository * [kubectl-stash rebuild-index](/docs/reference/cli/kubectl-stash_rebuild-index.md) - Build a new index * [kubectl-stash resume](/docs/reference/cli/kubectl-stash_resume.md) - Resume Stash backup * [kubectl-stash trigger](/docs/reference/cli/kubectl-stash_trigger.md) - Trigger a backup diff --git a/docs/reference/cli/kubectl-stash_delete_snapshot.md b/docs/reference/cli/kubectl-stash_delete_snapshot.md index d5c52bf8..74a30665 100644 --- a/docs/reference/cli/kubectl-stash_delete_snapshot.md +++ b/docs/reference/cli/kubectl-stash_delete_snapshot.md @@ -30,7 +30,7 @@ kubectl-stash delete snapshot [flags] ### Options ``` - --docker-registry string Docker image registry (default "stashed") + --docker-registry string Docker image registry (default "restic") -h, --help help for snapshot --image-tag string Stash image tag (default "latest") ``` diff --git a/docs/reference/cli/kubectl-stash_download.md b/docs/reference/cli/kubectl-stash_download.md index 78d930cb..5f63ca6e 100644 --- a/docs/reference/cli/kubectl-stash_download.md +++ b/docs/reference/cli/kubectl-stash_download.md @@ -24,7 +24,7 @@ kubectl-stash download [flags] ``` --destination string Destination path where snapshot will be restored. - --docker-registry string Docker image registry for restic cli (default "stashed") + --docker-registry string Docker image registry for restic cli (default "restic") -h, --help help for download --host string Name of the source host machine (default "host-0") --image-tag string Restic docker image tag (default "latest") diff --git a/docs/reference/cli/kubectl-stash_migrate.md b/docs/reference/cli/kubectl-stash_migrate.md new file mode 100644 index 00000000..851287a4 --- /dev/null +++ b/docs/reference/cli/kubectl-stash_migrate.md @@ -0,0 +1,54 @@ +--- +title: Migrate +menu: + docs_{{ .version }}: + identifier: kubectl-stash-migrate + name: Migrate + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash migrate + +Migrate restic repository to v2 + +``` +kubectl-stash migrate [flags] +``` + +### Options + +``` + --docker-registry string Docker image registry for restic cli (default "restic") + -h, --help help for migrate + --image-tag string Restic docker image tag (default "latest") +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --as-uid string UID to impersonate for the operation. + --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 + --disable-compression If true, opt-out of response compression for all requests to the server + --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 + --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 + diff --git a/docs/reference/cli/kubectl-stash_prune.md b/docs/reference/cli/kubectl-stash_prune.md new file mode 100644 index 00000000..decfff63 --- /dev/null +++ b/docs/reference/cli/kubectl-stash_prune.md @@ -0,0 +1,60 @@ +--- +title: Prune +menu: + docs_{{ .version }}: + identifier: kubectl-stash-prune + name: Prune + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash prune + +Prune restic repository + +``` +kubectl-stash prune [flags] +``` + +### Options + +``` + --docker-registry string Docker image registry for restic cli (default "restic") + --dry-run do not modify the repository, just print what would be done + -h, --help help for prune + --image-tag string Restic docker image tag (default "latest") + --max-repack-size string maximum size to repack (allowed suffixes: k/K, m/M, g/G, t/T) + --max-unused-limit string tolerate given limit of unused data (absolute value in bytes with suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited') (default "5%") + --repack-cacheable-only only repack packs which are cacheable + --repack-small repack pack files below 80% of target pack size + --repack-uncompressed repack all uncompressed data +``` + +### Options inherited from parent commands + +``` + --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. + --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. + --as-uid string UID to impersonate for the operation. + --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 + --disable-compression If true, opt-out of response compression for all requests to the server + --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 + --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 +