v1alpha1

Documentation

Overview

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

Index

• Constants
• Variables
• type ObservedStateValue
• type ReplicationState
• type VolumeReplication
  • func (in *VolumeReplication) DeepCopy() *VolumeReplication
  • func (in *VolumeReplication) DeepCopyInto(out *VolumeReplication)
  • func (in *VolumeReplication) DeepCopyObject() runtime.Object
• 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)

Constants

const (
	// ConditionTypeReconciled denotes resource was reconciled
	ConditionTypeReconciled = "Reconciled"
	// ConditionReasonComplete denotes reconciliation was completed
	ConditionReasonComplete = "Complete"
	// ConditionReasonError denotes reconciliation had errors
	ConditionReasonError = "Error"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "replication.storage.ramen.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 ObservedStateValue

type ObservedStateValue string

ObservedStateValue is the set of states that have been observed for the volume replication request +kubebuilder:validation:Enum=Primary;Secondary;Unknown

const (
	ObservedPrimary   ObservedStateValue = "Primary"
	ObservedSecondary ObservedStateValue = "Secondary"
	ObservedUnknown   ObservedStateValue = "Unknown"
)

valid values for ObservedState

type ReplicationState

type ReplicationState string

ReplicationState is the set of states that can be used in a volume replication state. +kubebuilder:validation:Enum=Primary;Secondary

const (
	ReplicationPrimary   ReplicationState = "Primary"
	ReplicationSecondary ReplicationState = "Secondary"
)

These are the valid values for ReplicationState

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 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 {
	// This field can be used to specify either:
	// * An existing PVC (PersistentVolumeClaim)
	// It will enable the volume for replication and ensure its state is as desired.
	DataSource *corev1.TypedLocalObjectReference `json:"dataSource,omitempty"`

	// Specifies the desired replication state for the DataSource
	State ReplicationState `json:"state,omitempty"`
}

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 {
	// ObservedState reflects the state observed at the generation in ObservedGeneration
	ObservedState ObservedStateValue `json:"state,omitempty"`
	// ObservedGeneration reflects the generation of the most recently observed volume replication
	// NOTE: As desired state may flip if user updates it before any actual change, the observed
	// generation is reflected in status to aid ensuring actual state is the same as the
	// current generation of desired state
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// Conditions regarding status
	Conditions []metav1.Condition `json:"conditions,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.