v1

package
v1.10.0-RC1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 7, 2020 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Overview

Package v1 is the v1 version of the API. +groupName=volumesnapshot.external-storage.k8s.io

Index

Constants

View Source 
const (
	// VolumeSnapshotDataResourcePlural is "volumesnapshotdatas"
	VolumeSnapshotDataResourcePlural = "volumesnapshotdatas"
	// VolumeSnapshotResourcePlural is "volumesnapshots"
	VolumeSnapshotResourcePlural = "volumesnapshots"
)
View Source 
const GroupName = "volumesnapshot.external-storage.k8s.io"

GroupName is the group name used for snapshot.

Variables

View Source 
var (
	// SchemeGroupVersion is the group version for snapshot.
	SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1"}
	// SchemeBuilder is the new scheme builder for snapshot
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme adds to scheme
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

func GetSupportedVolumeFromPVSpec 

func GetSupportedVolumeFromPVSpec(spec *core_v1.PersistentVolumeSpec) string

GetSupportedVolumeFromPVSpec gets supported volume from PV spec

func GetSupportedVolumeFromSnapshotDataSpec 

func GetSupportedVolumeFromSnapshotDataSpec(spec *VolumeSnapshotDataSpec) string

GetSupportedVolumeFromSnapshotDataSpec gets supported volume from snapshot data spec

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group-qualified GroupResource.

Types

type HostPathVolumeSnapshotSource 

type HostPathVolumeSnapshotSource struct {
	// Path represents a tar file that stores the HostPath volume source
	Path string `json:"snapshot"`
}

HostPathVolumeSnapshotSource is HostPath volume snapshot source

func (*HostPathVolumeSnapshotSource) DeepCopy 

func (in *HostPathVolumeSnapshotSource) DeepCopy() *HostPathVolumeSnapshotSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new HostPathVolumeSnapshotSource.

func (*HostPathVolumeSnapshotSource) DeepCopyInto 

func (in *HostPathVolumeSnapshotSource) DeepCopyInto(out *HostPathVolumeSnapshotSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OpenEBSVolumeSnapshotSource 

type OpenEBSVolumeSnapshotSource struct {
	// Unique id of the cinder volume snapshot resource. Used to identify the snapshot in OpenStack
	SnapshotID string `json:"snapshotId"`
	// Capacity of a snapshot will hold the size of the snapshot
	Capacity string `json:"capacity"`
}

OpenEBSVolumeSnapshotSource is OpenEBS volume snapshot source

func (*OpenEBSVolumeSnapshotSource) DeepCopy 

func (in *OpenEBSVolumeSnapshotSource) DeepCopy() *OpenEBSVolumeSnapshotSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OpenEBSVolumeSnapshotSource.

func (*OpenEBSVolumeSnapshotSource) DeepCopyInto 

func (in *OpenEBSVolumeSnapshotSource) DeepCopyInto(out *OpenEBSVolumeSnapshotSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshot 

type VolumeSnapshot struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata"`

	// Spec represents the desired state of the snapshot
	// +optional
	Spec VolumeSnapshotSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`

	// Status represents the latest observer state of the snapshot
	// +optional
	Status VolumeSnapshotStatus `json:"status" protobuf:"bytes,3,opt,name=status"`
}

VolumeSnapshot is the volume snapshot object accessible to the user. Upon successful creation of the actual snapshot by the volume provider it is bound to the corresponding VolumeSnapshotData through the VolumeSnapshotSpec

func (*VolumeSnapshot) DeepCopy 

func (in *VolumeSnapshot) DeepCopy() *VolumeSnapshot

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshot.

func (*VolumeSnapshot) DeepCopyInto 

func (in *VolumeSnapshot) DeepCopyInto(out *VolumeSnapshot)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VolumeSnapshot) DeepCopyObject 

func (in *VolumeSnapshot) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeSnapshotCondition 

type VolumeSnapshotCondition struct {
	// Type of replication controller condition.
	Type VolumeSnapshotConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=VolumeSnapshotConditionType"`
	// Status of the condition, one of True, False, Unknown.
	Status core_v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=ConditionStatus"`
	// The last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,3,opt,name=lastTransitionTime"`
	// The reason for the condition's last transition.
	// +optional
	Reason string `json:"reason" protobuf:"bytes,4,opt,name=reason"`
	// A human readable message indicating details about the transition.
	// +optional
	Message string `json:"message" protobuf:"bytes,5,opt,name=message"`
}

VolumeSnapshotCondition describes the state of a volume snapshot at a certain point.

func (*VolumeSnapshotCondition) DeepCopy 

func (in *VolumeSnapshotCondition) DeepCopy() *VolumeSnapshotCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotCondition.

func (*VolumeSnapshotCondition) DeepCopyInto 

func (in *VolumeSnapshotCondition) DeepCopyInto(out *VolumeSnapshotCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotConditionType 

type VolumeSnapshotConditionType string

VolumeSnapshotConditionType is the type of VolumeSnapshot conditions 

const (
	// VolumeSnapshotConditionPending means the snapshot is cut and the application
	// can resume accessing data if core_v1.ConditionStatus is True. It corresponds
	// to "Uploading" in GCE PD or "Pending" in AWS and core_v1.ConditionStatus is True.
	// It also corresponds to "Creating" in OpenStack Cinder and core_v1.ConditionStatus
	// is Unknown.
	VolumeSnapshotConditionPending VolumeSnapshotConditionType = "Pending"
	// VolumeSnapshotConditionReady is added when the snapshot has been successfully created and is ready to be used.
	VolumeSnapshotConditionReady VolumeSnapshotConditionType = "Ready"
	// VolumeSnapshotConditionError means an error occurred during snapshot creation.
	VolumeSnapshotConditionError VolumeSnapshotConditionType = "Error"
)

These are valid conditions of a volume snapshot.

type VolumeSnapshotData 

type VolumeSnapshotData struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata"`

	// Spec represents the desired state of the snapshot
	// +optional
	Spec VolumeSnapshotDataSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`

	// Status represents the latest observed state of the snapshot
	// +optional
	Status VolumeSnapshotDataStatus `json:"status" protobuf:"bytes,3,opt,name=status"`
}

VolumeSnapshotData represents the actual "on-disk" snapshot object

func (*VolumeSnapshotData) DeepCopy 

func (in *VolumeSnapshotData) DeepCopy() *VolumeSnapshotData

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotData.

func (*VolumeSnapshotData) DeepCopyInto 

func (in *VolumeSnapshotData) DeepCopyInto(out *VolumeSnapshotData)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VolumeSnapshotData) DeepCopyObject 

func (in *VolumeSnapshotData) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeSnapshotDataCondition 

type VolumeSnapshotDataCondition struct {
	// Type of volume snapshot condition.
	Type VolumeSnapshotDataConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=VolumeSnapshotDataConditionType"`
	// Status of the condition, one of True, False, Unknown.
	Status core_v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=ConditionStatus"`
	// The last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime" protobuf:"bytes,3,opt,name=lastTransitionTime"`
	// The reason for the condition's last transition.
	// +optional
	Reason string `json:"reason" protobuf:"bytes,4,opt,name=reason"`
	// A human readable message indicating details about the transition.
	// +optional
	Message string `json:"message" protobuf:"bytes,5,opt,name=message"`
}

VolumeSnapshotDataCondition describes the state of a volume snapshot at a certain point.

func (*VolumeSnapshotDataCondition) DeepCopy 

func (in *VolumeSnapshotDataCondition) DeepCopy() *VolumeSnapshotDataCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotDataCondition.

func (*VolumeSnapshotDataCondition) DeepCopyInto 

func (in *VolumeSnapshotDataCondition) DeepCopyInto(out *VolumeSnapshotDataCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotDataConditionType 

type VolumeSnapshotDataConditionType string

VolumeSnapshotDataConditionType is the type of the VolumeSnapshotData condition 

const (
	// VolumeSnapshotDataConditionReady is added when the on-disk snapshot has been successfully created.
	VolumeSnapshotDataConditionReady VolumeSnapshotDataConditionType = "Ready"
	// VolumeSnapshotDataConditionPending is added when the on-disk snapshot has been successfully created but is not available to use.
	VolumeSnapshotDataConditionPending VolumeSnapshotDataConditionType = "Pending"
	// VolumeSnapshotDataConditionError is added but the on-disk snapshot is failed to created
	VolumeSnapshotDataConditionError VolumeSnapshotDataConditionType = "Error"
)

These are valid conditions of a volume snapshot.

type VolumeSnapshotDataList 

type VolumeSnapshotDataList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []VolumeSnapshotData `json:"items"`
}

VolumeSnapshotDataList is a list of VolumeSnapshotData objects

func (*VolumeSnapshotDataList) DeepCopy 

func (in *VolumeSnapshotDataList) DeepCopy() *VolumeSnapshotDataList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotDataList.

func (*VolumeSnapshotDataList) DeepCopyInto 

func (in *VolumeSnapshotDataList) DeepCopyInto(out *VolumeSnapshotDataList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VolumeSnapshotDataList) DeepCopyObject 

func (in *VolumeSnapshotDataList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeSnapshotDataSource 

type VolumeSnapshotDataSource struct {
	// HostPath represents a directory on the host.
	// Provisioned by a developer or tester.
	// This is useful for single-node development and testing only!
	// On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster.
	// More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
	// +optional
	HostPath *HostPathVolumeSnapshotSource `json:"hostPath,omitempty"`
	// OpenEBSVolumeSnapshotSource represents OpenEBS snapshot resource
	// +optional
	OpenEBSSnapshot *OpenEBSVolumeSnapshotSource `json:"openebsVolume,omitempty"`
}

VolumeSnapshotDataSource represents the actual location and type of the snapshot. Only one of its members may be specified.

func (*VolumeSnapshotDataSource) DeepCopy 

func (in *VolumeSnapshotDataSource) DeepCopy() *VolumeSnapshotDataSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotDataSource.

func (*VolumeSnapshotDataSource) DeepCopyInto 

func (in *VolumeSnapshotDataSource) DeepCopyInto(out *VolumeSnapshotDataSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotDataSpec 

type VolumeSnapshotDataSpec struct {
	// Source represents the location and type of the volume snapshot
	VolumeSnapshotDataSource `json:",inline" protobuf:"bytes,1,opt,name=volumeSnapshotDataSource"`

	// VolumeSnapshotRef is part of bi-directional binding between VolumeSnapshot
	// and VolumeSnapshotData
	// +optional
	VolumeSnapshotRef *core_v1.ObjectReference `json:"volumeSnapshotRef" protobuf:"bytes,2,opt,name=volumeSnapshotRef"`

	// PersistentVolumeRef represents the PersistentVolume that the snapshot has been
	// taken from
	// +optional
	PersistentVolumeRef *core_v1.ObjectReference `json:"persistentVolumeRef" protobuf:"bytes,3,opt,name=persistentVolumeRef"`
}

VolumeSnapshotDataSpec is the spec of the volume snapshot data

func (*VolumeSnapshotDataSpec) DeepCopy 

func (in *VolumeSnapshotDataSpec) DeepCopy() *VolumeSnapshotDataSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotDataSpec.

func (*VolumeSnapshotDataSpec) DeepCopyInto 

func (in *VolumeSnapshotDataSpec) DeepCopyInto(out *VolumeSnapshotDataSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotDataStatus 

type VolumeSnapshotDataStatus struct {
	// The time the snapshot was successfully created
	// +optional
	CreationTimestamp metav1.Time `json:"creationTimestamp" protobuf:"bytes,1,opt,name=creationTimestamp"`

	// Represents the lates available observations about the volume snapshot
	Conditions []VolumeSnapshotDataCondition `json:"conditions" protobuf:"bytes,2,rep,name=conditions"`
}

VolumeSnapshotDataStatus is the actual state of the volume snapshot

func (*VolumeSnapshotDataStatus) DeepCopy 

func (in *VolumeSnapshotDataStatus) DeepCopy() *VolumeSnapshotDataStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotDataStatus.

func (*VolumeSnapshotDataStatus) DeepCopyInto 

func (in *VolumeSnapshotDataStatus) DeepCopyInto(out *VolumeSnapshotDataStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotList 

type VolumeSnapshotList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`
	Items           []VolumeSnapshot `json:"items"`
}

VolumeSnapshotList is a list of VolumeSnapshot objects

func (*VolumeSnapshotList) DeepCopy 

func (in *VolumeSnapshotList) DeepCopy() *VolumeSnapshotList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotList.

func (*VolumeSnapshotList) DeepCopyInto 

func (in *VolumeSnapshotList) DeepCopyInto(out *VolumeSnapshotList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*VolumeSnapshotList) DeepCopyObject 

func (in *VolumeSnapshotList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type VolumeSnapshotSpec 

type VolumeSnapshotSpec struct {
	// PersistentVolumeClaimName is the name of the PVC being snapshotted
	// +optional
	PersistentVolumeClaimName string `json:"persistentVolumeClaimName" protobuf:"bytes,1,opt,name=persistentVolumeClaimName"`

	// SnapshotDataName binds the VolumeSnapshot object with the VolumeSnapshotData
	// +optional
	SnapshotDataName string `json:"snapshotDataName" protobuf:"bytes,2,opt,name=snapshotDataName"`
}

VolumeSnapshotSpec is the desired state of the volume snapshot

func (*VolumeSnapshotSpec) DeepCopy 

func (in *VolumeSnapshotSpec) DeepCopy() *VolumeSnapshotSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotSpec.

func (*VolumeSnapshotSpec) DeepCopyInto 

func (in *VolumeSnapshotSpec) DeepCopyInto(out *VolumeSnapshotSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type VolumeSnapshotStatus 

type VolumeSnapshotStatus struct {
	// The time the snapshot was successfully created
	// +optional
	CreationTimestamp metav1.Time `json:"creationTimestamp" protobuf:"bytes,1,opt,name=creationTimestamp"`

	// Represent the latest available observations about the volume snapshot
	Conditions []VolumeSnapshotCondition `json:"conditions" protobuf:"bytes,2,rep,name=conditions"`
}

VolumeSnapshotStatus is the status of the VolumeSnapshot

func (*VolumeSnapshotStatus) DeepCopy 

func (in *VolumeSnapshotStatus) DeepCopy() *VolumeSnapshotStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VolumeSnapshotStatus.

func (*VolumeSnapshotStatus) DeepCopyInto 

func (in *VolumeSnapshotStatus) DeepCopyInto(out *VolumeSnapshotStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.