Thuật ngữ Jenkins

Mục lục

• Mục tiêu
• 1. Bản đồ khái niệm
• 2. Job, item, build và run
• 3. Controller, node, agent và executor
• 4. Pipeline, stage và step
• 5. Queue, workspace, artifact và fingerprint
• 6. Plugin, credential và secret
• 7. Trigger, upstream và downstream
• 8. Trạng thái build
• 9. Thuật ngữ cũ và dễ nhầm
• 10. Đọc một Jenkinsfile bằng thuật ngữ chuẩn
• Bài tập tự kiểm tra
• Tài liệu tham khảo

Mục tiêu

Sau bài này, bạn có thể:

• dùng đúng từ khi trao đổi về Jenkins;
• phân biệt job với build, node với executor, workspace với artifact;
• đọc một Pipeline cơ bản và gọi tên các thành phần;
• hiểu các trạng thái SUCCESS, UNSTABLE, FAILURE, ABORTED;
• tránh các thuật ngữ cũ như “master/slave”.

1. Bản đồ khái niệm

Một câu mô tả đầy đủ có thể là:

Webhook trigger Pipeline orders-service; run số 142 chờ trong queue cho tới khi một executor trên agent có label linux && docker rảnh, sau đó checkout code vào workspace và publish artifact version 1.8.4.

2. Job, item, build và run

2.1 Job không phải build

Job là định nghĩa; build là một lần chạy của định nghĩa đó. Sửa cấu hình job sẽ ảnh hưởng các lần chạy sau nhưng không biến lịch sử build cũ thành một job mới.

Job: orders-service
├── Build #140 → SUCCESS
├── Build #141 → FAILURE
└── Build #142 → SUCCESS

2.2 Freestyle, Pipeline và Multibranch Pipeline

3. Controller, node, agent và executor

3.1 Phân biệt node, agent và executor

• Một agent thường chạy trên một node.
• Một node có thể có không, một hoặc nhiều executor.
• Executor không phải process build cố định; nó là capacity slot được cấp cho workload.
• Một agent 4 executor không mặc nhiên nhanh hơn agent 1 executor; workload có thể tranh chấp CPU, RAM và disk.

Xem mô hình đầy đủ tại Kiến trúc Jenkins.

4. Pipeline, stage và step

4.1 Stage không phải environment

Stage là phần logic của Pipeline; environment là nơi phần mềm chạy. Một stage có thể deploy đến environment, nhưng hai khái niệm không đồng nghĩa.

Stage: Deploy Staging
Action: gọi Helm để thay đổi
Environment: cluster/namespace staging

4.2 Step không nhất thiết là một command

Một step có thể gọi shell command, chờ approval, retry block, ghi test report hoặc archive artifact. Plugin có thể cung cấp step mới.

5. Queue, workspace, artifact và fingerprint

5.1 Phân biệt artifact, cache và workspace

Workspace: nơi đang làm việc, có thể xóa
Cache: dữ liệu tăng tốc, mất thì tạo lại
Artifact: output có version cần lưu và phân phối

Ví dụ với ứng dụng Java:

• Maven dependency trong .m2 là cache;
• source checkout và target/classes nằm trong workspace;
• file JAR đã version hóa để release là artifact.

6. Plugin, credential và secret

6.1 Credential ID không phải secret

ID như prod-token có thể xuất hiện trong Jenkinsfile; giá trị token thật không được hard-code. Tuy nhiên, ID cũng không nên chứa dữ liệu nhạy cảm như username nội bộ nếu không cần.

6.2 Masking không phải sandbox bảo mật

Jenkins có thể che giá trị credential trong nhiều tình huống log thông thường, nhưng Pipeline chạy code độc hại vẫn có thể tìm cách lấy secret đã được cấp. Chỉ cấp trusted credential cho trusted code và giới hạn scope/thời gian sử dụng.

7. Trigger, upstream và downstream

7.1 Trigger không đảm bảo executor rảnh

Webhook thành công chỉ cho biết Jenkins đã nhận event. Build vẫn có thể nằm trong queue vì thiếu agent hoặc executor.

7.2 Cron và webhook phục vụ mục đích khác nhau

• Webhook phù hợp feedback theo thay đổi source code.
• Cron phù hợp công việc định kỳ như dependency scan hoặc cleanup.
• SCM polling là phương án thay thế khi không cấu hình được webhook, nhưng tạo request định kỳ lên SCM.

8. Trạng thái build

8.1 UNSTABLE không phải SUCCESS

Một Pipeline có thể tiếp tục sau khi test report đánh dấu UNSTABLE. Quy tắc publish/deploy phải kiểm tra trạng thái rõ ràng thay vì chỉ dựa vào việc Pipeline chưa dừng.

8.2 Exit code và trạng thái

Trên Unix/Linux, shell command trả exit code 0 thường được hiểu là thành công; giá trị khác 0 làm step thất bại nếu không được xử lý. Không dùng || true chỉ để làm Pipeline xanh vì sẽ che lỗi thật. Nếu cần tiếp tục để publish report, hãy dùng cơ chế error handling có chủ đích.

9. Thuật ngữ cũ và dễ nhầm

9.1 Jenkins URL và Resource Root URL

• Jenkins URL là URL chính user và integration truy cập.
• Resource Root URL là URL phụ có thể dùng để phục vụ nội dung build có khả năng không đáng tin cậy, tách khỏi origin chính.

9.2 LTS và weekly

• LTS release ưu tiên chu kỳ ổn định và phù hợp phần lớn môi trường production.
• Weekly release nhận feature/fix sớm hơn nhưng đòi hỏi nhịp kiểm thử và nâng cấp thường xuyên hơn.

10. Đọc một Jenkinsfile bằng thuật ngữ chuẩn

pipeline {
    agent { label 'linux && jdk21' }

    stages {
        stage('Build') {
            steps {
                sh './mvnw -B package'
            }
        }
    }

    post {
        always {
            junit 'target/surefire-reports/*.xml'
            archiveArtifacts artifacts: 'target/*.jar', fingerprint: true
        }
    }
}

Diễn giải:

1. đây là Declarative Pipeline;
2. agent yêu cầu Jenkins tìm node có label linux và jdk21;
3. run chờ trong queue cho tới khi có executor phù hợp;
4. Jenkins cấp workspace trên agent;
5. stage Build chứa step sh gọi Maven Wrapper;
6. post chạy action publish JUnit report và archive file JAR;
7. fingerprint: true tạo fingerprint để hỗ trợ theo dõi file;
8. toàn bộ lần thực thi tạo thành một Pipeline run/build có build number riêng.

Bài tập tự kiểm tra

Điền thuật ngữ đúng vào chỗ trống:

1. Một lần thực thi job được gọi là ______.
2. Slot chạy workload trên node là ______.
3. Thư mục checkout source trên agent là ______.
4. File JAR đã đóng gói và lưu để phát hành là ______.
5. Danh sách workload đang chờ executor là ______.
6. File định nghĩa Pipeline as Code thường tên là ______.

Tài liệu tham khảo

• Jenkins Glossary
• Using Jenkins Agents
• Jenkins Pipeline
• Pipeline Syntax
• Using Credentials