GitLab CI/CD Pipeline 自動化佈署

現代軟體開發流程中，持續整合與持續佈署至關重要。本文介紹如何運用 GitLab CI/CD Pipeline 自動化執行建置、測試和佈署流程，提升開發效率與軟體品質。文章將詳細說明 GitLab Runner 的安裝、組態與註冊流程，並探討不同 Runner 型別與執行器的使用時機。同時，文章也將示範如何透過 .gitlab-ci.yml 檔案定義 Pipeline 階段，執行程式碼品質掃描、功能測試以及安全掃描，確保程式碼品質與安全性。最後，文章將說明如何封裝與佈署程式碼，並展望 CI/CD 的未來發展趨勢。

自動化 DevOps 階段：GitLab CI/CD Pipeline 的應用

本章節將探討如何利用 GitLab CI/CD Pipelines 自動化常見的軟體開發生命週期手動步驟。完成這部分學習後，你將能夠建立支援 Pipeline 的基礎設施，並自信地組態 Pipeline 來執行多項關鍵任務，包括：執行品質掃描和功能測試以驗證程式碼、執行安全掃描以保障程式碼及其依賴性、自動執行標準的構建和封裝工具以封裝程式碼、以及自動將程式碼佈署到適當的環境中。

安裝與組態 GitLab Runners

在上一章，我們已經介紹了 GitLab CI/CD 的基本概念，包括 CI/CD Pipeline 的組成部分、不同型別的 Pipeline、如何在 GitLab UI 中觀察和互動 Pipeline，以及如何使用 .gitlab-ci.yml 檔案編寫 Pipeline 組態。同時也提到了 GitLab Runner 作為 GitLab CI/CD 的關鍵組成部分，負責執行 Pipeline 任務並將結果報告回 GitLab。

本章節將探討 GitLab Runner。我們將瞭解 Runner 在 CI/CD 流程中的角色，並學會如何安裝和組態 Runner 以執行 CI/CD 工作。最後，我們還將討論在不同情況下使用不同型別的 Runner 的最佳實踐。

GitLab Runners 的定義及其與 CI/CD 的關係

GitLab Runners 是 CI/CD 流程中的「動力」，它們是獨立於主 GitLab 應用程式之外安裝的小型程式。Runner 的主要功能是接收由 GitLab 發行的新 CI/CD 工作，並按照 .gitlab-ci.yml 檔案中指定的指令執行這些工作。Runners 可以安裝並組態在多種基礎設施型別上執行，包括獨立伺服器、虛擬機器、容器等。

Runner 架構及支援平臺

GitLab Runner 的架構設計使其能夠靈活地適應不同的基礎設施需求。無論你選擇獨立伺服器、虛擬機器還是容器環境，GitLab Runner 都能提供高效且可靠的執行能力。

安裝 Runner Agent

首先，我們需要安裝 GitLab Runner Agent。這一步驟相對簡單，只需按照官方檔案中的指引下載並安裝相應的 Runner Agent 即可。根據你所選擇的作業系統和平臺，安裝步驟可能會有所不同。

sudo apt-get update
sudo apt-get install gitlab-runner

圖表1：GitLab Runner 安裝流程

  flowchart TD
 A[開始安裝] --> B[更新套件清單]
 B --> C[安裝 GitLab Runner]
 C --> D[完成安裝]

圖表1翻譯：

此圖表展示了 GitLab Runner 的安裝流程。首先更新系統的套件清單，接著安裝 GitLab Runner，最後完成安裝步驟。

組態與註冊 Runner 至 GitLab

安裝完成後，下一步是組態並註冊 Runner 至你的 GitLab 例項。這一過程包括生成一個 Token 用於身份驗證，並在 .gitlab-ci.yml 檔案中組態相應的執行環境。

sudo gitlab-runner register

在註冊過程中，你需要輸入以下資訊：

GitLab 例項 URL
Token（從 GitLab 專案中取得）
描述（可選）
標籤（可選）
執行器（如 shell, docker, kubernetes 等）

組態示例

stages:
 - build
 - test
 - deploy

build_job:
 stage: build
 script:
 - echo "Building the application..."
 - make build

test_job:
 stage: test
 script:
 - echo "Running tests..."
 - make test

deploy_job:
 stage: deploy
 script:
 - echo "Deploying the application..."
 - make deploy

圖表2：CI/CD Pipeline 階段示意圖

  flowchart LR
 A[原始碼] -->|build| B[建置]
 B -->|test| C[測試]
 C -->|deploy| D[佈署]

圖表2翻譯：

此圖表展示了一個典型的 CI/CD Pipeline 流程，包括建置（build）、測試（test）和佈署（deploy）三個主要階段。原始碼經過建置後進入測試階段，最終佈署到生產環境。

不同 Runner 型別及執行器的使用時機

根據不同的需求和環境，你可能需要選擇不同型別的 Runner 和執行器。例如：

Shell 執行器：適用於簡單且不需要隔離環境的情況。
Docker 執行器：適用於需要容器化環境的情況。
Kubernetes 執行器：適用於需要自動縮放和管理資源的情況。

驗證你的程式碼

在自動化開發流程中，驗證程式碼是非常重要的一環。我們可以透過執行品質掃描和功能測試來確保程式碼的品質和正確性。

品質掃描

品質掃描工具可以幫助我們檢測程式碼中的潛在問題和漏洞。例如，SonarQube 是一個常用的程式碼品質掃描工具，可以整合到 GitLab CI/CD Pipeline 中。

定義品質掃描工作

code-quality:
 stage: test
 script:
 - sonar-scanner
 artifacts:
 paths:
 - gl-code-quality-report.json

圖表3：程式碼品質掃描流程

  flowchart TD
 A[原始碼] --> B[執行 SonarQube 掃描]
 B --> C[生成品質報告]
 C --> D[儲存報告]

圖表3翻譯：

此圖表展示了程式碼品質掃描的流程。首先對原始碼執行 SonarQube 掃描，接著生成品質報告，最後儲存報告以供進一步分析。

內容解密：

工作名稱：code-quality 明確表示此任務的目的。
階段分配：將此任務放在 test 階段，符合 CI/CD 的最佳實踐。
指令指令碼：使用 sonar-scanner 工具進行程式碼品質掃描。
成品（Artifacts）：儲存掃描結果報告，以便在 GitLab UI 中檢視。

功能測試

功能測試是驗證程式碼是否符合預期功能的重要手段。我們可以透過編寫測試案例並在 CI/CD Pipeline 中執行這些測試來確保程式碼的正確性。

定義功能測試工作

functional-tests:
 stage: test
 script:
 - pytest tests/
 artifacts:
 reports:
 junit: report.xml

圖表4：功能測試流程

  flowchart TD
 A[測試案例] --> B[執行 Pytest]
 B --> C[生成測試報告]
 C --> D[儲存報告]

圖表4翻譯：

此圖表展示了功能測試的流程。首先執行測試案例，接著生成測試報告，最後儲存報告以供進一步分析。

內容解密：

工作名稱：functional-tests 明確表示此任務的目的。
階段分配：將此任務放在 test 階段，與其他測試任務平行執行。
指令指令碼：使用 pytest 工具執行功能測試。
成品（Artifacts）：儲存測試報告，以便在 GitLab UI 中檢視。

安全掃描

安全掃描是確保程式碼及其依賴性安全性的重要步驟。我們可以透過整合安全掃描工具到 CI/CD Pipeline 中來自動執行安全檢查。

定義安全掃描工作

security-scan:
 stage: test
 script:
 - sast
 artifacts:
 reports:
 sast: gl-sast-report.json

圖表5：安全掃描流程

  flowchart TD
 A[原始碼] --> B[執行 SAST 掃描]
 B --> C[生成安全報告]
 C --> D[儲存報告]

圖表5翻譯：

此圖表展示了安全掃描的流程。首先對原始碼執行 SAST（Static Application Security Testing）掃描，接著生成安全報告，最後儲存報告以供進一步分析。

內容解密：

工作名稱：security-scan 明確表示此任務的目的。
階段分配：將此任務放在 test 階段，與其他測試任務平行執行。
指令指令碼：使用 sast 工具執行安全掃描。
成品（Artifacts）：儲存安全報告，以便在 GitLab UI 中檢視。

封裝與佈署

在完成測試和掃描後，我們需要將程式碼封裝並佈署到適當的環境中。

定義封裝工作

package-job:
 stage: build
 script:
 - make package
 artifacts:
 paths:
 - dist/

圖表6：封裝流程

  flowchart TD
 A[原始碼] --> B[執行封裝命令]
 B --> C[生成封裝檔案]
 C --> D[儲存封裝檔案]

圖表6翻譯：

此圖表展示了封裝的流程。首先執行封裝命令，接著生成封裝檔案，最後儲存封裝檔案以供進一步佈署。

內容解密：

工作名稱：package-job 明確表示此任務的目的。
階段分配：將此任務放在 build 階段，符合 CI/CD 的最佳實踐。
指令指令碼：使用 make package 命令進行封裝。
成品（Artifacts）：儲存封裝檔案，以便在後續階段中使用。

定義佈署工作

deploy-job:
 stage: deploy
 script:
 - make deploy
 environment:
 name: production
 url: https://example.com

圖表7：佈署流程

  flowchart TD
 A[封裝檔案] --> B[執行佈署命令]
 B --> C[佈署到生產環境]
 C --> D[更新環境 URL]

圖表7翻譯：

此圖表展示了佈署的流程。首先使用封裝檔案執行佈署命令，接著佈署到生產環境，最後更新環境 URL 以反映最新的佈署狀態。

內容解密：

工作名稱：deploy-job 明確表示此任務的目的。
階段分配：將此任務放在 deploy 階段，符合 CI/CD 的最佳實踐。
指令指令碼：使用 make deploy 命令進行佈署。
環境組態：指定佈署的環境名稱和 URL，以便在 GitLab UI 中追蹤佈署狀態。

隨著 DevOps 實踐的不斷發展，CI/CD 將在軟體開發中扮演越來越重要的角色。未來，我們可以期待更多自動化工具和平臺的出現，進一步簡化開發流程並提高效率。同時，安全性和可觀測性也將成為 CI/CD 流程中的重要考量因素。

圖表8：未來 CI/CD 流程展望

  flowchart LR
 A[當前 CI/CD] -->|進化| B[未來 CI/CD]
 B --> C[更高效]
 B --> D[更安全]
 B --> E[更透明]

圖表8翻譯：

此圖表展示了未來 CI/CD 流程的展望。隨著技術的進步，未來的 CI/CD 將變得更加高效、安全和透明。

透過不斷學習和實踐，我們可以充分利用 GitLab CI/CD 的強大功能，打造出更高效、更可靠的軟體開發流程。

使用 GitLab CI/CD 實作自動化佈署與持續整合

隨著軟體開發的日益複雜化，持續整合（CI）與持續佈署（CD）已成為現代軟體開發流程中的重要環節。GitLab CI/CD 提供了一套強大的工具，能夠幫助開發團隊實作自動化測試、構建和佈署，從而提升開發效率和軟體品質。本文將深入探討如何利用 GitLab CI/CD 實作自動化佈署與持續整合，並提供詳細的技術解析和程式碼範例。

什麼是 GitLab CI/CD？

GitLab CI/CD 是 GitLab 提供的一套內建的持續整合和持續佈署工具。它允許開發者自動化執行測試、構建和佈署任務，從而實作快速迭代和高效交付。GitLab CI/CD 的核心是 .gitlab-ci.yml 檔案，該檔案定義了 CI/CD 流程中的各個階段和任務。

設定 GitLab CI/CD

要使用 GitLab CI/CD，首先需要在專案根目錄下建立一個名為 .gitlab-ci.yml 的檔案。這個檔案使用 YAML 語法來定義 CI/CD 流程。

`.gitlab-ci.yml` 檔案範例

stages:
  - build
  - test
  - deploy

variables:
  APP_NAME: "myapp"

build:
  stage: build
  script:
    - echo "Building $APP_NAME"
    - mvn package
  artifacts:
    paths:
      - target/*.jar

test:
  stage: test
  script:
    - echo "Testing $APP_NAME"
    - mvn test

deploy:
  stage: deploy
  script:
    - echo "Deploying $APP_NAME"
    - scp target/*.jar user@server:/path/to/deploy/
  only:
    - main

內容解密：

stages: 定義了 CI/CD 流程中的三個階段：構建（build）、測試（test）和佈署（deploy）。
variables: 定義了一個變數 APP_NAME，用於在指令碼中參照。
build 作業: 在構建階段執行，使用 Maven 將專案封裝成 JAR 檔案，並將產物儲存為 artifacts。
test 作業: 在測試階段執行，執行 Maven 測試命令。
deploy 作業: 在佈署階段執行，將構建好的 JAR 檔案透過 SCP 傳輸到遠端伺服器，並且只在 main 分支上觸發。

自動化測試

自動化測試是 CI/CD 流程中的重要環節。GitLab CI/CD 允許開發者執行各種型別的測試，包括單元測試、整合測試和功能測試。

品質掃描

品質掃描是透過靜態程式碼分析工具來檢查程式碼的品質。例如，使用 SonarQube 進行程式碼品質分析。

quality_scan:
  stage: test
  script:
    - sonar-scanner

內容解密：

quality_scan 作業: 在測試階段執行，使用 SonarQube 掃描器分析程式碼品質。
sonar-scanner 命令: 執行 SonarQube 掃描，將分析結果上傳到 SonarQube 伺服器。

功能測試

功能測試則是透過自動化測試框架來執行一系列測試使用案例，確保程式碼在各種情況下都能正常執行。例如，JUnit 是一個常用的 Java 測試框架。

functional_tests:
  stage: test
  script:
    - mvn test

內容解密：

functional_tests 作業: 在測試階段執行，使用 Maven 執行 JUnit 測試。
mvn test 命令: 執行 Maven 的測試生命週期，執行所有測試使用案例。

安全掃描

保障程式碼及其依賴性的安全性同樣重要。我們可以透過安全掃描工具來檢測潛在的安全漏洞和風險。

安全掃描工具

例如，OWASP Dependency-Check 是一個常用的安全掃描工具，可以幫助我們檢測專案依賴中的已知漏洞。

security_scan:
  stage: test
  script:
    - dependency-check --scan ./ --out ./report.html --format HTML

內容解密：

security_scan 作業: 在測試階段執行，使用 OWASP Dependency-Check 掃描專案依賴。
dependency-check 命令: 掃描當前目錄下的依賴，並生成 HTML 格式的報告。

包裝與佈署你的程式碼

最後一步是將程式碼包裝並佈署到適當的環境中。這一過程通常包括構建、封裝和佈署三個階段。

架構圖示

  graph TD;
  A[開始] --> B[構建];
  B --> C[測試];
  C --> D[安全掃描];
  D --> E[封裝];
  E --> F[佈署];
  F --> G[結束];

圖表翻譯：

開始: CI/CD 流程的起始點。
構建: 將原始碼編譯成可執行檔案或二進位制檔案。
測試: 執行各種測試來驗證程式碼的功能和品質。
安全掃描: 檢測程式碼中的潛在安全漏洞。
封裝: 將構建好的檔案封裝成佈署所需的格式。
佈署: 將封裝好的檔案佈署到生產環境或其他目標環境中。
結束: CI/CD 流程的終點。

GitLab CI/CD Pipeline 應用總結與展望

綜觀自動化 DevOps 階段的技術發展脈絡，GitLab CI/CD Pipeline 已成為現代軟體開發流程中不可或缺的根本。本文深入探討瞭如何利用 GitLab CI/CD Pipeline 實作從程式碼驗證、安全掃描到封裝佈署的完整自動化流程。其核心價值在於整合多個開發階段，顯著提升了軟體交付效率和品質。透過 GitLab Runner 的靈活組態和 .gitlab-ci.yml 檔案的精細化定義，開發團隊得以構建高度客製化的 CI/CD 流程，滿足不同專案的特定需求。

從程式碼品質掃描、功能測試到安全掃描，GitLab CI/CD 提供了豐富的工具和整合方案，有效保障了軟體的可靠性和安全性。此外，自動化的封裝和佈署流程，更進一步簡化了繁瑣的手動操作，加快了產品迭代速度。然而，GitLab CI/CD 並非完美無缺，其學習曲線較陡峭，需要開發者投入一定的時間和精力去掌握相關技術和最佳實踐。同時，對於複雜的佈署環境和微服務架構，Pipeline 的組態和管理也可能變得更加複雜。

隨著雲原生技術和 DevOps 理念的普及，GitLab CI/CD 將持續演進，融入更多先進的功能和特性。預計未來發展方向包括：更深度整合雲原生生態、更智慧化的 Pipeline 協調、更全面的安全防護以及更便捷的可觀測性。開發者應持續關注這些趨勢，不斷學習和實踐，才能更好地利用 GitLab CI/CD 的強大功能，打造更加高效、安全、可靠的軟體交付流程。建議開發團隊積極探索 GitLab CI/CD 的進階功能，例如多環境佈署、自動回復和金絲雀發布等，以進一步最佳化 CI/CD 流程，最大化其商業價值。

玄貓

技術愛好者，專注於分享程式開發、雲端技術與 AI 應用的心得體會。

GitLab CI/CD Pipeline 自動化佈署

自動化 DevOps 階段：GitLab CI/CD Pipeline 的應用

安裝與組態 GitLab Runners

GitLab Runners 的定義及其與 CI/CD 的關係

Runner 架構及支援平臺

安裝 Runner Agent

圖表1：GitLab Runner 安裝流程

圖表1翻譯：

組態與註冊 Runner 至 GitLab

組態示例

圖表2：CI/CD Pipeline 階段示意圖

圖表2翻譯：

不同 Runner 型別及執行器的使用時機

驗證你的程式碼

品質掃描

定義品質掃描工作

圖表3：程式碼品質掃描流程

圖表3翻譯：

內容解密：

功能測試

定義功能測試工作

圖表4：功能測試流程

圖表4翻譯：

內容解密：

安全掃描

定義安全掃描工作

圖表5：安全掃描流程

圖表5翻譯：

內容解密：

封裝與佈署

定義封裝工作

圖表6：封裝流程

圖表6翻譯：

內容解密：

定義佈署工作

圖表7：佈署流程

圖表7翻譯：

內容解密：

圖表8：未來 CI/CD 流程展望

圖表8翻譯：

使用 GitLab CI/CD 實作自動化佈署與持續整合

什麼是 GitLab CI/CD？

設定 GitLab CI/CD

.gitlab-ci.yml 檔案範例

內容解密：

自動化測試

品質掃描

內容解密：

功能測試

內容解密：

安全掃描

安全掃描工具

內容解密：

包裝與佈署你的程式碼

架構圖示

圖表翻譯：

GitLab CI/CD Pipeline 應用總結與展望

玄貓

`.gitlab-ci.yml` 檔案範例