Initial commit

Signed-off-by: Andy Goldstein <andy.goldstein@gmail.com>

docs/cli-reference/README.md

@@ -0,0 +1,21 @@
+# Command line reference
+
+The Ark client provides a CLI that allows you to initiate ad-hoc backups, scheduled backups, or restores.
+
+*The files in this directory enumerate each of the possible `ark` commands and their flags. Note that you can also find this info with the CLI itself, using the `--help` flag.*
+
+## Running the client
+
+While it is possible to build and run the `ark` executable yourself, it is recommended to use the containerized version. Use the alias described in the quickstart:
+
+```
+alias ark='docker run --rm -v $(dirname $KUBECONFIG):/kubeconfig -e KUBECONFIG=/kubeconfig/$(basename $KUBECONFIG) gcr.io/heptio-images/ark:latest'
+```
+
+Assuming that your `KUBECONFIG` variable is set, this alias takes care of specifying the appropriate Kubernetes cluster credentials for you.
+
+## 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

docs/cli-reference/ark.md

@@ -0,0 +1,32 @@
+## 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.
+
+### Options
+
+```
+      --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
+      --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
+      --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 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
+

docs/cli-reference/ark_backup.md

@@ -0,0 +1,27 @@
+## ark backup
+
+Work with backups
+
+### Synopsis
+
+
+Work with 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
+      --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
+      --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 get](ark_backup_get.md)	 - Get backups
+

docs/cli-reference/ark_backup_create.md

@@ -0,0 +1,45 @@
+## ark backup create
+
+Create a backup
+
+### Synopsis
+
+
+Create a backup
+
+```
+ark backup create NAME
+```
+
+### 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
+      --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 <none>)
+      --show-labels                      show labels in the last column
+      --snapshot-volumes                 take snapshots of PersistentVolumes as part of the backup
+      --ttl duration                     how long before the backup can be garbage collected (default 24h0m0s)
+```
+
+### 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
+      --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
+      --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
+

docs/cli-reference/ark_backup_get.md

@@ -0,0 +1,38 @@
+## ark backup get
+
+Get backups
+
+### Synopsis
+
+
+Get backups
+
+```
+ark backup get
+```
+
+### Options
+
+```
+      --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
+      --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
+      --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
+

docs/cli-reference/ark_restore.md

@@ -0,0 +1,28 @@
+## ark restore
+
+Work with restores
+
+### Synopsis
+
+
+Work with 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
+      --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
+      --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 get](ark_restore_get.md)	 - get restores
+

docs/cli-reference/ark_restore_create.md

@@ -0,0 +1,42 @@
+## ark restore create
+
+Create a restore
+
+### Synopsis
+
+
+Create a restore
+
+```
+ark restore create BACKUP
+```
+
+### Options
+
+```
+      --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,...
+      --namespaces stringArray               comma-separated list of namespaces to restore
+  -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                      whether to restore volumes from snapshots
+  -l, --selector labelSelector               only restore resources matching this label selector (default <none>)
+      --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
+      --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
+      --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
+

docs/cli-reference/ark_restore_delete.md

@@ -0,0 +1,29 @@
+## ark restore delete
+
+Delete a restore
+
+### Synopsis
+
+
+Delete a restore
+
+```
+ark restore delete NAME
+```
+
+### 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
+      --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
+      --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
+

docs/cli-reference/ark_restore_get.md

@@ -0,0 +1,38 @@
+## ark restore get
+
+get restores
+
+### Synopsis
+
+
+get restores
+
+```
+ark restore get
+```
+
+### Options
+
+```
+      --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
+      --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
+      --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
+

docs/cli-reference/ark_schedule.md

@@ -0,0 +1,28 @@
+## ark schedule
+
+Work with schedules
+
+### Synopsis
+
+
+Work with schedules
+
+### 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
+      --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
+      --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 get](ark_schedule_get.md)	 - Get schedules
+

docs/cli-reference/ark_schedule_create.md

@@ -0,0 +1,46 @@
+## ark schedule create
+
+Create a schedule
+
+### Synopsis
+
+
+Create a schedule
+
+```
+ark schedule create NAME
+```
+
+### 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
+      --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 <none>)
+      --show-labels                      show labels in the last column
+      --snapshot-volumes                 take snapshots of PersistentVolumes as part of the backup
+      --ttl duration                     how long before the backup can be garbage collected (default 24h0m0s)
+```
+
+### 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
+      --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
+      --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
+

docs/cli-reference/ark_schedule_delete.md

@@ -0,0 +1,29 @@
+## ark schedule delete
+
+Delete a schedule
+
+### Synopsis
+
+
+Delete a schedule
+
+```
+ark schedule delete NAME
+```
+
+### 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
+      --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
+      --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
+

docs/cli-reference/ark_schedule_get.md

@@ -0,0 +1,38 @@
+## ark schedule get
+
+Get schedules
+
+### Synopsis
+
+
+Get schedules
+
+```
+ark schedule get
+```
+
+### Options
+
+```
+      --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
+      --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
+      --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
+

docs/cli-reference/ark_server.md

@@ -0,0 +1,34 @@
+## ark server
+
+Run the ark server
+
+### Synopsis
+
+
+Run the ark server
+
+```
+ark server
+```
+
+### Options
+
+```
+      --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
+```
+
+### Options inherited from parent commands
+
+```
+      --alsologtostderr                  log to standard error as well as files
+      --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
+      --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.
+

docs/cli-reference/ark_version.md

@@ -0,0 +1,29 @@
+## ark version
+
+Print the ark version and associated image
+
+### Synopsis
+
+
+Print the ark version and associated image
+
+```
+ark 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
+      --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
+      --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.
+