diff --git a/docs/cli-reference/README.md b/docs/cli-reference/README.md deleted file mode 100644 index 00cca3a2f..000000000 --- a/docs/cli-reference/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Command line reference - -The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores. - -[The files in the CLI reference directory][1] in the repository enumerate each of the possible `ark` commands and their flags. -This information is available in the CLI, using the `--help` flag. - -## Running the client - -We recommend that you [download a pre-built release][26], but you can also build and run the `ark` executable. - -## Kubernetes cluster credentials - -In general, Ark will search for your cluster credentials in the following order: -* `--kubeconfig` command line flag -* `$KUBECONFIG` environment variable -* In-cluster credentials--this only works when you are running Ark in a pod - -[1]: https://github.com/heptio/ark/tree/master/docs/cli-reference -[26]: https://github.com/heptio/ark/releases diff --git a/docs/cli-reference/ark.md b/docs/cli-reference/ark.md deleted file mode 100644 index c93939297..000000000 --- a/docs/cli-reference/ark.md +++ /dev/null @@ -1,48 +0,0 @@ -## ark - -Back up and restore Kubernetes cluster resources. - -### Synopsis - -Heptio Ark is a tool for managing disaster recovery, specifically for Kubernetes -cluster resources. It provides a simple, configurable, and operationally robust -way to back up your application state and associated data. - -If you're familiar with kubectl, Ark supports a similar model, allowing you to -execute commands such as 'ark get backup' and 'ark create schedule'. The same -operations can also be performed as 'ark backup get' and 'ark schedule create'. - -### Options - -``` - --alsologtostderr log to standard error as well as files - -h, --help help for ark - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup](ark_backup.md) - Work with backups -* [ark backup-location](ark_backup-location.md) - Work with backup storage locations -* [ark bug](ark_bug.md) - Report an Ark bug -* [ark client](ark_client.md) - Ark client related commands -* [ark completion](ark_completion.md) - Output shell completion code for the specified shell (bash or zsh) -* [ark create](ark_create.md) - Create ark resources -* [ark delete](ark_delete.md) - Delete ark resources -* [ark describe](ark_describe.md) - Describe ark resources -* [ark get](ark_get.md) - Get ark resources -* [ark plugin](ark_plugin.md) - Work with plugins -* [ark restic](ark_restic.md) - Work with restic -* [ark restore](ark_restore.md) - Work with restores -* [ark schedule](ark_schedule.md) - Work with schedules -* [ark server](ark_server.md) - Run the ark server -* [ark version](ark_version.md) - Print the ark version and associated image - diff --git a/docs/cli-reference/ark_backup-location.md b/docs/cli-reference/ark_backup-location.md deleted file mode 100644 index e3b96cbed..000000000 --- a/docs/cli-reference/ark_backup-location.md +++ /dev/null @@ -1,35 +0,0 @@ -## ark backup-location - -Work with backup storage locations - -### Synopsis - -Work with backup storage locations - -### Options - -``` - -h, --help help for backup-location -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark backup-location create](ark_backup-location_create.md) - Create a backup storage location -* [ark backup-location get](ark_backup-location_get.md) - Get backup storage locations - diff --git a/docs/cli-reference/ark_backup-location_create.md b/docs/cli-reference/ark_backup-location_create.md deleted file mode 100644 index 0c95dec14..000000000 --- a/docs/cli-reference/ark_backup-location_create.md +++ /dev/null @@ -1,45 +0,0 @@ -## ark backup-location create - -Create a backup storage location - -### Synopsis - -Create a backup storage location - -``` -ark backup-location create NAME [flags] -``` - -### Options - -``` - --bucket string name of the object storage bucket where backups should be stored - --config mapStringString configuration key-value pairs - -h, --help help for create - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the backup storage location - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - --prefix string prefix under which all Ark data should be stored within the bucket. Optional. - --provider string name of the backup storage provider (e.g. aws, azure, gcp) - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup-location](ark_backup-location.md) - Work with backup storage locations - diff --git a/docs/cli-reference/ark_backup-location_get.md b/docs/cli-reference/ark_backup-location_get.md deleted file mode 100644 index accd12369..000000000 --- a/docs/cli-reference/ark_backup-location_get.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark backup-location get - -Get backup storage locations - -### Synopsis - -Get backup storage locations - -``` -ark backup-location get [flags] -``` - -### Options - -``` - -h, --help help for get - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup-location](ark_backup-location.md) - Work with backup storage locations - diff --git a/docs/cli-reference/ark_backup.md b/docs/cli-reference/ark_backup.md deleted file mode 100644 index 64e023ea6..000000000 --- a/docs/cli-reference/ark_backup.md +++ /dev/null @@ -1,39 +0,0 @@ -## ark backup - -Work with backups - -### Synopsis - -Work with backups - -### Options - -``` - -h, --help help for backup -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark backup create](ark_backup_create.md) - Create a backup -* [ark backup delete](ark_backup_delete.md) - Delete backups -* [ark backup describe](ark_backup_describe.md) - Describe backups -* [ark backup download](ark_backup_download.md) - Download a backup -* [ark backup get](ark_backup_get.md) - Get backups -* [ark backup logs](ark_backup_logs.md) - Get backup logs - diff --git a/docs/cli-reference/ark_backup_create.md b/docs/cli-reference/ark_backup_create.md deleted file mode 100644 index 5d85e762c..000000000 --- a/docs/cli-reference/ark_backup_create.md +++ /dev/null @@ -1,51 +0,0 @@ -## ark backup create - -Create a backup - -### Synopsis - -Create a backup - -``` -ark backup create NAME [flags] -``` - -### Options - -``` - --exclude-namespaces stringArray namespaces to exclude from the backup - --exclude-resources stringArray resources to exclude from the backup, formatted as resource.group, such as storageclasses.storage.k8s.io - -h, --help help for create - --include-cluster-resources optionalBool[=true] include cluster-scoped resources in the backup - --include-namespaces stringArray namespaces to include in the backup (use '*' for all namespaces) (default *) - --include-resources stringArray resources to include in the backup, formatted as resource.group, such as storageclasses.storage.k8s.io (use '*' for all resources) - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the backup - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - -l, --selector labelSelector only back up resources matching this label selector (default ) - --show-labels show labels in the last column - --snapshot-volumes optionalBool[=true] take snapshots of PersistentVolumes as part of the backup - --storage-location string location in which to store the backup - --ttl duration how long before the backup can be garbage collected (default 720h0m0s) - -w, --wait wait for the operation to complete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup](ark_backup.md) - Work with backups - diff --git a/docs/cli-reference/ark_backup_delete.md b/docs/cli-reference/ark_backup_delete.md deleted file mode 100644 index d8461aec2..000000000 --- a/docs/cli-reference/ark_backup_delete.md +++ /dev/null @@ -1,60 +0,0 @@ -## ark backup delete - -Delete backups - -### Synopsis - -Delete backups - -``` -ark backup delete [NAMES] [flags] -``` - -### Examples - -``` - # delete a backup named "backup-1" - ark backup delete backup-1 - - # delete a backup named "backup-1" without prompting for confirmation - ark backup delete backup-1 --confirm - - # delete backups named "backup-1" and "backup-2" - ark backup delete backup-1 backup-2 - - # delete all backups triggered by schedule "schedule-1" - ark backup delete --selector ark-schedule=schedule-1 - - # delete all backups - ark backup delete --all - -``` - -### Options - -``` - --all Delete all backups - --confirm Confirm deletion - -h, --help help for delete - -l, --selector labelSelector Delete all backups matching this label selector (default ) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup](ark_backup.md) - Work with backups - diff --git a/docs/cli-reference/ark_backup_describe.md b/docs/cli-reference/ark_backup_describe.md deleted file mode 100644 index e955a7cb5..000000000 --- a/docs/cli-reference/ark_backup_describe.md +++ /dev/null @@ -1,39 +0,0 @@ -## ark backup describe - -Describe backups - -### Synopsis - -Describe backups - -``` -ark backup describe [NAME1] [NAME2] [NAME...] [flags] -``` - -### Options - -``` - -h, --help help for describe - -l, --selector string only show items matching this label selector - --volume-details display details of restic volume backups -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup](ark_backup.md) - Work with backups - diff --git a/docs/cli-reference/ark_backup_download.md b/docs/cli-reference/ark_backup_download.md deleted file mode 100644 index 3aa4137e5..000000000 --- a/docs/cli-reference/ark_backup_download.md +++ /dev/null @@ -1,40 +0,0 @@ -## ark backup download - -Download a backup - -### Synopsis - -Download a backup - -``` -ark backup download NAME [flags] -``` - -### Options - -``` - --force forces the download and will overwrite file if it exists already - -h, --help help for download - -o, --output string path to output file. Defaults to -data.tar.gz in the current directory - --timeout duration maximum time to wait to process download request (default 1m0s) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup](ark_backup.md) - Work with backups - diff --git a/docs/cli-reference/ark_backup_get.md b/docs/cli-reference/ark_backup_get.md deleted file mode 100644 index 311054a3c..000000000 --- a/docs/cli-reference/ark_backup_get.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark backup get - -Get backups - -### Synopsis - -Get backups - -``` -ark backup get [flags] -``` - -### Options - -``` - -h, --help help for get - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup](ark_backup.md) - Work with backups - diff --git a/docs/cli-reference/ark_backup_logs.md b/docs/cli-reference/ark_backup_logs.md deleted file mode 100644 index 0bab21962..000000000 --- a/docs/cli-reference/ark_backup_logs.md +++ /dev/null @@ -1,38 +0,0 @@ -## ark backup logs - -Get backup logs - -### Synopsis - -Get backup logs - -``` -ark backup logs BACKUP [flags] -``` - -### Options - -``` - -h, --help help for logs - --timeout duration how long to wait to receive logs (default 1m0s) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark backup](ark_backup.md) - Work with backups - diff --git a/docs/cli-reference/ark_bug.md b/docs/cli-reference/ark_bug.md deleted file mode 100644 index 007d765e2..000000000 --- a/docs/cli-reference/ark_bug.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark bug - -Report an Ark bug - -### Synopsis - -Open a browser window to report an Ark bug - -``` -ark bug [flags] -``` - -### Options - -``` - -h, --help help for bug -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. - diff --git a/docs/cli-reference/ark_client.md b/docs/cli-reference/ark_client.md deleted file mode 100644 index ddaa20065..000000000 --- a/docs/cli-reference/ark_client.md +++ /dev/null @@ -1,34 +0,0 @@ -## ark client - -Ark client related commands - -### Synopsis - -Ark client related commands - -### Options - -``` - -h, --help help for client -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark client config](ark_client_config.md) - Get and set client configuration file values - diff --git a/docs/cli-reference/ark_client_config.md b/docs/cli-reference/ark_client_config.md deleted file mode 100644 index 4d736be77..000000000 --- a/docs/cli-reference/ark_client_config.md +++ /dev/null @@ -1,35 +0,0 @@ -## ark client config - -Get and set client configuration file values - -### Synopsis - -Get and set client configuration file values - -### Options - -``` - -h, --help help for config -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark client](ark_client.md) - Ark client related commands -* [ark client config get](ark_client_config_get.md) - Get client configuration file values -* [ark client config set](ark_client_config_set.md) - Set client configuration file values - diff --git a/docs/cli-reference/ark_client_config_get.md b/docs/cli-reference/ark_client_config_get.md deleted file mode 100644 index c7b7e24f7..000000000 --- a/docs/cli-reference/ark_client_config_get.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark client config get - -Get client configuration file values - -### Synopsis - -Get client configuration file values - -``` -ark client config get [KEY 1] [KEY 2] [...] [flags] -``` - -### Options - -``` - -h, --help help for get -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark client config](ark_client_config.md) - Get and set client configuration file values - diff --git a/docs/cli-reference/ark_client_config_set.md b/docs/cli-reference/ark_client_config_set.md deleted file mode 100644 index 588d71a05..000000000 --- a/docs/cli-reference/ark_client_config_set.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark client config set - -Set client configuration file values - -### Synopsis - -Set client configuration file values - -``` -ark client config set KEY=VALUE [KEY=VALUE]... [flags] -``` - -### Options - -``` - -h, --help help for set -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark client config](ark_client_config.md) - Get and set client configuration file values - diff --git a/docs/cli-reference/ark_completion.md b/docs/cli-reference/ark_completion.md deleted file mode 100644 index b4bb0864b..000000000 --- a/docs/cli-reference/ark_completion.md +++ /dev/null @@ -1,46 +0,0 @@ -## ark completion - -Output shell completion code for the specified shell (bash or zsh) - -### Synopsis - -Generate shell completion code. - -Auto completion supports both bash and zsh. Output is to STDOUT. - -Load the ark completion code for bash into the current shell - -source <(ark completion bash) - -Load the ark completion code for zsh into the current shell - -source <(ark completion zsh) - - -``` -ark completion SHELL [flags] -``` - -### Options - -``` - -h, --help help for completion -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. - diff --git a/docs/cli-reference/ark_create.md b/docs/cli-reference/ark_create.md deleted file mode 100644 index 3728cde9b..000000000 --- a/docs/cli-reference/ark_create.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark create - -Create ark resources - -### Synopsis - -Create ark resources - -### Options - -``` - -h, --help help for create -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark create backup](ark_create_backup.md) - Create a backup -* [ark create backup-location](ark_create_backup-location.md) - Create a backup storage location -* [ark create restore](ark_create_restore.md) - Create a restore -* [ark create schedule](ark_create_schedule.md) - Create a schedule - diff --git a/docs/cli-reference/ark_create_backup-location.md b/docs/cli-reference/ark_create_backup-location.md deleted file mode 100644 index fae6d80b9..000000000 --- a/docs/cli-reference/ark_create_backup-location.md +++ /dev/null @@ -1,45 +0,0 @@ -## ark create backup-location - -Create a backup storage location - -### Synopsis - -Create a backup storage location - -``` -ark create backup-location NAME [flags] -``` - -### Options - -``` - --bucket string name of the object storage bucket where backups should be stored - --config mapStringString configuration key-value pairs - -h, --help help for backup-location - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the backup storage location - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - --prefix string prefix under which all Ark data should be stored within the bucket. Optional. - --provider string name of the backup storage provider (e.g. aws, azure, gcp) - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark create](ark_create.md) - Create ark resources - diff --git a/docs/cli-reference/ark_create_backup.md b/docs/cli-reference/ark_create_backup.md deleted file mode 100644 index 3b6ddc3f7..000000000 --- a/docs/cli-reference/ark_create_backup.md +++ /dev/null @@ -1,51 +0,0 @@ -## ark create backup - -Create a backup - -### Synopsis - -Create a backup - -``` -ark create backup NAME [flags] -``` - -### Options - -``` - --exclude-namespaces stringArray namespaces to exclude from the backup - --exclude-resources stringArray resources to exclude from the backup, formatted as resource.group, such as storageclasses.storage.k8s.io - -h, --help help for backup - --include-cluster-resources optionalBool[=true] include cluster-scoped resources in the backup - --include-namespaces stringArray namespaces to include in the backup (use '*' for all namespaces) (default *) - --include-resources stringArray resources to include in the backup, formatted as resource.group, such as storageclasses.storage.k8s.io (use '*' for all resources) - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the backup - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - -l, --selector labelSelector only back up resources matching this label selector (default ) - --show-labels show labels in the last column - --snapshot-volumes optionalBool[=true] take snapshots of PersistentVolumes as part of the backup - --storage-location string location in which to store the backup - --ttl duration how long before the backup can be garbage collected (default 720h0m0s) - -w, --wait wait for the operation to complete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark create](ark_create.md) - Create ark resources - diff --git a/docs/cli-reference/ark_create_restore.md b/docs/cli-reference/ark_create_restore.md deleted file mode 100644 index 7276a391e..000000000 --- a/docs/cli-reference/ark_create_restore.md +++ /dev/null @@ -1,66 +0,0 @@ -## ark create restore - -Create a restore - -### Synopsis - -Create a restore - -``` -ark create restore [RESTORE_NAME] [--from-backup BACKUP_NAME | --from-schedule SCHEDULE_NAME] [flags] -``` - -### Examples - -``` - # create a restore named "restore-1" from backup "backup-1" - ark restore create restore-1 --from-backup backup-1 - - # create a restore with a default name ("backup-1-") from backup "backup-1" - ark restore create --from-backup backup-1 - - # create a restore from the latest successful backup triggered by schedule "schedule-1" - ark restore create --from-schedule schedule-1 - -``` - -### Options - -``` - --exclude-namespaces stringArray namespaces to exclude from the restore - --exclude-resources stringArray resources to exclude from the restore, formatted as resource.group, such as storageclasses.storage.k8s.io - --from-backup string backup to restore from - --from-schedule string schedule to restore from - -h, --help help for restore - --include-cluster-resources optionalBool[=true] include cluster-scoped resources in the restore - --include-namespaces stringArray namespaces to include in the restore (use '*' for all namespaces) (default *) - --include-resources stringArray resources to include in the restore, formatted as resource.group, such as storageclasses.storage.k8s.io (use '*' for all resources) - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the restore - --namespace-mappings mapStringString namespace mappings from name in the backup to desired restored name in the form src1:dst1,src2:dst2,... - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - --restore-volumes optionalBool[=true] whether to restore volumes from snapshots - -l, --selector labelSelector only restore resources matching this label selector (default ) - --show-labels show labels in the last column - -w, --wait wait for the operation to complete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark create](ark_create.md) - Create ark resources - diff --git a/docs/cli-reference/ark_create_schedule.md b/docs/cli-reference/ark_create_schedule.md deleted file mode 100644 index 7098e8df7..000000000 --- a/docs/cli-reference/ark_create_schedule.md +++ /dev/null @@ -1,65 +0,0 @@ -## ark create schedule - -Create a schedule - -### Synopsis - -The --schedule flag is required, in cron notation: - -| Character Position | Character Period | Acceptable Values | -| -------------------|:----------------:| -----------------:| -| 1 | Minute | 0-59,* | -| 2 | Hour | 0-23,* | -| 3 | Day of Month | 1-31,* | -| 4 | Month | 1-12,* | -| 5 | Day of Week | 0-7,* | - -``` -ark create schedule NAME --schedule [flags] -``` - -### Examples - -``` -ark create schedule NAME --schedule="0 */6 * * *" -``` - -### Options - -``` - --exclude-namespaces stringArray namespaces to exclude from the backup - --exclude-resources stringArray resources to exclude from the backup, formatted as resource.group, such as storageclasses.storage.k8s.io - -h, --help help for schedule - --include-cluster-resources optionalBool[=true] include cluster-scoped resources in the backup - --include-namespaces stringArray namespaces to include in the backup (use '*' for all namespaces) (default *) - --include-resources stringArray resources to include in the backup, formatted as resource.group, such as storageclasses.storage.k8s.io (use '*' for all resources) - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the backup - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - --schedule string a cron expression specifying a recurring schedule for this backup to run - -l, --selector labelSelector only back up resources matching this label selector (default ) - --show-labels show labels in the last column - --snapshot-volumes optionalBool[=true] take snapshots of PersistentVolumes as part of the backup - --storage-location string location in which to store the backup - --ttl duration how long before the backup can be garbage collected (default 720h0m0s) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark create](ark_create.md) - Create ark resources - diff --git a/docs/cli-reference/ark_delete.md b/docs/cli-reference/ark_delete.md deleted file mode 100644 index c1e0dc01e..000000000 --- a/docs/cli-reference/ark_delete.md +++ /dev/null @@ -1,36 +0,0 @@ -## ark delete - -Delete ark resources - -### Synopsis - -Delete ark resources - -### Options - -``` - -h, --help help for delete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark delete backup](ark_delete_backup.md) - Delete backups -* [ark delete restore](ark_delete_restore.md) - Delete a restore -* [ark delete schedule](ark_delete_schedule.md) - Delete a schedule - diff --git a/docs/cli-reference/ark_delete_backup.md b/docs/cli-reference/ark_delete_backup.md deleted file mode 100644 index 15b79dea8..000000000 --- a/docs/cli-reference/ark_delete_backup.md +++ /dev/null @@ -1,60 +0,0 @@ -## ark delete backup - -Delete backups - -### Synopsis - -Delete backups - -``` -ark delete backup [NAMES] [flags] -``` - -### Examples - -``` - # delete a backup named "backup-1" - ark backup delete backup-1 - - # delete a backup named "backup-1" without prompting for confirmation - ark backup delete backup-1 --confirm - - # delete backups named "backup-1" and "backup-2" - ark backup delete backup-1 backup-2 - - # delete all backups triggered by schedule "schedule-1" - ark backup delete --selector ark-schedule=schedule-1 - - # delete all backups - ark backup delete --all - -``` - -### Options - -``` - --all Delete all backups - --confirm Confirm deletion - -h, --help help for backup - -l, --selector labelSelector Delete all backups matching this label selector (default ) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark delete](ark_delete.md) - Delete ark resources - diff --git a/docs/cli-reference/ark_delete_restore.md b/docs/cli-reference/ark_delete_restore.md deleted file mode 100644 index 0d20436fb..000000000 --- a/docs/cli-reference/ark_delete_restore.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark delete restore - -Delete a restore - -### Synopsis - -Delete a restore - -``` -ark delete restore NAME [flags] -``` - -### Options - -``` - -h, --help help for restore -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark delete](ark_delete.md) - Delete ark resources - diff --git a/docs/cli-reference/ark_delete_schedule.md b/docs/cli-reference/ark_delete_schedule.md deleted file mode 100644 index f59548160..000000000 --- a/docs/cli-reference/ark_delete_schedule.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark delete schedule - -Delete a schedule - -### Synopsis - -Delete a schedule - -``` -ark delete schedule NAME [flags] -``` - -### Options - -``` - -h, --help help for schedule -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark delete](ark_delete.md) - Delete ark resources - diff --git a/docs/cli-reference/ark_describe.md b/docs/cli-reference/ark_describe.md deleted file mode 100644 index 1f4d9d163..000000000 --- a/docs/cli-reference/ark_describe.md +++ /dev/null @@ -1,36 +0,0 @@ -## ark describe - -Describe ark resources - -### Synopsis - -Describe ark resources - -### Options - -``` - -h, --help help for describe -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark describe backups](ark_describe_backups.md) - Describe backups -* [ark describe restores](ark_describe_restores.md) - Describe restores -* [ark describe schedules](ark_describe_schedules.md) - Describe schedules - diff --git a/docs/cli-reference/ark_describe_backups.md b/docs/cli-reference/ark_describe_backups.md deleted file mode 100644 index a08cf730d..000000000 --- a/docs/cli-reference/ark_describe_backups.md +++ /dev/null @@ -1,39 +0,0 @@ -## ark describe backups - -Describe backups - -### Synopsis - -Describe backups - -``` -ark describe backups [NAME1] [NAME2] [NAME...] [flags] -``` - -### Options - -``` - -h, --help help for backups - -l, --selector string only show items matching this label selector - --volume-details display details of restic volume backups -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark describe](ark_describe.md) - Describe ark resources - diff --git a/docs/cli-reference/ark_describe_restores.md b/docs/cli-reference/ark_describe_restores.md deleted file mode 100644 index f105525bb..000000000 --- a/docs/cli-reference/ark_describe_restores.md +++ /dev/null @@ -1,39 +0,0 @@ -## ark describe restores - -Describe restores - -### Synopsis - -Describe restores - -``` -ark describe restores [NAME1] [NAME2] [NAME...] [flags] -``` - -### Options - -``` - -h, --help help for restores - -l, --selector string only show items matching this label selector - --volume-details display details of restic volume restores -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark describe](ark_describe.md) - Describe ark resources - diff --git a/docs/cli-reference/ark_describe_schedules.md b/docs/cli-reference/ark_describe_schedules.md deleted file mode 100644 index 81432b64a..000000000 --- a/docs/cli-reference/ark_describe_schedules.md +++ /dev/null @@ -1,38 +0,0 @@ -## ark describe schedules - -Describe schedules - -### Synopsis - -Describe schedules - -``` -ark describe schedules [NAME1] [NAME2] [NAME...] [flags] -``` - -### Options - -``` - -h, --help help for schedules - -l, --selector string only show items matching this label selector -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark describe](ark_describe.md) - Describe ark resources - diff --git a/docs/cli-reference/ark_get.md b/docs/cli-reference/ark_get.md deleted file mode 100644 index 2a30ff03b..000000000 --- a/docs/cli-reference/ark_get.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark get - -Get ark resources - -### Synopsis - -Get ark resources - -### Options - -``` - -h, --help help for get -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark get backup-locations](ark_get_backup-locations.md) - Get backup storage locations -* [ark get backups](ark_get_backups.md) - Get backups -* [ark get restores](ark_get_restores.md) - Get restores -* [ark get schedules](ark_get_schedules.md) - Get schedules - diff --git a/docs/cli-reference/ark_get_backup-locations.md b/docs/cli-reference/ark_get_backup-locations.md deleted file mode 100644 index cb5fe7a30..000000000 --- a/docs/cli-reference/ark_get_backup-locations.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark get backup-locations - -Get backup storage locations - -### Synopsis - -Get backup storage locations - -``` -ark get backup-locations [flags] -``` - -### Options - -``` - -h, --help help for backup-locations - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark get](ark_get.md) - Get ark resources - diff --git a/docs/cli-reference/ark_get_backups.md b/docs/cli-reference/ark_get_backups.md deleted file mode 100644 index 9f7310c75..000000000 --- a/docs/cli-reference/ark_get_backups.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark get backups - -Get backups - -### Synopsis - -Get backups - -``` -ark get backups [flags] -``` - -### Options - -``` - -h, --help help for backups - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark get](ark_get.md) - Get ark resources - diff --git a/docs/cli-reference/ark_get_restores.md b/docs/cli-reference/ark_get_restores.md deleted file mode 100644 index 27d649786..000000000 --- a/docs/cli-reference/ark_get_restores.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark get restores - -Get restores - -### Synopsis - -Get restores - -``` -ark get restores [flags] -``` - -### Options - -``` - -h, --help help for restores - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark get](ark_get.md) - Get ark resources - diff --git a/docs/cli-reference/ark_get_schedules.md b/docs/cli-reference/ark_get_schedules.md deleted file mode 100644 index d9250499e..000000000 --- a/docs/cli-reference/ark_get_schedules.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark get schedules - -Get schedules - -### Synopsis - -Get schedules - -``` -ark get schedules [flags] -``` - -### Options - -``` - -h, --help help for schedules - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark get](ark_get.md) - Get ark resources - diff --git a/docs/cli-reference/ark_plugin.md b/docs/cli-reference/ark_plugin.md deleted file mode 100644 index a7eb5f72e..000000000 --- a/docs/cli-reference/ark_plugin.md +++ /dev/null @@ -1,35 +0,0 @@ -## ark plugin - -Work with plugins - -### Synopsis - -Work with plugins - -### Options - -``` - -h, --help help for plugin -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark plugin add](ark_plugin_add.md) - Add a plugin -* [ark plugin remove](ark_plugin_remove.md) - Remove a plugin - diff --git a/docs/cli-reference/ark_plugin_add.md b/docs/cli-reference/ark_plugin_add.md deleted file mode 100644 index 081edf5a6..000000000 --- a/docs/cli-reference/ark_plugin_add.md +++ /dev/null @@ -1,38 +0,0 @@ -## ark plugin add - -Add a plugin - -### Synopsis - -Add a plugin - -``` -ark plugin add IMAGE [flags] -``` - -### Options - -``` - -h, --help help for add - --image-pull-policy the imagePullPolicy for the plugin container. Valid values are Always, IfNotPresent, Never. (default IfNotPresent) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark plugin](ark_plugin.md) - Work with plugins - diff --git a/docs/cli-reference/ark_plugin_remove.md b/docs/cli-reference/ark_plugin_remove.md deleted file mode 100644 index a8de066d2..000000000 --- a/docs/cli-reference/ark_plugin_remove.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark plugin remove - -Remove a plugin - -### Synopsis - -Remove a plugin - -``` -ark plugin remove [NAME | IMAGE] [flags] -``` - -### Options - -``` - -h, --help help for remove -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark plugin](ark_plugin.md) - Work with plugins - diff --git a/docs/cli-reference/ark_restic.md b/docs/cli-reference/ark_restic.md deleted file mode 100644 index ff64eb1dc..000000000 --- a/docs/cli-reference/ark_restic.md +++ /dev/null @@ -1,35 +0,0 @@ -## ark restic - -Work with restic - -### Synopsis - -Work with restic - -### Options - -``` - -h, --help help for restic -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark restic repo](ark_restic_repo.md) - Work with restic repositories -* [ark restic server](ark_restic_server.md) - Run the ark restic server - diff --git a/docs/cli-reference/ark_restic_repo.md b/docs/cli-reference/ark_restic_repo.md deleted file mode 100644 index a05b19a26..000000000 --- a/docs/cli-reference/ark_restic_repo.md +++ /dev/null @@ -1,34 +0,0 @@ -## ark restic repo - -Work with restic repositories - -### Synopsis - -Work with restic repositories - -### Options - -``` - -h, --help help for repo -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restic](ark_restic.md) - Work with restic -* [ark restic repo get](ark_restic_repo_get.md) - Get restic repositories - diff --git a/docs/cli-reference/ark_restic_repo_get.md b/docs/cli-reference/ark_restic_repo_get.md deleted file mode 100644 index ce59028f4..000000000 --- a/docs/cli-reference/ark_restic_repo_get.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark restic repo get - -Get restic repositories - -### Synopsis - -Get restic repositories - -``` -ark restic repo get [flags] -``` - -### Options - -``` - -h, --help help for get - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restic repo](ark_restic_repo.md) - Work with restic repositories - diff --git a/docs/cli-reference/ark_restic_server.md b/docs/cli-reference/ark_restic_server.md deleted file mode 100644 index 734f02459..000000000 --- a/docs/cli-reference/ark_restic_server.md +++ /dev/null @@ -1,39 +0,0 @@ -## ark restic server - -Run the ark restic server - -### Synopsis - -Run the ark restic server - -``` -ark restic server [flags] -``` - -### Options - -``` - --default-backup-storage-location string name of the default backup storage location (default "default") - -h, --help help for server - --log-level the level at which to log. Valid values are debug, info, warning, error, fatal, panic. (default info) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restic](ark_restic.md) - Work with restic - diff --git a/docs/cli-reference/ark_restore.md b/docs/cli-reference/ark_restore.md deleted file mode 100644 index ed365161d..000000000 --- a/docs/cli-reference/ark_restore.md +++ /dev/null @@ -1,38 +0,0 @@ -## ark restore - -Work with restores - -### Synopsis - -Work with restores - -### Options - -``` - -h, --help help for restore -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark restore create](ark_restore_create.md) - Create a restore -* [ark restore delete](ark_restore_delete.md) - Delete a restore -* [ark restore describe](ark_restore_describe.md) - Describe restores -* [ark restore get](ark_restore_get.md) - Get restores -* [ark restore logs](ark_restore_logs.md) - Get restore logs - diff --git a/docs/cli-reference/ark_restore_create.md b/docs/cli-reference/ark_restore_create.md deleted file mode 100644 index 37a352dd2..000000000 --- a/docs/cli-reference/ark_restore_create.md +++ /dev/null @@ -1,66 +0,0 @@ -## ark restore create - -Create a restore - -### Synopsis - -Create a restore - -``` -ark restore create [RESTORE_NAME] [--from-backup BACKUP_NAME | --from-schedule SCHEDULE_NAME] [flags] -``` - -### Examples - -``` - # create a restore named "restore-1" from backup "backup-1" - ark restore create restore-1 --from-backup backup-1 - - # create a restore with a default name ("backup-1-") from backup "backup-1" - ark restore create --from-backup backup-1 - - # create a restore from the latest successful backup triggered by schedule "schedule-1" - ark restore create --from-schedule schedule-1 - -``` - -### Options - -``` - --exclude-namespaces stringArray namespaces to exclude from the restore - --exclude-resources stringArray resources to exclude from the restore, formatted as resource.group, such as storageclasses.storage.k8s.io - --from-backup string backup to restore from - --from-schedule string schedule to restore from - -h, --help help for create - --include-cluster-resources optionalBool[=true] include cluster-scoped resources in the restore - --include-namespaces stringArray namespaces to include in the restore (use '*' for all namespaces) (default *) - --include-resources stringArray resources to include in the restore, formatted as resource.group, such as storageclasses.storage.k8s.io (use '*' for all resources) - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the restore - --namespace-mappings mapStringString namespace mappings from name in the backup to desired restored name in the form src1:dst1,src2:dst2,... - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - --restore-volumes optionalBool[=true] whether to restore volumes from snapshots - -l, --selector labelSelector only restore resources matching this label selector (default ) - --show-labels show labels in the last column - -w, --wait wait for the operation to complete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restore](ark_restore.md) - Work with restores - diff --git a/docs/cli-reference/ark_restore_delete.md b/docs/cli-reference/ark_restore_delete.md deleted file mode 100644 index ad827b77b..000000000 --- a/docs/cli-reference/ark_restore_delete.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark restore delete - -Delete a restore - -### Synopsis - -Delete a restore - -``` -ark restore delete NAME [flags] -``` - -### Options - -``` - -h, --help help for delete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restore](ark_restore.md) - Work with restores - diff --git a/docs/cli-reference/ark_restore_describe.md b/docs/cli-reference/ark_restore_describe.md deleted file mode 100644 index fa56535b6..000000000 --- a/docs/cli-reference/ark_restore_describe.md +++ /dev/null @@ -1,39 +0,0 @@ -## ark restore describe - -Describe restores - -### Synopsis - -Describe restores - -``` -ark restore describe [NAME1] [NAME2] [NAME...] [flags] -``` - -### Options - -``` - -h, --help help for describe - -l, --selector string only show items matching this label selector - --volume-details display details of restic volume restores -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restore](ark_restore.md) - Work with restores - diff --git a/docs/cli-reference/ark_restore_get.md b/docs/cli-reference/ark_restore_get.md deleted file mode 100644 index 91ebfb7cb..000000000 --- a/docs/cli-reference/ark_restore_get.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark restore get - -Get restores - -### Synopsis - -Get restores - -``` -ark restore get [flags] -``` - -### Options - -``` - -h, --help help for get - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restore](ark_restore.md) - Work with restores - diff --git a/docs/cli-reference/ark_restore_logs.md b/docs/cli-reference/ark_restore_logs.md deleted file mode 100644 index 25426047b..000000000 --- a/docs/cli-reference/ark_restore_logs.md +++ /dev/null @@ -1,38 +0,0 @@ -## ark restore logs - -Get restore logs - -### Synopsis - -Get restore logs - -``` -ark restore logs RESTORE [flags] -``` - -### Options - -``` - -h, --help help for logs - --timeout duration how long to wait to receive logs (default 1m0s) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark restore](ark_restore.md) - Work with restores - diff --git a/docs/cli-reference/ark_schedule.md b/docs/cli-reference/ark_schedule.md deleted file mode 100644 index f4976a446..000000000 --- a/docs/cli-reference/ark_schedule.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark schedule - -Work with schedules - -### Synopsis - -Work with schedules - -### Options - -``` - -h, --help help for schedule -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. -* [ark schedule create](ark_schedule_create.md) - Create a schedule -* [ark schedule delete](ark_schedule_delete.md) - Delete a schedule -* [ark schedule describe](ark_schedule_describe.md) - Describe schedules -* [ark schedule get](ark_schedule_get.md) - Get schedules - diff --git a/docs/cli-reference/ark_schedule_create.md b/docs/cli-reference/ark_schedule_create.md deleted file mode 100644 index 241398d07..000000000 --- a/docs/cli-reference/ark_schedule_create.md +++ /dev/null @@ -1,65 +0,0 @@ -## ark schedule create - -Create a schedule - -### Synopsis - -The --schedule flag is required, in cron notation: - -| Character Position | Character Period | Acceptable Values | -| -------------------|:----------------:| -----------------:| -| 1 | Minute | 0-59,* | -| 2 | Hour | 0-23,* | -| 3 | Day of Month | 1-31,* | -| 4 | Month | 1-12,* | -| 5 | Day of Week | 0-7,* | - -``` -ark schedule create NAME --schedule [flags] -``` - -### Examples - -``` -ark create schedule NAME --schedule="0 */6 * * *" -``` - -### Options - -``` - --exclude-namespaces stringArray namespaces to exclude from the backup - --exclude-resources stringArray resources to exclude from the backup, formatted as resource.group, such as storageclasses.storage.k8s.io - -h, --help help for create - --include-cluster-resources optionalBool[=true] include cluster-scoped resources in the backup - --include-namespaces stringArray namespaces to include in the backup (use '*' for all namespaces) (default *) - --include-resources stringArray resources to include in the backup, formatted as resource.group, such as storageclasses.storage.k8s.io (use '*' for all resources) - --label-columns stringArray a comma-separated list of labels to be displayed as columns - --labels mapStringString labels to apply to the backup - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. - --schedule string a cron expression specifying a recurring schedule for this backup to run - -l, --selector labelSelector only back up resources matching this label selector (default ) - --show-labels show labels in the last column - --snapshot-volumes optionalBool[=true] take snapshots of PersistentVolumes as part of the backup - --storage-location string location in which to store the backup - --ttl duration how long before the backup can be garbage collected (default 720h0m0s) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark schedule](ark_schedule.md) - Work with schedules - diff --git a/docs/cli-reference/ark_schedule_delete.md b/docs/cli-reference/ark_schedule_delete.md deleted file mode 100644 index 78d4b20c9..000000000 --- a/docs/cli-reference/ark_schedule_delete.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark schedule delete - -Delete a schedule - -### Synopsis - -Delete a schedule - -``` -ark schedule delete NAME [flags] -``` - -### Options - -``` - -h, --help help for delete -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark schedule](ark_schedule.md) - Work with schedules - diff --git a/docs/cli-reference/ark_schedule_describe.md b/docs/cli-reference/ark_schedule_describe.md deleted file mode 100644 index e9b9cd273..000000000 --- a/docs/cli-reference/ark_schedule_describe.md +++ /dev/null @@ -1,38 +0,0 @@ -## ark schedule describe - -Describe schedules - -### Synopsis - -Describe schedules - -``` -ark schedule describe [NAME1] [NAME2] [NAME...] [flags] -``` - -### Options - -``` - -h, --help help for describe - -l, --selector string only show items matching this label selector -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark schedule](ark_schedule.md) - Work with schedules - diff --git a/docs/cli-reference/ark_schedule_get.md b/docs/cli-reference/ark_schedule_get.md deleted file mode 100644 index 9c5178d9b..000000000 --- a/docs/cli-reference/ark_schedule_get.md +++ /dev/null @@ -1,41 +0,0 @@ -## ark schedule get - -Get schedules - -### Synopsis - -Get schedules - -``` -ark schedule get [flags] -``` - -### Options - -``` - -h, --help help for get - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark schedule](ark_schedule.md) - Work with schedules - diff --git a/docs/cli-reference/ark_server.md b/docs/cli-reference/ark_server.md deleted file mode 100644 index 0674f1fd7..000000000 --- a/docs/cli-reference/ark_server.md +++ /dev/null @@ -1,45 +0,0 @@ -## ark server - -Run the ark server - -### Synopsis - -Run the ark server - -``` -ark server [flags] -``` - -### Options - -``` - --backup-sync-period duration how often to ensure all Ark backups in object storage exist as Backup API objects in the cluster (default 1h0m0s) - --default-backup-storage-location string name of the default backup storage location (default "default") - -h, --help help for server - --log-level the level at which to log. Valid values are debug, info, warning, error, fatal, panic. (default info) - --metrics-address string the address to expose prometheus metrics (default ":8085") - --plugin-dir string directory containing Ark plugins (default "/plugins") - --restic-timeout duration how long backups/restores of pod volumes should be allowed to run before timing out (default 1h0m0s) - --restore-only run in a mode where only restores are allowed; backups, schedules, and garbage-collection are all disabled - --restore-resource-priorities strings desired order of resource restores; any resource not in the list will be restored alphabetically after the prioritized resources (default [namespaces,persistentvolumes,persistentvolumeclaims,secrets,configmaps,serviceaccounts,limitranges,pods]) -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. - diff --git a/docs/cli-reference/ark_version.md b/docs/cli-reference/ark_version.md deleted file mode 100644 index 02d7e0689..000000000 --- a/docs/cli-reference/ark_version.md +++ /dev/null @@ -1,37 +0,0 @@ -## ark version - -Print the ark version and associated image - -### Synopsis - -Print the ark version and associated image - -``` -ark version [flags] -``` - -### Options - -``` - -h, --help help for version -``` - -### Options inherited from parent commands - -``` - --alsologtostderr log to standard error as well as files - --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration - --kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context) - --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) - --log_dir string If non-empty, write log files in this directory - --logtostderr log to standard error instead of files - -n, --namespace string The namespace in which Ark should operate (default "heptio-ark") - --stderrthreshold severity logs at or above this threshold go to stderr (default 2) - -v, --v Level log level for V logs - --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging -``` - -### SEE ALSO - -* [ark](ark.md) - Back up and restore Kubernetes cluster resources. - diff --git a/hack/update-generated-docs.sh b/hack/update-generated-docs.sh deleted file mode 100755 index 7bc5df7f9..000000000 --- a/hack/update-generated-docs.sh +++ /dev/null @@ -1,37 +0,0 @@ -#!/bin/bash -e -# -# Copyright 2017 the Heptio Ark contributors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -ARK_ROOT=$(dirname ${BASH_SOURCE})/.. -BIN=${ARK_ROOT}/_output/bin -mkdir -p ${BIN} - -echo "Updating generated docs" - -go build -o ${BIN}/docs-gen ./docs/generate/ark.go - -if [[ $# -gt 1 ]]; then - echo "usage: ${BASH_SOURCE} [DIRECTORY]" - exit 1 -fi - -OUTPUT_DIR="$@" -if [[ -z "${OUTPUT_DIR}" ]]; then - OUTPUT_DIR=${ARK_ROOT}/docs/cli-reference -fi - -${BIN}/docs-gen ark ${OUTPUT_DIR} - -echo "Success!" diff --git a/hack/verify-generated-docs.sh b/hack/verify-generated-docs.sh deleted file mode 100755 index dfb2ec58b..000000000 --- a/hack/verify-generated-docs.sh +++ /dev/null @@ -1,41 +0,0 @@ -#!/bin/bash -e -# -# Copyright 2017 the Heptio Ark contributors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -ARK_ROOT=$(dirname ${BASH_SOURCE})/.. -HACK_DIR=$(dirname "${BASH_SOURCE}") -DOCS_DIR=${ARK_ROOT}/docs/cli-reference -TMP_DIR="$(mktemp -d)" - -trap cleanup INT TERM HUP EXIT - -cleanup() { - rm -rf ${TMP_DIR} -} - -echo "Verifying generated docs" - -${HACK_DIR}/update-generated-docs.sh ${TMP_DIR} > /dev/null - -exclude_file="README.md" -output=$(echo "`diff -r ${DOCS_DIR} ${TMP_DIR}`" | sed "/${exclude_file}/d") - -if [[ -n "${output}" ]] ; then - echo "FAILURE: verification of docs failed:" - echo "${output}" - exit 1 -fi - -echo "Success!"