diff --git a/docs/reference/cli/kubectl-stash.md b/docs/reference/cli/kubectl-stash.md index c659d510..fae974c5 100644 --- a/docs/reference/cli/kubectl-stash.md +++ b/docs/reference/cli/kubectl-stash.md @@ -54,9 +54,11 @@ kubectl plugin for Stash by AppsCode. For more information, visit here: https:// * [kubectl-stash debug](/docs/reference/cli/kubectl-stash_debug.md) - Debug common Stash issues * [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 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 pause](/docs/reference/cli/kubectl-stash_pause.md) - Pause Stash backup temporarily * [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 -* [kubectl-stash unlock](/docs/reference/cli/kubectl-stash_unlock.md) - Unlock Restic Repository +* [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_gen.md b/docs/reference/cli/kubectl-stash_gen.md new file mode 100644 index 00000000..fc125857 --- /dev/null +++ b/docs/reference/cli/kubectl-stash_gen.md @@ -0,0 +1,48 @@ +--- +title: Gen +menu: + docs_{{ .version }}: + identifier: kubectl-stash-gen + name: Gen + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash gen + +generate stash resources + +### Options + +``` + -h, --help help for gen +``` + +### 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 + --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 +* [kubectl-stash gen rules](/docs/reference/cli/kubectl-stash_gen_rules.md) - Generate restore rules from nearest snapshots at a specific time. + diff --git a/docs/reference/cli/kubectl-stash_gen_rules.md b/docs/reference/cli/kubectl-stash_gen_rules.md new file mode 100644 index 00000000..91f0d2d1 --- /dev/null +++ b/docs/reference/cli/kubectl-stash_gen_rules.md @@ -0,0 +1,57 @@ +--- +title: Gen Rules +menu: + docs_{{ .version }}: + identifier: kubectl-stash-gen-rules + name: Gen Rules + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash gen rules + +Generate restore rules from nearest snapshots at a specific time. + +### Synopsis + +Generate restore rules for a repository based on the closest snapshots to a specific time + +``` +kubectl-stash gen rules [flags] +``` + +### Options + +``` + --group-interval string Snaspshot grouping interval (default "4m") + -h, --help help for rules + --request-timeout string Request timeout duration for the kubectl command + --timestamp string Timestamp to find the closest snapshots +``` + +### 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 + --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 + -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 gen](/docs/reference/cli/kubectl-stash_gen.md) - generate stash resources + diff --git a/docs/reference/cli/kubectl-stash_key.md b/docs/reference/cli/kubectl-stash_key.md new file mode 100644 index 00000000..d6c567c9 --- /dev/null +++ b/docs/reference/cli/kubectl-stash_key.md @@ -0,0 +1,51 @@ +--- +title: Key +menu: + docs_{{ .version }}: + identifier: kubectl-stash-key + name: Key + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash key + +manages restic keys (passwords) for accessing the repository + +### Options + +``` + -h, --help help for key +``` + +### 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 + --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 +* [kubectl-stash key add](/docs/reference/cli/kubectl-stash_key_add.md) - Add a new key (password) to a restic repository +* [kubectl-stash key list](/docs/reference/cli/kubectl-stash_key_list.md) - List the keys (passwords) of a restic repository +* [kubectl-stash key remove](/docs/reference/cli/kubectl-stash_key_remove.md) - Remove a key (password) of a restic repository +* [kubectl-stash key update](/docs/reference/cli/kubectl-stash_key_update.md) - Update current key (password) of a restic repository + diff --git a/docs/reference/cli/kubectl-stash_key_add.md b/docs/reference/cli/kubectl-stash_key_add.md new file mode 100644 index 00000000..90336cae --- /dev/null +++ b/docs/reference/cli/kubectl-stash_key_add.md @@ -0,0 +1,53 @@ +--- +title: Key Add +menu: + docs_{{ .version }}: + identifier: kubectl-stash-key-add + name: Key Add + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash key add + +Add a new key (password) to a restic repository + +``` +kubectl-stash key add [flags] +``` + +### Options + +``` + -h, --help help for add + --host string Host for the new key + --new-password-file string File from which to read the new password + --user string Username for the new key +``` + +### 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 + --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 +``` + +### SEE ALSO + +* [kubectl-stash key](/docs/reference/cli/kubectl-stash_key.md) - manages restic keys (passwords) for accessing the repository + diff --git a/docs/reference/cli/kubectl-stash_key_list.md b/docs/reference/cli/kubectl-stash_key_list.md new file mode 100644 index 00000000..b7f1a28e --- /dev/null +++ b/docs/reference/cli/kubectl-stash_key_list.md @@ -0,0 +1,51 @@ +--- +title: Key List +menu: + docs_{{ .version }}: + identifier: kubectl-stash-key-list + name: Key List + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash key list + +List the keys (passwords) of a restic repository + +``` +kubectl-stash key list [flags] +``` + +### Options + +``` + -h, --help help for list +``` + +### 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 + --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 key](/docs/reference/cli/kubectl-stash_key.md) - manages restic keys (passwords) for accessing the repository + diff --git a/docs/reference/cli/kubectl-stash_key_remove.md b/docs/reference/cli/kubectl-stash_key_remove.md new file mode 100644 index 00000000..66ff238e --- /dev/null +++ b/docs/reference/cli/kubectl-stash_key_remove.md @@ -0,0 +1,52 @@ +--- +title: Key Remove +menu: + docs_{{ .version }}: + identifier: kubectl-stash-key-remove + name: Key Remove + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash key remove + +Remove a key (password) of a restic repository + +``` +kubectl-stash key remove [flags] +``` + +### Options + +``` + -h, --help help for remove + --id string ID of the restic key +``` + +### 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 + --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 key](/docs/reference/cli/kubectl-stash_key.md) - manages restic keys (passwords) for accessing the repository + diff --git a/docs/reference/cli/kubectl-stash_key_update.md b/docs/reference/cli/kubectl-stash_key_update.md new file mode 100644 index 00000000..762c588e --- /dev/null +++ b/docs/reference/cli/kubectl-stash_key_update.md @@ -0,0 +1,52 @@ +--- +title: Key Update +menu: + docs_{{ .version }}: + identifier: kubectl-stash-key-update + name: Key Update + parent: reference-cli +menu_name: docs_{{ .version }} +section_menu_id: reference +--- +## kubectl-stash key update + +Update current key (password) of a restic repository + +``` +kubectl-stash key update [flags] +``` + +### Options + +``` + -h, --help help for update + --new-password-file string File from which to read the new password +``` + +### 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 + --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 key](/docs/reference/cli/kubectl-stash_key.md) - manages restic keys (passwords) for accessing the repository + diff --git a/docs/reference/cli/kubectl-stash_unlock.md b/docs/reference/cli/kubectl-stash_unlock.md index d69fa211..c3f35153 100644 --- a/docs/reference/cli/kubectl-stash_unlock.md +++ b/docs/reference/cli/kubectl-stash_unlock.md @@ -10,11 +10,7 @@ section_menu_id: reference --- ## kubectl-stash unlock -Unlock Restic Repository - -### Synopsis - -Unlock Restic Repository +Unlock restic repository ``` kubectl-stash unlock [flags]