GitLab CI/CD 進階配置：環境變數與平行部署

前言#

在開發團隊中，一個穩定且高效的自動化部署流程是不可或缺的。GitLab CI/CD 提供了強大的功能來實現這個目標，但要妥善配置這些功能需要一些技巧。本文將從實務角度出發，詳細說明如何設定環境變數、撰寫部署腳本，以及實現多台伺服器的平行部署。

CI/CD 配置基礎#

讓我們先來看看一個典型的 .gitlab-ci.yml 檔案結構：

1
# 全域變數設定
2
variables:
3
  PUBLISH_PATH: "./dist/"
4

5
# 預設設定
6
default:
7
  image: node:18.1.0-alpine
8
  tags: [docker]
9

10
# 定義部署階段
11
stages:
12
  - build
13
  - deploy

這是最基本的配置，接下來我們會逐步加入更多功能。

善用環境變數#

在管理不同環境的部署配置時，善用環境變數可以讓整個流程更加靈活且易於維護。

使用錨點管理環境配置#

YAML 的錨點（Anchors）功能讓我們能夠重複使用相同的配置：

1
# 測試環境
2
.beta_vars: &beta_vars
3
  SFTP_USER: "deploy_user"
4
  SFTP_HOST: "beta.example.com"
5
  SFTP_PORT: "22"
6
  REMOTE_PATH: "/var/www/html/beta"
7

8
# 預發環境
9
.stage_vars: &stage_vars
10
  SFTP_USER: "deploy_user"
11
  SFTP_HOST: "stage.example.com"
12
  SFTP_PORT: "22"
13
  REMOTE_PATH: "/var/www/html/stage"
14

15
# 正式環境（多台伺服器）
16
.main_vars: &main_vars
17
  SFTP_USER: "deploy_user"
18
  SFTP_PORT: "22"
19
  REMOTE_PATH: "/var/www/html/prod"
20
  SFTP_HOST_1: "prod1.example.com"
21
  SFTP_HOST_2: "prod2.example.com"

部署工具介紹#

在開始寫部署腳本之前，我們需要了解兩個重要的部署工具。

sshpass：自動化 SSH 連線#

sshpass 讓我們能夠在腳本中自動處理 SSH 密碼：

1
# 基本用法
2
sshpass -p "密碼" ssh user@host "指令"
3

4
# 在 CI/CD 中的使用方式
5
sshpass -p "${SFTP_PASSWORD}" ssh -p ${SFTP_PORT} ${SFTP_USER}@${SFTP_HOST} "指令"

注意：雖然 sshpass 很方便，但從安全性考量，建議在正式環境使用 SSH 金鑰認證。

rsync：高效的檔案同步#

rsync 是一個強大的檔案同步工具，特別適合用於部署：

1
# 常用參數說明
2
rsync -avz
3
# -a：保留檔案屬性
4
# -v：顯示進度
5
# -z：傳輸時壓縮

部署策略實作#

我們採用了一個安全且高效的部署策略，主要分為三個步驟：

建立臨時目錄
同步檔案
原子性切換

共用部署腳本#

1
.deploy-script: &deploy_script |
2
  # 1. 建立臨時目錄
3
  TEMP_PATH="${REMOTE_PATH}_temp"
4
  sshpass -p "${SFTP_PASSWORD}" ssh -o StrictHostKeyChecking=no \
5
    -p ${SFTP_PORT} ${SFTP_USER}@${SFTP_HOST} "mkdir -p '${TEMP_PATH}'"
6

7
  # 2. 同步檔案到臨時目錄
8
  sshpass -p "${SFTP_PASSWORD}" rsync -avz \
9
    -e "ssh -p ${SFTP_PORT}" \
10
    ${PUBLISH_PATH}/* \
11
    ${SFTP_USER}@${SFTP_HOST}:${TEMP_PATH}/
12

13
  # 3. 原子性切換目錄
14
  sshpass -p "${SFTP_PASSWORD}" ssh -p ${SFTP_PORT} \
15
    ${SFTP_USER}@${SFTP_HOST} "
16
    cd ${REMOTE_PATH%/*} &&
17
    rm -rf ${REMOTE_PATH##*/} &&
18
    mv ${TEMP_PATH} ${REMOTE_PATH##*/} &&
19
    chmod -R 755 ${REMOTE_PATH##*/}
20
  "

實際部署配置#

單一環境部署#

1
deploy-beta:
2
  stage: deploy
3
  environment:
4
    name: beta
5
    url: https://beta.example.com
6
  variables:
7
    <<: *beta_vars
8
  only:
9
    - beta
10
  needs:
11
    - build-beta
12
  before_script:
13
    - apk add --update --no-cache openssh sshpass rsync
14
  script:
15
    - *deploy_script

多伺服器平行部署#

1
deploy-production:
2
  stage: deploy
3
  environment:
4
    name: production
5
    url: https://example.com
6
  variables:
7
    <<: *main_vars
8
  only:
9
    - main
10
  parallel:
11
    matrix:
12
      - SFTP_HOST: ["$SFTP_HOST_1", "$SFTP_HOST_2"]
13
  script:
14
    - *deploy_script

安全性考量#

在設定 CI/CD 時，安全性是重要的考量點：

敏感資訊處理
- 使用 GitLab CI/CD 變數功能
- 啟用 Protected 和 Masked 選項
- 避免在配置檔中明文存放密碼
存取控制
- 限制部署權限
- 使用環境專用的部署帳號
- 定期更新存取憑證

效能優化建議#

使用快取

1
cache:
2
  paths:
3
    - node_modules/
4
  key: ${CI_COMMIT_REF_SLUG}

最小化部署內容
- 只部署必要的檔案
- 使用 .gitignore 和 .dockerignore
- 善用 rsync 的排除功能

常見問題處理#

部署失敗檢查清單
- 網路連線狀態
- 伺服器磁碟空間
- 檔案權限設定
- 環境變數值
除錯技巧
- 使用 set -x 顯示詳細執行過程
- 檢查 GitLab CI/CD 日誌
- 驗證環境變數值：echo $VARIABLE_NAME

前言#