🐥

KubernetesでMySQLのMaster/Slave構成

2022/01/10に公開

https://kubernetes.io/ja/docs/tasks/run-application/run-replicated-stateful-application/

ドキュメントを参考に、MasterとSlaveでMySQL環境を構成しました。
自分の環境に合わせてカスタマイズしている箇所もあるので、ご了承ください。

ConfigMapを作る

レプリケーションに必要な設定をするために、master.cnfとslave.cnfをここで定義する。
これらの設定情報は、後述するMaster担当(master.cnf)とSlave担当(slave.cnf)のそれぞれのPodに供給される。
masterでは、バイナリログを吐かせるために、log-binを設定。
slaveでは、読み取り専用とするために、super-read-onlyを設定。

さらに、初期データ登録用のcreatedb.sqlを作成し、後程docker-entrypoint-initdb.dディレクトリ配下に、マウントする。
公式MySQLイメージのdocker-entrypoint-initdb.dディレクトリ配下の.sh/.sql拡張子のファイルは、イメージの起動時に実行される。

mysql-configmap.yml
apiVersion: v1
kind: ConfigMap
metadata:
  name: mysql
  labels:
    app: mysql
data:
  master.cnf: |
    # Apply this config only on the master.
    [mysqld]
    log-bin
    character-set-server = utf8mb4
    collation-server = utf8mb4_bin

    default-time-zone = SYSTEM
    log_timestamps = SYSTEM
    general_log=1
    general_log_file=/var/log/mysql/general-query.log

    [mysql]
    default-character-set = utf8mb4

    [client]
    default-character-set = utf8mb4
  slave.cnf: |
    # Apply this config only on slaves.
    [mysqld]
    super-read-only
    character-set-server = utf8mb4
    collation-server = utf8mb4_bin

    default-time-zone = SYSTEM
    log_timestamps = SYSTEM
    general_log=1
    general_log_file=/var/log/mysql/general-query.log

    [mysql]
    default-character-set = utf8mb4

    [client]
    default-character-set = utf8mb4
  createdb.sql: |
    CREATE TABLE IF NOT EXISTS
    go_database.users(
        id serial,
        sex int NOT NULL,
        introduction VARCHAR(255) NOT NULL,
        created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
        updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
        PRIMARY KEY(id)
    ) ENGINE=INNODB DEFAULT CHARSET=utf8;
    CREATE TABLE IF NOT EXISTS
    go_database.posts(
        id serial,
        title VARCHAR(255) NOT NULL,
        content VARCHAR(255) NOT NULL,
        publish_date int NOT NULL,
        thumbnail_url VARCHAR(255),
        user_id bigint UNSIGNED NOT NULL,
        created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
        updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
        PRIMARY KEY(id),
        FOREIGN KEY (user_id)
        REFERENCES users(id)
        ON UPDATE CASCADE
        ON DELETE CASCADE
    ) ENGINE=INNODB DEFAULT CHARSET=utf8;

作ったら、アプライします。

$ kubectl apply -f ./k8s/mysql-configmap.yml --record 

Serviceを作る

これは、ドキュメント通りです。ここでは、2つのサービスを定義しています。
1つ目は、ヘッドレスサービスを提供します。このヘッドレスサービスを後で定義するStatefulSetで利用することで、Pod名でIPアドレスを引くことができます。言い換えると、<pad名>.mysqlで特定のPodとして名前解決することができるということです。
2つ目は、ClusterIPタイプでサービスを定義するため、クラスタ内からのみ受けつけます。MasterとSlaveの全てを含んだReady状態のすべてのMySQL Podに接続を分散します。

mysql-services.yml
# Headless service for stable DNS entries of StatefulSet members.
apiVersion: v1
kind: Service
metadata:
  name: mysql
  labels:
    app: mysql
spec:
  ports:
    - name: mysql
      port: 3306
  clusterIP: None
  selector:
    app: mysql
---
# Client service for connecting to any MySQL instance for reads.
# For writes, you must instead connect to the master: mysql-0.mysql.
apiVersion: v1
kind: Service
metadata:
  name: mysql-read
  labels:
    app: mysql
spec:
  ports:
    - name: mysql
      port: 3306
  selector:
    app: mysql

さて。
作ったら、アプライします。

$ kubectl apply -f ./k8s/mysql-services.yml --record 

Secretを作成する

MySQLにアクセスするための、認証情報は環境変数で渡します。しかし、環境変数は、後述するStatefulSetのマニフェストファイルに設定するため、平文をマニフェストファイルに残さないように、Secretリソースを作成します。

Secretで設定する値は、Base64でエンコードした文字列を記述します。

echo -n "<mysqlのパスワード>" | base64 
<ここに出力されたBase64文字列を①に記述>

$ echo -n "<mysqlの作成するユーザーのパスワード>" | base64 
<ここに出力されたBase64文字列を②に記述>
mysql-secret.yml
apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
data:
  mysql_password:mysql_root_password:

さあ。これもアプライします。

$ kubectl apply -f ./k8s/mysql-services.yml --record

StatefulSetを作成する

mysql-statefulset.yml
apiVersion: apps/v1
kind: StatefulSet
metadata:
  name: mysql
spec:
  selector:
    matchLabels:
      app: mysql
  serviceName: mysql
  replicas: 3
  template:
    metadata:
      labels:
        app: mysql
    spec:
      initContainers:
        - name: init-mysql
          image: mysql@sha256:92ad1d7e3f8eb7e67d35bf251912fb7cd12676a601dc90b6beb1aece7c1f5073
          command:
            - bash
            - "-c"
            - |
              set -ex
              # Generate mysql server-id from pod ordinal index.
              [[ `hostname` =~ -([0-9]+)$ ]] || exit 1
              ordinal=${BASH_REMATCH[1]}
              echo [mysqld] > /mnt/conf.d/server-id.cnf
              # Add an offset to avoid reserved server-id=0 value.
              echo server-id=$((100 + $ordinal)) >> /mnt/conf.d/server-id.cnf
              # Copy appropriate conf.d files from config-map to emptyDir.
              if [[ $ordinal -eq 0 ]]; then
                cp /mnt/config-map/master.cnf /mnt/conf.d/
                cp /mnt/config-map/createdb.sql /mnt/initdb/
              else
                cp /mnt/config-map/slave.cnf /mnt/conf.d/
              fi
          volumeMounts:
            - name: conf
              mountPath: /mnt/conf.d
            - name: config-map
              mountPath: /mnt/config-map
            - name: initdb
              mountPath: /mnt/initdb
        - name: clone-mysql
          image: gcr.io/google-samples/xtrabackup:1.0
          command:
            - bash
            - "-c"
            - |
              set -ex
              # Skip the clone if data already exists.
              [[ -d /var/lib/mysql/mysql ]] && exit 0
              # Skip the clone on master (ordinal index 0).
              [[ `hostname` =~ -([0-9]+)$ ]] || exit 1
              ordinal=${BASH_REMATCH[1]}
              [[ $ordinal -eq 0 ]] && exit 0
              # Clone data from previous peer.
              ncat --recv-only mysql-$(($ordinal-1)).mysql 3307 | xbstream -x -C /var/lib/mysql
              # Prepare the backup.
              xtrabackup --prepare --target-dir=/var/lib/mysql
          volumeMounts:
            - name: data
              mountPath: /var/lib/mysql
              subPath: mysql
            - name: conf
              mountPath: /etc/mysql/conf.d
      containers:
        - name: mysql
          image: mysql@sha256:92ad1d7e3f8eb7e67d35bf251912fb7cd12676a601dc90b6beb1aece7c1f5073
          env:
            - name: MYSQL_USER
              value: go_user
            - name: MYSQL_PASSWORD
              valueFrom:
                secretKeyRef:
                  name: mysecret
                  key: mysql_password
            - name: MYSQL_ROOT_PASSWORD
              valueFrom:
                secretKeyRef:
                  name: mysecret
                  key: mysql_root_password
            - name: TZ
              value: Asia/Tokyo
            - name: MYSQL_DATABASE
              value: go_database
          ports:
            - name: mysql
              containerPort: 3306
          volumeMounts:
            - name: data
              mountPath: /var/lib/mysql
              subPath: mysql
            - name: conf
              mountPath: /etc/mysql/conf.d
            - name: initdb
              mountPath: /docker-entrypoint-initdb.d
          resources:
            requests:
              cpu: 500m
              memory: 1Gi
          livenessProbe:
            exec:
              command:
                ["mysqladmin", "ping", "-uroot", "-p$(MYSQL_ROOT_PASSWORD)"]
            initialDelaySeconds: 30
            periodSeconds: 10
            timeoutSeconds: 5
          readinessProbe:
            exec:
              # Check we can execute queries over TCP (skip-networking is off).
              command:
                ["mysqladmin", "ping", "-uroot", "-p$(MYSQL_ROOT_PASSWORD)"]
            initialDelaySeconds: 5
            periodSeconds: 2
            timeoutSeconds: 1
        - name: xtrabackup
          image: gcr.io/google-samples/xtrabackup:1.0
          env:
            - name: MYSQL_PASSWORD
              valueFrom:
                secretKeyRef:
                  name: mysecret
                  key: mysql_password
            - name: MYSQL_ROOT_PASSWORD
              valueFrom:
                secretKeyRef:
                  name: mysecret
                  key: mysql_root_password
          ports:
            - name: xtrabackup
              containerPort: 3307
          command:
            - bash
            - "-c"
            - |
              set -ex
              cd /var/lib/mysql

              # Determine binlog position of cloned data, if any.
              if [[ -f xtrabackup_slave_info && "x$(<xtrabackup_slave_info)" != "x" ]]; then
                # XtraBackup already generated a partial "CHANGE MASTER TO" query
                # because we're cloning from an existing slave. (Need to remove the tailing semicolon!)
                cat xtrabackup_slave_info | sed -E 's/;$//g' > change_master_to.sql.in
                # Ignore xtrabackup_binlog_info in this case (it's useless).
                rm -f xtrabackup_slave_info xtrabackup_binlog_info
              elif [[ -f xtrabackup_binlog_info ]]; then
                # We're cloning directly from master. Parse binlog position.
                [[ `cat xtrabackup_binlog_info` =~ ^(.*?)[[:space:]]+(.*?)$ ]] || exit 1
                rm -f xtrabackup_binlog_info xtrabackup_slave_info
                echo "CHANGE MASTER TO MASTER_LOG_FILE='${BASH_REMATCH[1]}',\
                      MASTER_LOG_POS=${BASH_REMATCH[2]}" > change_master_to.sql.in
              fi

              # Check if we need to complete a clone by starting replication.
              if [[ -f change_master_to.sql.in ]]; then
                echo "Waiting for mysqld to be ready (accepting connections)"
                until mysql -h 127.0.0.1 -uroot -p$(MYSQL_ROOT_PASSWORD) -e "SELECT 1"; do sleep 1; done

                echo "Initializing replication from clone position"
                mysql -h 127.0.0.1 -uroot -p$(MYSQL_ROOT_PASSWORD) \
                      -e "$(<change_master_to.sql.in), \
                              MASTER_HOST='mysql-0.mysql', \
                              MASTER_USER='root', \
                              MASTER_PASSWORD='$(MYSQL_ROOT_PASSWORD)', \
                              MASTER_CONNECT_RETRY=10; \
                            START SLAVE;" || exit 1
                # In case of container restart, attempt this at-most-once.
                mv change_master_to.sql.in change_master_to.sql.orig
              fi

              # Start a server to send backups when requested by peers.
              exec ncat --listen --keep-open --send-only --max-conns=1 3307 -c \
                "xtrabackup --backup --slave-info --stream=xbstream --host=127.0.0.1 --user=root --password=$(MYSQL_ROOT_PASSWORD)"
          volumeMounts:
            - name: data
              mountPath: /var/lib/mysql
              subPath: mysql
            - name: conf
              mountPath: /etc/mysql/conf.d
          resources:
            requests:
              cpu: 100m
              memory: 100Mi
      volumes:
        - name: conf
          emptyDir: {}
        - name: initdb
          emptyDir: {}
        - name: config-map
          configMap:
            name: mysql
  volumeClaimTemplates:
    - metadata:
        name: data
      spec:
        accessModes: ["ReadWriteOnce"]
        resources:
          requests:
            storage: 10Gi

いつものごとく、これもアプライします。

$ kubectl apply -f ./k8s/mysql-services.yml --record

StatefulSetなので、Pod名は、「mysql-<連番>」で一意に決まります。

$ kubectl get pods                                                                                                                          
NAME      READY   STATUS    RESTARTS   AGE
mysql-0   2/2     Running   0          6h57m
mysql-1   2/2     Running   0          6h56m
mysql-2   2/2     Running   0          6h56m

検証

初期データが作成されているかを確認します。
Masterは、「mysql-0.mysql」、Slaveは、「mysql-1.mysql」「mysql-2.mysql」をホスト名としてアクセスすることができます。

$ kubectl run mysql-client --image=mysql@sha256:92ad1d7e3f8eb7e67d35bf251912fb7cd12676a601dc90b6beb1aece7c1f5073 -i --rm --restart=Never --\
  mysql -h mysql-0.mysql -u root -proot  -e "desc go_database.users"
 
If you don't see a command prompt, try pressing enter.

Field	Type	Null	Key	Default	Extra
id	bigint(20) unsigned	NO	PRI	NULL	auto_increment
sex	int(11)	NO		NULL	
introduction	varchar(255)	NO		NULL	
created_at	timestamp	NO		CURRENT_TIMESTAMP	
updated_at	timestamp	NO		CURRENT_TIMESTAMP	on update CURRENT_TIMESTAMP

pod "mysql-client" deleted

$ kubectl run mysql-client --image=mysql@sha256:92ad1d7e3f8eb7e67d35bf251912fb7cd12676a601dc90b6beb1aece7c1f5073 -i --rm --restart=Never --\
  mysql -h mysql-0.mysql -u root -proot  -e "desc go_database.posts"

If you don't see a command prompt, try pressing enter.
Field	Type	Null	Key	Default	Extra
id	bigint(20) unsigned	NO	PRI	NULL	auto_increment
title	varchar(255)	NO		NULL	
content	varchar(255)	NO		NULL	
publish_date	int(11)	NO		NULL	
thumbnail_url	varchar(255)	YES		NULL	
user_id	bigint(20) unsigned	NO	MUL	NULL	
created_at	timestamp	NO		CURRENT_TIMESTAMP	
updated_at	timestamp	NO		CURRENT_TIMESTAMP	on update CURRENT_TIMESTAMP

pod "mysql-client" deleted

「mysql-0.mysql」「mysql-1.mysql」「mysql-2.mysql」のそれぞれで上記コマンドを試してみます。
きちんと作成されていることが確認できるはずです。

あとは、ドキュメントにそって、クライアントトラフィックを送信したり、PodとNodeのダウンタイムをシミュレーションしたりできます。

Discussion