v1

Documentation

Overview

Package v1 contains API Schema definitions for the clickhouse v1 API group +k8s:deepcopy-gen=package,register +groupName=clickhouse.sensetime.com

Package v1 contains API Schema definitions for the clickhouse v1 API group +k8s:deepcopy-gen=package,register +groupName=clickhouse.sensetime.com

Index

• Constants
• Variables
• func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition
• type ClickHouseCluster
  • func (cc *ClickHouseCluster) ComputeLastAppliedConfiguration() (string, error)
  • func (in *ClickHouseCluster) DeepCopy() *ClickHouseCluster
  • func (in *ClickHouseCluster) DeepCopyInto(out *ClickHouseCluster)
  • func (in *ClickHouseCluster) DeepCopyObject() runtime.Object
• type ClickHouseClusterList
  • func (in *ClickHouseClusterList) DeepCopy() *ClickHouseClusterList
  • func (in *ClickHouseClusterList) DeepCopyInto(out *ClickHouseClusterList)
  • func (in *ClickHouseClusterList) DeepCopyObject() runtime.Object
• type ClickHouseClusterSpec
  • func (in *ClickHouseClusterSpec) DeepCopy() *ClickHouseClusterSpec
  • func (in *ClickHouseClusterSpec) DeepCopyInto(out *ClickHouseClusterSpec)
• type ClickHouseClusterStatus
  • func (in *ClickHouseClusterStatus) DeepCopy() *ClickHouseClusterStatus
  • func (in *ClickHouseClusterStatus) DeepCopyInto(out *ClickHouseClusterStatus)
• type ShardStatus
  • func (in *ShardStatus) DeepCopy() *ShardStatus
  • func (in *ShardStatus) DeepCopyInto(out *ShardStatus)
• type ZookeeperConfig
  • func (in *ZookeeperConfig) DeepCopy() *ZookeeperConfig
  • func (in *ZookeeperConfig) DeepCopyInto(out *ZookeeperConfig)
• type ZookeeperNode
  • func (in *ZookeeperNode) DeepCopy() *ZookeeperNode
  • func (in *ZookeeperNode) DeepCopyInto(out *ZookeeperNode)

Constants

const (
	AnnotationLastApplied string = "clickhouse.sensetime.com/last-applied-configuration"
)

Variables

var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: "clickhouse.sensetime.com", Version: "v1"}

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

Functions

func GetOpenAPIDefinitions

func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenAPIDefinition

Types

type ClickHouseCluster

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

	Spec   ClickHouseClusterSpec   `json:"spec,omitempty"`
	Status ClickHouseClusterStatus `json:"status,omitempty"`
}

ClickHouseCluster is the Schema for the clickhouseclusters API +k8s:openapi-gen=true +kubebuilder:resource:path=clickhouseclusters,scope=Namespaced,shortName=chc

func (*ClickHouseCluster) ComputeLastAppliedConfiguration

func (cc *ClickHouseCluster) ComputeLastAppliedConfiguration() (string, error)

func (*ClickHouseCluster) DeepCopy

func (in *ClickHouseCluster) DeepCopy() *ClickHouseCluster

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

func (*ClickHouseCluster) DeepCopyInto

func (in *ClickHouseCluster) DeepCopyInto(out *ClickHouseCluster)

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

func (*ClickHouseCluster) DeepCopyObject

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

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

type ClickHouseClusterList

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

ClickHouseClusterList contains a list of ClickHouseCluster

func (*ClickHouseClusterList) DeepCopy

func (in *ClickHouseClusterList) DeepCopy() *ClickHouseClusterList

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

func (*ClickHouseClusterList) DeepCopyInto

func (in *ClickHouseClusterList) DeepCopyInto(out *ClickHouseClusterList)

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

func (*ClickHouseClusterList) DeepCopyObject

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

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

type ClickHouseClusterSpec

type ClickHouseClusterSpec struct {
	//ClickHouse Docker image
	Image string `json:"image,omitempty"`

	//ClickHouse init  image
	InitImage string `json:"initImage,omitempty"`

	//DeletePVC defines if the PVC must be deleted when the cluster is deleted
	//it is false by default
	DeletePVC bool `json:"deletePVC,omitempty"`

	//Shards count
	ShardsCount int32 `json:"shardsCount,omitempty"`

	//Replicas count
	ReplicasCount int32 `json:"replicasCount,omitempty"`

	//Zookeeper config
	Zookeeper *ZookeeperConfig `json:"zookeeper,omitempty"`

	//Custom defined XML settings, like <yandex>somethine</yandex>
	CustomSettings string

	//The storage capacity
	DataCapacity string `json:"dataCapacity,omitempty"`

	//Define StorageClass for Persistent Volume Claims in the local storage.
	DataStorageClass string `json:"dataStorageClass,omitempty"`
}

ClickHouseClusterSpec defines the desired state of ClickHouseCluster +k8s:openapi-gen=true

func (*ClickHouseClusterSpec) DeepCopy

func (in *ClickHouseClusterSpec) DeepCopy() *ClickHouseClusterSpec

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

func (*ClickHouseClusterSpec) DeepCopyInto

func (in *ClickHouseClusterSpec) DeepCopyInto(out *ClickHouseClusterSpec)

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

type ClickHouseClusterStatus

type ClickHouseClusterStatus struct {
	Phase       string                  `json:"phase,omitempty"`
	ShardStatus map[string]*ShardStatus `json:"shardStatus,omitempty"`
}

Remove subresources, cuz https://github.com/kubernetes/kubectl/issues/564 ClickHouseClusterStatus defines the observed state of ClickHouseCluster +k8s:openapi-gen=true

func (*ClickHouseClusterStatus) DeepCopy

func (in *ClickHouseClusterStatus) DeepCopy() *ClickHouseClusterStatus

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

func (*ClickHouseClusterStatus) DeepCopyInto

func (in *ClickHouseClusterStatus) DeepCopyInto(out *ClickHouseClusterStatus)

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

type ShardStatus

type ShardStatus struct {
	// Phase indicates the state this Clickhouse cluster jumps in.
	// Phase goes as one way as below:
	//   Initial -> Running <-> updating
	Phase string `json:"phase,omitempty"`
}

ShardStatus defines states of Clickhouse for 1 shard (1 statefulset)

func (*ShardStatus) DeepCopy

func (in *ShardStatus) DeepCopy() *ShardStatus

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

func (*ShardStatus) DeepCopyInto

func (in *ShardStatus) DeepCopyInto(out *ShardStatus)

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

type ZookeeperConfig

type ZookeeperConfig struct {
	Nodes              []ZookeeperNode `json:"nodes,omitempty"                yaml:"nodes"  xml:"nodes"`
	SessionTimeoutMs   int             `json:"session_timeout_ms,omitempty"   yaml:"session_timeout_ms" xml:"session_timeout_ms"`
	OperationTimeoutMs int             `json:"operation_timeout_ms,omitempty" yaml:"operation_timeout_ms" xml:"operation_timeout_ms"`
	Root               string          `json:"root,omitempty"                 yaml:"root" xml:"root"`
	Identity           string          `json:"identity,omitempty"             yaml:"identity" xml:"identity"`
}

ZookeeperConfig defines zookeeper Refers to https://clickhouse.yandex/docs/en/single/index.html?#server-settings_zookeeper

func (*ZookeeperConfig) DeepCopy

func (in *ZookeeperConfig) DeepCopy() *ZookeeperConfig

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

func (*ZookeeperConfig) DeepCopyInto

func (in *ZookeeperConfig) DeepCopyInto(out *ZookeeperConfig)

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

type ZookeeperNode

type ZookeeperNode struct {
	Host string `json:"host" yaml:"host" xml:"host"`
	Port int32  `json:"port" yaml:"port" xml:"port"`
}

ZookeeperNode defines item of nodes section

func (*ZookeeperNode) DeepCopy

func (in *ZookeeperNode) DeepCopy() *ZookeeperNode

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

func (*ZookeeperNode) DeepCopyInto

func (in *ZookeeperNode) DeepCopyInto(out *ZookeeperNode)

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