# Packages

No description provided by the author
No description provided by the author

# Functions

AppendLabelReady adds "ready" label with value = UTC now.
CreateCHIServiceFQDN creates a FQD name of a root ClickHouseInstallation Service resource.
CreateCHIServiceName creates a name of a root ClickHouseInstallation Service resource.
CreateClusterServiceName returns a name of a cluster's Service.
CreateConfigMapCommonName returns a name for a ConfigMap for replica's common config.
CreateConfigMapCommonUsersName returns a name for a ConfigMap for replica's common users config.
CreateConfigMapPersonalName returns a name for a ConfigMap for replica's personal config.
CreateFQDN is a wrapper over pod FQDN function.
CreateFQDNs is a wrapper over set of create FQDN functions obj specifies source object to create FQDNs from scope specifies target scope - what entity to create FQDNs for - be it CHI, cluster, shard or a host excludeSelf specifies whether to exclude the host itself from the result.
CreateHostName return a name of a host.
CreatePodHostname returns a name of a Pod of a ClickHouse instance.
CreatePodName create Pod name based on specified StatefulSet or Host.
CreatePodRegexp creates pod regexp template is defined in operator config: CHConfigNetworksHostRegexpTemplate: chi-{chi}-[^.]+\\d+-\\d+\\.{namespace}.svc.cluster.local$".
CreatePVCName create PVC name from components, to which PVC belongs to.
CreateReplicaHostname returns hostname (pod-hostname + service or FQDN) which can be used as a replica name in all places where ClickHouse requires replica name.
CreateReplicaName return a name of a replica.
CreateShardName return a name of a shard.
CreateShardServiceName returns a name of a shard's Service.
CreateStatefulSetName creates a name of a StatefulSet for ClickHouse instance.
CreateStatefulSetServiceName returns a name of a StatefulSet-related Service for ClickHouse instance.
DeleteLabelReady deletes "ready" label.
GetCHINameFromObjectMeta extracts CHI name from ObjectMeta by labels.
GetClusterNameFromObjectMeta extracts cluster name from ObjectMeta by labels.
GetReclaimPolicy gets reclaim policy from meta.
GetSelectorHostScope gets labels to select a Host-scoped object.
HostCanDeletePVC checks whether PVC on a host can be deleted.
IsAutoGeneratedHostName checks whether name is auto-generated.
IsAutoGeneratedReplicaName checks whether provided name is auto-generated.
IsAutoGeneratedShardName checks whether provided name is auto-generated.
IsCHOPGeneratedObject check whether object is generated by an operator.
IsObjectTheSame checks whether objects are the same.
IsStatefulSetGeneration returns whether StatefulSet has requested generation or not.
IsStatefulSetNotReady returns whether StatefulSet is not ready.
IsStatefulSetReady returns whether StatefulSet is ready.
MakeObjectVersionLabel makes object version label.
MakeSelectorFromObjectMeta makes selector from meta TODO review usage.
NewActionPlan makes new ActionPlan out of two CHIs.
NewAnnotator creates new annotator with context.
NewClickHouseConfigFilesGenerator creates new clickhouse configuration generator object.
NewClickHouseConfigFilesGeneratorOptions creates new options for clickhouse configuration generator.
NewClickHouseConfigGenerator returns new ClickHouseConfigGenerator struct.
NewCluster creates new cluster object.
NewCreator creates new Creator object.
NewLabeler creates new labeler with context.
NewNormalizer creates new normalizer.
NewRegistry creates new registry.
NewRemoteServersGeneratorOptions creates new remote-servers generator options.
NewSchemer creates new Schemer object.
StrStatefulSetStatus returns human-friendly string representation of StatefulSet status.

# Constants

ClickHouseContainerName specifies name of the clickhouse container in the pod.
ClickHouseLogContainerName specifies name of the logger container in the pod.
Possible entity types.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Set of kubernetes labels used by the operator.
Possible entity types.
Possible entity types.
Possible entity types.
Possible entity types.

# Structs

ActionPlan is an action plan with list of differences between two CHIs.
Annotator is an entity which can annotate CHI artifacts.
ClickHouseConfigFilesGenerator specifies clickhouse configuration generator object.
ClickHouseConfigFilesGeneratorOptions specifies options for clickhouse configuration generator.
ClickHouseConfigGenerator generates ClickHouse configuration files content for specified CHI ClickHouse configuration files content is an XML ATM, so config generator provides set of Get*() functions which produces XML which are parts of ClickHouse configuration and can/should be used as ClickHouse config files.
Cluster specifies ClickHouse cluster.
Creator specifies creator object.
Labeler is an entity which can label CHI artifacts.
Normalizer specifies structures normalizer.
Registry specifies registry struct.
RemoteServersGeneratorOptions specifies options for remote-servers generator.
Schemer specifies schema manager.

# Type aliases

EntityType specifies registry entity type.