Bỏ qua để đến nội dung
AggregaAggrega
Chọn ngôn ngữ: Tiếng Việt
Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

Một chart nằm trong kho git

Một Helm chart không nhất thiết phải đến từ một chart registry. Ví dụ này lấy nguồn một chart nằm trong một kho git — chart ví dụ hello-world của chính dự án Helm — và xây dựng nó thành các manifest Kubernetes.

Aggregate của nhà phát triển không nói gì về tất cả những điều này. Nó khai báo một core/compute/server, còn việc đóng gói của server đó đến từ đâu được quyết định trong Recipe và được ràng buộc bởi Manifest.

Khối nguồn

catalog/recipe/helm/hello-world-git/1.0.0/recipe.yaml
source:
kind: git-repository
url: https://github.com/helm/examples.git
ref: hello-world-0.1.0
module_subdir: charts/hello-world

Ba tọa độ, mỗi tọa độ trả lời một câu hỏi khác nhau:

  • url — kho cần clone. https://, ssh:// và git:// đều được chấp nhận. Một kho riêng tư được truy cập qua SSH thông qua SSH agent, hoặc qua HTTPS với một mục cho host của nó trong tệp netrc của bạn — machine github.com login <user> password <token>. Thông tin xác thực được viết ngay trong URL sẽ bị từ chối, như mô tả trong Xác thực.
  • ref — tham chiếu để đọc kho: một tag, một nhánh hoặc một commit. Đó là bất cứ tên gì mà chính các tác giả của kho đặt, không phải lúc nào cũng là một số phiên bản đơn thuần — ở đây tag còn mang cả tên của chart.
  • module_subdir — thư mục bên trong kho chính là chart. Kho chứa một chart dưới đường dẫn này chứ bản thân nó không phải là chart, và thư mục là một phần tạo nên sự khác biệt của artifact: hai thư mục của một kho tại cùng một commit là hai artifact, không phải một.

Loại nguồn đặt tên cho phương thức truyền tải và vị trí, không phải định dạng. Cùng một loại có thể tải một chart, một module Terraform hoặc bất kỳ thư mục tệp nào khác; thư mục chứa gì là việc của provider tiêu thụ nó.

Lockfile ghi lại những gì

Chỉ một commit mới chỉ định nội dung không thể thay đổi mà bạn không hay biết. Một tag hay một nhánh là một cái tên mà kho có thể trỏ lại sang một commit khác, nên aggrega pull phân giải tham chiếu và ghi lại cả hai — tham chiếu bạn đã viết, và commit mà nó được phân giải thành:

# release-chart.lock
source_artifacts:
- kind: git-repository
url: https://github.com/helm/examples.git
module_subdir: charts/hello-world
pinned_version: f3dc419e558e6ccebce2ed447384e5d2e11de2f9
digest: sha256:2bee62cfc2efccc61d8e17efeb72f9f77ad7bd87f3ea4e50b1e4219c8d5a2c78
mediatype: application/gzip
referenced_by:
- entity: recipe
uri: helm/hello-world-git:1.0.0
field: spec.source
requested_ref: hello-world-0.1.0

Cả hai nửa đều có lý do tồn tại. Commit là thứ mà bản build tải về, nên bản build có thể tái lập. Tham chiếu là thứ mà bản build dùng để tra cứu mục, chính điều này cho phép bạn tiếp tục viết ref: hello-world-0.1.0 trong Recipe mà vẫn phân giải đến đúng commit mà tag đó trỏ tới khi lockfile được ghi.

Tạo ví dụ

Bạn có thể build ví dụ này bằng các lệnh bên dưới, hoặc để trợ lý AI của bạn build giúp bạn.

Ghi ví dụ vào một thư mục mới đặt theo tên của nó:

Terminal window
aggrega scaffold --example chart-from-git-repository

Sau đó nó in ra các lệnh cần chạy tiếp theo. Lệnh đầu tiên chuyển vào thư mục mới:

Terminal window
cd chart-from-git-repository

Build

Terminal window
aggrega build --release release-chart.yaml --auto-pull

Ví dụ này có hai release, nên release cần build phải được chỉ tên. Lần build đầu tiên cần một lockfile, đó là lý do --auto-pull được truyền ở đây; chạy aggrega pull --release release-chart.yaml một lần trước đó cũng có tác dụng tương tự và cho phép mọi lần build sau chạy mà không cần cờ nào.

Deployment được kết xuất mang các giá trị mà Release cung cấp, được ánh xạ vào các tên giá trị riêng của chart:

dist/app/helm/web-deployment-web-hello-world.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: web-hello-world
[… omitted: the chart's own labels, and the labels and annotations every rendered document carries]
spec:
replicas: 2
[… omitted: the selector and the pod template's own labels]
spec:
serviceAccountName: web-hello-world
securityContext: {}
containers:
- name: hello-world
securityContext: {}
image: "nginx:1.27.3"
imagePullPolicy: IfNotPresent
[… omitted: the container port and the two probes]

Mỗi lần build đều in ra một cảnh báo:

warning: node "web": .infra key "compute" is read by no template in recipe "hello-world-git" — correct the spelling, or remove the key

Cảnh báo đó chính xác và đáng đọc thay vì tắt đi. Component core/compute/server cung cấp một tham số điều chỉnh kích thước CPU và bộ nhớ; chart cụ thể này không để lộ giá trị nào cho nó, nên Recipe không ánh xạ gì ở đó. Một Recipe có nguồn ánh xạ những gì chart mà nó lấy nguồn thực sự chấp nhận, và trình biên dịch báo cáo giá trị không đi đến đâu cả thay vì giả vờ rằng nó đã được áp dụng.

Với trợ lý AI

Một trợ lý AI được thiết lập với các công cụ của Aggrega cũng có thể làm như vậy: hãy dán prompt này vào trợ lý.

Chỉ dùng các công cụ của Aggrega và không tự tạo thư mục nào. Nếu thư mục workspace chưa có thư mục `chart-from-git-repository`, hãy gọi công cụ `scaffold` một lần với `example` đặt thành `chart-from-git-repository` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `chart-from-git-repository` mới. Sau đó gọi công cụ `build` với `workspace_root` đặt thành `chart-from-git-repository`, `release` đặt thành `release-chart.yaml`, `auto_pull` đặt thành true và `write` đặt thành true. Hãy cho tôi biết bản build đã ghi những tệp nào; chúng nằm trong `chart-from-git-repository/dist/`.

Khi tham chiếu thay đổi

Một tag có thể bị trỏ lại tại kho. Khi điều đó xảy ra, lần aggrega pull thông thường tiếp theo sẽ thấy tham chiếu phân giải đến một nơi khác với commit mà nó đã ghi lại, và dừng lại thay vì chấp nhận nó:

# aggrega pull --release release-chart.yaml
#
# [E0130]
# lockfile: out of date; it no longer matches what its Release resolves to
# ---
# source-artifact kind=git-repository url=https://github.com/helm/examples.git
# module_subdir=charts/hello-world: reference "hello-world-0.1.0" moved — the
# lockfile pins 03f4a18d3c2b77b7ecd91d0324a95910d4f04152, and it now resolves to
# f3dc419e558e6ccebce2ed447384e5d2e11de2f9; adopt where it now points with
# `aggrega pull --upgrade --release <release>`

Nó nêu tên cả hai commit, nên bạn có thể thấy chính xác những gì đã thay đổi trước khi quyết định. Lockfile được giữ nguyên — việc dừng xảy ra trước khi bất cứ thứ gì được ghi — và việc chấp nhận commit mới là một hành động có chủ ý:

Terminal window
aggrega pull --upgrade --pin-sources --release release-chart.yaml

Một tham chiếu đã thay đổi chính là trường hợp dành cho --upgrade: một lần pull thông thường giữ commit mà lockfile ghi lại, và chỉ một lần upgrade mới chấp nhận nơi tham chiếu hiện trỏ tới. Một --upgrade đơn thuần bỏ mọi pin đã ghi, nên nó yêu cầu xác nhận trước. --pin-sources cũng cần thiết, vì Recipe này còn ghi commit nguồn của nó trong entity.lock bên cạnh: lần upgrade ghi lại pin đó thành commit mới, còn nếu không có cờ này, lần pull sẽ dừng ở tệp lock và nêu tên aggrega pin. Hãy commit entity.lock đã được ghi lại cùng với Recipe.

Một chỉnh sửa thực hiện trong workspace này, chẳng hạn đối với Aggregate hoặc Release, là một loại sai lệch khác: lần build tiếp theo sẽ báo cáo nó, và một lần aggrega pull --release release-chart.yaml thông thường sẽ xóa nó.

Ghim một commit trong ref: thay vì một tag là cách khác để có được cùng sự đảm bảo, với cái giá là một tọa độ mà con người không thể đọc được.

Release bảo vệ

release-negative.yaml được dự kiến sẽ thất bại, và nó có mặt ở đây vì một đường dẫn tải chỉ được kiểm tra trên trường hợp thuận lợi sẽ không cho bạn biết gì về các cơ chế bảo vệ của nó. Nó triển khai cùng Aggregate thông qua manifest-negative.yaml, tệp này ràng buộc một Recipe giống hệt Recipe đang hoạt động ngoại trừ tham chiếu của nó — nó chỉ tên một tag mà kho không có:

Terminal window
aggrega build --release release-negative.yaml --auto-pull
# exits non-zero
# [E0137]
# auto-pull: resolving the source of each Recipe and FeatureRecipe the Release
# uses: resolve: resolve source for recipe
# "helm/hello-world-git-missing-ref:1.0.0": sourceresolver: kind=git-repository
# url=https://github.com/helm/examples.git version=: oci: artifact not found at
# remote source (cause: reference not found)
[… omitted: the rest of that line, a remediation naming the URL and version to check]

Kho có thể truy cập được và việc clone thành công; chỉ đơn giản là không có tham chiếu nào như vậy trong đó, nên không có commit nào để ghim và không có gì để lưu trữ.

Ví dụ này cần gì từ mạng

Không giống hầu hết các workspace ở đây, workspace này clone một kho thực trong lần build đầu tiên, nên lần build đó cần quyền truy cập ra ngoài đến host được nêu trong url. Khi lockfile và bộ nhớ đệm phân giải đã tồn tại, các lần build sau đọc từ bộ nhớ đệm và chạy hoàn toàn không cần mạng — aggrega build --release release-chart.yaml --offline xây dựng lại đúng các byte như cũ.