v1alpha3

Documentation

Overview

Package v1alpha3 contains API Schema definitions for the operator v1alpha3 API group +kubebuilder:object:generate=true +groupName=operator.open-cluster-management.io

Index

• Variables
• type DataLayerConfig
  • func (in *DataLayerConfig) DeepCopy() *DataLayerConfig
  • func (in *DataLayerConfig) DeepCopyInto(out *DataLayerConfig)
• type DataLayerType
• type KafkaConfig
  • func (in *KafkaConfig) DeepCopy() *KafkaConfig
  • func (in *KafkaConfig) DeepCopyInto(out *KafkaConfig)
• type LargeScaleConfig
  • func (in *LargeScaleConfig) DeepCopy() *LargeScaleConfig
  • func (in *LargeScaleConfig) DeepCopyInto(out *LargeScaleConfig)
• type MulticlusterGlobalHub
  • func (in *MulticlusterGlobalHub) DeepCopy() *MulticlusterGlobalHub
  • func (in *MulticlusterGlobalHub) DeepCopyInto(out *MulticlusterGlobalHub)
  • func (in *MulticlusterGlobalHub) DeepCopyObject() runtime.Object
  • func (mgh *MulticlusterGlobalHub) GetConditions() []metav1.Condition
  • func (mgh *MulticlusterGlobalHub) SetConditions(conditions []metav1.Condition)
• type MulticlusterGlobalHubList
  • func (in *MulticlusterGlobalHubList) DeepCopy() *MulticlusterGlobalHubList
  • func (in *MulticlusterGlobalHubList) DeepCopyInto(out *MulticlusterGlobalHubList)
  • func (in *MulticlusterGlobalHubList) DeepCopyObject() runtime.Object
• type MulticlusterGlobalHubSpec
  • func (in *MulticlusterGlobalHubSpec) DeepCopy() *MulticlusterGlobalHubSpec
  • func (in *MulticlusterGlobalHubSpec) DeepCopyInto(out *MulticlusterGlobalHubSpec)
• type MulticlusterGlobalHubStatus
  • func (in *MulticlusterGlobalHubStatus) DeepCopy() *MulticlusterGlobalHubStatus
  • func (in *MulticlusterGlobalHubStatus) DeepCopyInto(out *MulticlusterGlobalHubStatus)
• type TransportFormatType

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "operator.open-cluster-management.io", Version: "v1alpha3"}

	// 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 DataLayerConfig

type DataLayerConfig struct {
	// +unionDiscriminator
	// +kubebuilder:validation:Required
	Type DataLayerType `json:"type"`

	// LargeScale is to use kafka as transport layer and use postgres as data layer
	// This is for a large scale environment.
	// +optional
	LargeScale *LargeScaleConfig `json:"largeScale,omitempty"`
}

DataLayerConfig is a discriminated union of data layer specific configuration. +union

func (*DataLayerConfig) DeepCopy

func (in *DataLayerConfig) DeepCopy() *DataLayerConfig

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

func (*DataLayerConfig) DeepCopyInto

func (in *DataLayerConfig) DeepCopyInto(out *DataLayerConfig)

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

type DataLayerType

type DataLayerType string

DataLayerType specifies the type of data layer that global hub stores and transports the data. +kubebuilder:validation:Enum:="largeScale"

const (
	// // Native is a DataLayerType using kubernetes native storage and event subscription
	// Native DataLayerType = "native"
	// LargeScale is a DataLayerType using external high performance data storage and transport layer
	LargeScale DataLayerType = "largeScale"
)

type KafkaConfig

type KafkaConfig struct {
	// TransportFormat defines the transport format for kafka, which is either cloudEvents or kafka message
	// +kubebuilder:default:="cloudEvents"
	TransportFormat TransportFormatType `json:"transportFormat,omitempty"`
}

KafkaConfig defines the desired state of kafka

func (*KafkaConfig) DeepCopy

func (in *KafkaConfig) DeepCopy() *KafkaConfig

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

func (*KafkaConfig) DeepCopyInto

func (in *KafkaConfig) DeepCopyInto(out *KafkaConfig)

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

type LargeScaleConfig

type LargeScaleConfig struct {
	// +optional
	Kafka *KafkaConfig `json:"kafka,omitempty"`
}

LargeScaleConfig is the config of large scale data layer

func (*LargeScaleConfig) DeepCopy

func (in *LargeScaleConfig) DeepCopy() *LargeScaleConfig

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

func (*LargeScaleConfig) DeepCopyInto

func (in *LargeScaleConfig) DeepCopyInto(out *LargeScaleConfig)

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

type MulticlusterGlobalHub

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

	Spec   MulticlusterGlobalHubSpec   `json:"spec,omitempty"`
	Status MulticlusterGlobalHubStatus `json:"status,omitempty"`
}

+kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:resource:shortName={mgh,mcgh} MulticlusterGlobalHub is the Schema for the multiclusterglobalhubs API

func (*MulticlusterGlobalHub) DeepCopy

func (in *MulticlusterGlobalHub) DeepCopy() *MulticlusterGlobalHub

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

func (*MulticlusterGlobalHub) DeepCopyInto

func (in *MulticlusterGlobalHub) DeepCopyInto(out *MulticlusterGlobalHub)

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

func (*MulticlusterGlobalHub) DeepCopyObject

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

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

func (*MulticlusterGlobalHub) GetConditions

func (mgh *MulticlusterGlobalHub) GetConditions() []metav1.Condition

func (*MulticlusterGlobalHub) SetConditions

func (mgh *MulticlusterGlobalHub) SetConditions(conditions []metav1.Condition)

type MulticlusterGlobalHubList

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

+kubebuilder:object:root=true MulticlusterGlobalHubList contains a list of MulticlusterGlobalHub

func (*MulticlusterGlobalHubList) DeepCopy

func (in *MulticlusterGlobalHubList) DeepCopy() *MulticlusterGlobalHubList

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

func (*MulticlusterGlobalHubList) DeepCopyInto

func (in *MulticlusterGlobalHubList) DeepCopyInto(out *MulticlusterGlobalHubList)

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

func (*MulticlusterGlobalHubList) DeepCopyObject

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

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

type MulticlusterGlobalHubSpec

type MulticlusterGlobalHubSpec struct {
	// Pull policy of the multicluster global hub images
	// +optional
	ImagePullPolicy corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
	// Pull secret of the multicluster global hub images
	// +optional
	ImagePullSecret string `json:"imagePullSecret,omitempty"`
	// Spec of NodeSelector
	// +optional
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
	// Tolerations causes all components to tolerate any taints.
	// +optional
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
	// DataLayer can be configured to use a different data layer, only support largeScale now.
	// largeScale: large scale data layer served by kafka and postgres.
	// +kubebuilder:validation:Required
	DataLayer *DataLayerConfig `json:"dataLayer"`
}

MulticlusterGlobalHubSpec defines the desired state of MulticlusterGlobalHub

func (*MulticlusterGlobalHubSpec) DeepCopy

func (in *MulticlusterGlobalHubSpec) DeepCopy() *MulticlusterGlobalHubSpec

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

func (*MulticlusterGlobalHubSpec) DeepCopyInto

func (in *MulticlusterGlobalHubSpec) DeepCopyInto(out *MulticlusterGlobalHubSpec)

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

type MulticlusterGlobalHubStatus

type MulticlusterGlobalHubStatus struct {
	// MulticlusterGlobalHubStatus defines the observed state of MulticlusterGlobalHub
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

MulticlusterGlobalHubStatus defines the observed state of MulticlusterGlobalHub

func (*MulticlusterGlobalHubStatus) DeepCopy

func (in *MulticlusterGlobalHubStatus) DeepCopy() *MulticlusterGlobalHubStatus

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

func (*MulticlusterGlobalHubStatus) DeepCopyInto

func (in *MulticlusterGlobalHubStatus) DeepCopyInto(out *MulticlusterGlobalHubStatus)

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

type TransportFormatType

type TransportFormatType string

TransportFormatType specifies the type of data format based on kafka implementation. +kubebuilder:validation:Enum:="message";"cloudEvents"

const (
	KafkaMessage TransportFormatType = "message"
	CloudEvents  TransportFormatType = "cloudEvents"
)