透過 GitLab CI/CD 發布檔案至 MinIO

GitLab CI/CD 是一個基於 GitLab 的持續整合與持續交付服務,它可以協助開發者在每次提交程式碼後自動執行一系列任務,例如編譯、測試、打包和部署。MinIO 是一個高效能的物件儲存服務,它提供與 Amazon S3 相容的 API,並支援分散式、容錯和加密等特性。本文將介紹如何使用 GitLab CI/CD 將產生的檔案發布到 MinIO 上,以實現一個簡單而高效的自動化流程。

先決條件

  • 擁有一個 GitLab 帳號,並建立或匯入一個專案
  • 擁有一個 MinIO 帳號,並建立或取得一個儲存桶(Bucket)和存取金鑰(Access Key 和 Secret Key)
  • 在專案根目錄下建立一個 .gitlab-ci.yml 檔案,用於定義 GitLab CI/CD 的設定

如何設定 Gitlab CI/CD

要使用 Gitlab CI/CD 自動發布檔案至 MinIO 物件儲存,我們需要做以下幾個步驟:

  1. 在專案根目錄下建立一個 .gitlab-ci.yml 檔案,這是一個宣告式的檔案,用於定義 Gitlab CI/CD 的流程和任務。
  2. 在 .gitlab-ci.yml 檔案中定義一個 deploy 階段,用於執行發布檔案的操作。
  3. 在 deploy 階段中使用 mc 命令列工具或其他 MinIO 用戶端工具來上傳檔案至 MinIO 物件儲存。
  4. 在 deploy 階段中設定一些環境變數,如 MinIO 的位址、金鑰、儲存桶名稱等。
  5. 在專案設定中啟用 Gitlab CI/CD,並新增相應的環境變數。

這裡我們假設專案已經有了建置腳本,並且產生了 dist/ 目錄。如果沒有,請根據自己的專案情況進行調整。

另外,我們還需要在專案設定中新增以下三個環境變數:

  • MINIO_URL: MinIO 的位址,如 http://localhost:9000
  • MINIO_ACCESS_KEY: MinIO 的存取金鑰
  • MINIO_SECRET_KEY: MinIO 的存取金鑰

這些環境變數可以在專案設定 -> CI/CD -> Variables 中新增,並且可以選擇是否保護或遮罩。

下面是一個範例 .gitlab-ci.yml 檔案:

stages:
  - deploy

before_script:
  - curl https://dl.min.io/client/mc/release/linux-amd64/mc -o mc  # 下载并安装 MinIO 客户端
  - chmod +x mc  # 赋予可执行权限

master-deploy:
  stage: deploy
  only:
    - master # 只有master更新的时候才执行命令
  script: # 执行的命令
    - ./mc config host add minio $MINIO_URL $MINIO_ACCESS_KEY $MINIO_SECRET_KEY # 设置 MinIO 别名和认证信息
    - ./mc cp dist/ minio/<bucket-name>/<project-name>/ # 将 dist 目录下的所有文件复制到 MinIO 的指定存储桶和目录下

這個檔案定義了一個 deploy 階段

  • before_script 下載了 MinIO 用戶端並賦予其執行權限。
  • 接著執行的指令中,第一條設定了 MinIO 的位址和金鑰。
  • 第二條指令是將專案建置後產生的 dist/ 目錄下的所有檔案複製到 MinIO 的指定儲存桶中。

如何驗證結果

當我們提交程式碼後,Gitlab CI/CD 就會自動觸發並執行 .gitlab-ci.yml 檔案中定義的任務。我們可以在專案頁面 -> CI/CD -> Pipelines 中查看流程的狀態和日誌。