Support MySQL 8.4.0 for moco

.github/actions/e2e/action.yaml

@@ -26,7 +26,7 @@ runs:
       run: make start KUBERNETES_VERSION=${{ inputs.k8s-version }} MYSQL_VERSION=${{ inputs.mysql-version }} KIND_CONFIG=kind-config_actions.yaml
       working-directory: e2e
       shell: bash
-    - run: make test
+    - run: make test MYSQL_VERSION=${{ inputs.mysql-version }}
       working-directory: e2e
       shell: bash
     - run: make logs

.github/workflows/ci-e2e.yaml

@@ -24,7 +24,7 @@ jobs:
     name: Integration tests with MySQL
     strategy:
       matrix:
-        mysql-version: ["8.0.35", "8.0.36", "8.0.37"]
+        mysql-version: ["8.0.28", "8.0.36", "8.0.37", "8.4.0"]
     runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
@@ -44,7 +44,7 @@ jobs:
     name: Supported Kubernetes versions End-to-End Tests
     strategy:
       matrix:
-        mysql-version: ["8.0.37"]
+        mysql-version: ["8.4.0"]
         k8s-version: ["1.27.13", "1.28.9", "1.29.4"]
     runs-on:
       group: moco
@@ -67,7 +67,7 @@ jobs:
     name: Supported MySQL versions End-to-End Tests
     strategy:
       matrix:
-        mysql-version: ["8.0.35", "8.0.36", "8.0.37"]
+        mysql-version: ["8.0.28", "8.0.36", "8.0.37", "8.4.0"]
         k8s-version: ["1.29.4"]
     runs-on:
       group: moco

.github/workflows/weekly.yaml

@@ -17,7 +17,7 @@ jobs:
     name: Integration tests with MySQL
     strategy:
       matrix:
-        mysql-version: ["8.0.18", "8.0.25", "8.0.26", "8.0.27", "8.0.28", "8.0.30", "8.0.31", "8.0.32", "8.0.33", "8.0.34", "8.0.35", "8.0.36", "8.0.37"]
+        mysql-version: ["8.0.28", "8.0.36", "8.0.37", "8.4.0"]
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
@@ -29,7 +29,7 @@ jobs:
     name: Supported Kubernetes versions End-to-End Tests
     strategy:
       matrix:
-        mysql-version: ["8.0.37"]
+        mysql-version: ["8.4.0"]
         k8s-version: ["1.27.13", "1.28.9", "1.29.4"]
     runs-on:
       group: moco
@@ -44,7 +44,7 @@ jobs:
     name: Supported MySQL versions End-to-End Tests
     strategy:
       matrix:
-        mysql-version: ["8.0.18", "8.0.25", "8.0.26", "8.0.27", "8.0.28", "8.0.30", "8.0.31", "8.0.32", "8.0.33", "8.0.34", "8.0.35", "8.0.36", "8.0.37"]
+        mysql-version: ["8.0.28", "8.0.36", "8.0.37", "8.4.0"]
         k8s-version: ["1.29.4"]
     runs-on:
       group: moco

DEVELOP.md

@@ -58,10 +58,10 @@ Edit the following lines in `Dockerfile`:
 
 ```
 # The tag should be the latest one
-FROM ghcr.io/cybozu-go/moco/mysql:8.0.35.1 as mysql
+FROM ghcr.io/cybozu-go/moco/mysql:8.4.0.1 as mysql
 
 # See the below description for how to get the version string.
-ARG MYSQLSH_VERSION=8.0.35-1
+ARG MYSQLSH_VERSION=8.4.0-1
 ```
 
 The MySQL shell debian package can be found in https://dev.mysql.com/downloads/shell/ .
@@ -88,23 +88,23 @@ MySQL versions appear twice:
     name: Integration tests with MySQL
     strategy:
       matrix:
-        mysql-version: ["8.0.18", "8.0.25", "8.0.26", "8.0.27", "8.0.28", "8.0.30", "8.0.31", "8.0.32", "8.0.33", "8.0.34", "8.0.35"]
+        mysql-version: ["8.0.28", "8.0.36", "8.0.37", "8.4.0"]
 ...
   # Matrix tests for the latest MySQL version on different Kubernetes versions.
   e2e:
     name: Supported Kubernetes versions End-to-End Tests
     strategy:
       matrix:
-        mysql-version: ["8.0.35"]
-        k8s-version: ["1.19.11", "1.20.7", "1.21.1"]
+        mysql-version: ["8.4.0"]
+        k8s-version: ["1.27.13", "1.28.9", "1.29.4"]
 ...
   # Matrix tests for different MySQL versions on the latest supported Kubernetes version.
   e2e-mysql:
     name: Supported MySQL versions End-to-End Tests
     strategy:
       matrix:
-        mysql-version: ["8.0.18", "8.0.25", "8.0.26", "8.0.27", "8.0.28", "8.0.30", "8.0.31", "8.0.32", "8.0.33", "8.0.34", "8.0.35"]
-        k8s-version: ["1.21.1"]
+        mysql-version: ["8.0.28", "8.0.36", "8.0.37", "8.4.0"]
+        k8s-version: ["1.29.4"]
 ```
 
 ## Updating moco-agent

Dockerfile

@@ -20,13 +20,13 @@ USER 10000:10000
 ENTRYPOINT ["/moco-controller"]
 
 # For MySQL binaries
-FROM --platform=$TARGETPLATFORM ghcr.io/cybozu-go/moco/mysql:8.0.37.1 as mysql
+FROM --platform=$TARGETPLATFORM ghcr.io/cybozu-go/moco/mysql:8.4.0.1 as mysql
 
 # the backup image
 FROM --platform=$TARGETPLATFORM ghcr.io/cybozu/ubuntu:22.04
 LABEL org.opencontainers.image.source https://github.com/cybozu-go/moco
 
-ARG MYSQLSH_VERSION=8.0.37
+ARG MYSQLSH_VERSION=8.4.0
 ARG MYSQLSH_GLIBC_VERSION=2.28
 ARG TARGETARCH
 
@@ -41,7 +41,7 @@ RUN apt-get update \
   && rm -rf /var/lib/apt/lists/* \
   && if [ "${TARGETARCH}" = 'amd64' ]; then MYSQLSH_ARCH='x86-64'; fi \
   && if [ "${TARGETARCH}" = 'arm64' ]; then MYSQLSH_ARCH='arm-64'; fi \
-  && curl -o /tmp/mysqlsh.tar.gz -fsL "https://cdn.mysql.com//Downloads/MySQL-Shell/mysql-shell-${MYSQLSH_VERSION}-linux-glibc${MYSQLSH_GLIBC_VERSION}-${MYSQLSH_ARCH:-unknown}bit.tar.gz" \
+  && curl -o /tmp/mysqlsh.tar.gz -fsL "https://cdn.mysql.com/Downloads/MySQL-Shell/mysql-shell-${MYSQLSH_VERSION}-linux-glibc${MYSQLSH_GLIBC_VERSION}-${MYSQLSH_ARCH:-unknown}bit.tar.gz" \
   && mkdir /usr/local/mysql-shell \
   && tar -xf /tmp/mysqlsh.tar.gz -C /usr/local/mysql-shell --strip-components=1 \
   && rm -f /tmp/mysqlsh.tar.gz

Makefile

@@ -4,7 +4,7 @@ CTRL_RUNTIME_VERSION := $(shell awk '/sigs.k8s.io\/controller-runtime/ {print su
 KUSTOMIZE_VERSION = 5.4.1
 HELM_VERSION = 3.15.0
 CRD_TO_MARKDOWN_VERSION = 0.0.3
-MYSQLSH_VERSION = 8.0.37-1
+MYSQLSH_VERSION = 8.4.0-1
 MDBOOK_VERSION = 0.4.37
 GORELEASER_VERSION = 1.26.1
 YQ_VERSION = 4.44.1

README.md

@@ -26,7 +26,7 @@ Blog article: [Introducing MOCO, a modern MySQL operator on Kubernetes](https://
 
 ## Supported software
 
-- MySQL: 8.0.18, 8.0.25, 8.0.26, 8.0.27, 8.0.28, 8.0.30, 8.0.31, 8.0.32, 8.0.33, 8.0.34, 8.0.35, 8.0.36, 8.0.37
+- MySQL: 8.0.28, 8.0.36, 8.0.37, 8.4.0
 - Kubernetes: 1.27, 1.28, 1.29
 
 MOCO supports (tests) the LTS releases of MySQL 8.
@@ -74,7 +74,7 @@ spec:
     spec:
       containers:
       - name: mysqld
-        image: ghcr.io/cybozu-go/moco/mysql:8.0.37
+        image: ghcr.io/cybozu-go/moco/mysql:8.4.0
   volumeClaimTemplates:
   - metadata:
       name: mysql-data

backup/restore.go

@@ -123,7 +123,7 @@ func (rm *RestoreManager) Restore(ctx context.Context) error {
 		st := &bkop.ServerStatus{}
 		if err := op.GetServerStatus(ctx, st); err != nil {
 			rm.log.Error(err, "failed to get server status")
-			// SHOW MASTER STATUS fails due to the insufficient privileges,
+			// SHOW MASTER STATUS | SHOW BINARY LOG STATUS fails due to the insufficient privileges,
 			// if this restore process connects a target database before moco-agent grants privileges to moco-admin.
 			// In this case, the restore process panics and retries from the beginning.
 			panic(ErrBadConnection)

clustering/manager_test.go

@@ -442,7 +442,7 @@ var _ = Describe("manager", func() {
 			Expect(st.GlobalVariables.SuperReadOnly).To(BeTrue())
 			Expect(st.GlobalVariables.SemiSyncSlaveEnabled).To(BeFalse())
 			Expect(st.ReplicaStatus).NotTo(BeNil())
-			Expect(st.ReplicaStatus.SlaveIORunning).To(Equal("Yes"))
+			Expect(st.ReplicaStatus.ReplicaIORunning).To(Equal("Yes"))
 		}
 
 		Expect(of.getKillConnectionsCount(cluster.PodHostname(0))).To(Equal(0)) // connection should not be killed
@@ -537,9 +537,9 @@ var _ = Describe("manager", func() {
 			Expect(st.GlobalVariables.SemiSyncSlaveEnabled).To(BeFalse())
 			Expect(st.ReplicaStatus).NotTo(BeNil())
 			if i == newPrimary {
-				Expect(st.ReplicaStatus.MasterHost).To(Equal("external"))
+				Expect(st.ReplicaStatus.SourceHost).To(Equal("external"))
 			} else {
-				Expect(st.ReplicaStatus.MasterHost).To(Equal(cluster.PodHostname(newPrimary)))
+				Expect(st.ReplicaStatus.SourceHost).To(Equal(cluster.PodHostname(newPrimary)))
 			}
 		}
 
@@ -597,7 +597,7 @@ var _ = Describe("manager", func() {
 				Expect(st.GlobalVariables.SuperReadOnly).To(BeTrue())
 				Expect(st.GlobalVariables.SemiSyncSlaveEnabled).To(BeTrue())
 				Expect(st.ReplicaStatus).NotTo(BeNil())
-				Expect(st.ReplicaStatus.MasterHost).To(Equal(cluster.PodHostname(newPrimary)))
+				Expect(st.ReplicaStatus.SourceHost).To(Equal(cluster.PodHostname(newPrimary)))
 			}
 		}
 	})
@@ -856,7 +856,7 @@ var _ = Describe("manager", func() {
 		st1 := of.getInstanceStatus(cluster.PodHostname(1))
 		Expect(st1).NotTo(BeNil())
 		if st1.ReplicaHosts != nil {
-			Expect(st1.ReplicaStatus.SlaveIORunning).NotTo(Equal("Yes"))
+			Expect(st1.ReplicaStatus.ReplicaIORunning).NotTo(Equal("Yes"))
 		}
 
 		for i := 0; i < 5; i++ {

clustering/mock_test.go

@@ -265,10 +265,10 @@ func (o *mockOperator) ConfigureReplica(ctx context.Context, source dbop.AccessI
 
 	if o.mysql.status.ReplicaStatus != nil {
 		var oldi *mockMySQL
-		if o.mysql.status.ReplicaStatus.MasterHost == source.Host {
+		if o.mysql.status.ReplicaStatus.SourceHost == source.Host {
 			oldi = si
 		} else {
-			oldi = o.factory.getInstance(o.mysql.status.ReplicaStatus.MasterHost)
+			oldi = o.factory.getInstance(o.mysql.status.ReplicaStatus.SourceHost)
 			if oldi == nil {
 				panic(oldi)
 			}
@@ -292,10 +292,10 @@ func (o *mockOperator) ConfigureReplica(ctx context.Context, source dbop.AccessI
 
 	gtid, _ := testGetGTID(source.Host)
 	o.mysql.status.ReplicaStatus = &dbop.ReplicaStatus{
-		MasterHost:       source.Host,
-		RetrievedGtidSet: gtid,
-		SlaveIORunning:   "Yes",
-		SlaveSQLRunning:  "Yes",
+		SourceHost:        source.Host,
+		RetrievedGtidSet:  gtid,
+		ReplicaIORunning:  "Yes",
+		ReplicaSQLRunning: "Yes",
 	}
 	o.mysql.status.GlobalVariables.SemiSyncSlaveEnabled = semisync
 	return setPodReadiness(ctx, o.cluster.PodName(o.index), true)
@@ -315,7 +315,7 @@ func (o *mockOperator) ConfigurePrimary(ctx context.Context, waitForCount int) e
 	return nil
 }
 
-// StopReplicaIOThread executes `STOP SLAVE IO_THREAD`.
+// StopReplicaIOThread executes `STOP REPLICA IO_THREAD`.
 func (o *mockOperator) StopReplicaIOThread(ctx context.Context) error {
 	if o.failing {
 		return errors.New("mysqld is down")
@@ -326,7 +326,7 @@ func (o *mockOperator) StopReplicaIOThread(ctx context.Context) error {
 	if o.mysql.status.ReplicaStatus == nil {
 		return nil
 	}
-	o.mysql.status.ReplicaStatus.SlaveIORunning = "No"
+	o.mysql.status.ReplicaStatus.ReplicaIORunning = "No"
 	return setPodReadiness(ctx, o.cluster.PodName(o.index), false)
 }
 
@@ -352,12 +352,12 @@ func (o *mockOperator) WaitForGTID(_ context.Context, gtidSet string, _ int) err
 		o.mysql.status.GlobalVariables.ExecutedGTID = gtidSet
 		return nil
 	}
-	if o.mysql.status.ReplicaStatus.SlaveIORunning == "Yes" {
-		primary := o.factory.getInstance(o.mysql.status.ReplicaStatus.MasterHost)
+	if o.mysql.status.ReplicaStatus.ReplicaIORunning == "Yes" {
+		primary := o.factory.getInstance(o.mysql.status.ReplicaStatus.SourceHost)
 		if primary == nil {
 			return errors.New("waitForGTID: primary not found")
 		}
-		primaryGTID, _ := testGetGTID(o.mysql.status.ReplicaStatus.MasterHost)
+		primaryGTID, _ := testGetGTID(o.mysql.status.ReplicaStatus.SourceHost)
 		if primaryGTID == gtidSet {
 			testSetGTID(o.Name(), gtidSet)
 			o.mysql.status.GlobalVariables.ExecutedGTID = gtidSet
@@ -383,7 +383,7 @@ func (o *mockOperator) SetReadOnly(ctx context.Context, readonly bool) error {
 	}
 
 	if o.mysql.status.ReplicaStatus != nil {
-		primary := o.factory.getInstance(o.mysql.status.ReplicaStatus.MasterHost)
+		primary := o.factory.getInstance(o.mysql.status.ReplicaStatus.SourceHost)
 		if primary == nil {
 			return errors.New("setReadOnly: primary not found")
 		}

clustering/operations.go

@@ -427,7 +427,7 @@ func (p *managerProcess) configureIntermediatePrimary(ctx context.Context, ss *S
 		User:     string(secret.Data[constants.CloneSourceUserKey]),
 		Password: string(secret.Data[constants.CloneSourcePasswordKey]),
 	}
-	if pst.ReplicaStatus == nil || pst.ReplicaStatus.SlaveIORunning != "Yes" || pst.ReplicaStatus.MasterHost != ai.Host {
+	if pst.ReplicaStatus == nil || pst.ReplicaStatus.ReplicaIORunning != "Yes" || pst.ReplicaStatus.SourceHost != ai.Host {
 		redo = true
 		log.Info("start replication", "instance", ss.Primary, "semisync", false)
 		if err := op.ConfigureReplica(ctx, ai, false); err != nil {
@@ -443,7 +443,7 @@ func (p *managerProcess) configurePrimary(ctx context.Context, ss *StatusSet) (r
 	op := ss.DBOps[ss.Primary]
 
 	// wait for all retrieved transactions to be executed if this used to be an intermediate replica
-	if pst.ReplicaStatus != nil && pst.ReplicaStatus.SlaveIORunning == "Yes" {
+	if pst.ReplicaStatus != nil && pst.ReplicaStatus.ReplicaIORunning == "Yes" {
 		redo = true
 		log.Info("stop replica IO thread", "instance", ss.Primary)
 		if err := op.StopReplicaIOThread(ctx); err != nil {
@@ -484,7 +484,7 @@ func (p *managerProcess) configureReplica(ctx context.Context, ss *StatusSet, in
 		if st.ReplicaStatus == nil {
 			return
 		}
-		if st.ReplicaStatus.SlaveIORunning != "Yes" {
+		if st.ReplicaStatus.ReplicaIORunning != "Yes" {
 			return
 		}
 		log.Info("stop replica IO thread", "instance", index)
@@ -567,7 +567,7 @@ func (p *managerProcess) configureReplica(ctx context.Context, ss *StatusSet, in
 		Password: ss.Password.Replicator(),
 	}
 	semisync := ss.Cluster.Spec.ReplicationSourceSecretName == nil
-	if st.ReplicaStatus == nil || st.ReplicaStatus.SlaveIORunning != "Yes" || st.ReplicaStatus.MasterHost != ai.Host || st.GlobalVariables.SemiSyncSlaveEnabled != semisync {
+	if st.ReplicaStatus == nil || st.ReplicaStatus.ReplicaIORunning != "Yes" || st.ReplicaStatus.SourceHost != ai.Host || st.GlobalVariables.SemiSyncSlaveEnabled != semisync {
 		redo = true
 		log.Info("start replication", "instance", index, "semisync", semisync)
 		if err := op.ConfigureReplica(ctx, ai, semisync); err != nil {

clustering/status.go

@@ -377,7 +377,7 @@ func isHealthy(ss *StatusSet) bool {
 		if ist.ReplicaStatus == nil {
 			return false
 		}
-		if ist.ReplicaStatus.MasterHost != primaryHostname {
+		if ist.ReplicaStatus.SourceHost != primaryHostname {
 			return false
 		}
 		ss.Candidates = append(ss.Candidates, i)
@@ -481,7 +481,7 @@ func isDegraded(ss *StatusSet) bool {
 		if ist.ReplicaStatus == nil {
 			continue
 		}
-		if ist.ReplicaStatus.MasterHost != primaryHostname {
+		if ist.ReplicaStatus.SourceHost != primaryHostname {
 			continue
 		}
 		if ist.IsErrant {

clustering/status_test.go

@@ -161,7 +161,7 @@ func (b *mysqlBuilder) build() *dbop.MySQLInstanceStatus {
 	}
 	if len(b.sourceHost) > 0 {
 		st.ReplicaStatus = &dbop.ReplicaStatus{
-			MasterHost: b.sourceHost,
+			SourceHost: b.sourceHost,
 		}
 	}
 	st.ReplicaHosts = b.replicaHosts

docs/backup.md

@@ -127,7 +127,7 @@ MOCO then creates a tarball of the dump and puts it to an object storage bucket.
 
 To retrieve transactions since the last backup until now, `mysqlbinlog` is used with these flags:
 
-- [`--read-from-remote-master=BINLOG-DUMP-GTIDS`](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html#option_mysqlbinlog_read-from-remote-master)
+- [`--read-from-remote-source=BINLOG-DUMP-GTIDS`](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html#option_mysqlbinlog_read-from-remote-source)
 - [`--exclude-gtids=<the GTID of the last backup>`](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html#option_mysqlbinlog_exclude-gtids)
 - [`--to-last-log`](https://dev.mysql.com/doc/refman/8.0/en/mysqlbinlog.html#option_mysqlbinlog_to-last-log)
 
@@ -139,7 +139,7 @@ Finally, the Job updates MySQLCluster status field with the following informatio
 - The time spent on the backup
 - The ordinal of the backup source instance
 - `server_uuid` of the instance (to check whether the instance was re-initialized or not)
-- The binlog filename in `SHOW MASTER STATUS` output.
+- The binlog filename in `SHOW MASTER STATUS | SHOW BINARY LOG STATUS` output.
 - The size of the tarball of the dumped files
 - The size of the tarball of the binlog files
 - The maximum usage of the working directory

docs/change-pvc-template.md

@@ -93,7 +93,7 @@ For example, the user modifies the `.spec.volumeClaimTemplates` of the MySQLClus
       spec:
         containers:
         - name: mysqld
-          image: ghcr.io/cybozu-go/moco/mysql:8.0.30
+          image: ghcr.io/cybozu-go/moco/mysql:8.4.0
     volumeClaimTemplates:
     - metadata:
         name: mysql-data

docs/clustering.md

@@ -47,9 +47,9 @@ Likewise, MOCO configures [`rpl_semi_sync_master_wait_for_slave_count`](https://
 
 MOCO also disables [`relay_log_recovery`](https://dev.mysql.com/doc/refman/8.0/en/replication-options-replica.html#sysvar_relay_log_recovery) because enabling it would drop the relay logs on replicas.
 
-`mysqld` always starts with `super_read_only=1` to prevent erroneous writes, and with `skip_slave_start` to prevent misconfigured replication.
+`mysqld` always starts with `super_read_only=1` to prevent erroneous writes, and with `skip_replica_start` to prevent misconfigured replication.
 
-[`moco-agent`][agent], a sidecar container for MOCO, initializes MySQL users and plugins.  At the end of the initialization, it issues `RESET MASTER` to clear [executed GTID set](https://dev.mysql.com/doc/refman/8.0/en/replication-options-gtids.html#sysvar_gtid_executed).
+[`moco-agent`][agent], a sidecar container for MOCO, initializes MySQL users and plugins.  At the end of the initialization, it issues `RESET MASTER | RESET BINARY LOGS AND GTIDS` to clear [executed GTID set](https://dev.mysql.com/doc/refman/8.0/en/replication-options-gtids.html#sysvar_gtid_executed).
 
 `moco-agent` also provides a readiness probe for `mysqld` container.  If a replica instance does not start replication threads or is too delayed to execute transactions, the container and the Pod will be determined as unready.
 
@@ -156,8 +156,8 @@ MOCO gathers the information from `kube-apiserver` and `mysqld` as follows:
 - Pod resources
     - If some of the Pods are missing, MOCO does nothing.
 - `mysqld`
-    - `SHOW SLAVE HOSTS` (on the primary)
-    - `SHOW SLAVE STATUS` (on the replicas)
+    - `SHOW REPLICAS` (on the primary)
+    - `SHOW REPLICA STATUS` (on the replicas)
     - Global variables such as `gtid_executed` or `super_read_only`
     - Result of CLONE from `performance_schema.clone_status` table