velero/docs/cli-reference
Steve Kriss a927906e52 add --maintenance-frequency flag to ark restic repo init
Signed-off-by: Steve Kriss <steve@heptio.com>
2018-06-20 09:21:43 -07:00
..
README.md add doc changes for 0.7.0 2018-02-15 13:25:18 -05:00
ark.md add restic repo getter and reorg restic cmds 2018-06-20 09:21:43 -07:00
ark_backup.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_backup_create.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_backup_delete.md Regen docs 2018-04-05 11:19:11 -04:00
ark_backup_describe.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_backup_download.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_backup_get.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_backup_logs.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_client.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_client_config.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_client_config_get.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_client_config_set.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_completion.md Add bash and zsh completion support 2018-04-12 13:26:23 +05:30
ark_create.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_create_backup.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_create_restore.md regen docs 2018-03-05 10:06:43 -08:00
ark_create_schedule.md Merge pull request #331 from lypht/schedule 2018-02-28 15:32:28 -08:00
ark_delete.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_delete_backup.md Regen docs 2018-04-05 11:19:11 -04:00
ark_delete_restore.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_delete_schedule.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_describe.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_describe_backups.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_describe_restores.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_describe_schedules.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_get.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_get_backups.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_get_restores.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_get_schedules.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_plugin.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_plugin_add.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_plugin_remove.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_restic.md add restic repo getter and reorg restic cmds 2018-06-20 09:21:43 -07:00
ark_restic_repo.md add restic repo getter and reorg restic cmds 2018-06-20 09:21:43 -07:00
ark_restic_repo_get.md add restic repo getter and reorg restic cmds 2018-06-20 09:21:43 -07:00
ark_restic_repo_init.md add --maintenance-frequency flag to ark restic repo init 2018-06-20 09:21:43 -07:00
ark_restic_server.md add restic repo getter and reorg restic cmds 2018-06-20 09:21:43 -07:00
ark_restore.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_restore_create.md regen docs 2018-03-05 10:06:43 -08:00
ark_restore_delete.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_restore_describe.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_restore_get.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_restore_logs.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_schedule.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_schedule_create.md Merge pull request #331 from lypht/schedule 2018-02-28 15:32:28 -08:00
ark_schedule_delete.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_schedule_describe.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_schedule_get.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08:00
ark_server.md Add a metrics package to add and expose metrics 2018-06-13 13:17:08 -07:00
ark_version.md Add global kubecontext CLI flag 2018-02-26 10:47:39 -08: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