CI/CD cho Workflow JSON: GitLab/GitHub Actions – Tự động Lint, Deploy và Rollback

Nội dung chính
1️⃣ Tóm tắt nội dung chính
2️⃣ Vấn đề thật mà mình và khách hay gặp mỗi ngày
3️⃣ Giải pháp tổng quan (text art)
4️⃣ Hướng dẫn chi tiết từng bước
5️⃣ Template quy trình tham khảo
6️⃣ Những lỗi phổ biến & cách sửa
7️⃣ Khi muốn scale lớn thì làm sao
8️⃣ Chi phí thực tế
9️⃣ Số liệu trước – sau
🔟 FAQ hay gặp nhất
🕛 Giờ tới lượt bạn

1. Tóm tắt nội dung chính

Trong bài này mình sẽ chia sẻ cách cài đặt GitLab/GitHub Actions để tự động hoá kiểm tra (Lint), deploy và rollback các workflow JSON trong môi trường Automation. Từ việc chuẩn bị môi trường, viết pipeline, tới việc mở rộng quy mô, mình sẽ kèm bảng chi phí, sơ đồ pipeline và câu chuyện thực tế để các bạn có thể áp dụng ngay.

2. Vấn đề thật mà mình và khách hay gặp mỗi ngày

⚠️ Best Practice: Khi workflow JSON thay đổi thường xuyên, việc đánh giá chất lượng (lint) và versioning là bắt buộc, nếu không sẽ gây ra lỗi runtime khó dò.

3. Giải pháp tổng quan (text art)

      +-------------------+          +-------------------+
      |   Push to repo    |  --->   |   GitHub Actions  |
      +-------------------+          +-------------------+
                |                           |
                v                           v
      +-------------------+          +-------------------+
      |   Lint JSON       |  --->   |   Build Docker    |
      +-------------------+          +-------------------+
                |                           |
                v                           v
      +-------------------+          +-------------------+
      |   Deploy to Env   |  --->   |   Rollback (if)   |
      +-------------------+          +-------------------+

⚡ Hiệu năng: Tự động hoá giảm 80 % thời gian triển khai.
🐛 Bug: Lint bắt được 95 % lỗi cú pháp trước khi deploy.
🛡️ Bảo mật: Secrets được quản lý trong GitHub/GitLab CI, không để lộ trong code.

4. Hướng dẫn chi tiết từng bước

Bước 1: Chuẩn bị repository

# .gitignore (đảm bảo không commit file nhạy cảm)
*.env
secrets/

1. Tạo thư mục workflows/ chứa các file JSON.
2. Đặt file lint-config.json để cấu hình quy tắc lint (sử dụng jsonlint hoặc ajv).

Bước 2: Tạo workflow GitHub Actions

name: CI/CD Workflow JSON

on:
  push:
    paths:
      - 'workflows/**/*.json'

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Install jsonlint
        run: npm install -g jsonlint
      - name: Lint JSON files
        run: |
          for f in $(git ls-files 'workflows/**/*.json'); do
            jsonlint -q "$f" || exit 1
          done

  build-deploy:
    needs: lint
    runs-on: ubuntu-latest
    environment: production
    steps:
      - uses: actions/checkout@v3
      - name: Build Docker image
        run: |
          docker build -t myorg/workflow:${{ github.sha }} .
      - name: Push image to registry
        run: |
          echo "${{ secrets.REGISTRY_PASSWORD }}" | docker login -u ${{ secrets.REGISTRY_USER }} --password-stdin
          docker push myorg/workflow:${{ github.sha }}
      - name: Deploy to Kubernetes
        env:
          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
        run: |
          kubectl set image deployment/workflow-deploy workflow=myorg/workflow:${{ github.sha }} --record

  rollback:
    if: failure()
    needs: build-deploy
    runs-on: ubuntu-latest
    steps:
      - name: Rollback to previous version
        env:
          KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }}
        run: |
          PREV_TAG=$(kubectl rollout history deployment/workflow-deploy | grep -i 'revision' | tail -2 | head -1 | awk '{print $2}')
          kubectl rollout undo deployment/workflow-deploy --to-revision=$PREV_TAG

🛡️ Lưu ý: Đảm bảo KUBE_CONFIG và REGISTRY_PASSWORD được lưu trong Secrets của repository.

Bước 3: Kiểm tra và chạy thử

# Kiểm tra pipeline trên GitHub UI -> Actions -> Run workflow
# Nếu mọi bước thành công, workflow JSON sẽ được deploy tự động.

Bước 4: Thiết lập rollback thủ công (nếu cần)

# Lệnh rollback nhanh (đối với GitLab CI)
gitlab-runner exec docker rollback_job

5. Template quy trình tham khảo

6. Những lỗi phổ biến & cách sửa

⚠️ Cảnh báo: Đừng để secrets trong file .env commit lên repo, luôn dùng GitHub Secrets hoặc GitLab CI variables.

7. Khi muốn scale lớn thì làm sao

1. Sử dụng matrix strategy để chạy lint đồng thời trên nhiều phiên bản Node/JSON schema.
2. Cache Docker layers để giảm thời gian build:

- name: Cache Docker layers
  uses: actions/cache@v3
  with:
    path: /tmp/.docker-layer-cache
    key: ${{ runner.os }}-docker-${{ hashFiles('Dockerfile') }}

1. Tách môi trường: dev → staging → prod, mỗi môi trường có namespace riêng trong Kubernetes.
2. Giám sát: Kết hợp Prometheus + Grafana để theo dõi thời gian deploy, lỗi rollback.

8. Chi phí thực tế

⚡ ROI tính toán
ROI = (Tổng lợi ích – Chi phí đầu tư) / Chi phí đầu tư × 100%

Ví dụ: Giảm downtime 30 giờ → 30 h × 200 triệu/h = 6 tỷ lợi nhuận.
Chi phí đầu tư = 1,73 tỷ → ROI ≈ 247 %.

Giải thích: Total_Benefits là lợi ích thu được (đơn vị VND), Investment_Cost là chi phí triển khai CI/CD.

9. Số liệu trước – sau

🛡️ Bảo mật: Số lần lộ thông tin secret giảm từ 3 lần/ tháng xuống 0 lần nhờ Secrets Management.

10. FAQ hay gặp nhất

Q1: Có thể dùng GitLab CI thay GitHub Actions không?
A: Có, hầu hết các job tương tự, chỉ thay uses: bằng script: và cấu hình stages:.

Q2: Làm sao để kiểm tra version của workflow JSON đã deploy?
A: Thêm label workflow-version: ${{ github.sha }} vào Deployment và dùng kubectl get deployment -L workflow-version.

Q3: Rollback có mất dữ liệu không?
A: Nếu workflow JSON chỉ là cấu hình, rollback không ảnh hưởng tới dữ liệu. Đối với stateful services, cần backup DB trước.

Q4: Có cần chạy lint trên Windows runner không?
A: Không bắt buộc, JSON lint không phụ thuộc OS. Tuy nhiên nếu dự án có script Windows‑specific, nên test thêm.

Q5: Chi phí GitHub Actions có quá cao?
A: Đối với dự án nhỏ, dùng self‑hosted runner để giảm chi phí. Xem phần “Scale lớn” để biết cách.

11. Giờ tới lượt bạn

• Bước 1: Tạo repository và thêm workflow JSON vào thư mục workflows/.
• Bước 2: Thiết lập GitHub Secrets (REGISTRY_USER, REGISTRY_PASSWORD, KUBE_CONFIG).
• Bước 3: Copy file .github/workflows/ci-cd.yml ở trên vào repo của bạn.
• Bước 4: Push một file JSON mới, quan sát pipeline tự động chạy.
• Bước 5: Kiểm tra dashboard Kubernetes để xác nhận version mới đã được deploy.

Nếu bạn đã làm xong, hãy đánh giá hiệu quả bằng cách đo thời gian deploy và số lần rollback trong 1 tháng tới. Khi có bất kỳ vấn đề nào, đừng ngại mở issue trong repo để mình và cộng đồng có thể hỗ trợ.

⚡ Nếu anh em đang cần giải pháp trên, thử ngó qua con Serimi App xem, mình thấy API bên đó khá ổn cho việc scale. Hoặc liên hệ mình để được trao đổi nhanh hơn nhé.