Documentation ¶
Overview ¶
Package v2beta2 contains API Schema definitions for the storage v2beta2 API group +k8s:deepcopy-gen=package,register +groupName=storage.atomix.io
Package v2beta2 contains API Schema definitions for the cloud v2beta1 API group +k8s:deepcopy-gen=package,register +groupName=storage.atomix.io
Index ¶
- Variables
- type MultiRaftCluster
- type MultiRaftClusterList
- type MultiRaftClusterSpec
- type MultiRaftClusterState
- type MultiRaftClusterStatus
- type MultiRaftProtocol
- type MultiRaftProtocolList
- type MultiRaftProtocolSpec
- type MultiRaftProtocolState
- type MultiRaftProtocolStatus
- type RaftConfig
- type RaftGroup
- type RaftGroupList
- type RaftGroupSpec
- type RaftGroupState
- type RaftGroupStatus
- type RaftMember
- type RaftMemberList
- type RaftMemberRole
- type RaftMemberSpec
- type RaftMemberState
- type RaftMemberStatus
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "storage.atomix.io", Version: "v2beta2"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is required by the client code generator AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type MultiRaftCluster ¶
type MultiRaftCluster struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MultiRaftClusterSpec `json:"spec,omitempty"` Status MultiRaftClusterStatus `json:"status,omitempty"` }
MultiRaftCluster is the Schema for the RaftCluster API +k8s:openapi-gen=true
func (*MultiRaftCluster) DeepCopy ¶
func (in *MultiRaftCluster) DeepCopy() *MultiRaftCluster
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftCluster.
func (*MultiRaftCluster) DeepCopyInto ¶
func (in *MultiRaftCluster) DeepCopyInto(out *MultiRaftCluster)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiRaftCluster) DeepCopyObject ¶
func (in *MultiRaftCluster) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MultiRaftClusterList ¶
type MultiRaftClusterList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` // Items is the RaftCluster of items in the list Items []MultiRaftCluster `json:"items"` }
MultiRaftClusterList contains a list of MultiRaftCluster
func (*MultiRaftClusterList) DeepCopy ¶
func (in *MultiRaftClusterList) DeepCopy() *MultiRaftClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftClusterList.
func (*MultiRaftClusterList) DeepCopyInto ¶
func (in *MultiRaftClusterList) DeepCopyInto(out *MultiRaftClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiRaftClusterList) DeepCopyObject ¶
func (in *MultiRaftClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MultiRaftClusterSpec ¶
type MultiRaftClusterSpec struct { // Replicas is the number of raft replicas Replicas int32 `json:"replicas,omitempty"` // Groups is the number of groups Groups int32 `json:"groups,omitempty"` // Image is the image to run Image string `json:"image,omitempty"` // ImagePullPolicy is the pull policy to apply ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"` // ImagePullSecrets is a list of secrets for pulling images ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"` // SecurityContext is a pod security context SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"` // VolumeClaimTemplate is the volume claim template for Raft logs VolumeClaimTemplate *corev1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"` // Raft is the Raft protocol configuration Raft RaftConfig `json:"raft,omitempty"` }
MultiRaftClusterSpec specifies a MultiRaftClusterSpec configuration
func (*MultiRaftClusterSpec) DeepCopy ¶
func (in *MultiRaftClusterSpec) DeepCopy() *MultiRaftClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftClusterSpec.
func (*MultiRaftClusterSpec) DeepCopyInto ¶
func (in *MultiRaftClusterSpec) DeepCopyInto(out *MultiRaftClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MultiRaftClusterState ¶
type MultiRaftClusterState string
MultiRaftClusterState is a state constant for MultiRaftCluster
const ( // MultiRaftClusterNotReady indicates a MultiRaftCluster is not yet ready MultiRaftClusterNotReady MultiRaftClusterState = "NotReady" // MultiRaftClusterReady indicates a MultiRaftCluster is ready MultiRaftClusterReady MultiRaftClusterState = "Ready" )
type MultiRaftClusterStatus ¶
type MultiRaftClusterStatus struct {
State MultiRaftClusterState `json:"state,omitempty"`
}
MultiRaftClusterStatus defines the status of a RaftCluster
func (*MultiRaftClusterStatus) DeepCopy ¶
func (in *MultiRaftClusterStatus) DeepCopy() *MultiRaftClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftClusterStatus.
func (*MultiRaftClusterStatus) DeepCopyInto ¶
func (in *MultiRaftClusterStatus) DeepCopyInto(out *MultiRaftClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MultiRaftProtocol ¶
type MultiRaftProtocol struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec MultiRaftProtocolSpec `json:"spec,omitempty"` Status MultiRaftProtocolStatus `json:"status,omitempty"` }
MultiRaftProtocol is the Schema for the MultiRaftProtocol API +k8s:openapi-gen=true
func (*MultiRaftProtocol) DeepCopy ¶
func (in *MultiRaftProtocol) DeepCopy() *MultiRaftProtocol
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftProtocol.
func (*MultiRaftProtocol) DeepCopyInto ¶
func (in *MultiRaftProtocol) DeepCopyInto(out *MultiRaftProtocol)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiRaftProtocol) DeepCopyObject ¶
func (in *MultiRaftProtocol) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MultiRaftProtocolList ¶
type MultiRaftProtocolList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` // Items is the MultiRaftProtocol of items in the list Items []MultiRaftProtocol `json:"items"` }
MultiRaftProtocolList contains a list of MultiRaftProtocol
func (*MultiRaftProtocolList) DeepCopy ¶
func (in *MultiRaftProtocolList) DeepCopy() *MultiRaftProtocolList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftProtocolList.
func (*MultiRaftProtocolList) DeepCopyInto ¶
func (in *MultiRaftProtocolList) DeepCopyInto(out *MultiRaftProtocolList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*MultiRaftProtocolList) DeepCopyObject ¶
func (in *MultiRaftProtocolList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type MultiRaftProtocolSpec ¶
type MultiRaftProtocolSpec struct {
MultiRaftClusterSpec `json:",inline"`
}
MultiRaftProtocolSpec specifies a MultiRaftProtocol configuration
func (*MultiRaftProtocolSpec) DeepCopy ¶
func (in *MultiRaftProtocolSpec) DeepCopy() *MultiRaftProtocolSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftProtocolSpec.
func (*MultiRaftProtocolSpec) DeepCopyInto ¶
func (in *MultiRaftProtocolSpec) DeepCopyInto(out *MultiRaftProtocolSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MultiRaftProtocolState ¶
type MultiRaftProtocolState string
MultiRaftProtocolState is a state constant for MultiRaftProtocol
const ( // MultiRaftProtocolNotReady indicates a MultiRaftProtocol is not yet ready MultiRaftProtocolNotReady MultiRaftProtocolState = "NotReady" // MultiRaftProtocolReady indicates a MultiRaftProtocol is ready MultiRaftProtocolReady MultiRaftProtocolState = "Ready" )
type MultiRaftProtocolStatus ¶
type MultiRaftProtocolStatus struct { *v2beta1.ProtocolStatus `json:",inline"` State MultiRaftProtocolState `json:"state,omitempty"` }
MultiRaftProtocolStatus defines the status of a MultiRaftProtocol
func (*MultiRaftProtocolStatus) DeepCopy ¶
func (in *MultiRaftProtocolStatus) DeepCopy() *MultiRaftProtocolStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRaftProtocolStatus.
func (*MultiRaftProtocolStatus) DeepCopyInto ¶
func (in *MultiRaftProtocolStatus) DeepCopyInto(out *MultiRaftProtocolStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RaftConfig ¶ added in v0.9.1
type RaftConfig struct { // QuorumSize is the number of replicas in the group QuorumSize *int32 `json:"quorumSize,omitempty"` // ReadReplicas is the number of read-only replicas in the group ReadReplicas *int32 `json:"readReplicas,omitempty"` HeartbeatPeriod *metav1.Duration `json:"heartbeatPeriod,omitempty"` ElectionTimeout *metav1.Duration `json:"electionTimeout,omitempty"` SnapshotEntryThreshold *int64 `json:"snapshotEntryThreshold,omitempty"` CompactionRetainEntries *int64 `json:"compactionRetainEntries,omitempty"` }
RaftConfig is the configuration of a Raft group
func (*RaftConfig) DeepCopy ¶ added in v0.9.1
func (in *RaftConfig) DeepCopy() *RaftConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftConfig.
func (*RaftConfig) DeepCopyInto ¶ added in v0.9.1
func (in *RaftConfig) DeepCopyInto(out *RaftConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RaftGroup ¶
type RaftGroup struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RaftGroupSpec `json:"spec,omitempty"` Status RaftGroupStatus `json:"status,omitempty"` }
RaftGroup is the Schema for the RaftGroup API +k8s:openapi-gen=true
func (*RaftGroup) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftGroup.
func (*RaftGroup) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RaftGroup) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RaftGroupList ¶
type RaftGroupList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` // Items is the RaftGroup of items in the list Items []RaftGroup `json:"items"` }
RaftGroupList contains a list of RaftGroup
func (*RaftGroupList) DeepCopy ¶
func (in *RaftGroupList) DeepCopy() *RaftGroupList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftGroupList.
func (*RaftGroupList) DeepCopyInto ¶
func (in *RaftGroupList) DeepCopyInto(out *RaftGroupList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RaftGroupList) DeepCopyObject ¶
func (in *RaftGroupList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RaftGroupSpec ¶
type RaftGroupSpec struct { RaftConfig `json:",inline"` GroupID int32 `json:"groupId,omitempty"` }
RaftGroupSpec specifies a RaftGroupSpec configuration
func (*RaftGroupSpec) DeepCopy ¶
func (in *RaftGroupSpec) DeepCopy() *RaftGroupSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftGroupSpec.
func (*RaftGroupSpec) DeepCopyInto ¶
func (in *RaftGroupSpec) DeepCopyInto(out *RaftGroupSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RaftGroupState ¶
type RaftGroupState string
RaftGroupState is a state constant for RaftGroup
const ( // RaftGroupNotReady indicates a RaftGroup is not yet ready RaftGroupNotReady RaftGroupState = "NotReady" // RaftGroupReady indicates a RaftGroup is ready RaftGroupReady RaftGroupState = "Ready" )
type RaftGroupStatus ¶
type RaftGroupStatus struct { State RaftGroupState `json:"state,omitempty"` Leader *string `json:"leader,omitempty"` Term *uint64 `json:"term,omitempty"` }
RaftGroupStatus defines the status of a RaftGroup
func (*RaftGroupStatus) DeepCopy ¶
func (in *RaftGroupStatus) DeepCopy() *RaftGroupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftGroupStatus.
func (*RaftGroupStatus) DeepCopyInto ¶
func (in *RaftGroupStatus) DeepCopyInto(out *RaftGroupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RaftMember ¶
type RaftMember struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec RaftMemberSpec `json:"spec,omitempty"` Status RaftMemberStatus `json:"status,omitempty"` }
RaftMember is the Schema for the RaftMember API +k8s:openapi-gen=true
func (*RaftMember) DeepCopy ¶
func (in *RaftMember) DeepCopy() *RaftMember
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftMember.
func (*RaftMember) DeepCopyInto ¶
func (in *RaftMember) DeepCopyInto(out *RaftMember)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RaftMember) DeepCopyObject ¶
func (in *RaftMember) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RaftMemberList ¶
type RaftMemberList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` // Items is the RaftMember of items in the list Items []RaftMember `json:"items"` }
RaftMemberList contains a list of RaftMember
func (*RaftMemberList) DeepCopy ¶
func (in *RaftMemberList) DeepCopy() *RaftMemberList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftMemberList.
func (*RaftMemberList) DeepCopyInto ¶
func (in *RaftMemberList) DeepCopyInto(out *RaftMemberList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*RaftMemberList) DeepCopyObject ¶
func (in *RaftMemberList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type RaftMemberRole ¶
type RaftMemberRole string
RaftMemberRole is a constant for RaftMember representing the current role of the member
const ( // RaftLeader is a RaftMemberRole indicating the RaftMember is currently the leader of the group RaftLeader RaftMemberRole = "Leader" // RaftCandidate is a RaftMemberRole indicating the RaftMember is currently a candidate RaftCandidate RaftMemberRole = "Candidate" // RaftFollower is a RaftMemberRole indicating the RaftMember is currently a follower RaftFollower RaftMemberRole = "Follower" )
type RaftMemberSpec ¶
type RaftMemberSpec struct { PodName string `json:"podName,omitempty"` ReadOnly bool `json:"readOnly,omitempty"` }
RaftMemberSpec specifies a RaftMemberSpec configuration
func (*RaftMemberSpec) DeepCopy ¶
func (in *RaftMemberSpec) DeepCopy() *RaftMemberSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftMemberSpec.
func (*RaftMemberSpec) DeepCopyInto ¶
func (in *RaftMemberSpec) DeepCopyInto(out *RaftMemberSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RaftMemberState ¶
type RaftMemberState string
RaftMemberState is a state constant for RaftMember
const ( // RaftMemberNotReady indicates a RaftMember is not yet ready RaftMemberNotReady RaftMemberState = "NotReady" // RaftMemberReady indicates a RaftMember is ready RaftMemberReady RaftMemberState = "Ready" )
type RaftMemberStatus ¶
type RaftMemberStatus struct { State *RaftMemberState `json:"state,omitempty"` Role *RaftMemberRole `json:"role,omitempty"` Leader *string `json:"leader,omitempty"` Term *uint64 `json:"term,omitempty"` LastUpdated *metav1.Time `json:"lastUpdated,omitempty"` LastSnapshotIndex *uint64 `json:"lastSnapshotIndex,omitempty"` LastSnapshotTime *metav1.Time `json:"lastSnapshotTime,omitempty"` }
RaftMemberStatus defines the status of a RaftMember
func (*RaftMemberStatus) DeepCopy ¶
func (in *RaftMemberStatus) DeepCopy() *RaftMemberStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RaftMemberStatus.
func (*RaftMemberStatus) DeepCopyInto ¶
func (in *RaftMemberStatus) DeepCopyInto(out *RaftMemberStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.