Use different sidecar image when running with mysql 8.0

Author: AMecea

Dockerfile.sidecar

@@ -58,9 +58,10 @@ RUN apt-get update \
 COPY hack/docker/percona.gpg /etc/apt/trusted.gpg.d/percona.gpg
 RUN echo 'deb https://repo.percona.com/apt buster main' > /etc/apt/sources.list.d/percona.list
 
+ARG XTRABACKUP_PKG=percona-xtrabackup-24
 RUN apt-get update \
     && apt-get install -y --no-install-recommends \
-        percona-toolkit percona-xtrabackup-80 unzip default-mysql-client
+        percona-toolkit ${XTRABACKUP_PKG} unzip default-mysql-client
 
 
 USER mysql

Makefile

@@ -1,7 +1,8 @@
 APP_VERSION ?= $(shell git describe --abbrev=5 --dirty --tags --always)
 REGISTRY := quay.io/presslabs
 IMAGE_NAME := mysql-operator
-SIDECAR_IMAGE_NAME := mysql-operator-sidecar
+SIDECAR_MYSQL57_IMAGE_NAME := mysql-operator-sidecar-mysql57
+SIDECAR_MYSQL8_IMAGE_NAME := mysql-operator-sidecar-mysql8
 BUILD_TAG := build
 IMAGE_TAGS := $(APP_VERSION)
 PKG_NAME := github.com/presslabs/mysql-operator
@@ -126,11 +127,14 @@ dependencies-local: dependencies
 .PHONY: images
 images:
 	docker build . -f Dockerfile -t $(REGISTRY)/$(IMAGE_NAME):$(BUILD_TAG)
-	docker build . -f Dockerfile.sidecar -t $(REGISTRY)/$(SIDECAR_IMAGE_NAME):$(BUILD_TAG)
+	docker build . -f Dockerfile.sidecar -t $(REGISTRY)/$(SIDECAR_MYSQL57_IMAGE_NAME):$(BUILD_TAG)
+	docker build . -f Dockerfile.sidecar --build-arg XTRABACKUP_PKG=percona-xtrabackup-80 \
+								-t $(REGISTRY)/$(SIDECAR_MYSQL8_IMAGE_NAME):$(BUILD_TAG)
 	set -e; \
 		for tag in $(IMAGE_TAGS); do \
 			docker tag $(REGISTRY)/$(IMAGE_NAME):$(BUILD_TAG) $(REGISTRY)/$(IMAGE_NAME):$${tag}; \
-			docker tag $(REGISTRY)/$(SIDECAR_IMAGE_NAME):$(BUILD_TAG) $(REGISTRY)/$(SIDECAR_IMAGE_NAME):$${tag}; \
+			docker tag $(REGISTRY)/$(SIDECAR_MYSQL57_IMAGE_NAME):$(BUILD_TAG) $(REGISTRY)/$(SIDECAR_MYSQL57_IMAGE_NAME):$${tag}; \
+			docker tag $(REGISTRY)/$(SIDECAR_MYSQL8_IMAGE_NAME):$(BUILD_TAG) $(REGISTRY)/$(SIDECAR_MYSQL8_IMAGE_NAME):$${tag}; \
 	done
 
 # Push the docker image
@@ -139,7 +143,8 @@ publish: images
 	set -e; \
 		for tag in $(IMAGE_TAGS); do \
 		docker push $(REGISTRY)/$(IMAGE_NAME):$${tag}; \
-		docker push $(REGISTRY)/$(SIDECAR_IMAGE_NAME):$${tag}; \
+		docker push $(REGISTRY)/$(SIDECAR_MYSQL57_IMAGE_NAME):$${tag}; \
+		docker push $(REGISTRY)/$(SIDECAR_MYSQL8_IMAGE_NAME):$${tag}; \
 	done
 
 # E2E tests
@@ -161,5 +166,6 @@ e2e-remote:
 		--kubernetes-config $(KUBECONFIG) --kubernetes-context $(K8S_CONTEXT) \
 		--report-dir ../../e2e-reports \
 		--operator-image quay.io/presslabs/mysql-operator:$(E2E_IMG_TAG) \
-		--sidecar-image  quay.io/presslabs/mysql-operator-sidecar:$(E2E_IMG_TAG) \
+		--sidecar-mysql57-image  quay.io/presslabs/mysql-operator-sidecar-mysql57:$(E2E_IMG_TAG) \
+		--sidecar-mysql8-image  quay.io/presslabs/mysql-operator-sidecar-mysql8:$(E2E_IMG_TAG) \
 		--orchestrator-image  quay.io/presslabs/mysql-operator-orchestrator:$(E2E_IMG_TAG)

charts/mysql-operator/templates/statefulset.yaml

@@ -51,6 +51,9 @@ spec:
             {{- if .Values.sidecarImage }}
             - --sidecar-image={{ .Values.sidecarImage }}
             {{- end -}}
+            {{- if .Values.sidecarMysql8Image }}
+            - --sidecar-mysql8-image={{ .Values.sidecarMysql8Image }}
+            {{- end -}}
             {{- if .Values.watchNamespace }}
             - --namespace={{ .Values.watchNamespace }}
             {{- end }}

charts/mysql-operator/values.yaml

@@ -4,7 +4,8 @@
 
 replicas: 1
 image: quay.io/presslabs/mysql-operator:latest
-sidecarImage: quay.io/presslabs/mysql-operator-sidecar:latest
+sidecarImage: quay.io/presslabs/mysql-operator-sidecar-mysql57:latest
+sidecarMysql8Image: quay.io/presslabs/mysql-operator-sidecar-mysql8:latest
 imagePullPolicy: IfNotPresent
 
 # Insert a pre-stop lifecycle hook and trigger a failover. NOTE: Use this when your cluster network

hack/development/Dockerfile.sidecar

@@ -44,9 +44,10 @@ RUN apt-get update \
 COPY hack/docker/percona.gpg /etc/apt/trusted.gpg.d/percona.gpg
 RUN echo 'deb https://repo.percona.com/apt buster main' > /etc/apt/sources.list.d/percona.list
 
+ARG XTRABACKUP_PKG=percona-xtrabackup-80
 RUN apt-get update \
     && apt-get install -y --no-install-recommends \
-        percona-toolkit percona-xtrabackup-80 unzip default-mysql-client
+        percona-toolkit ${XTRABACKUP_PKG} unzip default-mysql-client
 
 USER mysql
 

hack/generate_chart.sh

@@ -20,6 +20,7 @@ echo "Updating chart images tag to: ${version}"
 sed -i.bak -E "
     s#image: (.*):.*#image: \\1:${version}#
     s#sidecarImage: (.*):.*#sidecarImage: \\1:${version}#
+    s#sidecarMysql8Image: (.*):.*#sidecarMysql8Image: \\1:${version}#
     s#  image: (.*): (.*):.*#  image: \\1:${version}#
 " ${CHART_PATH}/values.yaml
 rm ${CHART_PATH}/values.yaml.bak

pkg/controller/mysqlbackup/internal/syncer/deletionjob.go

@@ -167,9 +167,14 @@ func (s *deletionJobSyncer) ensureContainers() []core.Container {
 
 	rcloneCommand = append(rcloneCommand, "delete", bucketForRclone(s.backup.Spec.BackupURL))
 
+	image := s.opt.SidecarMysql57Image
+	if s.cluster != nil {
+		image = s.cluster.GetSidecarImage()
+	}
+
 	container := core.Container{
 		Name:            "delete",
-		Image:           s.opt.SidecarImage,
+		Image:           image,
 		ImagePullPolicy: s.opt.ImagePullPolicy,
 		Args:            rcloneCommand,
 	}

pkg/controller/mysqlbackup/internal/syncer/job.go

@@ -127,7 +127,7 @@ func (s *jobSyncer) ensurePodSpec(in core.PodSpec) core.PodSpec {
 	}
 
 	in.Containers[0].Name = "backup"
-	in.Containers[0].Image = s.opt.SidecarImage
+	in.Containers[0].Image = s.cluster.GetSidecarImage()
 	in.Containers[0].ImagePullPolicy = s.opt.ImagePullPolicy
 	in.Containers[0].Args = []string{
 		"take-backup-to",

pkg/controller/mysqlcluster/internal/syncer/statefullset.go

@@ -348,7 +348,7 @@ func (s *sfsSyncer) ensureInitContainersSpec() []core.Container {
 
 	// clone and init container
 	cloneInit := s.ensureContainer(containerCloneAndInitName,
-		s.opt.SidecarImage,
+		s.cluster.GetSidecarImage(),
 		[]string{"clone-and-init"},
 	)
 	initCs = append(initCs, cloneInit)
@@ -415,7 +415,7 @@ func (s *sfsSyncer) ensureContainersSpec() []core.Container {
 
 	// SIDECAR container
 	sidecar := s.ensureContainer(containerSidecarName,
-		s.opt.SidecarImage,
+		s.cluster.GetSidecarImage(),
 		[]string{"config-and-serve"},
 	)
 	sidecar.Ports = ensurePorts(core.ContainerPort{
@@ -465,7 +465,7 @@ func (s *sfsSyncer) ensureContainersSpec() []core.Container {
 
 	// PT-HEARTBEAT container
 	heartbeat := s.ensureContainer(containerHeartBeatName,
-		s.opt.SidecarImage,
+		s.cluster.GetSidecarImage(),
 		[]string{
 			"pt-heartbeat",
 			"--update", "--replace",
@@ -500,7 +500,7 @@ func (s *sfsSyncer) ensureContainersSpec() []core.Container {
 		command = append(command, getCliOptionsFromQueryLimits(s.cluster.Spec.QueryLimits)...)
 
 		killer := s.ensureContainer(containerKillerName,
-			s.opt.SidecarImage,
+			s.cluster.GetSidecarImage(),
 			command,
 		)
 

pkg/internal/mysqlcluster/mysqlcluster.go

@@ -265,3 +265,14 @@ func (c *MysqlCluster) GetNamespacedName() types.NamespacedName {
 		Name:      c.Name,
 	}
 }
+
+// GetSidecarImage selects the sidecar docker image based on mysql version
+func (c *MysqlCluster) GetSidecarImage() string {
+	// decide the sidecar image based on mysql version
+	sidecarImage := options.GetOptions().SidecarMysql57Image
+	if c.GetMySQLSemVer().Major == 8 {
+		sidecarImage = options.GetOptions().SidecarMysql8Image
+	}
+
+	return sidecarImage
+}

pkg/options/options.go

@@ -37,8 +37,10 @@ func getFromEnvOrDefault(key, def string) string {
 
 // Options is the data structure that contains information about mysql operator configuration
 type Options struct {
-	// SidecarImage is the image used in sidecar container to serve backups and configure MySQL
-	SidecarImage string
+	// SidecarMysql57Image is the image used in sidecar container to serve backups and configure MySQL
+	SidecarMysql57Image string
+	// SidecarMysql8Image as above but used when cluster uses mysql 8.0 and above
+	SidecarMysql8Image string
 
 	// MetricsExporterImage is the image for exporter container
 	MetricsExporterImage string
@@ -118,13 +120,17 @@ const (
 )
 
 var (
-	defaultSidecarImage = "quay.io/presslabs/mysql-operator-sidecar:" + util.AppVersion
+	defaultSidecarMysql57Image = "quay.io/presslabs/mysql-operator-sidecar-mysql57:" + util.AppVersion
+	defaultSidecarMysql8Image  = "quay.io/presslabs/mysql-operator-sidecar-mysql8:" + util.AppVersion
 )
 
 // AddFlags registers all mysql-operator needed flags
 func (o *Options) AddFlags(fs *pflag.FlagSet) {
-	fs.StringVar(&o.SidecarImage, "sidecar-image", defaultSidecarImage,
-		"The image that instrumentate mysql.")
+	fs.StringVar(&o.SidecarMysql57Image, "sidecar-image", defaultSidecarMysql57Image,
+		"The image that is used for mysql node instrumentation.")
+
+	fs.StringVar(&o.SidecarMysql8Image, "sidecar-mysql8-image", defaultSidecarMysql8Image,
+		"The image that is used for mysql (version 8.0 or above) node instrumentation.")
 
 	fs.StringVar(&o.MetricsExporterImage, "metrics-exporter-image", defaultExporterImage,
 		"The image for mysql metrics exporter.")
@@ -166,7 +172,8 @@ var once sync.Once
 func GetOptions() *Options {
 	once.Do(func() {
 		instance = &Options{
-			SidecarImage:         defaultSidecarImage,
+			SidecarMysql57Image:  defaultSidecarMysql57Image,
+			SidecarMysql8Image:   defaultSidecarMysql8Image,
 			MetricsExporterImage: defaultExporterImage,
 
 			ImagePullPolicy:     defaultImagePullPolicy,

skaffold.yaml

@@ -5,9 +5,16 @@ build:
   - image: quay.io/presslabs/mysql-operator
     docker:
       dockerfile: hack/development/Dockerfile.operator
-  - image: quay.io/presslabs/mysql-operator-sidecar
+  - image: quay.io/presslabs/mysql-operator-sidecar-mysql57
     docker:
       dockerfile: hack/development/Dockerfile.sidecar
+      buildArgs:
+        XTRABACKUP_PKG: percona-xtrabackup-24
+  - image: quay.io/presslabs/mysql-operator-sidecar-mysql8
+    docker:
+      dockerfile: hack/development/Dockerfile.sidecar
+      buildArgs:
+        XTRABACKUP_PKG: percona-xtrabackup-80
   - image: quay.io/presslabs/mysql-operator-orchestrator
     docker:
       dockerfile: hack/development/Dockerfile.orchestrator
@@ -22,5 +29,6 @@ deploy:
       - hack/development/dev-values.yaml
       values:
         image: quay.io/presslabs/mysql-operator
-        sidecarImage: quay.io/presslabs/mysql-operator-sidecar
+        sidecarImage: quay.io/presslabs/mysql-operator-sidecar-mysql57
+        sidecarMysql8Image: quay.io/presslabs/mysql-operator-sidecar-mysql8
         orchestrator.image: quay.io/presslabs/mysql-operator-orchestrator

test/e2e/framework/helm.go

@@ -32,7 +32,8 @@ func HelmInstallChart(release, ns string) {
 		"--values", TestContext.ChartValues, "--wait",
 		"--kube-context", TestContext.KubeContext,
 		"--set", fmt.Sprintf("image=%s", TestContext.OperatorImage),
-		"--set", fmt.Sprintf("sidecarImage=%s", TestContext.SidecarImage),
+		"--set", fmt.Sprintf("sidecarImage=%s", TestContext.SidecarMysql57Image),
+		"--set", fmt.Sprintf("sidecarMysql8Image=%s", TestContext.SidecarMysql8Image),
 		"--set", fmt.Sprintf("orchestrator.image=%s", TestContext.OrchestratorImage),
 	}
 

test/e2e/framework/text_context.go

@@ -36,9 +36,10 @@ type TestContextType struct {
 	ChartPath   string
 	ChartValues string
 
-	OperatorImage     string
-	SidecarImage      string
-	OrchestratorImage string
+	OperatorImage       string
+	SidecarMysql57Image string
+	SidecarMysql8Image  string
+	OrchestratorImage   string
 
 	TimeoutSeconds    int
 	DumpLogsOnFailure bool
@@ -66,7 +67,8 @@ func RegisterCommonFlags() {
 	flag.StringVar(&TestContext.ChartValues, "operator-chart-values-path", "../../test/e2e-values.yaml", "Path to a values file for mysql-operator chart.")
 
 	flag.StringVar(&TestContext.OperatorImage, "operator-image", "quay.io/presslabs/mysql-operator:build", "Image for mysql operator.")
-	flag.StringVar(&TestContext.SidecarImage, "sidecar-image", "quay.io/presslabs/mysql-operator-sidecar:build", "Image for mysql helper.")
+	flag.StringVar(&TestContext.SidecarMysql57Image, "sidecar-mysql57-image", "quay.io/presslabs/mysql-operator-sidecar-mysql57:build", "Image for mysql helper.")
+	flag.StringVar(&TestContext.SidecarMysql8Image, "sidecar-mysql8-image", "quay.io/presslabs/mysql-operator-sidecar-mysql8:build", "Image for mysql helper.")
 	flag.StringVar(&TestContext.OrchestratorImage, "orchestrator-image", "quay.io/presslabs/mysql-operator-orchestrator:build", "Image for mysql orchestrator.")
 
 	flag.IntVar(&TestContext.TimeoutSeconds, "pod-wait-timeout", 100, "Timeout to wait for a pod to be ready.")