運行復制的有狀態應用程式
本頁面展示瞭如何使用 StatefulSet 執行有狀態的複製應用程式。此應用程式是一個複製的 MySQL 資料庫。示例拓撲結構有一個主伺服器和多個副本,使用非同步基於行的複製。
注意
這不是生產配置。MySQL 設定仍使用不安全的預設值,以便將重點放在 Kubernetes 中執行有狀態應用程式的通用模式上。準備工作
你需要有一個 Kubernetes 叢集,並且 kubectl 命令列工具必須配置為與你的叢集通訊。建議在至少有兩個不作為控制平面主機的節點的叢集上執行本教程。如果你還沒有叢集,可以使用 minikube 建立一個,或者使用以下 Kubernetes 演練環境之一:
你需要有一個具有預設 StorageClass 的 動態 PersistentVolume 供應器,或者你自己 靜態配置 PersistentVolumes 以滿足此處使用的 PersistentVolumeClaims。
- 本教程假定你熟悉 PersistentVolumes 和 StatefulSets,以及其他核心概念,例如 Pods、Services 和 ConfigMaps。
- 對 MySQL 有一定的瞭解會有幫助,但本教程旨在呈現對其他系統也應有用的通用模式。
- 你正在使用預設名稱空間或其他不包含任何衝突物件的名稱空間。
- 你需要一個相容 AMD64 的 CPU。
目標
- 使用 StatefulSet 部署一個複製的 MySQL 拓撲。
- 傳送 MySQL 客戶端流量。
- 觀察對停機時間的抵抗力。
- 擴縮 StatefulSet。
部署 MySQL
示例 MySQL 部署包含一個 ConfigMap、兩個 Service 和一個 StatefulSet。
建立 ConfigMap
從以下 YAML 配置檔案建立 ConfigMap:
apiVersion: v1
kind: ConfigMap
metadata:
name: mysql
labels:
app: mysql
app.kubernetes.io/name: mysql
data:
primary.cnf: |
# Apply this config only on the primary.
[mysqld]
log-bin
replica.cnf: |
# Apply this config only on replicas.
[mysqld]
super-read-only
kubectl apply -f https://k8s.io/examples/application/mysql/mysql-configmap.yaml
此 ConfigMap 提供了 my.cnf
覆蓋,使你能夠獨立控制主 MySQL 伺服器及其副本的配置。在這種情況下,你希望主伺服器能夠向副本提供複製日誌,並且你希望副本拒絕任何非透過複製進行的寫入。
ConfigMap 本身並沒有什麼特別之處,導致不同部分應用於不同的 Pod。每個 Pod 在初始化時根據 StatefulSet 控制器提供的資訊決定檢視哪一部分。
建立 Service
從以下 YAML 配置檔案建立 Service:
# Headless service for stable DNS entries of StatefulSet members.
apiVersion: v1
kind: Service
metadata:
name: mysql
labels:
app: mysql
app.kubernetes.io/name: 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 primary: mysql-0.mysql.
apiVersion: v1
kind: Service
metadata:
name: mysql-read
labels:
app: mysql
app.kubernetes.io/name: mysql
readonly: "true"
spec:
ports:
- name: mysql
port: 3306
selector:
app: mysql
kubectl apply -f https://k8s.io/examples/application/mysql/mysql-services.yaml
無頭 Service 為 StatefulSet 控制器 為集合中的每個 Pod 建立的 DNS 條目提供了一個宿主。由於無頭 Service 名為 mysql
,因此在同一 Kubernetes 叢集和名稱空間中的任何其他 Pod 內,透過解析 <pod-name>.mysql
即可訪問這些 Pod。
客戶端 Service,名為 mysql-read
,是一個正常的 Service,具有自己的叢集 IP,它在所有報告就緒的 MySQL Pod 之間分配連線。潛在的端點集包括主 MySQL 伺服器和所有副本。
請注意,只有讀取查詢才能使用負載均衡的客戶端 Service。由於只有一個主 MySQL 伺服器,客戶端應直接連線到主 MySQL Pod(透過其在無頭 Service 中的 DNS 條目)來執行寫入。
建立 StatefulSet
最後,從以下 YAML 配置檔案建立 StatefulSet:
apiVersion: apps/v1
kind: StatefulSet
metadata:
name: mysql
spec:
selector:
matchLabels:
app: mysql
app.kubernetes.io/name: mysql
serviceName: mysql
replicas: 3
template:
metadata:
labels:
app: mysql
app.kubernetes.io/name: mysql
spec:
initContainers:
- name: init-mysql
image: mysql:5.7
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/primary.cnf /mnt/conf.d/
else
cp /mnt/config-map/replica.cnf /mnt/conf.d/
fi
volumeMounts:
- name: conf
mountPath: /mnt/conf.d
- name: config-map
mountPath: /mnt/config-map
- 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 primary (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:5.7
env:
- name: MYSQL_ALLOW_EMPTY_PASSWORD
value: "1"
ports:
- name: mysql
containerPort: 3306
volumeMounts:
- name: data
mountPath: /var/lib/mysql
subPath: mysql
- name: conf
mountPath: /etc/mysql/conf.d
resources:
requests:
cpu: 500m
memory: 1Gi
livenessProbe:
exec:
command: ["mysqladmin", "ping"]
initialDelaySeconds: 30
periodSeconds: 10
timeoutSeconds: 5
readinessProbe:
exec:
# Check we can execute queries over TCP (skip-networking is off).
command: ["mysql", "-h", "127.0.0.1", "-e", "SELECT 1"]
initialDelaySeconds: 5
periodSeconds: 2
timeoutSeconds: 1
- name: xtrabackup
image: gcr.io/google-samples/xtrabackup:1.0
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 replica. (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 primary. 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 -e "SELECT 1"; do sleep 1; done
echo "Initializing replication from clone position"
mysql -h 127.0.0.1 \
-e "$(<change_master_to.sql.in), \
MASTER_HOST='mysql-0.mysql', \
MASTER_USER='root', \
MASTER_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"
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: config-map
configMap:
name: mysql
volumeClaimTemplates:
- metadata:
name: data
spec:
accessModes: ["ReadWriteOnce"]
resources:
requests:
storage: 10Gi
kubectl apply -f https://k8s.io/examples/application/mysql/mysql-statefulset.yaml
你可以透過執行以下命令檢視啟動進度:
kubectl get pods -l app=mysql --watch
一段時間後,你應該會看到所有 3 個 Pod 都變為 Running
:
NAME READY STATUS RESTARTS AGE
mysql-0 2/2 Running 0 2m
mysql-1 2/2 Running 0 1m
mysql-2 2/2 Running 0 1m
按 Ctrl+C 取消觀察。
注意
如果你沒有看到任何進展,請確保已啟用動態 PersistentVolume 供應器,如前提條件中所述。此清單使用各種技術來管理作為 StatefulSet 一部分的有狀態 Pod。下一節將重點介紹其中一些技術,以解釋 StatefulSet 建立 Pod 時發生的情況。
理解有狀態 Pod 初始化
StatefulSet 控制器一次啟動一個 Pod,按照其序數索引的順序。它會等待每個 Pod 報告就緒後才啟動下一個 Pod。
此外,控制器為每個 Pod 分配一個唯一且穩定的名稱,格式為 <statefulset-name>-<ordinal-index>
,這導致 Pod 被命名為 mysql-0
、mysql-1
和 mysql-2
。
上述 StatefulSet 清單中的 Pod 模板利用這些特性來執行 MySQL 複製的有序啟動。
生成配置
在啟動 Pod 規約中的任何容器之前,Pod 會首先按照定義的順序執行所有 Init 容器。
第一個 Init 容器,名為 init-mysql
,根據序數索引生成特殊的 MySQL 配置檔案。
指令碼透過從 hostname
命令返回的 Pod 名稱末尾提取序數索引來確定自己的序數索引。然後,它將序數(帶有數字偏移量以避免保留值)儲存到 MySQL conf.d
目錄中名為 server-id.cnf
的檔案中。這會將 StatefulSet 提供的唯一穩定身份轉換為需要相同屬性的 MySQL 伺服器 ID 域。
init-mysql
容器中的指令碼還透過將內容複製到 conf.d
來應用 ConfigMap 中的 primary.cnf
或 replica.cnf
。由於示例拓撲結構包含一個主 MySQL 伺服器和任意數量的副本,因此指令碼將序數 0
分配給主伺服器,其他所有伺服器都作為副本。結合 StatefulSet 控制器的部署順序保證,這確保了主 MySQL 伺服器在建立副本之前就緒,以便它們可以開始複製。
克隆現有資料
通常,當一個新的 Pod 作為副本加入集合時,它必須假定主 MySQL 伺服器上可能已經存在資料。它還必須假定複製日誌可能無法一直追溯到最初。這些保守的假設是允許執行中的 StatefulSet 隨著時間的推移進行擴縮而不是固定其初始大小的關鍵。
第二個 Init 容器,名為 clone-mysql
,在副本 Pod 首次在空的 PersistentVolume 上啟動時執行克隆操作。這意味著它會從另一個執行中的 Pod 複製所有現有資料,以便其本地狀態足夠一致以開始從主伺服器進行復制。
MySQL 本身不提供執行此操作的機制,因此示例使用了一個流行的開源工具 Percona XtraBackup。在克隆過程中,源 MySQL 伺服器的效能可能會下降。為了最大程度地減少對主 MySQL 伺服器的影響,指令碼指示每個 Pod 從其序數索引低一個的 Pod 進行克隆。這之所以有效,是因為 StatefulSet 控制器總是確保 Pod N
在啟動 Pod N+1
之前就緒。
啟動複製
Init 容器成功完成後,常規容器開始執行。MySQL Pod 包含一個執行實際 mysqld
伺服器的 mysql
容器,以及一個充當邊車的 xtrabackup
容器。
xtrabackup
邊車會檢視克隆的資料檔案,並確定是否有必要在副本上初始化 MySQL 複製。如果是,它會等待 mysqld
就緒,然後使用從 XtraBackup 克隆檔案中提取的複製引數執行 CHANGE MASTER TO
和 START SLAVE
命令。
一旦副本開始複製,它會記住其主 MySQL 伺服器,如果伺服器重啟或連線斷開,它會自動重新連線。此外,由於副本透過其穩定的 DNS 名稱(mysql-0.mysql
)查詢主伺服器,即使主伺服器因重新排程而獲得新的 Pod IP,它們也能自動找到主伺服器。
最後,啟動複製後,xtrabackup
容器會監聽來自其他請求資料克隆的 Pod 的連線。如果 StatefulSet 擴縮或下一個 Pod 丟失其 PersistentVolumeClaim 並需要重新進行克隆,此伺服器將無限期保持執行。
傳送客戶端流量
你可以透過執行帶有 mysql:5.7
映象的臨時容器並執行 mysql
客戶端二進位制檔案來向主 MySQL 伺服器(主機名 mysql-0.mysql
)傳送測試查詢。
kubectl run mysql-client --image=mysql:5.7 -i --rm --restart=Never --\
mysql -h mysql-0.mysql <<EOF
CREATE DATABASE test;
CREATE TABLE test.messages (message VARCHAR(250));
INSERT INTO test.messages VALUES ('hello');
EOF
使用主機名 mysql-read
向任何報告就緒的伺服器傳送測試查詢。
kubectl run mysql-client --image=mysql:5.7 -i -t --rm --restart=Never --\
mysql -h mysql-read -e "SELECT * FROM test.messages"
你應該會得到如下輸出:
Waiting for pod default/mysql-client to be running, status is Pending, pod ready: false
+---------+
| message |
+---------+
| hello |
+---------+
pod "mysql-client" deleted
為了證明 mysql-read
Service 在伺服器之間分配連線,你可以在迴圈中執行 SELECT @@server_id
:
kubectl run mysql-client-loop --image=mysql:5.7 -i -t --rm --restart=Never --\
bash -ic "while sleep 1; do mysql -h mysql-read -e 'SELECT @@server_id,NOW()'; done"
你應該會看到報告的 @@server_id
隨機變化,因為每次連線嘗試都可能選擇不同的端點:
+-------------+---------------------+
| @@server_id | NOW() |
+-------------+---------------------+
| 100 | 2006-01-02 15:04:05 |
+-------------+---------------------+
+-------------+---------------------+
| @@server_id | NOW() |
+-------------+---------------------+
| 102 | 2006-01-02 15:04:06 |
+-------------+---------------------+
+-------------+---------------------+
| @@server_id | NOW() |
+-------------+---------------------+
| 101 | 2006-01-02 15:04:07 |
+-------------+---------------------+
你可以按 Ctrl+C 停止迴圈,但讓它在另一個視窗中執行很有用,這樣你就可以看到以下步驟的效果。
模擬 Pod 和節點故障
為了展示從副本池而不是單個伺服器讀取的可用性更高,請讓上面執行的 SELECT @@server_id
迴圈保持執行,同時強制一個 Pod 退出就緒狀態。
中斷就緒探測
mysql
容器的就緒探測執行命令 mysql -h 127.0.0.1 -e 'SELECT 1'
,以確保伺服器已啟動並能夠執行查詢。
強制此就緒探測失敗的一種方法是破壞該命令:
kubectl exec mysql-2 -c mysql -- mv /usr/bin/mysql /usr/bin/mysql.off
這會進入 Pod mysql-2
的實際容器檔案系統,並重命名 mysql
命令,使就緒探測找不到它。幾秒鐘後,Pod 應該報告其一個容器未就緒,你可以透過執行以下命令進行檢查:
kubectl get pod mysql-2
在 READY
列中查詢 1/2
:
NAME READY STATUS RESTARTS AGE
mysql-2 1/2 Running 0 3m
此時,你應該會看到 SELECT @@server_id
迴圈繼續執行,儘管它不再報告 102
。回想一下,init-mysql
指令碼將 server-id
定義為 100 + $ordinal
,因此伺服器 ID 102
對應於 Pod mysql-2
。
現在修復 Pod,幾秒鐘後它應該會重新出現在迴圈輸出中:
kubectl exec mysql-2 -c mysql -- mv /usr/bin/mysql.off /usr/bin/mysql
刪除 Pod
如果 Pod 被刪除,StatefulSet 也會重新建立 Pod,類似於 ReplicaSet 對無狀態 Pod 所做的那樣。
kubectl delete pod mysql-2
StatefulSet 控制器注意到不再存在 mysql-2
Pod,並建立一個同名的新 Pod,並將其連結到相同的 PersistentVolumeClaim。你應該會看到伺服器 ID 102
從迴圈輸出中消失一段時間,然後自行返回。
排空節點
如果你的 Kubernetes 叢集有多個節點,你可以透過發出 drain 命令來模擬節點停機(例如在節點升級時)。
首先確定 MySQL Pod 之一位於哪個節點上:
kubectl get pod mysql-2 -o wide
節點名稱應顯示在最後一列中:
NAME READY STATUS RESTARTS AGE IP NODE
mysql-2 2/2 Running 0 15m 10.244.5.27 kubernetes-node-9l2t
然後,透過執行以下命令排空節點,該命令將隔離節點,使其無法排程新的 Pod,然後驅逐任何現有的 Pod。將 <node-name>
替換為你上一步中找到的節點名稱。
注意
排空節點可能會影響在同一節點上執行的其他工作負載和應用程式。僅在測試叢集中執行以下步驟。# See above advice about impact on other workloads
kubectl drain <node-name> --force --delete-emptydir-data --ignore-daemonsets
現在你可以看到 Pod 在不同的節點上重新排程:
kubectl get pod mysql-2 -o wide --watch
它應該看起來像這樣:
NAME READY STATUS RESTARTS AGE IP NODE
mysql-2 2/2 Terminating 0 15m 10.244.1.56 kubernetes-node-9l2t
[...]
mysql-2 0/2 Pending 0 0s <none> kubernetes-node-fjlm
mysql-2 0/2 Init:0/2 0 0s <none> kubernetes-node-fjlm
mysql-2 0/2 Init:1/2 0 20s 10.244.5.32 kubernetes-node-fjlm
mysql-2 0/2 PodInitializing 0 21s 10.244.5.32 kubernetes-node-fjlm
mysql-2 1/2 Running 0 22s 10.244.5.32 kubernetes-node-fjlm
mysql-2 2/2 Running 0 30s 10.244.5.32 kubernetes-node-fjlm
同樣,你應該會看到伺服器 ID 102
從 SELECT @@server_id
迴圈輸出中消失一段時間,然後返回。
現在解除節點的隔離,使其恢復正常狀態:
kubectl uncordon <node-name>
擴縮副本數量
使用 MySQL 複製時,可以透過新增副本擴充套件讀取查詢容量。對於 StatefulSet,你可以透過一個命令實現這一點:
kubectl scale statefulset mysql --replicas=5
透過執行以下命令觀察新 Pod 的啟動:
kubectl get pods -l app=mysql --watch
一旦它們啟動,你應該會看到伺服器 ID 103
和 104
開始出現在 SELECT @@server_id
迴圈輸出中。
你還可以驗證這些新伺服器是否包含在你新增它們之前新增的資料:
kubectl run mysql-client --image=mysql:5.7 -i -t --rm --restart=Never --\
mysql -h mysql-3.mysql -e "SELECT * FROM test.messages"
Waiting for pod default/mysql-client to be running, status is Pending, pod ready: false
+---------+
| message |
+---------+
| hello |
+---------+
pod "mysql-client" deleted
縮減也同樣無縫:
kubectl scale statefulset mysql --replicas=3
注意
儘管擴容會自動建立新的 PersistentVolumeClaim,但縮容不會自動刪除這些 PVC。
這讓你選擇保留這些已初始化的 PVC,以便更快地進行擴容,或者在刪除它們之前提取資料。
你可以透過執行以下命令來檢視:
kubectl get pvc -l app=mysql
這表明所有 5 個 PVC 仍然存在,儘管 StatefulSet 已縮減到 3 個:
NAME STATUS VOLUME CAPACITY ACCESSMODES AGE
data-mysql-0 Bound pvc-8acbf5dc-b103-11e6-93fa-42010a800002 10Gi RWO 20m
data-mysql-1 Bound pvc-8ad39820-b103-11e6-93fa-42010a800002 10Gi RWO 20m
data-mysql-2 Bound pvc-8ad69a6d-b103-11e6-93fa-42010a800002 10Gi RWO 20m
data-mysql-3 Bound pvc-50043c45-b1c5-11e6-93fa-42010a800002 10Gi RWO 2m
data-mysql-4 Bound pvc-500a9957-b1c5-11e6-93fa-42010a800002 10Gi RWO 2m
如果你不打算重複使用多餘的 PVC,可以刪除它們:
kubectl delete pvc data-mysql-3
kubectl delete pvc data-mysql-4
清理
透過在終端中按 Ctrl+C 或從另一個終端執行以下命令來取消
SELECT @@server_id
迴圈:kubectl delete pod mysql-client-loop --now
刪除 StatefulSet。這也會開始終止 Pod。
kubectl delete statefulset mysql
驗證 Pod 是否消失。它們可能需要一些時間才能完成終止。
kubectl get pods -l app=mysql
當上述命令返回時,你就知道 Pod 已終止:
No resources found.
刪除 ConfigMap、Service 和 PersistentVolumeClaim。
kubectl delete configmap,service,pvc -l app=mysql
如果你手動預配 PersistentVolumes,還需要手動刪除它們,並釋放底層資源。如果你使用動態預配器,它會在你刪除 PersistentVolumeClaim 時自動刪除 PersistentVolumes。一些動態預配器(例如 EBS 和 PD 的)也會在刪除 PersistentVolumes 時釋放底層資源。
下一步
- 瞭解更多關於擴縮 StatefulSet 的資訊。
- 瞭解更多關於除錯 StatefulSet 的資訊。
- 瞭解更多關於刪除 StatefulSet 的資訊。
- 瞭解更多關於強制刪除 StatefulSet Pod 的資訊。
- 在 Helm Charts 倉庫中查詢其他有狀態應用程式示例。