Dữ liệu FDE TimesViệc làm FDE đang mở 873▼9 Thay đổi số việc đang mở trong 7 ngày, so sánh cùng phạm vi: không tính việc của các công ty mới được theo dõi tuần nàyMới trong 7 ngày 55Công ty đang tuyển 181Nhận làm từ xa 25%Lương trung vị (Mỹ) $200kTuyển nhiều nhất Databricks 98
中文EN

Tờ báo của nghề Forward Deployed Engineer

Công cụ

Vì sao FDE nên thôi chép YAML riêng cho từng khách hàng

Một base dùng chung, mỗi khách một overlay chỉ ghi phần khác biệt, và bản sửa upstream chỉ phải làm một lần.

Một diễn giả trình bày về Kubernetes tại Google Cloud Summit 2017, phía sau là slide có logo bánh lái của Kubernetes.
Ảnh: Raysonho @ Open Grid Scheduler / Grid Engine / CC0
Chia sẻLinkedInFacebookX

Tóm tắt nhanh

  • Chép YAML rồi sửa cho từng khách làm việc kéo cải tiến upstream về trở nên rất khó. Kustomize sinh ra để giải bài toán này.
  • Overlay là một kustomization trỏ tới base cùng các patch. Variant là thứ chạy thật trong cluster của một khách.
  • Đọc kết quả render và diff, đừng đọc file patch: patch sai có thể bị chặn ầm ĩ, cũng có thể lọt qua lặng lẽ.
So sánh hai cách tổ chức YAML cho năm khách hàng. Bên trái có năm bản YAML chép tay, nên một bản sửa upstream phải làm năm lần. Bên phải có một base chung và năm overlay mỏng chỉ ghi phần khác biệt, nên bản sửa chỉ làm một lần trong base.
Khi chép YAML riêng cho từng khách, mỗi bản sửa upstream phải chép tay vào từng bản sao. Với Kustomize, phần chung nằm trong base, còn mỗi overlay chỉ ghi phần khác biệt của một khách. Nguồn: blog Kubernetes (2018), tài liệu Kubernetes và SIG CLI.

Ngày 29/5/2018, khi Jeff Regan và Phil Wittrock của Google giới thiệu kustomize trên blog Kubernetes, họ mở đầu bằng một tình huống mà FDE nào cũng từng gặp: bạn chép vài file YAML của API object rồi sửa cho vừa nhu cầu của mình.

Ở thời điểm đó mọi thứ vẫn chạy. Rắc rối đến về sau, khi bản gốc có cải tiến và bạn không còn cách nào dễ dàng để kéo nó vào bản đã chép.

Với FDE, tình huống này lặp lại với mỗi khách hàng mới. Thử hình dung: khách thứ nhất cần 3 replica, khách thứ hai cần thêm memory, khách thứ ba chạy trên namespace riêng. Đến khách thứ năm, repo đã có năm thư mục YAML gần như giống hệt nhau, và không ai dám chắc chúng khác nhau đúng ở những dòng nào.

Kustomize là cách thoát khỏi vòng lặp đó mà không phải học một ngôn ngữ template. Nếu bạn đang hoặc sắp deploy cùng một sản phẩm cho nhiều khách, đây là công cụ đáng học trước Helm chart thứ mười.

Công cụ này thực ra làm gì?

Tài liệu Kubernetes mô tả Kustomize là một công cụ độc lập, tùy biến Kubernetes object thông qua một kustomization file. Nó cũng được tích hợp sẵn vào kubectl: từ bản 1.14, kubectl đọc được thư mục có kustomization file. Miễn là kubectl trên máy bạn từ bản đó trở lên, bạn đã render và apply được overlay mà không phải cài thêm gì.

Khác biệt nằm ở triết lý. README của dự án kubernetes-sigs/kustomize nhấn mạnh công cụ làm việc trên YAML thô, không có template, và file gốc được giữ nguyên. Ngay tiêu đề bài giới thiệu năm 2018 đã gọi nó là cách tùy biến cấu hình “không cần template”. YAML của bạn vẫn là YAML hợp lệ mà ai cũng đọc được, không lẫn dấu ngoặc nhọn nào.

Ba khái niệm, ba thứ có thật ở site khách

Bảng thuật ngữ chính thức định nghĩa ba khái niệm, và chúng ứng đúng với công việc của FDE. Base là phần chung. Overlay, theo tài liệu của SIG CLI, chỉ là một kustomization khác, trỏ tới base và tới các patch sẽ áp lên base đó.

Variant là kết quả trong cluster sau khi áp một overlay lên base. Trong ngôn ngữ của FDE, variant chính là deployment của một khách hàng. Tài liệu SIG CLI dùng một base chung cho các biến thể dev, staging và production, nhưng cơ chế ấy dùng y hệt được cho khách A, khách B, khách C.

Một ví dụ tối giản: hai khách, một base

Giả sử sản phẩm của bạn có một Deployment tên api. Khách Acme cần 3 replica, khách Beta giữ nguyên mặc định. Cây thư mục có thể được tổ chức như sau:

base/
  deployment.yaml
  kustomization.yaml
overlays/
  acme/
    kustomization.yaml
    replicas.yaml
  beta/
    kustomization.yaml

Overlay của Acme chỉ cần trỏ về base và khai báo patch:

# overlays/acme/kustomization.yaml
resources:
  - ../../base
patches:
  - path: replicas.yaml
# overlays/acme/replicas.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: api
spec:
  replicas: 3

Toàn bộ khác biệt của Acme so với sản phẩm chuẩn nằm trong sáu dòng của file patch đó. Tài liệu Kubernetes cũng khuyên viết patch nhỏ, mỗi patch một mục đích, như một patch riêng cho replicas. Khi upstream thêm liveness probe vào base, bạn sửa đúng một file, rồi kubectl apply -k overlays/acme và kubectl apply -k overlays/beta đưa thay đổi tới cả hai khách.

Đây chính là lời đáp cho rắc rối mà bài giới thiệu năm 2018 mô tả: bản sửa upstream không còn phải chép tay vào từng bản sao.

Thêm một lợi ích phụ: khi khách hỏi bản của họ khác bản chuẩn ở đâu, câu trả lời là thư mục overlay của họ, và đó cũng là thứ đáng rà đầu tiên khi bàn giao cho đội vận hành của khách.

Không có template thì mất gì?

Ưu điểm và giới hạn của Kustomize đến từ cùng một lựa chọn. Vì không có template, bạn không viết được vòng lặp hay điều kiện kiểu “nếu khách bật tính năng X thì sinh thêm ba object”. Mọi khác biệt đều phải diễn đạt bằng patch lên một base có thật.

Vì thế patch bám chặt vào cấu trúc của base. Tài liệu Kubernetes ghi rõ resource đích được khớp theo group, version, kind và name trong file patch. Khi base đổi tên một resource, các overlay đang patch resource đó sẽ lệch theo, nên hãy coi base như một API nội bộ: đổi cẩn thận và render lại mọi overlay trước khi merge.

Nếu cấu hình của khách biến thiên mạnh theo tham số, một công cụ có template có thể hợp hơn. Nhưng với tình huống phổ biến nhất của FDE, cùng một sản phẩm với vài khác biệt nhỏ cho mỗi khách, việc không có template lại là điểm cộng: ai mở overlay cũng hiểu ngay khách đó đã được chỉnh những gì.

Patch gõ sai không phải lúc nào cũng báo lỗi

Sai lầm dễ mắc nhất là gõ sai trong patch rồi tin rằng mình đã sửa xong. Hậu quả khác hẳn nhau tùy chỗ gõ sai là tên resource hay tên trường.

Khi sai tên resource, chẳng hạn patch nhắm vào my-app trong khi base không có Deployment nào tên như vậy, bạn thường thấy lỗi ngay. Một báo cáo trên diễn đàn Kubernetes ghi lại build dừng với thông báo “failed to find unique target for patch”.

Nhưng một wiki cộng đồng cảnh báo có loại patch không khớp resource nào bị bỏ qua mà không lỗi, không cảnh báo. Hành vi này phụ thuộc vào kiểu patch và phiên bản kustomize.

Khi sai tên trường, ví dụ replica thay vì replicas, API server không nhận ra trường đó, và kết cục nằm ở mức validation. kubectl mặc định bật validation nghiêm ngặt phía server, nên kubectl apply thường từ chối trường lạ.

Còn khi validation bị tắt bằng --validate=false, trên cluster cũ, hoặc qua công cụ tự đặt mặc định riêng, trường sai có thể chỉ sinh cảnh báo hoặc bị bỏ đi lặng lẽ. Acme khi đó vẫn chạy với số replica mặc định, và bản render hay diff vẫn cho thấy replicas không đổi.

Đọc bản render, đừng đọc file patch

Sai lầm thứ hai là apply thẳng lên cluster của khách trước khi nhìn thấy YAML cuối cùng. Cách phòng rất đơn giản: trước mỗi lần apply, nhất là sau khi base vừa đổi, chạy hai lệnh.

kubectl kustomize overlays/acme
kubectl diff -k overlays/acme

Lệnh đầu in ra toàn bộ resource sau khi áp overlay; bạn tìm dòng replicas: 3 trong Deployment api. Lệnh sau so trạng thái hiện tại của cluster với trạng thái sẽ có nếu apply. Wiki cộng đồng nói trên còn khuyên chạy bước build và diff này trong CI cho từng overlay, và với một repo nhiều khách thì nên làm vậy.

Khi overlay phình thành base thứ hai

Sai lầm thứ ba khó thấy hơn: overlay của một khách phình dần cho tới khi thành một base thứ hai. Lúc đó bạn quay về đúng bài toán chép YAML, chỉ là đổi tên thư mục.

Khi hai overlay cùng mang một khối patch giống nhau, đó là tín hiệu phần ấy nên được đưa lên base.

Học gì trước, và thể hiện ra sao

Trước hết, nắm chắc base, overlay, variant và thói quen render rồi diff trước khi apply. Sau đó tập viết patch cho các trường hay khác nhau giữa các khách như replicas, resources, env. Đến site khách, việc đầu tiên nên làm là tìm các bản YAML đã bị chép rồi sửa và gom chúng về một base.

Khi phỏng vấn cho vị trí FDE phải deploy cùng sản phẩm cho nhiều khách, nên hỏi thẳng team đang quản lý cấu hình riêng của từng khách bằng cách nào; câu trả lời cho bạn biết kỹ năng này có cần ngay hay không.

Trên CV, dòng có sức nặng không phải “biết Kustomize” mà là một con số: bao nhiêu khách đang dùng chung một base, bao nhiêu file chép tay đã được xóa.

Bài tập 20 phút với ví dụ Acme

Dựng lại cây thư mục ở trên trên máy của bạn. Bước một: đổi name: api trong replicas.yaml thành name: apii, chạy kubectl kustomize overlays/acme và ghi lại bạn nhận được lỗi hay một bản render không có thay đổi nào.

Bước hai: trả lại tên đúng, đổi replicas thành replica, render lần nữa và xem Deployment api trong output: trường nào xuất hiện, replicas mang giá trị gì. Nếu có cluster thử, chạy thêm kubectl diff -k overlays/acme để xem server phản ứng ra sao với trường lạ.

Bước ba: sửa lại cho đúng, render và chỉ dừng khi thấy replicas: 3 trong output.

Ba lần render đó dạy một điều mà file patch không bao giờ tự nói ra: patch đúng hay sai chỉ lộ ra trong output. Hãy chỉ tin một overlay khi đã tận mắt thấy thay đổi của khách nằm trong bản render.

Bài này có hữu ích không?

Dùng cùng trợ lý AIHỏi Claude ↗Hỏi ChatGPT ↗
8 nguồn
Đọc tiếp trên lộ trình · Chặng 5: Triển khaik9s giúp đọc cụm của khách nhanh hơn, và cũng giúp xoá nhầm nhanh hơnHãy bật read-only trước khi mở cụm prod, vì ctrl-k xoá tài nguyên mà không hỏi lại.