Skip to content

Commit

Permalink
Merge branch 'master' into pg-remote-replica
Browse files Browse the repository at this point in the history
  • Loading branch information
heheh13 authored Sep 29, 2023
2 parents f49bdea + a4ea74a commit a45ca57
Show file tree
Hide file tree
Showing 22 changed files with 2,062 additions and 2 deletions.
3 changes: 3 additions & 0 deletions apis/kubedb/v1alpha2/constants.go
Original file line number Diff line number Diff line change
Expand Up @@ -519,11 +519,14 @@ const (
KafkaBrokerClientPortName = "broker"
KafkaControllerClientPortName = "controller"
KafkaPortNameInternal = "internal"
KafkaPortNameExternal = "external"
KafkaTopicNameHealth = "kafka-health"
KafkaTopicDeletionThresholdOffset = 1000
KafkaControllerMaxID = 1000
KafkaRESTPort = 9092
KafkaControllerRESTPort = 9093
KafkaInternalRESTPort = 29092
KafkaExternalRESTPort = 19092
KafkaCruiseControlRESTPort = 9090
KafkaCruiseControlListenerPort = 9094
KafkaCCDefaultInNetwork = 500000
Expand Down
1 change: 1 addition & 0 deletions apis/kubedb/v1alpha2/kafka_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ const (
KafkaListenerBroker KafkaListenerType = "BROKER"
KafkaListenerController KafkaListenerType = "CONTROLLER"
KafkaListenerInternal KafkaListenerType = "INTERNAL"
KafkaListenerExternal KafkaListenerType = "EXTERNAL"
KafkaListenerCC KafkaListenerType = "CC"
)

Expand Down
2 changes: 1 addition & 1 deletion apis/kubedb/v1alpha2/pgbouncer_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ type Databases struct {

type ConnectionPoolConfig struct {
// Port is the port number on which PgBouncer listens to clients. Default: 5432.
// +kubebuilder:default=54342
// +kubebuilder:default=5432
// +optional
Port *int32 `json:"port,omitempty"`
// PoolMode is the pooling mechanism type. Default: session.
Expand Down
14 changes: 14 additions & 0 deletions apis/ops/v1alpha1/constant.go
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,20 @@ const (
VolumeExpansionCoordinatingNode = "VolumeExpansionCoordinatingNode"
)

// Kafka Constants
const (
ScaleUpBroker = "ScaleUpBroker"
ScaleUpController = "ScaleUpController"
ScaleUpCombined = "ScaleUpCombined"
ScaleDownBroker = "ScaleDownBroker"
ScaleDownController = "ScaleDownController"
ScaleDownCombined = "ScaleDownCombined"

UpdateBrokerNodePVCs = "UpdateBrokerNodePVCs"
UpdateControllerNodePVCs = "UpdateControllerNodePVCs"
UpdateCombinedNodePVCs = "UpdateCombinedNodePVCs"
)

// MongoDB Constants
const (
StartingBalancer = "StartingBalancer"
Expand Down
80 changes: 80 additions & 0 deletions apis/ops/v1alpha1/kafka_ops_helpers.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
/*
Copyright AppsCode Inc. and Contributors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1alpha1

import (
"fmt"

"kubedb.dev/apimachinery/apis"
"kubedb.dev/apimachinery/apis/ops"
"kubedb.dev/apimachinery/crds"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"kmodules.xyz/client-go/apiextensions"
)

func (_ *KafkaOpsRequest) CustomResourceDefinition() *apiextensions.CustomResourceDefinition {
return crds.MustCustomResourceDefinition(SchemeGroupVersion.WithResource(ResourcePluralKafkaOpsRequest))
}

var _ apis.ResourceInfo = &KafkaOpsRequest{}

func (k *KafkaOpsRequest) ResourceFQN() string {
return fmt.Sprintf("%s.%s", ResourcePluralKafkaOpsRequest, ops.GroupName)
}

func (k *KafkaOpsRequest) ResourceShortCode() string {
return ResourceCodeKafkaOpsRequest
}

func (k *KafkaOpsRequest) ResourceKind() string {
return ResourceKindKafkaOpsRequest
}

func (k *KafkaOpsRequest) ResourceSingular() string {
return ResourceSingularKafkaOpsRequest
}

func (k *KafkaOpsRequest) ResourcePlural() string {
return ResourcePluralKafkaOpsRequest
}

var _ Accessor = &KafkaOpsRequest{}

func (k *KafkaOpsRequest) GetRequestType() any {
return k.Spec.Type
}

func (k *KafkaOpsRequest) GetObjectMeta() metav1.ObjectMeta {
return k.ObjectMeta
}

func (k *KafkaOpsRequest) GetUpdateVersionSpec() *KafkaUpdateVersionSpec {
return k.Spec.UpdateVersion
}

func (k *KafkaOpsRequest) GetDBRefName() string {
return k.Spec.DatabaseRef.Name
}

func (k *KafkaOpsRequest) GetStatus() OpsRequestStatus {
return k.Status
}

func (k *KafkaOpsRequest) SetStatus(s OpsRequestStatus) {
k.Status = s
}
173 changes: 173 additions & 0 deletions apis/ops/v1alpha1/kafka_ops_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
/*
Copyright AppsCode Inc. and Contributors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

//go:generate go-enum --mustparse --names --values
package v1alpha1

import (
core "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const (
ResourceCodeKafkaOpsRequest = "kfops"
ResourceKindKafkaOpsRequest = "KafkaOpsRequest"
ResourceSingularKafkaOpsRequest = "kafkaopsrequest"
ResourcePluralKafkaOpsRequest = "kafkaopsrequests"
)

// kafkaDBOpsRequest defines a Kafka DBA operation.

// +genclient
// +k8s:openapi-gen=true
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// +kubebuilder:object:root=true
// +kubebuilder:resource:path=kafkaopsrequests,singular=kafkaopsrequest,shortName=kfops,categories={datastore,kubedb,appscode}
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="Type",type="string",JSONPath=".spec.type"
// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.phase"
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
type KafkaOpsRequest struct {
metav1.TypeMeta `json:",inline,omitempty"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec KafkaOpsRequestSpec `json:"spec,omitempty"`
Status OpsRequestStatus `json:"status,omitempty"`
}

// KafkaOpsRequestSpec is the spec for KafkaOpsRequest
type KafkaOpsRequestSpec struct {
// Specifies the Kafka reference
DatabaseRef core.LocalObjectReference `json:"databaseRef"`
// Specifies the ops request type: UpdateVersion, HorizontalScaling, VerticalScaling etc.
Type KafkaOpsRequestType `json:"type"`
// Specifies information necessary for upgrading Kafka
UpdateVersion *KafkaUpdateVersionSpec `json:"updateVersion,omitempty"`
// Specifies information necessary for horizontal scaling
HorizontalScaling *KafkaHorizontalScalingSpec `json:"horizontalScaling,omitempty"`
// Specifies information necessary for vertical scaling
VerticalScaling *KafkaVerticalScalingSpec `json:"verticalScaling,omitempty"`
// Specifies information necessary for volume expansion
VolumeExpansion *KafkaVolumeExpansionSpec `json:"volumeExpansion,omitempty"`
// Specifies information necessary for custom configuration of Kafka
Configuration *KafkaCustomConfigurationSpec `json:"configuration,omitempty"`
// Specifies information necessary for configuring TLS
TLS *TLSSpec `json:"tls,omitempty"`
// Specifies information necessary for restarting database
Restart *RestartSpec `json:"restart,omitempty"`
// Timeout for each step of the ops request in second. If a step doesn't finish within the specified timeout, the ops request will result in failure.
Timeout *metav1.Duration `json:"timeout,omitempty"`
// ApplyOption is to control the execution of OpsRequest depending on the database state.
// +kubebuilder:default="IfReady"
Apply ApplyOption `json:"apply,omitempty"`
}

// +kubebuilder:validation:Enum=UpdateVersion;HorizontalScaling;VerticalScaling;VolumeExpansion;Restart;Reconfigure;ReconfigureTLS
// ENUM(UpdateVersion, HorizontalScaling, VerticalScaling, VolumeExpansion, Restart, Reconfigure, ReconfigureTLS)
type KafkaOpsRequestType string

// KafkaReplicaReadinessCriteria is the criteria for checking readiness of a Kafka pod
// after updating, horizontal scaling etc.
type KafkaReplicaReadinessCriteria struct{}

// KafkaUpdateVersionSpec contains the update version information of a kafka cluster
type KafkaUpdateVersionSpec struct {
// Specifies the target version name from catalog
TargetVersion string `json:"targetVersion,omitempty"`
}

// KafkaHorizontalScalingSpec contains the horizontal scaling information of a Kafka cluster
type KafkaHorizontalScalingSpec struct {
// Number of combined (i.e. broker, controller) node
Node *int32 `json:"node,omitempty"`
// Node topology specification
Topology *KafkaHorizontalScalingTopologySpec `json:"topology,omitempty"`
}

// KafkaHorizontalScalingTopologySpec contains the horizontal scaling information in cluster topology mode
type KafkaHorizontalScalingTopologySpec struct {
// Number of broker nodes
Broker *int32 `json:"broker,omitempty"`
// Number of controller nodes
Controller *int32 `json:"controller,omitempty"`
}

// KafkaVerticalScalingSpec contains the vertical scaling information of a Kafka cluster
type KafkaVerticalScalingSpec struct {
// Resource spec for combined nodes
Node *core.ResourceRequirements `json:"node,omitempty"`
// Specifies the resource spec for cluster in topology mode
Topology *KafkaVerticalScalingTopologySpec `json:"topology,omitempty"`
}

// KafkaVerticalScalingTopologySpec contains the vertical scaling information in cluster topology mode
type KafkaVerticalScalingTopologySpec struct {
// Resource spec for broker
Broker *core.ResourceRequirements `json:"broker,omitempty"`
// Resource spec for controller
Controller *core.ResourceRequirements `json:"controller,omitempty"`
}

// KafkaVolumeExpansionSpec is the spec for Kafka volume expansion
type KafkaVolumeExpansionSpec struct {
// +kubebuilder:default="Online"
Mode *VolumeExpansionMode `json:"mode,omitempty"`
// volume specification for combined nodes
Node *resource.Quantity `json:"node,omitempty"`
// volume specification for kafka topology
Topology *KafkaVolumeExpansionTopologySpec `json:"topology,omitempty"`
}

type KafkaVolumeExpansionTopologySpec struct {
// volume specification for broker
Broker *resource.Quantity `json:"broker,omitempty"`
// volume specification for controller
Controller *resource.Quantity `json:"controller,omitempty"`
}

// KafkaCustomConfigurationSpec is the spec for Reconfiguring the Kafka Settings
type KafkaCustomConfigurationSpec struct {
// ConfigSecret is an optional field to provide custom configuration file for database.
// +optional
ConfigSecret *core.LocalObjectReference `json:"configSecret,omitempty"`
// ApplyConfig is an optional field to provide Kafka configuration.
// Provided configuration will be applied to config files stored in ConfigSecret.
// If the ConfigSecret is missing, the operator will create a new k8s secret by the
// following naming convention: {db-name}-user-config .
// Expected input format:
// applyConfig:
// file-name.properties: |
// key=value
// server.properties: |
// log.retention.ms=10000
// +optional
ApplyConfig map[string]string `json:"applyConfig,omitempty"`
// If set to "true", the user provided configuration will be removed.
// The Kafka cluster will start will default configuration that is generated by the operator.
// +optional
RemoveCustomConfig bool `json:"removeCustomConfig,omitempty"`
}

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// KafkaOpsRequestList is a list of KafkaOpsRequests
type KafkaOpsRequestList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
// Items is a list of KafkaOpsRequest CRD objects
Items []KafkaOpsRequest `json:"items,omitempty"`
}
Loading

0 comments on commit a45ca57

Please sign in to comment.