mirrors/velero
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/velero.git synced 2026-01-08 06:15:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Regenerate CLI docs

Browse Source 
Signed-off-by: Nolan Brubaker <nolan@heptio.com>
This commit is contained in:
Nolan Brubaker
2018-08-27 16:38:05 -04:00
parent 7bc27bbbfd
commit a50367f148
55 changed files with 64 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/cli-reference/ark.md
View File

@@ -4,7 +4,6 @@ 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.
@@ -30,6 +29,7 @@ operations can also be performed as 'ark backup get' and 'ark schedule create'.
```
### SEE ALSO
* [ark backup](ark_backup.md) - Work with backups
* [ark backup-location](ark_backup-location.md) - Work with backup storage locations
* [ark bug](ark_bug.md) - Report an Ark bug

2
docs/cli-reference/ark_backup-location.md
View File

@@ -4,7 +4,6 @@ Work with backup storage locations
### Synopsis
Work with backup storage locations
### Options
@@ -29,6 +28,7 @@ Work with backup storage locations
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark backup-location create](ark_backup-location_create.md) - Create a backup storage location
* [ark backup-location get](ark_backup-location_get.md) - Get backup storage locations

2
docs/cli-reference/ark_backup-location_create.md
View File

@@ -4,7 +4,6 @@ Create a backup storage location
### Synopsis
Create a backup storage location
```
@@ -41,5 +40,6 @@ ark backup-location create NAME [flags]
```
### SEE ALSO
* [ark backup-location](ark_backup-location.md) - Work with backup storage locations

2
docs/cli-reference/ark_backup-location_get.md
View File

@@ -4,7 +4,6 @@ Get backup storage locations
### Synopsis
Get backup storage locations
```
@@ -37,5 +36,6 @@ ark backup-location get [flags]
```
### SEE ALSO
* [ark backup-location](ark_backup-location.md) - Work with backup storage locations

2
docs/cli-reference/ark_backup.md
View File

@@ -4,7 +4,6 @@ Work with backups
### Synopsis
Work with backups
### Options
@@ -29,6 +28,7 @@ Work with backups
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark backup create](ark_backup_create.md) - Create a backup
* [ark backup delete](ark_backup_delete.md) - Delete backups

2
docs/cli-reference/ark_backup_create.md
View File

@@ -4,7 +4,6 @@ Create a backup
### Synopsis
Create a backup
```
@@ -47,5 +46,6 @@ ark backup create NAME [flags]
```
### SEE ALSO
* [ark backup](ark_backup.md) - Work with backups

2
docs/cli-reference/ark_backup_delete.md
View File

@@ -4,7 +4,6 @@ Delete backups
### Synopsis
Delete backups
```
@@ -56,5 +55,6 @@ ark backup delete [NAMES] [flags]
```
### SEE ALSO
* [ark backup](ark_backup.md) - Work with backups

2
docs/cli-reference/ark_backup_describe.md
View File

@@ -4,7 +4,6 @@ Describe backups
### Synopsis
Describe backups
```
@@ -35,5 +34,6 @@ ark backup describe [NAME1] [NAME2] [NAME...] [flags]
```
### SEE ALSO
* [ark backup](ark_backup.md) - Work with backups

2
docs/cli-reference/ark_backup_download.md
View File

@@ -4,7 +4,6 @@ Download a backup
### Synopsis
Download a backup
```
@@ -36,5 +35,6 @@ ark backup download NAME [flags]
```
### SEE ALSO
* [ark backup](ark_backup.md) - Work with backups

2
docs/cli-reference/ark_backup_get.md
View File

@@ -4,7 +4,6 @@ Get backups
### Synopsis
Get backups
```
@@ -37,5 +36,6 @@ ark backup get [flags]
```
### SEE ALSO
* [ark backup](ark_backup.md) - Work with backups

2
docs/cli-reference/ark_backup_logs.md
View File

@@ -4,7 +4,6 @@ Get backup logs
### Synopsis
Get backup logs
```
@@ -34,5 +33,6 @@ ark backup logs BACKUP [flags]
```
### SEE ALSO
* [ark backup](ark_backup.md) - Work with backups

2
docs/cli-reference/ark_bug.md
View File

@@ -4,7 +4,6 @@ Report an Ark bug
### Synopsis
Open a browser window to report an Ark bug
```
@@ -33,5 +32,6 @@ ark bug [flags]
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.

2
docs/cli-reference/ark_client.md
View File

@@ -4,7 +4,6 @@ Ark client related commands
### Synopsis
Ark client related commands
### Options
@@ -29,6 +28,7 @@ Ark client related commands
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark client config](ark_client_config.md) - Get and set client configuration file values

2
docs/cli-reference/ark_client_config.md
View File

@@ -4,7 +4,6 @@ Get and set client configuration file values
### Synopsis
Get and set client configuration file values
### Options
@@ -29,6 +28,7 @@ Get and set client configuration file values
```
### SEE ALSO
* [ark client](ark_client.md) - Ark client related commands
* [ark client config get](ark_client_config_get.md) - Get client configuration file values
* [ark client config set](ark_client_config_set.md) - Set client configuration file values

2
docs/cli-reference/ark_client_config_get.md
View File

@@ -4,7 +4,6 @@ Get client configuration file values
### Synopsis
Get client configuration file values
```
@@ -33,5 +32,6 @@ ark client config get [KEY 1] [KEY 2] [...] [flags]
```
### SEE ALSO
* [ark client config](ark_client_config.md) - Get and set client configuration file values

2
docs/cli-reference/ark_client_config_set.md
View File

@@ -4,7 +4,6 @@ Set client configuration file values
### Synopsis
Set client configuration file values
```
@@ -33,5 +32,6 @@ ark client config set KEY=VALUE [KEY=VALUE]... [flags]
```
### SEE ALSO
* [ark client config](ark_client_config.md) - Get and set client configuration file values

2
docs/cli-reference/ark_completion.md
View File

@@ -4,7 +4,6 @@ Output shell completion code for the specified shell (bash or zsh)
### Synopsis
Generate shell completion code.
Auto completion supports both bash and zsh. Output is to STDOUT.
@@ -42,5 +41,6 @@ ark completion SHELL [flags]
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.

2
docs/cli-reference/ark_create.md
View File

@@ -4,7 +4,6 @@ Create ark resources
### Synopsis
Create ark resources
### Options
@@ -29,6 +28,7 @@ Create ark resources
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark create backup](ark_create_backup.md) - Create a backup
* [ark create backup-location](ark_create_backup-location.md) - Create a backup storage location

2
docs/cli-reference/ark_create_backup-location.md
View File

@@ -4,7 +4,6 @@ Create a backup storage location
### Synopsis
Create a backup storage location
```
@@ -41,5 +40,6 @@ ark create backup-location NAME [flags]
```
### SEE ALSO
* [ark create](ark_create.md) - Create ark resources

2
docs/cli-reference/ark_create_backup.md
View File

@@ -4,7 +4,6 @@ Create a backup
### Synopsis
Create a backup
```
@@ -47,5 +46,6 @@ ark create backup NAME [flags]
```
### SEE ALSO
* [ark create](ark_create.md) - Create ark resources

2
docs/cli-reference/ark_create_restore.md
View File

@@ -4,7 +4,6 @@ Create a restore
### Synopsis
Create a restore
```
@@ -62,5 +61,6 @@ ark create restore [RESTORE_NAME] [--from-backup BACKUP_NAME | --from-schedule S
```
### SEE ALSO
* [ark create](ark_create.md) - Create ark resources

2
docs/cli-reference/ark_create_schedule.md
View File

@@ -4,7 +4,6 @@ Create a schedule
### Synopsis
The --schedule flag is required, in cron notation:
| Character Position | Character Period | Acceptable Values |
@@ -61,5 +60,6 @@ ark create schedule NAME --schedule="0 */6 * * *"
```
### SEE ALSO
* [ark create](ark_create.md) - Create ark resources

2
docs/cli-reference/ark_delete.md
View File

@@ -4,7 +4,6 @@ Delete ark resources
### Synopsis
Delete ark resources
### Options
@@ -29,6 +28,7 @@ Delete ark resources
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark delete backup](ark_delete_backup.md) - Delete backups
* [ark delete restore](ark_delete_restore.md) - Delete a restore

2
docs/cli-reference/ark_delete_backup.md
View File

@@ -4,7 +4,6 @@ Delete backups
### Synopsis
Delete backups
```
@@ -56,5 +55,6 @@ ark delete backup [NAMES] [flags]
```
### SEE ALSO
* [ark delete](ark_delete.md) - Delete ark resources

2
docs/cli-reference/ark_delete_restore.md
View File

@@ -4,7 +4,6 @@ Delete a restore
### Synopsis
Delete a restore
```
@@ -33,5 +32,6 @@ ark delete restore NAME [flags]
```
### SEE ALSO
* [ark delete](ark_delete.md) - Delete ark resources

2
docs/cli-reference/ark_delete_schedule.md
View File

@@ -4,7 +4,6 @@ Delete a schedule
### Synopsis
Delete a schedule
```
@@ -33,5 +32,6 @@ ark delete schedule NAME [flags]
```
### SEE ALSO
* [ark delete](ark_delete.md) - Delete ark resources

2
docs/cli-reference/ark_describe.md
View File

@@ -4,7 +4,6 @@ Describe ark resources
### Synopsis
Describe ark resources
### Options
@@ -29,6 +28,7 @@ Describe ark resources
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark describe backups](ark_describe_backups.md) - Describe backups
* [ark describe restores](ark_describe_restores.md) - Describe restores

2
docs/cli-reference/ark_describe_backups.md
View File

@@ -4,7 +4,6 @@ Describe backups
### Synopsis
Describe backups
```
@@ -35,5 +34,6 @@ ark describe backups [NAME1] [NAME2] [NAME...] [flags]
```
### SEE ALSO
* [ark describe](ark_describe.md) - Describe ark resources

2
docs/cli-reference/ark_describe_restores.md
View File

@@ -4,7 +4,6 @@ Describe restores
### Synopsis
Describe restores
```
@@ -35,5 +34,6 @@ ark describe restores [NAME1] [NAME2] [NAME...] [flags]
```
### SEE ALSO
* [ark describe](ark_describe.md) - Describe ark resources

2
docs/cli-reference/ark_describe_schedules.md
View File

@@ -4,7 +4,6 @@ Describe schedules
### Synopsis
Describe schedules
```
@@ -34,5 +33,6 @@ ark describe schedules [NAME1] [NAME2] [NAME...] [flags]
```
### SEE ALSO
* [ark describe](ark_describe.md) - Describe ark resources

2
docs/cli-reference/ark_get.md
View File

@@ -4,7 +4,6 @@ Get ark resources
### Synopsis
Get ark resources
### Options
@@ -29,6 +28,7 @@ Get ark resources
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark get backup-locations](ark_get_backup-locations.md) - Get backup storage locations
* [ark get backups](ark_get_backups.md) - Get backups

2
docs/cli-reference/ark_get_backup-locations.md
View File

@@ -4,7 +4,6 @@ Get backup storage locations
### Synopsis
Get backup storage locations
```
@@ -37,5 +36,6 @@ ark get backup-locations [flags]
```
### SEE ALSO
* [ark get](ark_get.md) - Get ark resources

2
docs/cli-reference/ark_get_backups.md
View File

@@ -4,7 +4,6 @@ Get backups
### Synopsis
Get backups
```
@@ -37,5 +36,6 @@ ark get backups [flags]
```
### SEE ALSO
* [ark get](ark_get.md) - Get ark resources

2
docs/cli-reference/ark_get_restores.md
View File

@@ -4,7 +4,6 @@ Get restores
### Synopsis
Get restores
```
@@ -37,5 +36,6 @@ ark get restores [flags]
```
### SEE ALSO
* [ark get](ark_get.md) - Get ark resources

2
docs/cli-reference/ark_get_schedules.md
View File

@@ -4,7 +4,6 @@ Get schedules
### Synopsis
Get schedules
```
@@ -37,5 +36,6 @@ ark get schedules [flags]
```
### SEE ALSO
* [ark get](ark_get.md) - Get ark resources

2
docs/cli-reference/ark_plugin.md
View File

@@ -4,7 +4,6 @@ Work with plugins
### Synopsis
Work with plugins
### Options
@@ -29,6 +28,7 @@ Work with plugins
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark plugin add](ark_plugin_add.md) - Add a plugin
* [ark plugin remove](ark_plugin_remove.md) - Remove a plugin

2
docs/cli-reference/ark_plugin_add.md
View File

@@ -4,7 +4,6 @@ Add a plugin
### Synopsis
Add a plugin
```
@@ -34,5 +33,6 @@ ark plugin add IMAGE [flags]
```
### SEE ALSO
* [ark plugin](ark_plugin.md) - Work with plugins

2
docs/cli-reference/ark_plugin_remove.md
View File

@@ -4,7 +4,6 @@ Remove a plugin
### Synopsis
Remove a plugin
```
@@ -33,5 +32,6 @@ ark plugin remove [NAME | IMAGE] [flags]
```
### SEE ALSO
* [ark plugin](ark_plugin.md) - Work with plugins

2
docs/cli-reference/ark_restic.md
View File

@@ -4,7 +4,6 @@ Work with restic
### Synopsis
Work with restic
### Options
@@ -29,6 +28,7 @@ Work with restic
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.
* [ark restic repo](ark_restic_repo.md) - Work with restic repositories
* [ark restic server](ark_restic_server.md) - Run the ark restic server

2
docs/cli-reference/ark_restic_repo.md
View File

@@ -4,7 +4,6 @@ Work with restic repositories
### Synopsis
Work with restic repositories
### Options
@@ -29,6 +28,7 @@ Work with restic repositories
```
### SEE ALSO
* [ark restic](ark_restic.md) - Work with restic
* [ark restic repo get](ark_restic_repo_get.md) - Get restic repositories

2
docs/cli-reference/ark_restic_repo_get.md
View File

@@ -4,7 +4,6 @@ Get restic repositories
### Synopsis
Get restic repositories
```
@@ -37,5 +36,6 @@ ark restic repo get [flags]
```
### SEE ALSO
* [ark restic repo](ark_restic_repo.md) - Work with restic repositories

2
docs/cli-reference/ark_restic_server.md
View File

@@ -4,7 +4,6 @@ Run the ark restic server
### Synopsis
Run the ark restic server
```
@@ -34,5 +33,6 @@ ark restic server [flags]
```
### SEE ALSO
* [ark restic](ark_restic.md) - Work with restic

2
docs/cli-reference/ark_restore.md
View File

@@ -4,7 +4,6 @@ Work with restores
### Synopsis
Work with restores
### Options
@@ -29,6 +28,7 @@ Work with restores
```
### 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

2
docs/cli-reference/ark_restore_create.md
View File

@@ -4,7 +4,6 @@ Create a restore
### Synopsis
Create a restore
```
@@ -62,5 +61,6 @@ ark restore create [RESTORE_NAME] [--from-backup BACKUP_NAME | --from-schedule S
```
### SEE ALSO
* [ark restore](ark_restore.md) - Work with restores

2
docs/cli-reference/ark_restore_delete.md
View File

@@ -4,7 +4,6 @@ Delete a restore
### Synopsis
Delete a restore
```
@@ -33,5 +32,6 @@ ark restore delete NAME [flags]
```
### SEE ALSO
* [ark restore](ark_restore.md) - Work with restores

2
docs/cli-reference/ark_restore_describe.md
View File

@@ -4,7 +4,6 @@ Describe restores
### Synopsis
Describe restores
```
@@ -35,5 +34,6 @@ ark restore describe [NAME1] [NAME2] [NAME...] [flags]
```
### SEE ALSO
* [ark restore](ark_restore.md) - Work with restores

2
docs/cli-reference/ark_restore_get.md
View File

@@ -4,7 +4,6 @@ Get restores
### Synopsis
Get restores
```
@@ -37,5 +36,6 @@ ark restore get [flags]
```
### SEE ALSO
* [ark restore](ark_restore.md) - Work with restores

2
docs/cli-reference/ark_restore_logs.md
View File

@@ -4,7 +4,6 @@ Get restore logs
### Synopsis
Get restore logs
```
@@ -34,5 +33,6 @@ ark restore logs RESTORE [flags]
```
### SEE ALSO
* [ark restore](ark_restore.md) - Work with restores

2
docs/cli-reference/ark_schedule.md
View File

@@ -4,7 +4,6 @@ Work with schedules
### Synopsis
Work with schedules
### Options
@@ -29,6 +28,7 @@ Work with schedules
```
### 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

2
docs/cli-reference/ark_schedule_create.md
View File

@@ -4,7 +4,6 @@ Create a schedule
### Synopsis
The --schedule flag is required, in cron notation:
| Character Position | Character Period | Acceptable Values |
@@ -61,5 +60,6 @@ ark create schedule NAME --schedule="0 */6 * * *"
```
### SEE ALSO
* [ark schedule](ark_schedule.md) - Work with schedules

2
docs/cli-reference/ark_schedule_delete.md
View File

@@ -4,7 +4,6 @@ Delete a schedule
### Synopsis
Delete a schedule
```
@@ -33,5 +32,6 @@ ark schedule delete NAME [flags]
```
### SEE ALSO
* [ark schedule](ark_schedule.md) - Work with schedules

2
docs/cli-reference/ark_schedule_describe.md
View File

@@ -4,7 +4,6 @@ Describe schedules
### Synopsis
Describe schedules
```
@@ -34,5 +33,6 @@ ark schedule describe [NAME1] [NAME2] [NAME...] [flags]
```
### SEE ALSO
* [ark schedule](ark_schedule.md) - Work with schedules

2
docs/cli-reference/ark_schedule_get.md
View File

@@ -4,7 +4,6 @@ Get schedules
### Synopsis
Get schedules
```
@@ -37,5 +36,6 @@ ark schedule get [flags]
```
### SEE ALSO
* [ark schedule](ark_schedule.md) - Work with schedules

20
docs/cli-reference/ark_server.md
View File

@@ -4,7 +4,6 @@ Run the ark server
### Synopsis
Run the ark server
```
@@ -14,15 +13,15 @@ ark server [flags]
### Options
```
--backup-sync-period duration how often to ensure all Ark backups in object storage exist as Backup API objects in the cluster (default 1h0m0s)
--default-backup-storage-location string name of the default backup storage location (default "default")
-h, --help help for server
--log-level the level at which to log. Valid values are debug, info, warning, error, fatal, panic. (default info)
--metrics-address string the address to expose prometheus metrics (default ":8085")
--plugin-dir string directory containing Ark plugins (default "/plugins")
--restic-timeout duration how long backups/restores of pod volumes should be allowed to run before timing out (default 1h0m0s)
--restore-only run in a mode where only restores are allowed; backups, schedules, and garbage-collection are all disabled
--restore-resource-priorities stringSlice desired order of resource restores; any resource not in the list will be restored alphabetically after the prioritized resources (default [namespaces,persistentvolumes,persistentvolumeclaims,secrets,configmaps,serviceaccounts,limitranges,pods])
--backup-sync-period duration how often to ensure all Ark backups in object storage exist as Backup API objects in the cluster (default 1h0m0s)
--default-backup-storage-location string name of the default backup storage location (default "default")
-h, --help help for server
--log-level the level at which to log. Valid values are debug, info, warning, error, fatal, panic. (default info)
--metrics-address string the address to expose prometheus metrics (default ":8085")
--plugin-dir string directory containing Ark plugins (default "/plugins")
--restic-timeout duration how long backups/restores of pod volumes should be allowed to run before timing out (default 1h0m0s)
--restore-only run in a mode where only restores are allowed; backups, schedules, and garbage-collection are all disabled
--restore-resource-priorities strings desired order of resource restores; any resource not in the list will be restored alphabetically after the prioritized resources (default [namespaces,persistentvolumes,persistentvolumeclaims,secrets,configmaps,serviceaccounts,limitranges,pods])
```
### Options inherited from parent commands
@@ -41,5 +40,6 @@ ark server [flags]
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.

2
docs/cli-reference/ark_version.md
View File

@@ -4,7 +4,6 @@ Print the ark version and associated image
### Synopsis
Print the ark version and associated image
```
@@ -33,5 +32,6 @@ ark version [flags]
```
### SEE ALSO
* [ark](ark.md) - Back up and restore Kubernetes cluster resources.