vmware-tanzu
/
velero
mirror of https://github.com/vmware-tanzu/velero.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
velero/docs/cli-reference
History
Steve Kriss 995050390c add plugin add/remove commands 
Signed-off-by: Steve Kriss <steve@heptio.com>
 		2017-11-29 12:22:30 -08:00
..
README.md Run ark client container as the active user 2017-08-04 11:30:07 -06:00
ark.md add plugin add/remove commands 2017-11-29 12:22:30 -08:00
ark_backup.md Regen docs 2017-11-27 15:22:35 -05:00
ark_backup_create.md Update default TTL to 30 days 2017-11-14 17:03:30 -05:00
ark_backup_describe.md Regen docs 2017-11-27 15:22:35 -05:00
ark_backup_download.md make update 2017-09-13 09:51:40 -04:00
ark_backup_get.md Renerate files 2017-09-11 15:40:48 -04:00
ark_backup_logs.md Renerate files 2017-09-11 15:40:48 -04:00
ark_create.md Add verb-noun command aliases 2017-10-20 13:26:34 -04:00
ark_create_backup.md Update default TTL to 30 days 2017-11-14 17:03:30 -05:00
ark_create_restore.md add --include-cluster-resources flag to restores (optional, default true) 2017-10-23 10:51:07 -07:00
ark_create_schedule.md Update default TTL to 30 days 2017-11-14 17:03:30 -05:00
ark_describe.md Regen docs 2017-11-27 15:22:35 -05:00
ark_describe_backups.md Regen docs 2017-11-27 15:22:35 -05:00
ark_describe_restores.md Regen docs 2017-11-27 15:22:35 -05:00
ark_describe_schedules.md Regen docs 2017-11-27 15:22:35 -05:00
ark_get.md Add verb-noun command aliases 2017-10-20 13:26:34 -04:00
ark_get_backups.md Add verb-noun command aliases 2017-10-20 13:26:34 -04:00
ark_get_restores.md Add verb-noun command aliases 2017-10-20 13:26:34 -04:00
ark_get_schedules.md Add verb-noun command aliases 2017-10-20 13:26:34 -04:00
ark_plugin.md add plugin add/remove commands 2017-11-29 12:22:30 -08:00
ark_plugin_add.md add plugin add/remove commands 2017-11-29 12:22:30 -08:00
ark_plugin_remove.md add plugin add/remove commands 2017-11-29 12:22:30 -08:00
ark_restore.md Move restore warnings/errors to object storage 2017-11-02 15:53:59 -04:00
ark_restore_create.md add --include-cluster-resources flag to restores (optional, default true) 2017-10-23 10:51:07 -07:00
ark_restore_delete.md Renerate files 2017-09-11 15:40:48 -04:00
ark_restore_describe.md Regen docs 2017-11-27 15:22:35 -05:00
ark_restore_get.md Add verb-noun command aliases 2017-10-20 13:26:34 -04:00
ark_restore_logs.md make update 2017-09-13 09:51:40 -04:00
ark_schedule.md Regen docs 2017-11-27 15:22:35 -05:00
ark_schedule_create.md Update default TTL to 30 days 2017-11-14 17:03:30 -05:00
ark_schedule_delete.md Renerate files 2017-09-11 15:40:48 -04:00
ark_schedule_describe.md Regen docs 2017-11-27 15:22:35 -05:00
ark_schedule_get.md Renerate files 2017-09-11 15:40:48 -04:00
ark_server.md add log-level flag to server command 2017-10-10 13:14:03 -07:00
ark_version.md Renerate files 2017-09-11 15:40:48 -04:00

README.md

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 -u $(id -u) -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