diff --git a/docs/cli-reference/ark_backup.md b/docs/cli-reference/ark_backup.md index 35638f0d7..fefdbad43 100644 --- a/docs/cli-reference/ark_backup.md +++ b/docs/cli-reference/ark_backup.md @@ -29,6 +29,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 describe](ark_backup_describe.md) - Describe backups * [ark backup download](ark_backup_download.md) - Download a backup * [ark backup get](ark_backup_get.md) - Get backups * [ark backup logs](ark_backup_logs.md) - Get backup logs diff --git a/docs/cli-reference/ark_backup_describe.md b/docs/cli-reference/ark_backup_describe.md new file mode 100644 index 000000000..f718cf20b --- /dev/null +++ b/docs/cli-reference/ark_backup_describe.md @@ -0,0 +1,36 @@ +## ark backup describe + +Describe backups + +### Synopsis + + +Describe backups + +``` +ark backup describe [NAME1] [NAME2] [NAME...] [flags] +``` + +### Options + +``` + -h, --help help for describe + -l, --selector string only show items matching this label selector +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --logtostderr log to standard error instead of files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level log level for V logs + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO +* [ark backup](ark_backup.md) - Work with backups + diff --git a/docs/cli-reference/ark_describe.md b/docs/cli-reference/ark_describe.md index a9086102d..6f47702eb 100644 --- a/docs/cli-reference/ark_describe.md +++ b/docs/cli-reference/ark_describe.md @@ -28,5 +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 +* [ark describe schedules](ark_describe_schedules.md) - Describe schedules diff --git a/docs/cli-reference/ark_describe_backups.md b/docs/cli-reference/ark_describe_backups.md new file mode 100644 index 000000000..867975b20 --- /dev/null +++ b/docs/cli-reference/ark_describe_backups.md @@ -0,0 +1,36 @@ +## ark describe backups + +Describe backups + +### Synopsis + + +Describe backups + +``` +ark describe backups [NAME1] [NAME2] [NAME...] [flags] +``` + +### Options + +``` + -h, --help help for backups + -l, --selector string only show items matching this label selector +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --logtostderr log to standard error instead of files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level log level for V logs + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO +* [ark describe](ark_describe.md) - Describe ark resources + diff --git a/docs/cli-reference/ark_describe_restores.md b/docs/cli-reference/ark_describe_restores.md index 1f29f1716..337667302 100644 --- a/docs/cli-reference/ark_describe_restores.md +++ b/docs/cli-reference/ark_describe_restores.md @@ -8,17 +8,14 @@ Describe restores Describe restores ``` -ark describe restores [flags] +ark describe restores [NAME1] [NAME2] [NAME...] [flags] ``` ### Options ``` - -h, --help help for restores - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column + -h, --help help for restores + -l, --selector string only show items matching this label selector ``` ### Options inherited from parent commands diff --git a/docs/cli-reference/ark_describe_schedules.md b/docs/cli-reference/ark_describe_schedules.md new file mode 100644 index 000000000..16b50b5f2 --- /dev/null +++ b/docs/cli-reference/ark_describe_schedules.md @@ -0,0 +1,36 @@ +## ark describe schedules + +Describe schedules + +### Synopsis + + +Describe schedules + +``` +ark describe schedules [NAME1] [NAME2] [NAME...] [flags] +``` + +### Options + +``` + -h, --help help for schedules + -l, --selector string only show items matching this label selector +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --logtostderr log to standard error instead of files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level log level for V logs + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO +* [ark describe](ark_describe.md) - Describe ark resources + diff --git a/docs/cli-reference/ark_restore_describe.md b/docs/cli-reference/ark_restore_describe.md index c87fab463..fcbd518f7 100644 --- a/docs/cli-reference/ark_restore_describe.md +++ b/docs/cli-reference/ark_restore_describe.md @@ -8,17 +8,14 @@ Describe restores Describe restores ``` -ark restore describe [flags] +ark restore describe [NAME1] [NAME2] [NAME...] [flags] ``` ### Options ``` - -h, --help help for describe - --label-columns stringArray a comma-separated list of labels to be displayed as columns - -o, --output string Output display format. For create commands, display the object but do not send it to the server. Valid formats are 'table', 'json', and 'yaml'. (default "table") - -l, --selector string only show items matching this label selector - --show-labels show labels in the last column + -h, --help help for describe + -l, --selector string only show items matching this label selector ``` ### Options inherited from parent commands diff --git a/docs/cli-reference/ark_schedule.md b/docs/cli-reference/ark_schedule.md index e080546e8..a2141cd74 100644 --- a/docs/cli-reference/ark_schedule.md +++ b/docs/cli-reference/ark_schedule.md @@ -30,5 +30,6 @@ Work with schedules * [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 +* [ark schedule describe](ark_schedule_describe.md) - Describe schedules * [ark schedule get](ark_schedule_get.md) - Get schedules diff --git a/docs/cli-reference/ark_schedule_describe.md b/docs/cli-reference/ark_schedule_describe.md new file mode 100644 index 000000000..a008142f8 --- /dev/null +++ b/docs/cli-reference/ark_schedule_describe.md @@ -0,0 +1,36 @@ +## ark schedule describe + +Describe schedules + +### Synopsis + + +Describe schedules + +``` +ark schedule describe [NAME1] [NAME2] [NAME...] [flags] +``` + +### Options + +``` + -h, --help help for describe + -l, --selector string only show items matching this label selector +``` + +### Options inherited from parent commands + +``` + --alsologtostderr log to standard error as well as files + --kubeconfig string Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration + --log_backtrace_at traceLocation when logging hits line file:N, emit a stack trace (default :0) + --log_dir string If non-empty, write log files in this directory + --logtostderr log to standard error instead of files + --stderrthreshold severity logs at or above this threshold go to stderr (default 2) + -v, --v Level log level for V logs + --vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging +``` + +### SEE ALSO +* [ark schedule](ark_schedule.md) - Work with schedules +