volume

Documentation

Index

• type ItemSnapshot
• type ItemSnapshotSpec
• type ItemSnapshotStatus
• type Snapshot
• type SnapshotPhase
• type SnapshotSpec
• type SnapshotStatus

Types

type ItemSnapshot

type ItemSnapshot struct {
	Spec ItemSnapshotSpec `json:"spec"`

	Status ItemSnapshotStatus `json:"status"`
}

ItemSnapshot stores information about an item snapshot (includes volumes and other Astrolabe objects) taken as part of a Velero backup.

type ItemSnapshotSpec

type ItemSnapshotSpec struct {
	// ItemSnapshotter is the name of the ItemSnapshotter plugin that took the snapshot
	ItemSnapshotter string `json:"itemSnapshotter"`

	// BackupName is the name of the Velero backup this snapshot
	// is associated with.
	BackupName string `json:"backupName"`

	// BackupUID is the UID of the Velero backup this snapshot
	// is associated with.
	BackupUID string `json:"backupUID"`

	// Location is the name of the location where this snapshot is stored.
	Location string `json:"location"`

	// Kubernetes resource identifier for the item
	ResourceIdentifier string "json:resourceIdentifier"
}

type ItemSnapshotStatus

type ItemSnapshotStatus struct {
	// ProviderSnapshotID is the ID of the snapshot taken by the ItemSnapshotter
	ProviderSnapshotID string `json:"providerSnapshotID,omitempty"`

	// Metadata is the metadata returned with the snapshot to be returned to the ItemSnapshotter at restore time
	Metadata map[string]string `json:"metadata,omitempty"`

	// Phase is the current state of the ItemSnapshot.
	Phase isv1.SnapshotPhase `json:"phase,omitempty"`
}

type Snapshot

type Snapshot struct {
	Spec SnapshotSpec `json:"spec"`

	Status SnapshotStatus `json:"status"`
}

Snapshot stores information about a persistent volume snapshot taken as part of a Velero backup.

type SnapshotPhase

type SnapshotPhase string

SnapshotPhase is the lifecycle phase of a Velero volume snapshot.

const (
	// SnapshotPhaseNew means the volume snapshot has been created but not
	// yet processed by the VolumeSnapshotController.
	SnapshotPhaseNew SnapshotPhase = "New"

	// SnapshotPhaseCompleted means the volume snapshot was successfully created and can be restored from..
	SnapshotPhaseCompleted SnapshotPhase = "Completed"

	// SnapshotPhaseFailed means the volume snapshot was unable to execute.
	SnapshotPhaseFailed SnapshotPhase = "Failed"
)

type SnapshotSpec

type SnapshotSpec struct {
	// BackupName is the name of the Velero backup this snapshot
	// is associated with.
	BackupName string `json:"backupName"`

	// BackupUID is the UID of the Velero backup this snapshot
	// is associated with.
	BackupUID string `json:"backupUID"`

	// Location is the name of the VolumeSnapshotLocation where this snapshot is stored.
	Location string `json:"location"`

	// PersistentVolumeName is the Kubernetes name for the volume.
	PersistentVolumeName string `json:persistentVolumeName`

	// ProviderVolumeID is the provider's ID for the volume.
	ProviderVolumeID string `json:"providerVolumeID"`

	// VolumeType is the type of the disk/volume in the cloud provider
	// API.
	VolumeType string `json:"volumeType"`

	// VolumeAZ is the where the volume is provisioned
	// in the cloud provider.
	VolumeAZ string `json:"volumeAZ,omitempty"`

	// VolumeIOPS is the optional value of provisioned IOPS for the
	// disk/volume in the cloud provider API.
	VolumeIOPS *int64 `json:"volumeIOPS,omitempty"`
}

type SnapshotStatus

type SnapshotStatus struct {
	// ProviderSnapshotID is the ID of the snapshot taken in the cloud
	// provider API of this volume.
	ProviderSnapshotID string `json:"providerSnapshotID,omitempty"`

	// Phase is the current state of the VolumeSnapshot.
	Phase SnapshotPhase `json:"phase,omitempty"`
}