0

Một pipeline, nhiều máy đích: template, agent tự host, và mật khẩu không được nằm trong YAML

Team mình có một pipeline deploy dùng chung cho sáu máy test: máy của từng dev, máy QA, máy demo cho khách. Mỗi máy có SQL Server riêng, tên database riêng, tài khoản riêng. Khi bấm chạy pipeline, người dùng chọn máy đích trong một danh sách, pipeline cài bản mới lên đúng máy đó và chạy script cập nhật database.

Câu hỏi khó nhất của pipeline này không nằm ở bước build. Nó là: làm sao chắc pipeline đang chạy SQL vào đúng database? Một máy được thêm vào với tên database đoán, kèm tài khoản sa, là đủ để script cập nhật chạy vào một database không ai định đụng tới, không có lỗi nào hiện ra.

Bài này là cách pipeline đó được tổ chức: một file mô tả từng máy, agent chạy ngay trên máy đích, ba cú pháp biến của Azure Pipelines, và vài cái chốt chặn để chạy nhầm thì dừng sớm. Kèm một chuyện mình không vui khi thấy: mật khẩu database nằm thẳng trong file YAML.

Một file, mỗi máy một khối

Thay vì rải if máy == X khắp pipeline, mọi thông tin về máy nằm trong một file template:

# templates/targets.yml: nơi DUY NHẤT mô tả một máy đích
parameters:
  - name: target
    type: string

variables:
  - ${{ if eq(parameters.target, 'TEST-01') }}:
    - { name: dbServer,   value: localhost }
    - { name: dbDatabase, value: AppDb_Test01 }
    - { name: dbUser,     value: app_deploy }
    - { name: poolName,   value: TEST-01 }
    - { name: poolDemand, value: '' }
    # Không có mật khẩu ở đây: nó nằm trong variable group TEST-01-secrets (phần cuối bài)
  - ${{ elseif eq(parameters.target, 'QA') }}:
    - { name: dbServer,   value: localhost }
    - { name: dbDatabase, value: AppDb_QA }
    - { name: dbUser,     value: app_deploy }
    - { name: poolName,   value: Shared Build Agents }
    - { name: poolDemand, value: 'Agent.ComputerName -equals qa-server' }
  # Máy chưa có khối nào: compile lỗi ngay, thay vì chạy với database rỗng
  - ${{ else }}:
    - template: unknown-target-${{ parameters.target }}.yml

Pipeline deploy chỉ cần:

parameters:
  - name: deployTo
    type: string
    values: [TEST-01, TEST-02, QA, DEMO]

variables:
  - template: templates/targets.yml
    parameters:
      target: ${{ parameters.deployTo }}

Thêm một máy là thêm một khối vào targets.yml, không sửa dòng code nào khác. Team còn viết hẳn một trang hướng dẫn "thêm một máy" chỉ dài vài dòng, vì chỉ có một chỗ cần sửa.

Dòng cuối của template là một mẹo hay: nếu ai đó truyền vào tên máy chưa có khối, template cố nạp file unknown-target-<tên>.yml không tồn tại, và pipeline không compile được, báo lỗi có chứa luôn tên máy. Danh sách values của tham số thường đã chặn chuyện này, nhưng có lần chạy thử bỏ qua được danh sách đó, và chính dòng này đã chặn lại.

Agent chạy ngay trên máy đích

Mỗi máy test cài sẵn một self-hosted agent: chương trình nhận việc từ Azure DevOps và chạy trên chính máy đó. Pipeline chọn agent qua poolName:

jobs:
  - deployment: Deploy
    environment: ${{ parameters.deployTo }}
    pool:
      name: ${{ variables.poolName }}
      ${{ if ne(variables.poolDemand, '') }}:
        demands: [ '${{ variables.poolDemand }}' ]

Vì job chạy trên máy đích, dbServer: localhost là đúng: localhost chính là SQL Server của máy đó. Không cần mở cổng SQL ra mạng cho một máy build ở xa gọi vào.

Phần demands dành cho trường hợp lắt léo: máy QA không có pool riêng, agent của nó nằm chung pool với các máy build khác. Chỉ ghi tên pool thì job có thể rơi vào máy build. demands ghim job vào đúng máy. Nó so khớp Agent.ComputerName chứ không phải tên agent, vì máy QA chạy hai agent cài ở hai thư mục, agent nào rảnh nhận cũng được, miễn là đúng máy.

Ba cú pháp biến, và vì sao pool phải dùng ${{ }}

Đây là chỗ nhiều người (gồm cả mình) dính khi mới viết pipeline. Azure Pipelines có ba cú pháp biến, được tính ở ba thời điểm khác nhau:

Cú pháp Tính lúc nào Dùng cho
${{ variables.x }} Lúc compile, trước khi pipeline chạy Chọn pool, điều kiện if trong YAML, tham số template
$(x) Ngay trước khi từng task chạy Đầu vào của task, script
$[ variables.x ] Lúc job hoặc stage chuẩn bị chạy Biến lấy từ output của job trước, điều kiện phức tạp

Pool được chọn lúc xếp hàng job, trước khi bất kỳ task nào chạy, nên phải là giá trị biết được lúc compile: ${{ variables.poolName }}. Vì vậy trong targets.yml, poolName và poolDemand phải là chữ cố định, không được chứa $(...) hay biểu thức runtime.

Thêm một cái bẫy của $(x): nếu biến x không tồn tại, Azure giữ nguyên chữ $(x) và đưa vào script. Script nhận được chuỗi $(e2eVariableGroup) thay vì báo lỗi "thiếu biến". File targets.yml của team xử lý bằng một quy tắc: máy nào đã khai báo nhóm biến cho kiểm thử tự động thì khai báo đủ, chưa biết giá trị thì để '' chứ không bỏ trống.

Chốt chặn: in ra mình đang ở đâu trước khi chạy SQL

Comment trong targets.yml thẳng thắn đến đáng quý: tên database của hai máy là đoán, chưa ai kiểm trên máy thật. Đoán sai kèm tài khoản sa là tổ hợp có thể gây hại mà không báo lỗi.

Nên trước mọi script cập nhật, pipeline in ra nó đang nói chuyện với ai:

- powershell: |
    $info = sqlcmd -S "$(dbServer)" -d "$(dbDatabase)" -U "$(dbUser)" -P "$env:DB_PASSWORD" -b -h -1 `
      -Q "SET NOCOUNT ON; SELECT @@SERVERNAME + ' / ' + DB_NAME()"
    if ($LASTEXITCODE -ne 0) { throw "Không kết nối được $(dbDatabase) trên $(dbServer)" }
    Write-Host "Sắp cập nhật: $info"
  env:
    DB_PASSWORD: $(dbPassword)   # biến secret phải map rõ vào env, xem phần dưới
  displayName: 'Kiểm database đích'

Một dòng log, nhưng khi có chuyện, đó là dòng đầu tiên người ta tìm. Muốn chặt hơn: đặt tên database mong đợi trong targets.yml và so khớp, lệch là dừng.

Mật khẩu không được nằm trong YAML

Bản thật của targets.yml mà mình đọc có mật khẩu SQL viết thẳng trong file, cạnh tên đăng nhập. File nằm trong Git. Nghĩa là:

  • Ai đọc được repo là có mật khẩu database của mọi máy test, kể cả người chỉ cần sửa giao diện.
  • Mật khẩu nằm trong lịch sử Git mãi mãi, xoá khỏi file hôm nay không xoá được commit cũ.
  • Đổi mật khẩu một máy là phải tạo commit, chạy lại pipeline.

Máy test không phải production, nhưng mật khẩu sa của máy test thường giống mật khẩu ở chỗ khác, và repo thì được clone đi khắp nơi.

Cách sửa của Azure: variable group cho mỗi máy, biến mật khẩu đánh dấu secret (hoặc nối thẳng vào Azure Key Vault). File YAML chỉ ghi tên nhóm:

variables:
  - template: templates/targets.yml
    parameters: { target: ${{ parameters.deployTo }} }
  # Quy ước tên nhóm theo máy: TEST-01-secrets, QA-secrets...; nhóm chứa dbPassword, đánh dấu secret
  - group: ${{ parameters.deployTo }}-secrets

Tên nhóm ghép thẳng từ tham số thay vì đọc từ biến trong template, để chắc chắn nó có giá trị ngay lúc compile.

Biến secret có hai tính chất cần biết. Azure tự che giá trị thành *** trong log. Và biến secret không tự động thành biến môi trường cho script: bạn phải map rõ bằng env: như ví dụ DB_PASSWORD ở trên. Quên map thì script nhận chuỗi rỗng và lỗi đăng nhập SQL rất khó hiểu.

Cuối cùng, mật khẩu đã từng nằm trong Git thì coi như đã lộ: chuyển sang variable group xong, đổi mật khẩu trên các máy.

Checklist cho pipeline nhiều máy đích

[ ] Mọi thông tin máy nằm trong một file template, mỗi máy một khối
[ ] Máy chưa khai báo làm pipeline compile lỗi, không chạy mù
[ ] Pool và demand là giá trị cố định, đọc bằng ${{ }}
[ ] Máy dùng chung pool có demand ghim đúng máy
[ ] In @@SERVERNAME và DB_NAME() trước khi chạy SQL
[ ] Không mật khẩu nào trong YAML; dùng variable group hoặc Key Vault
[ ] Biến secret được map rõ qua env:
[ ] Mật khẩu từng lọt vào Git đã được đổi

Thử ngay: chạy git grep -niE "password|pwd|secret" -- '*.yml' '*.yaml' trong repo của bạn. Mỗi dòng ra kết quả mà không phải tên biến là một việc cần làm.

Bài sau trong series: script deploy chạy trên máy đích, có backup, giữ lại file thuộc về máy, health check, và tự khôi phục khi lỗi. Team bạn đang để mật khẩu của pipeline ở đâu? Comment cho mình biết với.

P.S. Câu git grep ở trên chỉ bắt được mật khẩu đặt tên dễ đoán. Mình quét repo bằng skill vulnerability-scanner trong PrimeKit, bộ skill mình tự làm. Skill tìm secret viết cứng, dependency có lỗ hổng và các mẫu lỗi theo OWASP trong toàn bộ codebase, hợp để chạy trước mỗi đợt release lớn. Cài bằng npx @lovehlmmm/primekit init, rồi gõ /pk:vulnerability-scanner. Tìm ra rồi thì đổi mật khẩu vẫn là việc của người giữ máy.

Tài liệu để đọc thêm


Series khác của mình


All Rights Reserved

Viblo
Let's register a Viblo Account to get more interesting posts.