velero/docs/cli-reference
Steve Kriss d34994cb5f set azure restic env vars based on default backup location's config
Signed-off-by: Steve Kriss <steve@heptio.com>
2018-09-05 14:31:42 -06:00
..
README.md add doc changes for 0.7.0 2018-02-15 13:25:18 -05:00
ark.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup-location.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup-location_create.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup-location_get.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup_create.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup_delete.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup_describe.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup_download.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup_get.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_backup_logs.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_bug.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_client.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_client_config.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_client_config_get.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_client_config_set.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_completion.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_create.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_create_backup-location.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_create_backup.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_create_restore.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_create_schedule.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_delete.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_delete_backup.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_delete_restore.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_delete_schedule.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_describe.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_describe_backups.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_describe_restores.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_describe_schedules.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_get.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_get_backup-locations.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_get_backups.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_get_restores.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_get_schedules.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_plugin.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_plugin_add.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_plugin_remove.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restic.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restic_repo.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restic_repo_get.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restic_server.md set azure restic env vars based on default backup location's config 2018-09-05 14:31:42 -06:00
ark_restore.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restore_create.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restore_delete.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restore_describe.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restore_get.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_restore_logs.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_schedule.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_schedule_create.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_schedule_delete.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_schedule_describe.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_schedule_get.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_server.md Regenerate CLI docs 2018-08-28 16:57:52 -04:00
ark_version.md Regenerate CLI docs 2018-08-28 16:57:52 -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 the CLI reference directory 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, 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