Expand crd configuration options (#22)

akyriako · web-flow · commit af014dc3f58f · 2025-01-06T20:07:38.000+01:00
* added nodeselector, resources, tolerations #20 #18 #8 draft for additional vars from configmap #19 * added extra configuration #8 #18 #19 #20
diff --git a/Makefile b/Makefile
@@ -52,7 +52,7 @@ OPERATOR_SDK_VERSION ?= v1.38.0
 # Image URL to use all building/pushing image targets
 DOCKER_HUB_NAME ?= $(shell docker info | sed '/Username:/!d;s/.* //')
 IMG_NAME ?= typesense-operator
-IMG_TAG ?= 0.2.6
+IMG_TAG ?= 0.2.7
 IMG ?= $(DOCKER_HUB_NAME)/$(IMG_NAME):$(IMG_TAG)
 
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
diff --git a/README.md b/README.md
@@ -172,18 +172,30 @@ introducing `TypesenseCluster`, a new Custom Resource Definition:
 
 **Spec**
 
-| Name              | Description                                        | Optional | Default |
-|-------------------|----------------------------------------------------|----------|---------|
-| image             | Typesense image                                    |          |         |
-| adminApiKey       | Reference to the `Secret` to be used for bootstrap | X        |         |
-| replicas          | Size of the cluster                                |          | 1       |
-| apiPort           | REST/API port                                      |          | 8108    |
-| peeringPort       | Peering port                                       |          | 8107    |
-| resetPeersOnError | automatic reset of peers on error                  |          | true    |
-| corsDomains       | domains that would be allowed for CORS calls       | X        |         |
-| storage           | check `StorageSpec` below                            |          |         |
-| ingress           | check `IngressSpec` below                            | X        |         |
-| scrapers          | array of `DocSearchScraperSpec`; check below         | X        |         |
+| Name                          | Description                                              | Optional | Default       |
+|-------------------------------|----------------------------------------------------------|----------|---------------|
+| image                         | Typesense image                                          |          |               |
+| adminApiKey                   | Reference to the `Secret` to be used for bootstrap       | X        |               |
+| replicas                      | Size of the cluster                                      |          | 1             |
+| apiPort                       | REST/API port                                            |          | 8108          |
+| peeringPort                   | Peering port                                             |          | 8107          |
+| resetPeersOnError             | automatic reset of peers on error                        |          | true          |
+| enableCors                    | enables CORS                                             | X        | false         |
+| corsDomains                   | domains that would be allowed for CORS calls             | X        |               |
+| resources                     | resource request & limit                                 | X        | _check specs_ |
+| nodeSelector                  | node selection constraint                                | X        |               |
+| tolerations                   | schedule pods with matching taints                       | X        |               |
+| additionalServerConfiguration | a reference to a `ConfigMap` holding extra configuration | X        |               |
+| storage                       | check `StorageSpec` below                                |          |               |
+| ingress                       | check `IngressSpec` below                                | X        |               |
+| scrapers                      | array of `DocSearchScraperSpec`; check below             | X        |               |
+
+> [!IMPORTANT]
+> * Any Typesense server configuration variable that is defined in Spec is overriding any additional reference of
+>   the same variable in `additionalServerConfiguration`. You can find an example of providing an additional `ConfigMap`
+>   in: **config/samples/ts_v1alpha1_typesensecluster_kind.yaml**
+> * Add additional Typesense server configuration variables in `ConfigMap` as described in:
+>   https://typesense.org/docs/27.1/api/server-configuration.html#using-environment-variables
 
 **StorageSpec** (optional)
 
diff --git a/api/v1alpha1/typesensecluster_types.go b/api/v1alpha1/typesensecluster_types.go
@@ -61,10 +61,26 @@ type TypesenseClusterSpec struct {
 	// +kubebuilder:validation:Type=boolean
 	ResetPeersOnError bool `json:"resetPeersOnError,omitempty"`
 
+	// +optional
+	// +kubebuilder:default=false
+	// +kubebuilder:validation:Type=boolean
+	EnableCors bool `json:"enableCors,omitempty"`
+
 	// +optional
 	// +kubebuilder:validation:Type=string
 	CorsDomains *string `json:"corsDomains,omitempty"`
 
+	Resources *corev1.ResourceRequirements `json:"resources,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
+
+	// +kubebuilder:validation:Optional
+	AdditionalServerConfiguration *corev1.LocalObjectReference `json:"additionalServerConfiguration,omitempty"`
+
 	Storage *StorageSpec `json:"storage"`
 
 	Ingress *IngressSpec `json:"ingress,omitempty"`
diff --git a/api/v1alpha1/typesensecluster_types_helpers.go b/api/v1alpha1/typesensecluster_types_helpers.go
@@ -1,30 +1,54 @@
 package v1alpha1
 
 import (
+	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
-	"strings"
 )
 
-func (s *TypesenseClusterSpec) IsCorsEnabled() bool {
-	if s.CorsDomains != nil && strings.TrimSpace(*s.CorsDomains) != "" {
-		return true
+func (s *TypesenseClusterSpec) GetResources() corev1.ResourceRequirements {
+	if s.Resources != nil {
+		return *s.Resources
 	}
-	return false
+
+	return corev1.ResourceRequirements{
+		Limits: corev1.ResourceList{
+			corev1.ResourceCPU:    resource.MustParse("1024m"),
+			corev1.ResourceMemory: resource.MustParse("512Mi"),
+		},
+		Requests: corev1.ResourceList{
+			corev1.ResourceCPU:    resource.MustParse("128m"),
+			corev1.ResourceMemory: resource.MustParse("256Mi"),
+		},
+	}
+}
+
+func (s *TypesenseClusterSpec) GetAdditionalServerConfiguration() []corev1.EnvFromSource {
+	if s.AdditionalServerConfiguration != nil {
+		return []corev1.EnvFromSource{
+			{
+				ConfigMapRef: &corev1.ConfigMapEnvSource{
+					LocalObjectReference: *s.AdditionalServerConfiguration,
+				},
+			},
+		}
+	}
+
+	return []corev1.EnvFromSource{}
 }
 
 func (s *TypesenseClusterSpec) GetCorsDomains() string {
-	if s.IsCorsEnabled() {
+	if s.EnableCors {
 		return *s.CorsDomains
 	}
 	return ""
 }
 
-func (s *TypesenseClusterSpec) GetStorage() *StorageSpec {
+func (s *TypesenseClusterSpec) GetStorage() StorageSpec {
 	if s.Storage != nil {
-		return s.Storage
+		return *s.Storage
 	}
 
-	return &StorageSpec{
+	return StorageSpec{
 		Size:             resource.MustParse("100Mi"),
 		StorageClassName: "standard",
 	}
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/charts/typesense-operator/Chart.yaml b/charts/typesense-operator/Chart.yaml
@@ -13,9 +13,9 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.2.6
+version: 0.2.7
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.2.6"
+appVersion: "0.2.7"
diff --git a/charts/typesense-operator/values.yaml b/charts/typesense-operator/values.yaml
@@ -12,7 +12,7 @@ controllerManager:
         - ALL
     image:
       repository: akyriako78/typesense-operator
-      tag: 0.2.6
+      tag: 0.2.7
     resources:
       limits:
         cpu: 500m
diff --git a/config/crd/bases/ts.opentelekomcloud.com_typesenseclusters.yaml b/config/crd/bases/ts.opentelekomcloud.com_typesenseclusters.yaml
@@ -55,6 +55,24 @@ spec:
           spec:
             description: TypesenseClusterSpec defines the desired state of TypesenseCluster
             properties:
+              additionalServerConfiguration:
+                description: |-
+                  LocalObjectReference contains enough information to let you locate the
+                  referenced object inside the same namespace.
+                properties:
+                  name:
+                    default: ""
+                    description: |-
+                      Name of the referent.
+                      This field is effectively required, but due to backwards compatibility is
+                      allowed to be empty. Instances of this type with an empty value here are
+                      almost certainly wrong.
+                      TODO: Add other useful fields. apiVersion, kind, uid?
+                      More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+                      TODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
+                    type: string
+                type: object
+                x-kubernetes-map-type: atomic
               adminApiKey:
                 description: |-
                   SecretReference represents a Secret Reference. It has enough information to retrieve secret
@@ -78,6 +96,9 @@ spec:
                 type: integer
               corsDomains:
                 type: string
+              enableCors:
+                default: false
+                type: boolean
               image:
                 type: string
               ingress:
@@ -101,6 +122,10 @@ spec:
                 - host
                 - ingressClassName
                 type: object
+              nodeSelector:
+                additionalProperties:
+                  type: string
+                type: object
               peeringPort:
                 default: 8107
                 exclusiveMinimum: true
@@ -115,6 +140,61 @@ spec:
               resetPeersOnError:
                 default: true
                 type: boolean
+              resources:
+                description: ResourceRequirements describes the compute resource requirements.
+                properties:
+                  claims:
+                    description: |-
+                      Claims lists the names of resources, defined in spec.resourceClaims,
+                      that are used by this container.
+
+
+                      This is an alpha field and requires enabling the
+                      DynamicResourceAllocation feature gate.
+
+
+                      This field is immutable. It can only be set for containers.
+                    items:
+                      description: ResourceClaim references one entry in PodSpec.ResourceClaims.
+                      properties:
+                        name:
+                          description: |-
+                            Name must match the name of one entry in pod.spec.resourceClaims of
+                            the Pod where this field is used. It makes that resource available
+                            inside a container.
+                          type: string
+                      required:
+                      - name
+                      type: object
+                    type: array
+                    x-kubernetes-list-map-keys:
+                    - name
+                    x-kubernetes-list-type: map
+                  limits:
+                    additionalProperties:
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                      x-kubernetes-int-or-string: true
+                    description: |-
+                      Limits describes the maximum amount of compute resources allowed.
+                      More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+                    type: object
+                  requests:
+                    additionalProperties:
+                      anyOf:
+                      - type: integer
+                      - type: string
+                      pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                      x-kubernetes-int-or-string: true
+                    description: |-
+                      Requests describes the minimum amount of compute resources required.
+                      If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
+                      otherwise to an implementation-defined value. Requests cannot exceed Limits.
+                      More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
+                    type: object
+                type: object
               scrapers:
                 items:
                   properties:
@@ -148,6 +228,44 @@ spec:
                 required:
                 - storageClassName
                 type: object
+              tolerations:
+                items:
+                  description: |-
+                    The pod this Toleration is attached to tolerates any taint that matches
+                    the triple <key,value,effect> using the matching operator <operator>.
+                  properties:
+                    effect:
+                      description: |-
+                        Effect indicates the taint effect to match. Empty means match all taint effects.
+                        When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
+                      type: string
+                    key:
+                      description: |-
+                        Key is the taint key that the toleration applies to. Empty means match all taint keys.
+                        If the key is empty, operator must be Exists; this combination means to match all values and all keys.
+                      type: string
+                    operator:
+                      description: |-
+                        Operator represents a key's relationship to the value.
+                        Valid operators are Exists and Equal. Defaults to Equal.
+                        Exists is equivalent to wildcard for value, so that a pod can
+                        tolerate all taints of a particular category.
+                      type: string
+                    tolerationSeconds:
+                      description: |-
+                        TolerationSeconds represents the period of time the toleration (which must be
+                        of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
+                        it is not set, which means tolerate the taint forever (do not evict). Zero and
+                        negative values will be treated as 0 (evict immediately) by the system.
+                      format: int64
+                      type: integer
+                    value:
+                      description: |-
+                        Value is the taint value the toleration matches to.
+                        If the operator is Exists, the value should be empty, otherwise just a regular string.
+                      type: string
+                  type: object
+                type: array
             required:
             - image
             - storage
diff --git a/config/manager/kustomization.yaml b/config/manager/kustomization.yaml
@@ -5,4 +5,4 @@ kind: Kustomization
 images:
 - name: controller
   newName: akyriako78/typesense-operator
-  newTag: 0.1.0
+  newTag: 0.2.7-dev.1
diff --git a/config/samples/ts_v1alpha1_typesensecluster_kind.yaml b/config/samples/ts_v1alpha1_typesensecluster_kind.yaml
@@ -26,6 +26,14 @@ spec:
     ingressClassName: nginx
     clusterIssuer: lets-encrypt-prod
 ---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: c-kind-2-config
+data:
+  TYPESENSE_ENABLE_SEARCH_ANALYTICS: "true"
+  TYPESENSE_ENABLE_CORS: "true"
+---
 apiVersion: ts.opentelekomcloud.com/v1alpha1
 kind: TypesenseCluster
 metadata:
@@ -36,6 +44,8 @@ metadata:
 spec:
   image: typesense/typesense:26.0
   replicas: 1
+  additionalServerConfiguration:
+    name: c-kind-2-config
   storage:
     storageClassName: typesense-local-path
   ingress:
diff --git a/internal/controller/typesensecluster_statefulset.go b/internal/controller/typesensecluster_statefulset.go
