Documentation for version v1.10 is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.
Create a restore
velero restore create [RESTORE_NAME] [--from-backup BACKUP_NAME | --from-schedule SCHEDULE_NAME] [flags]
# Create a restore named "restore-1" from backup "backup-1".
velero restore create restore-1 --from-backup backup-1
# Create a restore with a default name ("backup-1-<timestamp>") from backup "backup-1".
velero restore create --from-backup backup-1
# Create a restore from the latest successful backup triggered by schedule "schedule-1".
velero restore create --from-schedule schedule-1
# Create a restore from the latest successful OR partially-failed backup triggered by schedule "schedule-1".
velero restore create --from-schedule schedule-1 --allow-partially-failed
# Create a restore for only persistentvolumeclaims and persistentvolumes within a backup.
velero restore create --from-backup backup-2 --include-resources persistentvolumeclaims,persistentvolumes
--allow-partially-failed optionalBool[=true] If using --from-schedule, whether to consider PartiallyFailed backups when looking for the most recent one. This flag has no effect if not using --from-schedule.
--exclude-namespaces stringArray Namespaces to exclude from the restore.
--exclude-resources stringArray Resources to exclude from the restore, formatted as resource.group, such as storageclasses.storage.k8s.io.
--existing-resource-policy string Restore Policy to be used during the restore workflow, can be - none or update
--from-backup string Backup to restore from
--from-schedule string Schedule to restore from
-h, --help help for create
--include-cluster-resources optionalBool[=true] Include cluster-scoped resources in the restore.
--include-namespaces stringArray Namespaces to include in the restore (use '*' for all namespaces) (default *)
--include-resources stringArray Resources to include in the restore, formatted as resource.group, such as storageclasses.storage.k8s.io (use '*' for all resources).
-L, --label-columns stringArray Accepts a comma separated list of labels that are going to be presented as columns. Names are case-sensitive. You can also use multiple flag options like -L label1 -L label2...
--labels mapStringString Labels to apply to the restore.
--namespace-mappings mapStringString Namespace mappings from name in the backup to desired restored name in the form src1:dst1,src2:dst2,...
-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'. 'table' is not valid for the install command.
--preserve-nodeports optionalBool[=true] Whether to preserve nodeports of Services when restoring.
--restore-volumes optionalBool[=true] Whether to restore volumes from snapshots.
-l, --selector labelSelector Only restore resources matching this label selector. (default <none>)
--show-labels Show labels in the last column
--status-exclude-resources stringArray Resources to exclude from the restore status, formatted as resource.group, such as storageclasses.storage.k8s.io.
--status-include-resources stringArray Resources to include in the restore status, formatted as resource.group, such as storageclasses.storage.k8s.io.
-w, --wait Wait for the operation to complete.
--add_dir_header If true, adds the file directory to the header of the log messages
--alsologtostderr log to standard error as well as files
--colorized optionalBool Show colored output in TTY. Overrides 'colorized' value from $HOME/.config/velero/config.json if present. Enabled by default
--features stringArray Comma-separated list of features to enable for this Velero process. Combines with values from $HOME/.config/velero/config.json if present
--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
--kubecontext string The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context)
--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
--log_file string If non-empty, use this log file
--log_file_max_size uint Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
--logtostderr log to standard error instead of files (default true)
-n, --namespace string The namespace in which Velero should operate (default "velero")
--one_output If true, only write logs to their native severity level (vs also writing to each lower severity level)
--skip_headers If true, avoid header prefixes in the log messages
--skip_log_headers If true, avoid headers when opening log files
--stderrthreshold severity logs at or above this threshold go to stderr (default 2)
-v, --v Level number for the log level verbosity
--vmodule moduleSpec comma-separated list of pattern=N settings for file-filtered logging
To help you get started, see the documentation.