v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the replication v1alpha1 API group +kubebuilder:object:generate=true +groupName=replication.storage.openshift.io

Index

• Variables
• type ReplicationState
• type State
• type VolumeReplication
  • func (in *VolumeReplication) DeepCopy() *VolumeReplication
  • func (in *VolumeReplication) DeepCopyInto(out *VolumeReplication)
  • func (in *VolumeReplication) DeepCopyObject() runtime.Object
• type VolumeReplicationClass
  • func (in *VolumeReplicationClass) DeepCopy() *VolumeReplicationClass
  • func (in *VolumeReplicationClass) DeepCopyInto(out *VolumeReplicationClass)
  • func (in *VolumeReplicationClass) DeepCopyObject() runtime.Object
• type VolumeReplicationClassList
  • func (in *VolumeReplicationClassList) DeepCopy() *VolumeReplicationClassList
  • func (in *VolumeReplicationClassList) DeepCopyInto(out *VolumeReplicationClassList)
  • func (in *VolumeReplicationClassList) DeepCopyObject() runtime.Object
• type VolumeReplicationClassSpec
  • func (in *VolumeReplicationClassSpec) DeepCopy() *VolumeReplicationClassSpec
  • func (in *VolumeReplicationClassSpec) DeepCopyInto(out *VolumeReplicationClassSpec)
• type VolumeReplicationClassStatus
  • func (in *VolumeReplicationClassStatus) DeepCopy() *VolumeReplicationClassStatus
  • func (in *VolumeReplicationClassStatus) DeepCopyInto(out *VolumeReplicationClassStatus)
• type VolumeReplicationList
  • func (in *VolumeReplicationList) DeepCopy() *VolumeReplicationList
  • func (in *VolumeReplicationList) DeepCopyInto(out *VolumeReplicationList)
  • func (in *VolumeReplicationList) DeepCopyObject() runtime.Object
• type VolumeReplicationSpec
  • func (in *VolumeReplicationSpec) DeepCopy() *VolumeReplicationSpec
  • func (in *VolumeReplicationSpec) DeepCopyInto(out *VolumeReplicationSpec)
• type VolumeReplicationStatus
  • func (in *VolumeReplicationStatus) DeepCopy() *VolumeReplicationStatus
  • func (in *VolumeReplicationStatus) DeepCopyInto(out *VolumeReplicationStatus)

Variables

var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "replication.storage.openshift.io", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type ReplicationState

type ReplicationState string

ReplicationState represents the replication operations to be performed on the volume. +kubebuilder:validation:Enum=primary;secondary;resync

const (
	// Primary ReplicationState enables mirroring and promotes the volume to primary.
	Primary ReplicationState = "primary"

	// Secondary ReplicationState demotes the volume to secondary and resyncs the volume if out of sync.
	Secondary ReplicationState = "secondary"

	// Resync option resyncs the volume.
	Resync ReplicationState = "resync"
)

type State

type State string

State captures the latest state of the replication operation.

const (
	// PrimaryState represents the Primary replication state.
	PrimaryState State = "Primary"

	// SecondaryState represents the Secondary replication state.
	SecondaryState State = "Secondary"

	// UnknownState represents the Unknown replication state.
	UnknownState State = "Unknown"
)

type VolumeReplication

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

	Spec   VolumeReplicationSpec   `json:"spec,omitempty"`
	Status VolumeReplicationStatus `json:"status,omitempty"`
}

VolumeReplication is the Schema for the volumereplications API.

func (*VolumeReplication) DeepCopy

func (in *VolumeReplication) DeepCopy() *VolumeReplication

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

func (*VolumeReplication) DeepCopyInto

func (in *VolumeReplication) DeepCopyInto(out *VolumeReplication)

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

func (*VolumeReplication) DeepCopyObject

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

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

type VolumeReplicationClass

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

	Spec   VolumeReplicationClassSpec   `json:"spec,omitempty"`
	Status VolumeReplicationClassStatus `json:"status,omitempty"`
}

VolumeReplicationClass is the Schema for the volumereplicationclasses API.

func (*VolumeReplicationClass) DeepCopy

func (in *VolumeReplicationClass) DeepCopy() *VolumeReplicationClass

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

func (*VolumeReplicationClass) DeepCopyInto

func (in *VolumeReplicationClass) DeepCopyInto(out *VolumeReplicationClass)

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

func (*VolumeReplicationClass) DeepCopyObject

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

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

type VolumeReplicationClassList

type VolumeReplicationClassList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VolumeReplicationClass `json:"items"`
}

VolumeReplicationClassList contains a list of VolumeReplicationClass.

func (*VolumeReplicationClassList) DeepCopy

func (in *VolumeReplicationClassList) DeepCopy() *VolumeReplicationClassList

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

func (*VolumeReplicationClassList) DeepCopyInto

func (in *VolumeReplicationClassList) DeepCopyInto(out *VolumeReplicationClassList)

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

func (*VolumeReplicationClassList) DeepCopyObject

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

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

type VolumeReplicationClassSpec

type VolumeReplicationClassSpec struct {
	// Provisioner is the name of storage provisioner
	// +kubebuilder:validation:Required
	Provisioner string `json:"provisioner"`
	// Parameters is a key-value map with storage provisioner specific configurations for
	// creating volume replicas
	// +kubebuilder:validation:Optional
	Parameters map[string]string `json:"parameters,omitempty"`
}

VolumeReplicationClassSpec specifies parameters that an underlying storage system uses when creating a volume replica. A specific VolumeReplicationClass is used by specifying its name in a VolumeReplication object.

func (*VolumeReplicationClassSpec) DeepCopy

func (in *VolumeReplicationClassSpec) DeepCopy() *VolumeReplicationClassSpec

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

func (*VolumeReplicationClassSpec) DeepCopyInto

func (in *VolumeReplicationClassSpec) DeepCopyInto(out *VolumeReplicationClassSpec)

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

type VolumeReplicationClassStatus

type VolumeReplicationClassStatus struct{}

VolumeReplicationClassStatus defines the observed state of VolumeReplicationClass.

func (*VolumeReplicationClassStatus) DeepCopy

func (in *VolumeReplicationClassStatus) DeepCopy() *VolumeReplicationClassStatus

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

func (*VolumeReplicationClassStatus) DeepCopyInto

func (in *VolumeReplicationClassStatus) DeepCopyInto(out *VolumeReplicationClassStatus)

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

type VolumeReplicationList

type VolumeReplicationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []VolumeReplication `json:"items"`
}

VolumeReplicationList contains a list of VolumeReplication.

func (*VolumeReplicationList) DeepCopy

func (in *VolumeReplicationList) DeepCopy() *VolumeReplicationList

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

func (*VolumeReplicationList) DeepCopyInto

func (in *VolumeReplicationList) DeepCopyInto(out *VolumeReplicationList)

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

func (*VolumeReplicationList) DeepCopyObject

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

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

type VolumeReplicationSpec

type VolumeReplicationSpec struct {
	// VolumeReplicationClass is the VolumeReplicationClass name for this VolumeReplication resource
	// +kubebuilder:validation:Required
	VolumeReplicationClass string `json:"volumeReplicationClass"`

	// ReplicationState represents the replication operation to be performed on the volume.
	// Supported operations are "primary", "secondary" and "resync"
	// +kubebuilder:validation:Required
	ReplicationState ReplicationState `json:"replicationState"`

	// DataSource represents the object associated with the volume
	// +kubebuilder:validation:Required
	DataSource corev1.TypedLocalObjectReference `json:"dataSource"`

	// replicationHandle represents an existing (but new) replication id
	// +kubebuilder:validation:Optional
	ReplicationHandle string `json:"replicationHandle"`
}

VolumeReplicationSpec defines the desired state of VolumeReplication.

func (*VolumeReplicationSpec) DeepCopy

func (in *VolumeReplicationSpec) DeepCopy() *VolumeReplicationSpec

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

func (*VolumeReplicationSpec) DeepCopyInto

func (in *VolumeReplicationSpec) DeepCopyInto(out *VolumeReplicationSpec)

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

type VolumeReplicationStatus

type VolumeReplicationStatus struct {
	State   State  `json:"state,omitempty"`
	Message string `json:"message,omitempty"`
	// Conditions are the list of conditions and their status.
	Conditions []metav1.Condition `json:"conditions,omitempty"`
	// observedGeneration is the last generation change the operator has dealt with
	// +optional
	ObservedGeneration int64        `json:"observedGeneration,omitempty"`
	LastStartTime      *metav1.Time `json:"lastStartTime,omitempty"`
	LastCompletionTime *metav1.Time `json:"lastCompletionTime,omitempty"`
}

VolumeReplicationStatus defines the observed state of VolumeReplication.

func (*VolumeReplicationStatus) DeepCopy

func (in *VolumeReplicationStatus) DeepCopy() *VolumeReplicationStatus

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

func (*VolumeReplicationStatus) DeepCopyInto

func (in *VolumeReplicationStatus) DeepCopyInto(out *VolumeReplicationStatus)

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