Merge pull request #247 from omersch381/add_pool_update_job

Add pool update job

Author: openshift-merge-bot[bot]

api/v1beta1/designate_types.go

@@ -33,6 +33,9 @@ const (
 
 	// Designate API timeout
 	APITimeout = 120
+
+	// PoolUpdateHash hash
+	PoolUpdateHash = "pool-update"
 )
 
 // DesignateAPISpecCore - this version has no containerImage for use with the OpenStackControlplane

controllers/designate_controller.go

@@ -816,6 +816,8 @@ func (r *DesignateReconciler) reconcileNormal(ctx context.Context, instance *des
 		return ctrl.Result{}, err
 	}
 
+	Log.Info("Before creating bind configmap")
+
 	_, err = controllerutil.CreateOrPatch(ctx, helper.GetClient(), bindConfigMap, func() error {
 		bindConfigMap.Labels = util.MergeStringMaps(bindConfigMap.Labels, bindLabels)
 		bindConfigMap.Data = updatedBindMap
@@ -827,25 +829,26 @@ func (r *DesignateReconciler) reconcileNormal(ctx context.Context, instance *des
 		return ctrl.Result{}, err
 	}
 
-	if err != nil {
-		return ctrl.Result{}, err
-	}
-	if len(nsRecordsConfigMap.Data) > 0 {
+	Log.Info("Bind configmap was created successfully")
+
+	if len(nsRecordsConfigMap.Data) > 0 && instance.Status.DesignateCentralReadyCount > 0 {
+		Log.Info("len(nsRecordsConfigMap.Data) > 0")
 		poolsYamlConfigMap := &corev1.ConfigMap{
 			ObjectMeta: metav1.ObjectMeta{
-				Name:      designate.PoolsYamlsConfigMap,
+				Name:      designate.PoolsYamlConfigMap,
 				Namespace: instance.GetNamespace(),
 				Labels:    bindLabels,
 			},
 			Data: make(map[string]string),
 		}
+		Log.Info("before designate.GeneratePoolsYamlData")
 		poolsYaml, err := designate.GeneratePoolsYamlData(bindConfigMap.Data, mdnsConfigMap.Data, nsRecordsConfigMap.Data)
 		if err != nil {
 			return ctrl.Result{}, err
 		}
 		Log.Info(fmt.Sprintf("pools.yaml content is\n%v", poolsYaml))
 		updatedPoolsYaml := make(map[string]string)
-		updatedPoolsYaml[designate.PoolsYamlsConfigMap] = poolsYaml
+		updatedPoolsYaml[designate.PoolsYamlContent] = poolsYaml
 
 		_, err = controllerutil.CreateOrPatch(ctx, helper.GetClient(), poolsYamlConfigMap, func() error {
 			poolsYamlConfigMap.Labels = util.MergeStringMaps(poolsYamlConfigMap.Labels, bindLabels)
@@ -864,9 +867,36 @@ func (r *DesignateReconciler) reconcileNormal(ctx context.Context, instance *des
 		_, changed, err := r.createHashOfInputHashes(ctx, instance, designate.PoolsYamlHash, poolsYamlsEnvVars, configMaps)
 		if err != nil {
 			return ctrl.Result{}, err
-		} else if changed {
-			// launch the pool update job
-			Log.Info("Creating a pool update job")
+		}
+		if changed {
+			Log.Info("PoolsYamlHash has changed, creating a pool update job")
+
+			var poolUpdateHash string
+			var ok bool
+			if poolUpdateHash, ok = instance.Status.Hash[designatev1beta1.PoolUpdateHash]; !ok {
+				instance.Status.Hash[designatev1beta1.PoolUpdateHash] = ""
+				poolUpdateHash = ""
+			}
+			jobDef := designate.PoolUpdateJob(instance, serviceLabels, serviceAnnotations)
+
+			Log.Info("Initializing pool update job")
+			poolUpdatejob := job.NewJob(
+				jobDef,
+				designatev1beta1.PoolUpdateHash,
+				instance.Spec.PreserveJobs,
+				time.Duration(15)*time.Second,
+				poolUpdateHash,
+			)
+			_, err = poolUpdatejob.DoJob(ctx, helper)
+			if err != nil {
+				return ctrl.Result{}, err
+			}
+			instance.Status.Hash[designatev1beta1.PoolUpdateHash] = poolUpdatejob.GetHash()
+			err = r.Client.Status().Update(ctx, instance)
+			if err != nil {
+				return ctrl.Result{}, err
+			}
+			Log.Info("Pool update job completed successfully")
 		}
 	}
 

demo/examples/ns_records/kustomization.yaml

@@ -0,0 +1,3 @@
+## Append samples you want in your CSV to this file as resources ##
+resources:
+- ns_records_CR_example.yaml

demo/examples/ns_records_CR_example.yaml renamed to demo/examples/ns_records/ns_records_CR_example.yaml

@@ -5,7 +5,7 @@ metadata:
   name: designate-ns-records-params
 data:
   ns_records: |
-    - host: ns1.example.com.
+    - hostname: ns1.example.com.
       priority: 1
-    - host: ns2.example.com.
+    - hostname: ns2.example.com.
       priority: 2

pkg/designate/const.go

@@ -47,12 +47,14 @@ const (
 
 	RndcConfDir = "/etc/designate/rndc-keys"
 
-	PoolsYamlsConfigMap = "designate-pools-yaml-config-map"
+	PoolsYamlConfigMap = "designate-pools-yaml-config-map"
 
-	PoolsYamlPath = "templates/designatepoolmanager/config/pools.yaml.tmpl"
+	PoolsYamlPath = "designatepoolmanager/config/pools.yaml.tmpl"
 
 	PoolsYamlHash = "pools-yaml-hash"
 
+	PoolsYamlContent = "pools-yaml-content"
+
 	// BindPredictableIPHash key for status hash
 	BindPredictableIPHash = "Bind IP Map"
 

pkg/designate/generate_bind9_pools_yaml.go

@@ -16,12 +16,13 @@ package designate
 import (
 	"bytes"
 	"fmt"
-	"gopkg.in/yaml.v2"
 	"os"
-	"os/exec"
-	"path/filepath"
-	"strings"
+	"path"
 	"text/template"
+
+	"gopkg.in/yaml.v2"
+
+	"github.com/openstack-k8s-operators/lib-common/modules/common/util"
 )
 
 type Pool struct {
@@ -131,16 +132,16 @@ func GeneratePoolsYamlData(BindMap, MdnsMap, NsRecordsMap map[string]string) (st
 		CatalogZone: nil, // set to catalogZone if this section should be presented
 	}
 
-	poolsYamlPath, err := getPoolsYamlPath()
+	opTemplates, err := util.GetTemplatesPath()
 	if err != nil {
 		return "", err
 	}
-
-	PoolsYaml, err := os.ReadFile(poolsYamlPath)
+	poolsYamlPath := path.Join(opTemplates, PoolsYamlPath)
+	poolsYaml, err := os.ReadFile(poolsYamlPath)
 	if err != nil {
 		return "", err
 	}
-	tmpl, err := template.New("pool").Parse(string(PoolsYaml))
+	tmpl, err := template.New("pool").Parse(string(poolsYaml))
 	if err != nil {
 		return "", err
 	}
@@ -153,13 +154,3 @@ func GeneratePoolsYamlData(BindMap, MdnsMap, NsRecordsMap map[string]string) (st
 
 	return buf.String(), nil
 }
-
-// We have this function so different tests could find PoolsYamlPath
-func getPoolsYamlPath() (string, error) {
-	cmdOut, err := exec.Command("git", "rev-parse", "--show-toplevel").Output()
-	if err != nil {
-		return "", fmt.Errorf("failed to get repository root directory from: %s because of %w", string(cmdOut), err)
-	}
-	repoRoot := strings.TrimSpace(string(cmdOut))
-	return filepath.Join(repoRoot, PoolsYamlPath), nil
-}

pkg/designate/pool_update.go

@@ -0,0 +1,132 @@
+package designate
+
+import (
+	"fmt"
+
+	designatev1beta1 "github.com/openstack-k8s-operators/designate-operator/api/v1beta1"
+	batchv1 "k8s.io/api/batch/v1"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+const (
+	PoolUpdateCommand      = "/usr/bin/designate-manage pool update"
+	DesignateConfigVolume  = "designate-config"
+	DesignateConfigMount   = "/etc/designate"
+	DesignateConfigKeyPath = "designate.conf"
+	DesignatePoolsYamlPath = "pools.yaml"
+)
+
+func PoolUpdateJob(
+	instance *designatev1beta1.Designate,
+	labels map[string]string,
+	annotations map[string]string,
+) *batchv1.Job {
+	runAsUser := int64(0)
+	volumeMounts := GetVolumeMounts(instance.Name)
+	volumes := GetVolumes(instance.Name)
+
+	volumes = append(volumes, corev1.Volume{
+		Name: "pools-yaml-config",
+		VolumeSource: corev1.VolumeSource{
+			ConfigMap: &corev1.ConfigMapVolumeSource{
+				LocalObjectReference: corev1.LocalObjectReference{
+					Name: PoolsYamlConfigMap,
+				},
+				Items: []corev1.KeyToPath{
+					{
+						Key:  PoolsYamlContent,
+						Path: DesignatePoolsYamlPath,
+					},
+				},
+			},
+		},
+	})
+
+	volumes = append(volumes, corev1.Volume{
+		Name: DesignateConfigVolume,
+		VolumeSource: corev1.VolumeSource{
+			Secret: &corev1.SecretVolumeSource{
+				SecretName: "designate-central-config-data",
+				Items: []corev1.KeyToPath{
+					{
+						Key:  "designate.conf",
+						Path: DesignateConfigKeyPath,
+					},
+				},
+			},
+		},
+	})
+
+	volumes = append(volumes, corev1.Volume{
+		Name: "rabbitmq-certs",
+		VolumeSource: corev1.VolumeSource{
+			Secret: &corev1.SecretVolumeSource{
+				SecretName: "cert-rabbitmq-svc",
+			},
+		},
+	})
+
+	volumeMounts = append(volumeMounts,
+		corev1.VolumeMount{
+			Name:      "pools-yaml-config",
+			MountPath: "/tmp/designate-pools",
+			ReadOnly:  true,
+		},
+		corev1.VolumeMount{
+			Name:      DesignateConfigVolume,
+			MountPath: DesignateConfigMount,
+			ReadOnly:  true,
+		},
+		corev1.VolumeMount{
+			Name:      "rabbitmq-certs",
+			MountPath: "/etc/pki/rabbitmq",
+			ReadOnly:  true,
+		},
+	)
+
+	job := &batchv1.Job{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      ServiceName + "-pool-update",
+			Namespace: instance.Namespace,
+			Labels:    labels,
+		},
+		Spec: batchv1.JobSpec{
+			Template: corev1.PodTemplateSpec{
+				ObjectMeta: metav1.ObjectMeta{
+					Annotations: annotations,
+				},
+				Spec: corev1.PodSpec{
+					RestartPolicy:      corev1.RestartPolicyNever,
+					ServiceAccountName: instance.RbacResourceName(),
+					Containers: []corev1.Container{
+						{
+							Name:  ServiceName + "-pool-update",
+							Image: instance.Spec.DesignateCentral.ContainerImage,
+							Env: []corev1.EnvVar{
+								{
+									Name:  "SSL_CERT_FILE",
+									Value: "/etc/pki/rabbitmq/ca.crt",
+								},
+							},
+							Command: []string{
+								"/bin/bash",
+								"-c",
+								fmt.Sprintf("%s --file /tmp/designate-pools/%s",
+									PoolUpdateCommand,
+									DesignatePoolsYamlPath,
+								),
+							},
+							SecurityContext: &corev1.SecurityContext{
+								RunAsUser: &runAsUser,
+							},
+							VolumeMounts: volumeMounts,
+						},
+					},
+					Volumes: volumes,
+				},
+			},
+		},
+	}
+	return job
+}

pkg/designatecentral/deployment.go

@@ -43,8 +43,9 @@ func Deployment(
 	// designateUser := int64(42411)
 	// designateGroup := int64(42411)
 
-	volumes := designate.GetVolumes("designate-central")
-	volumeMounts := designate.GetVolumeMounts("designate-central")
+	serviceName := fmt.Sprintf("%s-central", designate.ServiceName)
+	volumes := getServicePodVolumes(serviceName)
+	volumeMounts := getServicePodVolumeMounts(serviceName)
 
 	livenessProbe := &corev1.Probe{
 		// TODO might need tuning
@@ -69,8 +70,6 @@ func Deployment(
 	envVars["KOLLA_CONFIG_STRATEGY"] = env.SetValue("COPY_ALWAYS")
 	envVars["CONFIG_HASH"] = env.SetValue(configHash)
 
-	serviceName := fmt.Sprintf("%s-central", designate.ServiceName)
-
 	// Add the CA bundle
 	if instance.Spec.TLS.CaBundleSecretName != "" {
 		volumes = append(volumes, instance.Spec.TLS.CreateVolume())

pkg/designatecentral/volumes.go

@@ -0,0 +1,53 @@
+/*
+
+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 designatecentral
+
+import (
+	designate "github.com/openstack-k8s-operators/designate-operator/pkg/designate"
+	corev1 "k8s.io/api/core/v1"
+)
+
+func getServicePodVolumes(serviceName string) []corev1.Volume {
+	// var configMode int32 = 0640
+	// return append(designate.GetVolumes(serviceName), corev1.Volume{
+	// 	Name: "pools-yaml-config",
+	// 	VolumeSource: corev1.VolumeSource{
+	// 		ConfigMap: &corev1.ConfigMapVolumeSource{
+	// 			LocalObjectReference: corev1.LocalObjectReference{
+	// 				Name: designate.PoolsYamlConfigMap,
+	// 			},
+	// 			Items: []corev1.KeyToPath{
+	// 				{
+	// 					Key:  designate.PoolsYamlContent,
+	// 					Path: "pools.yaml",
+	// 				},
+	// 			},
+	// 			DefaultMode: &configMode,
+	// 		},
+	// 	},
+	// })
+	return designate.GetVolumes(serviceName)
+}
+
+func getServicePodVolumeMounts(serviceName string) []corev1.VolumeMount {
+	// return append(designate.GetVolumeMounts(serviceName), corev1.VolumeMount{
+	// 	Name:      "pools-yaml-config",
+	// 	MountPath: "/etc/designate/pools.yaml",
+	// 	SubPath:   "pools.yaml",
+	// 	ReadOnly:  true,
+	// })
+	return designate.GetVolumeMounts(serviceName)
+}