Documentation ¶
Overview ¶
Package v1 defines version 1 of the API used with ClickHouse Installation Custom Resources.
Package v1 defines version 1 of the API used with ClickHouseKeeper custom resource.
Index ¶
- Constants
- Variables
- type ChkCluster
- type ChkClusterLayout
- type ChkConfiguration
- func (in *ChkConfiguration) DeepCopy() *ChkConfiguration
- func (in *ChkConfiguration) DeepCopyInto(out *ChkConfiguration)
- func (c *ChkConfiguration) GetCluster(i int) *ChkCluster
- func (c *ChkConfiguration) GetClusters() []*ChkCluster
- func (c *ChkConfiguration) GetSettings() *apiChi.Settings
- func (configuration *ChkConfiguration) MergeFrom(from *ChkConfiguration, _type apiChi.MergeType) *ChkConfiguration
- type ChkSpec
- func (in *ChkSpec) DeepCopy() *ChkSpec
- func (in *ChkSpec) DeepCopyInto(out *ChkSpec)
- func (spec ChkSpec) EnsureConfiguration() *ChkConfiguration
- func (spec *ChkSpec) GetClientPort() int
- func (spec ChkSpec) GetConfiguration() *ChkConfiguration
- func (spec *ChkSpec) GetPath() string
- func (spec *ChkSpec) GetPort(name string, defaultValue int) int
- func (spec *ChkSpec) GetPrometheusPort() int
- func (spec *ChkSpec) GetRaftPort() int
- func (spec ChkSpec) GetTemplates() *apiChi.Templates
- func (spec *ChkSpec) MergeFrom(from *ChkSpec, _type apiChi.MergeType)
- type ChkStatus
- func (s *ChkStatus) ClearNormalizedCHK()
- func (s *ChkStatus) CopyFrom(from *ChkStatus, opts apiChi.CopyCHIStatusOptions)
- func (in *ChkStatus) DeepCopy() *ChkStatus
- func (in *ChkStatus) DeepCopyInto(out *ChkStatus)
- func (s *ChkStatus) GetNormalizedCHK() *ClickHouseKeeperInstallation
- func (s *ChkStatus) GetNormalizedCHKCompleted() *ClickHouseKeeperInstallation
- func (s *ChkStatus) HasNormalizedCHK() bool
- func (s *ChkStatus) HasNormalizedCHKCompleted() bool
- type ClickHouseKeeperInstallation
- func (in *ClickHouseKeeperInstallation) DeepCopy() *ClickHouseKeeperInstallation
- func (in *ClickHouseKeeperInstallation) DeepCopyInto(out *ClickHouseKeeperInstallation)
- func (in *ClickHouseKeeperInstallation) DeepCopyObject() runtime.Object
- func (chk *ClickHouseKeeperInstallation) EnsureStatus() *ChkStatus
- func (chk *ClickHouseKeeperInstallation) GetAncestor() *ClickHouseKeeperInstallation
- func (chk *ClickHouseKeeperInstallation) GetStatus() *ChkStatus
- func (chk *ClickHouseKeeperInstallation) GetTarget() *ClickHouseKeeperInstallation
- func (chk *ClickHouseKeeperInstallation) HasAncestor() bool
- func (chk *ClickHouseKeeperInstallation) HasStatus() bool
- func (chk *ClickHouseKeeperInstallation) HasTarget() bool
- func (chk *ClickHouseKeeperInstallation) MergeFrom(from *ClickHouseKeeperInstallation, _type apiChi.MergeType)
- func (chk *ClickHouseKeeperInstallation) SetAncestor(a *ClickHouseKeeperInstallation)
- func (chk *ClickHouseKeeperInstallation) SetTarget(a *ClickHouseKeeperInstallation)
- type ClickHouseKeeperInstallationList
- type ClickHouseKeeperInstallationRuntime
Constants ¶
const (
// APIVersion is the version of the ClickHouse Keeper Operator API.
APIVersion = "v1"
)
const (
ClickHouseKeeperInstallationCRDResourceKind = "ClickHouseKeeperInstallation"
)
Possible kinds of CRDs
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{ Group: clickhouse_keeper_altinity_com.APIGroupName, Version: APIVersion, } // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{ GroupVersion: SchemeGroupVersion, } // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ChkCluster ¶
type ChkCluster struct { Name string `json:"name,omitempty" yaml:"name,omitempty"` Layout *ChkClusterLayout `json:"layout,omitempty" yaml:"layout,omitempty"` }
ChkCluster defines item of a clusters section of .configuration
func (*ChkCluster) DeepCopy ¶
func (in *ChkCluster) DeepCopy() *ChkCluster
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChkCluster.
func (*ChkCluster) DeepCopyInto ¶
func (in *ChkCluster) DeepCopyInto(out *ChkCluster)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChkCluster) GetLayout ¶
func (c *ChkCluster) GetLayout() *ChkClusterLayout
type ChkClusterLayout ¶
type ChkClusterLayout struct { // The valid range of size is from 1 to 7. ReplicasCount int `json:"replicasCount,omitempty" yaml:"replicasCount,omitempty"` }
ChkClusterLayout defines layout section of .spec.configuration.clusters
func NewChkClusterLayout ¶
func NewChkClusterLayout() *ChkClusterLayout
NewChkClusterLayout creates new cluster layout
func (*ChkClusterLayout) DeepCopy ¶
func (in *ChkClusterLayout) DeepCopy() *ChkClusterLayout
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChkClusterLayout.
func (*ChkClusterLayout) DeepCopyInto ¶
func (in *ChkClusterLayout) DeepCopyInto(out *ChkClusterLayout)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChkClusterLayout) GetReplicasCount ¶
func (c *ChkClusterLayout) GetReplicasCount() int
type ChkConfiguration ¶
type ChkConfiguration struct { Settings *apiChi.Settings `json:"settings,omitempty" yaml:"settings,omitempty"` Clusters []*ChkCluster `json:"clusters,omitempty" yaml:"clusters,omitempty"` }
ChkConfiguration defines configuration section of .spec
func NewConfiguration ¶
func NewConfiguration() *ChkConfiguration
NewConfiguration creates new ChkConfiguration objects
func (*ChkConfiguration) DeepCopy ¶
func (in *ChkConfiguration) DeepCopy() *ChkConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChkConfiguration.
func (*ChkConfiguration) DeepCopyInto ¶
func (in *ChkConfiguration) DeepCopyInto(out *ChkConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChkConfiguration) GetCluster ¶
func (c *ChkConfiguration) GetCluster(i int) *ChkCluster
func (*ChkConfiguration) GetClusters ¶
func (c *ChkConfiguration) GetClusters() []*ChkCluster
func (*ChkConfiguration) GetSettings ¶
func (c *ChkConfiguration) GetSettings() *apiChi.Settings
func (*ChkConfiguration) MergeFrom ¶
func (configuration *ChkConfiguration) MergeFrom(from *ChkConfiguration, _type apiChi.MergeType) *ChkConfiguration
MergeFrom merges from specified source
type ChkSpec ¶
type ChkSpec struct { Configuration *ChkConfiguration `json:"configuration,omitempty" yaml:"configuration,omitempty"` Templates *apiChi.Templates `json:"templates,omitempty" yaml:"templates,omitempty"` }
ChkSpec defines spec section of ClickHouseKeeper resource
func (*ChkSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChkSpec.
func (*ChkSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (ChkSpec) EnsureConfiguration ¶
func (spec ChkSpec) EnsureConfiguration() *ChkConfiguration
func (*ChkSpec) GetClientPort ¶
func (ChkSpec) GetConfiguration ¶
func (spec ChkSpec) GetConfiguration() *ChkConfiguration
func (*ChkSpec) GetPrometheusPort ¶
func (*ChkSpec) GetRaftPort ¶
func (ChkSpec) GetTemplates ¶
type ChkStatus ¶
type ChkStatus struct { CHOpVersion string `json:"chop-version,omitempty" yaml:"chop-version,omitempty"` CHOpCommit string `json:"chop-commit,omitempty" yaml:"chop-commit,omitempty"` CHOpDate string `json:"chop-date,omitempty" yaml:"chop-date,omitempty"` CHOpIP string `json:"chop-ip,omitempty" yaml:"chop-ip,omitempty"` Status string `json:"status,omitempty" yaml:"status,omitempty"` // Replicas is the number of number of desired replicas in the cluster Replicas int32 `json:"replicas,omitempty"` // ReadyReplicas is the number of number of ready replicas in the cluster ReadyReplicas []apiChi.ChiZookeeperNode `json:"readyReplicas,omitempty"` Pods []string `json:"pods,omitempty" yaml:"pods,omitempty"` PodIPs []string `json:"pod-ips,omitempty" yaml:"pod-ips,omitempty"` FQDNs []string `json:"fqdns,omitempty" yaml:"fqdns,omitempty"` NormalizedCHK *ClickHouseKeeperInstallation `json:"normalized,omitempty" yaml:"normalized,omitempty"` NormalizedCHKCompleted *ClickHouseKeeperInstallation `json:"normalizedCompleted,omitempty" yaml:"normalizedCompleted,omitempty"` }
ChkStatus defines status section of ClickHouseKeeper resource
func (*ChkStatus) ClearNormalizedCHK ¶
func (s *ChkStatus) ClearNormalizedCHK()
ClearNormalizedCHK clears normalized CHK in status
func (*ChkStatus) CopyFrom ¶
func (s *ChkStatus) CopyFrom(from *ChkStatus, opts apiChi.CopyCHIStatusOptions)
CopyFrom copies the state of a given ChiStatus f into the receiver ChiStatus of the call.
func (*ChkStatus) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChkStatus.
func (*ChkStatus) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ChkStatus) GetNormalizedCHK ¶
func (s *ChkStatus) GetNormalizedCHK() *ClickHouseKeeperInstallation
GetNormalizedCHK gets target CHK
func (*ChkStatus) GetNormalizedCHKCompleted ¶
func (s *ChkStatus) GetNormalizedCHKCompleted() *ClickHouseKeeperInstallation
GetNormalizedCHKCompleted gets completed CHI
func (*ChkStatus) HasNormalizedCHK ¶
HasNormalizedCHK is a checker
func (*ChkStatus) HasNormalizedCHKCompleted ¶
HasNormalizedCHKCompleted is a checker
type ClickHouseKeeperInstallation ¶
type ClickHouseKeeperInstallation struct { meta.TypeMeta `json:",inline" yaml:",inline"` meta.ObjectMeta `json:"metadata,omitempty" yaml:"metadata,omitempty"` Spec ChkSpec `json:"spec" yaml:"spec"` Status *ChkStatus `json:"status,omitempty" yaml:"status,omitempty"` Runtime ClickHouseKeeperInstallationRuntime `json:"-" yaml:"-"` }
ClickHouseKeeperInstallation defines a ClickHouse Keeper ChkCluster
func (*ClickHouseKeeperInstallation) DeepCopy ¶
func (in *ClickHouseKeeperInstallation) DeepCopy() *ClickHouseKeeperInstallation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClickHouseKeeperInstallation.
func (*ClickHouseKeeperInstallation) DeepCopyInto ¶
func (in *ClickHouseKeeperInstallation) DeepCopyInto(out *ClickHouseKeeperInstallation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClickHouseKeeperInstallation) DeepCopyObject ¶
func (in *ClickHouseKeeperInstallation) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ClickHouseKeeperInstallation) EnsureStatus ¶
func (chk *ClickHouseKeeperInstallation) EnsureStatus() *ChkStatus
EnsureStatus ensures status
func (*ClickHouseKeeperInstallation) GetAncestor ¶
func (chk *ClickHouseKeeperInstallation) GetAncestor() *ClickHouseKeeperInstallation
GetAncestor gets ancestor of a CHI
func (*ClickHouseKeeperInstallation) GetStatus ¶
func (chk *ClickHouseKeeperInstallation) GetStatus() *ChkStatus
GetStatus gets Status
func (*ClickHouseKeeperInstallation) GetTarget ¶
func (chk *ClickHouseKeeperInstallation) GetTarget() *ClickHouseKeeperInstallation
GetTarget gets target of a CHI
func (*ClickHouseKeeperInstallation) HasAncestor ¶
func (chk *ClickHouseKeeperInstallation) HasAncestor() bool
HasAncestor checks whether CHI has an ancestor
func (*ClickHouseKeeperInstallation) HasStatus ¶
func (chk *ClickHouseKeeperInstallation) HasStatus() bool
HasStatus checks whether CHI has Status
func (*ClickHouseKeeperInstallation) HasTarget ¶
func (chk *ClickHouseKeeperInstallation) HasTarget() bool
HasTarget checks whether CHI has a target
func (*ClickHouseKeeperInstallation) MergeFrom ¶
func (chk *ClickHouseKeeperInstallation) MergeFrom(from *ClickHouseKeeperInstallation, _type apiChi.MergeType)
MergeFrom merges from CHI
func (*ClickHouseKeeperInstallation) SetAncestor ¶
func (chk *ClickHouseKeeperInstallation) SetAncestor(a *ClickHouseKeeperInstallation)
SetAncestor sets ancestor of a CHI
func (*ClickHouseKeeperInstallation) SetTarget ¶
func (chk *ClickHouseKeeperInstallation) SetTarget(a *ClickHouseKeeperInstallation)
SetTarget sets target of a CHI
type ClickHouseKeeperInstallationList ¶
type ClickHouseKeeperInstallationList struct { meta.TypeMeta `json:",inline" yaml:",inline"` meta.ListMeta `json:"metadata" yaml:"metadata"` Items []ClickHouseKeeperInstallation `json:"items" yaml:"items"` }
ClickHouseKeeperList defines a list of ClickHouseKeeper resources
func (*ClickHouseKeeperInstallationList) DeepCopy ¶
func (in *ClickHouseKeeperInstallationList) DeepCopy() *ClickHouseKeeperInstallationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClickHouseKeeperInstallationList.
func (*ClickHouseKeeperInstallationList) DeepCopyInto ¶
func (in *ClickHouseKeeperInstallationList) DeepCopyInto(out *ClickHouseKeeperInstallationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClickHouseKeeperInstallationList) DeepCopyObject ¶
func (in *ClickHouseKeeperInstallationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClickHouseKeeperInstallationRuntime ¶
type ClickHouseKeeperInstallationRuntime struct {
// contains filtered or unexported fields
}
func (*ClickHouseKeeperInstallationRuntime) DeepCopy ¶
func (in *ClickHouseKeeperInstallationRuntime) DeepCopy() *ClickHouseKeeperInstallationRuntime
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClickHouseKeeperInstallationRuntime.
func (*ClickHouseKeeperInstallationRuntime) DeepCopyInto ¶
func (in *ClickHouseKeeperInstallationRuntime) DeepCopyInto(out *ClickHouseKeeperInstallationRuntime)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.