Podvolumebackup v1 — velero.io

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object

PodVolumeBackupSpec is the specification for a PodVolumeBackup.

backupStorageLocation string required

BackupStorageLocation is the name of the backup storage location where the backup repository is stored.

cancel boolean

Cancel indicates request to cancel the ongoing PodVolumeBackup. It can be set when the PodVolumeBackup is in InProgress phase

node string required

Node is the name of the node that the Pod is running on.

pod object required

Pod is a reference to the pod containing the volume to be backed up.

apiVersion string

API version of the referent.

fieldPath string

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.

kind string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

name string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespace string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersion string

Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

uid string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

repoIdentifier string required

RepoIdentifier is the backup repository identifier.

tags object

Tags are a map of key-value pairs that should be applied to the volume backup as tags.

uploaderSettings object

UploaderSettings are a map of key-value pairs that should be applied to the uploader configuration.

uploaderType string

UploaderType is the type of the uploader to handle the data transfer.

enum: kopia, restic,

volume string required

Volume is the name of the volume within the Pod to be backed up.

status object

PodVolumeBackupStatus is the current status of a PodVolumeBackup.

acceptedTimestamp string

AcceptedTimestamp records the time the pod volume backup is to be prepared. The server's time is used for AcceptedTimestamp

format: date-time

completionTimestamp string

CompletionTimestamp records the time a backup was completed. Completion time is recorded even on failed backups. Completion time is recorded before uploading the backup object. The server's time is used for CompletionTimestamps

format: date-time

message string

Message is a message about the pod volume backup's status.

path string

Path is the full path within the controller pod being backed up.

phase string

Phase is the current state of the PodVolumeBackup.

enum: New, Accepted, Prepared, InProgress, Canceling, Canceled, Completed, Failed

progress object

Progress holds the total number of bytes of the volume and the current number of backed up bytes. This can be used to display progress information about the backup operation.

bytesDone integer

format: int64

totalBytes integer

format: int64

snapshotID string

SnapshotID is the identifier for the snapshot of the pod volume.

startTimestamp string

StartTimestamp records the time a backup was started. Separate from CreationTimestamp, since that value changes on restores. The server's time is used for StartTimestamps

format: date-time