History

Steve Kriss 8e5feec39c include restore & schedule under ark delete Signed-off-by: Steve Kriss <steve@heptio.com>		2017-12-21 10:47:37 -08:00
..
README.md	…
ark.md	add delete backup cmd using finalizer and simplify GC process	2017-12-21 10:47:37 -08:00
ark_backup.md	add delete backup cmd using finalizer and simplify GC process	2017-12-21 10:47:37 -08:00
ark_backup_create.md	…
ark_backup_delete.md	add delete backup cmd using finalizer and simplify GC process	2017-12-21 10:47:37 -08:00
ark_backup_describe.md	…
ark_backup_download.md	…
ark_backup_get.md	…
ark_backup_logs.md	…
ark_create.md	…
ark_create_backup.md	…
ark_create_restore.md	…
ark_create_schedule.md	…
ark_delete.md	include restore & schedule under ark delete	2017-12-21 10:47:37 -08:00
ark_delete_backup.md	add delete backup cmd using finalizer and simplify GC process	2017-12-21 10:47:37 -08:00
ark_delete_restore.md	include restore & schedule under ark delete	2017-12-21 10:47:37 -08:00
ark_delete_schedule.md	include restore & schedule under ark delete	2017-12-21 10:47:37 -08:00
ark_describe.md	…
ark_describe_backups.md	…
ark_describe_restores.md	…
ark_describe_schedules.md	…
ark_get.md	…
ark_get_backups.md	…
ark_get_restores.md	…
ark_get_schedules.md	…
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	…
ark_restore_create.md	…
ark_restore_delete.md	…
ark_restore_describe.md	…
ark_restore_get.md	…
ark_restore_logs.md	…
ark_schedule.md	…
ark_schedule_create.md	…
ark_schedule_delete.md	…
ark_schedule_describe.md	…
ark_schedule_get.md	…
ark_server.md	…
ark_version.md	…

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