v1

Documentation

Overview

Package v1 is the v1 version of the API.

Index

• Variables
• func Kind(kind string) schema.GroupKind
• func Resource(resource string) schema.GroupResource
• type PersistentVolumeClaimRuntime
  • func (in *PersistentVolumeClaimRuntime) DeepCopy() *PersistentVolumeClaimRuntime
  • func (in *PersistentVolumeClaimRuntime) DeepCopyInto(out *PersistentVolumeClaimRuntime)
  • func (in *PersistentVolumeClaimRuntime) DeepCopyObject() runtime.Object
• type PersistentVolumeClaimRuntimeList
  • func (in *PersistentVolumeClaimRuntimeList) DeepCopy() *PersistentVolumeClaimRuntimeList
  • func (in *PersistentVolumeClaimRuntimeList) DeepCopyInto(out *PersistentVolumeClaimRuntimeList)
  • func (in *PersistentVolumeClaimRuntimeList) DeepCopyObject() runtime.Object
• type PersistentVolumeClaimRuntimeSpec
  • func (in *PersistentVolumeClaimRuntimeSpec) DeepCopy() *PersistentVolumeClaimRuntimeSpec
  • func (in *PersistentVolumeClaimRuntimeSpec) DeepCopyInto(out *PersistentVolumeClaimRuntimeSpec)
• type PersistentVolumeClaimStatus
• type Workload
  • func (in *Workload) DeepCopy() *Workload
  • func (in *Workload) DeepCopyInto(out *Workload)

Variables

var (
	// SchemeBuilder to build scheme for storage APIs.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme adds storage APIs to the scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: storage.GroupName, Version: "v1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type PersistentVolumeClaimRuntime

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

	Spec PersistentVolumeClaimRuntimeSpec
}

PersistentVolumeClaimRuntime is the runtime information of a PVC/PV.

func (*PersistentVolumeClaimRuntime) DeepCopy

func (in *PersistentVolumeClaimRuntime) DeepCopy() *PersistentVolumeClaimRuntime

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

func (*PersistentVolumeClaimRuntime) DeepCopyInto

func (in *PersistentVolumeClaimRuntime) DeepCopyInto(out *PersistentVolumeClaimRuntime)

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

func (*PersistentVolumeClaimRuntime) DeepCopyObject

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

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

type PersistentVolumeClaimRuntimeList

type PersistentVolumeClaimRuntimeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`

	Items []PersistentVolumeClaimRuntime `json:"items"`
}

PersistentVolumeClaimRuntimeList is a list of PersistentVolumeClaimRuntime.

func (*PersistentVolumeClaimRuntimeList) DeepCopy

func (in *PersistentVolumeClaimRuntimeList) DeepCopy() *PersistentVolumeClaimRuntimeList

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

func (*PersistentVolumeClaimRuntimeList) DeepCopyInto

func (in *PersistentVolumeClaimRuntimeList) DeepCopyInto(out *PersistentVolumeClaimRuntimeList)

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

func (*PersistentVolumeClaimRuntimeList) DeepCopyObject

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

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

type PersistentVolumeClaimRuntimeSpec

type PersistentVolumeClaimRuntimeSpec struct {
	// Current Statuses of PersistentVolumeClaim.
	// PersistentVolumeClaim may have more than one status at a moment.
	// For example, an InUse volume maybe also in Expanding status.
	Statuses []PersistentVolumeClaimStatus `json:"status"`
	// Workloads mounted by.
	// +optional
	Workloads []Workload `json:"workloads"`
	// Current usage in bytes.
	// +optional
	UsageBytes int64 `json:"usageBytes"`
	// Nodes which mount this volume.
	// +optional
	MountedNodes []string `json:"mountedNodes"`
}

PersistentVolumeClaimRuntimeSpec is the spec for a PersistentVolumeClaimRuntime resource.

func (*PersistentVolumeClaimRuntimeSpec) DeepCopy

func (in *PersistentVolumeClaimRuntimeSpec) DeepCopy() *PersistentVolumeClaimRuntimeSpec

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

func (*PersistentVolumeClaimRuntimeSpec) DeepCopyInto

func (in *PersistentVolumeClaimRuntimeSpec) DeepCopyInto(out *PersistentVolumeClaimRuntimeSpec)

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

type PersistentVolumeClaimStatus

type PersistentVolumeClaimStatus string

PersistentVolumeClaimStatus is the status of a PVC/PV.

const (
	// ClaimStatusUnknown indicates cannot determine volume's status.
	ClaimStatusUnknown PersistentVolumeClaimStatus = "Unknown"
	// ClaimStatusCreating indicates the PV object is still creating.
	ClaimStatusCreating PersistentVolumeClaimStatus = "Creating"
	// ClaimStatusExpanding indicates the PVC is expanding.
	ClaimStatusExpanding PersistentVolumeClaimStatus = "Expanding"
	// ClaimStatusAvailable indicates the PVC is created and can be used by any workloads.
	ClaimStatusAvailable PersistentVolumeClaimStatus = "Available"
	// ClaimStatusInUse indicates the PVC is used by some workloads.
	ClaimStatusInUse PersistentVolumeClaimStatus = "InUse"
	// ClaimStatusLost indicates the PV is missed.
	ClaimStatusLost PersistentVolumeClaimStatus = "Lost"
	// ClaimStatusDeleting indicates the PVC is deleting.
	ClaimStatusDeleting PersistentVolumeClaimStatus = "Deleting"
)

type Workload

type Workload struct {
	corev1.ObjectReference `json:",inline"`

	// The volume is used by this workload as read only.
	ReadOnly bool `json:"readOnly"`
	// Replicas of this workload. Will be nil if we can't
	// determine the replicas, for example: DaemonSet.
	Replicas *int32 `json:"replicas"`
	// Timestamp when the workload added.
	Timestamp *metav1.Time `json:"timestamp"`
}

Workload is the information of workloads used some volumes.

func (*Workload) DeepCopy

func (in *Workload) DeepCopy() *Workload

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

func (*Workload) DeepCopyInto

func (in *Workload) DeepCopyInto(out *Workload)

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