v1beta1

package
v0.0.0-...-87df8d5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 19, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the apps v1beta1 API group +kubebuilder:object:generate=true +groupName=apps.hstream.io

Index

Constants

View Source
const ComponentTypeConnector = "connector"

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "apps.hstream.io", Version: "v1beta1"}

	// 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
)
View Source
var ConnectorContainerPortMap = map[ConnectorType]int32{
	SinkElaticsearch: 9200,
}
View Source
var ConnectorImageMap = map[ConnectorType]string{
	SinkElaticsearch: "hstreamdb/sink-elasticsearch:standalone",
}

Functions

func GenConnectorConfigMapName

func GenConnectorConfigMapName(name string, isTemplate bool) (suffix string)

func GenConnectorConfigMapNameForStream

func GenConnectorConfigMapNameForStream(connectorName, stream string) string

func GenConnectorDeploymentName

func GenConnectorDeploymentName(connectorName, stream string) string

Types

type Connector

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

	Spec   ConnectorSpec   `json:"spec,omitempty"`
	Status ConnectorStatus `json:"status,omitempty"`
}

Connector is the Schema for the connectors API

func (*Connector) DeepCopy

func (in *Connector) DeepCopy() *Connector

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

func (*Connector) DeepCopyInto

func (in *Connector) DeepCopyInto(out *Connector)

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

func (*Connector) DeepCopyObject

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

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

type ConnectorList

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

ConnectorList contains a list of Connector

func (*ConnectorList) DeepCopy

func (in *ConnectorList) DeepCopy() *ConnectorList

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

func (*ConnectorList) DeepCopyInto

func (in *ConnectorList) DeepCopyInto(out *ConnectorList)

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

func (*ConnectorList) DeepCopyObject

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

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

type ConnectorSpec

type ConnectorSpec struct {

	// Type is the type of the connector, typically used to verify that the type matches the configuration.
	//
	// Each connector type is associated with a connector image, which is used to create the connector container.
	// View `ConnectorImageMap` for more details.
	// +kubebuilder:validation:Enum=sink-elasticsearch
	// +kubebuilder:validation:Required
	Type ConnectorType `json:"type"`

	// TemplateName is the name of the connector template.
	// +kubebuilder:validation:Required
	TemplateName string `json:"templateName"`

	// Streams is used to specify the streams that the connector will be applied to.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinItems=1
	Streams []string `json:"streams"`

	// Patches is used to specify the patches that will be applied to the connector configuration.
	// +kubebuilder:validation:Schemaless
	// +kubebuilder:validation:Type=object
	// +kubebuilder:pruning:PreserveUnknownFields
	// +optional
	Patches json.RawMessage `json:"patches,omitempty"`

	// HServerEndpoint is the endpoint of the HStreamDB server.
	// For example: "hstreamdb-hserver:6570"
	// +kube:validation:Required
	HServerEndpoint string `json:"hserverEndpoint"`

	// ImageRegistry is used to specify the registry of the connector container image.
	// +optional
	ImageRegistry *string `json:"imageRegistry,omitempty"`

	// Deprecated: use `Container.Ports` instead.
	// ContainerPorts is used to specify the ports that will be exposed by the connector container.
	// +optional
	ContainerPorts []corev1.ContainerPort `json:"containerPorts,omitempty"`

	// Container is used to override the default connector container fields.
	// Note that not all fields are supported.
	// +optional
	Container corev1.Container `json:"container,omitempty"`

	// Containers is used to add additional containers to the connector pod.
	// +optional
	Containers []corev1.Container `json:"containers,omitempty"`
}

ConnectorSpec defines the desired state of Connector

func (*ConnectorSpec) DeepCopy

func (in *ConnectorSpec) DeepCopy() *ConnectorSpec

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

func (*ConnectorSpec) DeepCopyInto

func (in *ConnectorSpec) DeepCopyInto(out *ConnectorSpec)

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

type ConnectorStatus

type ConnectorStatus struct {
}

ConnectorStatus defines the observed state of Connector

func (*ConnectorStatus) DeepCopy

func (in *ConnectorStatus) DeepCopy() *ConnectorStatus

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

func (*ConnectorStatus) DeepCopyInto

func (in *ConnectorStatus) DeepCopyInto(out *ConnectorStatus)

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

type ConnectorTemplate

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

	Spec   ConnectorTemplateSpec   `json:"spec,omitempty"`
	Status ConnectorTemplateStatus `json:"status,omitempty"`
}

ConnectorTemplate is the Schema for the connectortemplates API

func (*ConnectorTemplate) DeepCopy

func (in *ConnectorTemplate) DeepCopy() *ConnectorTemplate

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

func (*ConnectorTemplate) DeepCopyInto

func (in *ConnectorTemplate) DeepCopyInto(out *ConnectorTemplate)

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

func (*ConnectorTemplate) DeepCopyObject

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

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

type ConnectorTemplateList

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

ConnectorTemplateList contains a list of ConnectorTemplate

func (*ConnectorTemplateList) DeepCopy

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

func (*ConnectorTemplateList) DeepCopyInto

func (in *ConnectorTemplateList) DeepCopyInto(out *ConnectorTemplateList)

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

func (*ConnectorTemplateList) DeepCopyObject

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

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

type ConnectorTemplateSpec

type ConnectorTemplateSpec struct {

	// Type is the type of the connector template, typically used to verify that the type matches the configuration.
	// +kubebuilder:validation:Enum=sink-elasticsearch
	// +kubebuilder:validation:Required
	Type ConnectorType `json:"type"`

	// Config is the configuration for the connector template.
	// For details, see https://docs.hstream.io/ingest-and-distribute/connectors.html.
	//
	// Note: currently, only the `sink-elasticsearch` connector is supported.
	// +kubebuilder:validation:Required
	Config string `json:"config"`
}

ConnectorTemplateSpec defines the desired state of ConnectorTemplate

func (*ConnectorTemplateSpec) DeepCopy

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

func (*ConnectorTemplateSpec) DeepCopyInto

func (in *ConnectorTemplateSpec) DeepCopyInto(out *ConnectorTemplateSpec)

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

type ConnectorTemplateStatus

type ConnectorTemplateStatus struct {
}

ConnectorTemplateStatus defines the observed state of ConnectorTemplate

func (*ConnectorTemplateStatus) DeepCopy

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

func (*ConnectorTemplateStatus) DeepCopyInto

func (in *ConnectorTemplateStatus) DeepCopyInto(out *ConnectorTemplateStatus)

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

type ConnectorType

type ConnectorType string
const (
	SinkElaticsearch ConnectorType = "sink-elasticsearch"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL