feat: support for custom schedulerName in observer pod configuration (#…

…515) Related to issue #494
oceanbase · Aug 14, 2024 · a188c14 · a188c14
1 parent 5ad5523
commit a188c14
Show file tree

Hide file tree

Showing 12 changed files with 117 additions and 7 deletions.
diff --git a/api/types/observer_template.go b/api/types/observer_template.go
@@ -13,7 +13,8 @@ See the Mulan PSL v2 for more details.
 package types
 
 type OBServerTemplate struct {
-	Image    string                `json:"image"`
-	Resource *ResourceSpec         `json:"resource"`
-	Storage  *OceanbaseStorageSpec `json:"storage"`
+	Image     string                `json:"image"`
+	Resource  *ResourceSpec         `json:"resource"`
+	Storage   *OceanbaseStorageSpec `json:"storage"`
+	PodFields *PodFieldsSpec        `json:"podFields,omitempty"`
 }
diff --git a/api/types/podfields.go b/api/types/podfields.go
@@ -0,0 +1,17 @@
+/*
+Copyright (c) 2024 OceanBase
+ob-operator is licensed under Mulan PSL v2.
+You can use this software according to the terms and conditions of the Mulan PSL v2.
+You may obtain a copy of Mulan PSL v2 at:
+         http://license.coscl.org.cn/MulanPSL2
+THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+See the Mulan PSL v2 for more details.
+*/
+
+package types
+
+type PodFieldsSpec struct {
+	SchedulerName *string `json:"schedulerName,omitempty"`
+}
diff --git a/config/crd/bases/oceanbase.oceanbase.com_obclusteroperations.yaml b/config/crd/bases/oceanbase.oceanbase.com_obclusteroperations.yaml
@@ -4610,6 +4610,11 @@ spec:
                         properties:
                           image:
                             type: string
+                          podFields:
+                            properties:
+                              schedulerName:
+                                type: string
+                            type: object
                           resource:
                             properties:
                               cpu:

diff --git a/config/crd/bases/oceanbase.oceanbase.com_obclusters.yaml b/config/crd/bases/oceanbase.oceanbase.com_obclusters.yaml
@@ -1775,6 +1775,11 @@ spec:
                 properties:
                   image:
                     type: string
+                  podFields:
+                    properties:
+                      schedulerName:
+                        type: string
+                    type: object
                   resource:
                     properties:
                       cpu:

diff --git a/config/crd/bases/oceanbase.oceanbase.com_observers.yaml b/config/crd/bases/oceanbase.oceanbase.com_observers.yaml
@@ -2678,6 +2678,11 @@ spec:
                 properties:
                   image:
                     type: string
+                  podFields:
+                    properties:
+                      schedulerName:
+                        type: string
+                    type: object
                   resource:
                     properties:
                       cpu:

diff --git a/config/crd/bases/oceanbase.oceanbase.com_obzones.yaml b/config/crd/bases/oceanbase.oceanbase.com_obzones.yaml
@@ -1781,6 +1781,11 @@ spec:
                 properties:
                   image:
                     type: string
+                  podFields:
+                    properties:
+                      schedulerName:
+                        type: string
+                    type: object
                   resource:
                     properties:
                       cpu:

diff --git a/deploy/operator.yaml b/deploy/operator.yaml
@@ -4633,6 +4633,11 @@ spec:
                         properties:
                           image:
                             type: string
+                          podFields:
+                            properties:
+                              schedulerName:
+                                type: string
+                            type: object
                           resource:
                             properties:
                               cpu:
@@ -7626,6 +7631,11 @@ spec:
                 properties:
                   image:
                     type: string
+                  podFields:
+                    properties:
+                      schedulerName:
+                        type: string
+                    type: object
                   resource:
                     properties:
                       cpu:
@@ -11695,6 +11705,11 @@ spec:
                 properties:
                   image:
                     type: string
+                  podFields:
+                    properties:
+                      schedulerName:
+                        type: string
+                    type: object
                   resource:
                     properties:
                       cpu:
@@ -17177,6 +17192,11 @@ spec:
                 properties:
                   image:
                     type: string
+                  podFields:
+                    properties:
+                      schedulerName:
+                        type: string
+                    type: object
                   resource:
                     properties:
                       cpu:

diff --git a/internal/resource/obcluster/obcluster_task.go b/internal/resource/obcluster/obcluster_task.go
@@ -369,6 +369,7 @@ func ValidateUpgradeInfo(m *OBClusterManager) tasktypes.TaskError {
 				Spec: corev1.PodSpec{
 					Containers:    []corev1.Container{container},
 					RestartPolicy: corev1.RestartPolicyNever,
+					SchedulerName: resourceutils.GetSchedulerName(m.OBCluster.Spec.OBServerTemplate.PodFields),
 				},
 			},
 			BackoffLimit:            &backoffLimit,
@@ -766,6 +767,7 @@ func CheckImageReady(m *OBClusterManager) tasktypes.TaskError {
 						Command:         []string{"bash", "-c", "/home/admin/oceanbase/bin/oceanbase-helper help"},
 					}},
 					RestartPolicy: corev1.RestartPolicyNever,
+					SchedulerName: resourceutils.GetSchedulerName(m.OBCluster.Spec.OBServerTemplate.PodFields),
 				},
 			},
 			TTLSecondsAfterFinished: &ttl,
@@ -840,6 +842,7 @@ func CheckClusterMode(m *OBClusterManager) tasktypes.TaskError {
 		versionOutput, _, err := resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace,
 			m.OBCluster.Name+"-get-version",
 			m.OBCluster.Spec.OBServerTemplate.Image,
+			m.OBCluster.Spec.OBServerTemplate.PodFields,
 			"/home/admin/oceanbase/bin/oceanbase-helper version",
 		)
 		if err != nil {
@@ -850,12 +853,14 @@ func CheckClusterMode(m *OBClusterManager) tasktypes.TaskError {
 				_, code, err = resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace,
 					m.OBCluster.Name+"-standalone-validate",
 					m.OBCluster.Spec.OBServerTemplate.Image,
+					m.OBCluster.Spec.OBServerTemplate.PodFields,
 					"/home/admin/oceanbase/bin/oceanbase-helper standalone validate",
 				)
 			case oceanbaseconst.ModeService:
 				_, code, err = resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace,
 					m.OBCluster.Name+"-service-validate",
 					m.OBCluster.Spec.OBServerTemplate.Image,
+					m.OBCluster.Spec.OBServerTemplate.PodFields,
 					"/home/admin/oceanbase/bin/oceanbase-helper service validate",
 				)
 			}
@@ -911,7 +916,11 @@ func CheckMigration(m *OBClusterManager) tasktypes.TaskError {
 	}
 
 	// check version strictly matches
-	targetVersionStr, _, err := resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace, fmt.Sprintf("%s-version", m.OBCluster.Name), m.OBCluster.Spec.OBServerTemplate.Image, oceanbaseconst.CmdVersion)
+	targetVersionStr, _, err := resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace,
+		fmt.Sprintf("%s-version", m.OBCluster.Name),
+		m.OBCluster.Spec.OBServerTemplate.Image,
+		m.OBCluster.Spec.OBServerTemplate.PodFields,
+		oceanbaseconst.CmdVersion)
 	if err != nil {
 		return errors.Wrap(err, "get target oceanbase version")
 	}
@@ -1058,6 +1067,7 @@ func CheckEnvironment(m *OBClusterManager) tasktypes.TaskError {
 		m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace,
 		jobName,
 		m.OBCluster.Spec.OBServerTemplate.Image,
+		m.OBCluster.Spec.OBServerTemplate.PodFields,
 		"/home/admin/oceanbase/bin/oceanbase-helper env-check storage "+oceanbaseconst.ClogPath,
 		volumeConfigs,
 	)
@@ -1126,7 +1136,12 @@ func OptimizeClusterByScenario(m *OBClusterManager) tasktypes.TaskError {
 	// start a job to read optimize parameters, ignore errors, only proceed with valid outputs and ignore the errors
 	m.Logger.Info("Start to optimize obcluster parameters")
 	jobName := fmt.Sprintf("optimize-cluster-%s-%s", m.OBCluster.Name, rand.String(6))
-	output, code, _ := resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace, jobName, m.OBCluster.Spec.OBServerTemplate.Image, fmt.Sprintf("bin/oceanbase-helper optimize cluster %s", m.OBCluster.Spec.Scenario))
+	output, code, _ := resourceutils.RunJob(
+		m.Ctx, m.Client, m.Logger, m.OBCluster.Namespace,
+		jobName,
+		m.OBCluster.Spec.OBServerTemplate.Image,
+		m.OBCluster.Spec.OBServerTemplate.PodFields,
+		fmt.Sprintf("bin/oceanbase-helper optimize cluster %s", m.OBCluster.Spec.Scenario))
 	if code == int32(cmdconst.ExitCodeOK) || code == int32(cmdconst.ExitCodeIgnorableErr) {
 		optimizeConfig := &helpermodel.OptimizationResponse{}
 		err := json.Unmarshal([]byte(output), optimizeConfig)

diff --git a/internal/resource/observer/utils.go b/internal/resource/observer/utils.go
@@ -285,6 +285,7 @@ func (m *OBServerManager) createOBPodSpec(obcluster *v1alpha1.OBCluster) corev1.
 		Affinity:           m.OBServer.Spec.Affinity,
 		Tolerations:        m.OBServer.Spec.Tolerations,
 		ServiceAccountName: m.OBServer.Spec.ServiceAccount,
+		SchedulerName:      resourceutils.GetSchedulerName(m.OBServer.Spec.OBServerTemplate.PodFields),
 	}
 	return podSpec
 }

diff --git a/internal/resource/obtenant/obtenant_task.go b/internal/resource/obtenant/obtenant_task.go
@@ -523,7 +523,11 @@ func OptimizeTenantByScenario(m *OBTenantManager) tasktypes.TaskError {
 	}
 	m.Logger.Info("Start to optimize tenant parameter and variable")
 	jobName := fmt.Sprintf("optimize-tenant-%s-%s", m.OBTenant.Name, rand.String(6))
-	output, code, _ := resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBTenant.Namespace, jobName, obcluster.Spec.OBServerTemplate.Image, fmt.Sprintf("bin/oceanbase-helper optimize tenant %s", m.OBTenant.Spec.Scenario))
+	output, code, _ := resourceutils.RunJob(m.Ctx, m.Client, m.Logger, m.OBTenant.Namespace,
+		jobName,
+		obcluster.Spec.OBServerTemplate.Image,
+		obcluster.Spec.OBServerTemplate.PodFields,
+		fmt.Sprintf("bin/oceanbase-helper optimize tenant %s", m.OBTenant.Spec.Scenario))
 	if code == int32(cmdconst.ExitCodeOK) || code == int32(cmdconst.ExitCodeIgnorableErr) {
 		optimizeConfig := &helpermodel.OptimizationResponse{}
 		err := json.Unmarshal([]byte(output), optimizeConfig)

diff --git a/internal/resource/utils/jobs.go b/internal/resource/utils/jobs.go
@@ -28,6 +28,7 @@ import (
 	"k8s.io/apimachinery/pkg/util/rand"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
+	apitypes "github.com/oceanbase/ob-operator/api/types"
 	"github.com/oceanbase/ob-operator/api/v1alpha1"
 	obcfg "github.com/oceanbase/ob-operator/internal/config/operator"
 	cmdconst "github.com/oceanbase/ob-operator/internal/const/cmd"
@@ -50,7 +51,9 @@ type JobContainerVolumes struct {
 	Volumes      []corev1.Volume
 }
 
-func RunJob(ctx context.Context, c client.Client, logger *logr.Logger, namespace string, jobName string, image string, cmd string, volumeConfigs ...JobContainerVolumes) (output string, exitCode int32, err error) {
+func RunJob(ctx context.Context, c client.Client, logger *logr.Logger, namespace string,
+	jobName string, image string, podFields *apitypes.PodFieldsSpec,
+	cmd string, volumeConfigs ...JobContainerVolumes) (output string, exitCode int32, err error) {
 	fullJobName := fmt.Sprintf("%s-%s", jobName, rand.String(6))
 	var backoffLimit int32
 	var ttl int32 = 300
@@ -78,6 +81,7 @@ func RunJob(ctx context.Context, c client.Client, logger *logr.Logger, namespace
 					Containers:    []corev1.Container{container},
 					RestartPolicy: corev1.RestartPolicyNever,
 					Volumes:       volumes,
+					SchedulerName: GetSchedulerName(podFields),
 				},
 			},
 			BackoffLimit:            &backoffLimit,

diff --git a/internal/resource/utils/podfields.go b/internal/resource/utils/podfields.go
@@ -0,0 +1,28 @@
+/*
+Copyright (c) 2024 OceanBase
+ob-operator is licensed under Mulan PSL v2.
+You can use this software according to the terms and conditions of the Mulan PSL v2.
+You may obtain a copy of Mulan PSL v2 at:
+         http://license.coscl.org.cn/MulanPSL2
+THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
+EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
+MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+See the Mulan PSL v2 for more details.
+*/
+
+package utils
+
+import (
+	corev1 "k8s.io/api/core/v1"
+
+	"github.com/oceanbase/ob-operator/api/types"
+)
+
+// GetSchedulerName returns the scheduler name from the given PodFields.
+// If PodFields or SchedulerName is nil, it returns the default scheduler name.
+func GetSchedulerName(podFields *types.PodFieldsSpec) string {
+	if podFields == nil || podFields.SchedulerName == nil {
+		return corev1.DefaultSchedulerName // return Kubernetes's default scheduler name
+	}
+	return *podFields.SchedulerName
+}