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.

Các plugin gắn thẻ tích hợp sẵn

Hai plugin quản trị được biên dịch sẵn vào CLI, ghi nhãn lên các nút của một bản build mà không cần viết chính sách: mỗi plugin đọc gì, ghi gì, và một ví dụ gắn kết mỗi plugin cùng các nhãn nó đã ghi.

CLI đi kèm hai plugin quản trị định hình nhãn chỉ từ cấu hình, không cần viết bằng ngôn ngữ chính sách nào:

PluginGhi
governance/label-injectorcác nhãn mà một danh sách quy tắc đặt lên mọi nút có nhãn khớp với quy tắc
governance/selector-taggermột nhãn, tag, mà giá trị của nó được một map tên Component gán cho từng nút

Cả hai được gắn kết như mọi plugin quản trị khác, thông qua plugins.governance trong cấu hình workspace (xem Gắn kết một chính sách), và cả hai đều được liệt kê trong số các plugin nhúng. Các ví dụ gắn kết trên trang này ghi 0.9.0, phiên bản của thực thể Plugin của mỗi plugin trong catalog thư viện chuẩn; bản build dùng plugin được biên dịch sẵn vào CLI.

Điểm chung của hai plugin

Chúng chỉ phục vụ vai trò label-transform và không vai trò nào khác. Mỗi plugin báo cáo thay đổi nhãn ở vai trò định hình nhãn, sau khi đồ thị build được dựng và trước khi nó được phán xét (xem các vai trò biến đổi). Khi gắn kết ở bất kỳ vai trò nào khác, cả hai đều bị từ chối trước khi chạy, vì chúng không khai báo export cho vai trò đó. Ở ir-verdict, bản build dừng với:

[E0085]
ir-verdict: plugin "governance/label-injector:0.9.0": call "verdict_ir": wasm: plugin "label-injector" does not declare export "verdict_ir" in describe(): wasm: plugin rejected by the sandbox
[E0085]
ir-verdict: plugin "governance/selector-tagger:0.9.0": call "verdict_ir": wasm: plugin "selector-tagger" does not declare export "verdict_ir" in describe(): wasm: plugin rejected by the sandbox

Ở render-verdict và annotation-transform, sự từ chối cũng là E0085, nhưng nêu tên verdict_render và transform_annotations thay vào đó.

Chúng đọc nhãn của một nút và Component của nút đó, ngoài ra không đọc gì khác. Nhãn của một nút là những nhãn nó mang khi plugin chạy: nhãn riêng của Component của nó, và những nhãn mà các phép biến đổi được liệt kê trước đó đã ghi. Component của nút là tên mà type: của Aggregate gán cho nó, chẳng hạn core/datastore/mariadb. Không plugin nào đọc các giá trị của nút, Release hay môi trường của nó: những gì một trong hai plugin ghi lên một nút chỉ xuất phát từ nhãn và Component của nút đó.

Chúng ghi nhãn, và chỉ ghi nhãn. Mọi thay đổi mà một trong hai plugin báo cáo đều nêu một nhãn trên một nút của bản build, với giá trị chuỗi. Ghi một nhãn mà nút đã mang sẽ thay thế giá trị của nó — kể cả nhãn riêng của một Component. Không plugin nào xóa nhãn, và không plugin nào có thể thay đổi một giá trị, Component hay phiên bản của một nút, hoặc tập các nút: vai trò định hình nhãn không cung cấp thay đổi loại đó (xem Định hình nhãn).

Thiết lập của chúng không được kiểm tra trước khi chạy. Không plugin nào khai báo schema cho settings của mình, nên bản build chuyển chúng cho plugin đúng như được viết. Một khóa mà plugin không đọc sẽ bị bỏ qua — một rules viết sai chính tả không đặt gì cả, và bản build vẫn hoàn tất — còn một khóa mà plugin đọc nhưng chứa giá trị kiểu khác sẽ dừng bản build với một thông báo nêu tên plugin, rồi decode settings: và lý do.

Chúng đọc các tệp trong sources dưới dạng YAML, theo thứ tự tên tệp. Plugin nhận các tệp đã sắp xếp theo tên tệp, bất kể bản gắn kết liệt kê chúng theo thứ tự nào. Một tệp không phải YAML hợp lệ sẽ dừng bản build với một thông báo nêu tên plugin, rồi parse source "<file>": và lý do của trình phân tích cú pháp; một tệp có nội dung không đúng hình dạng mà plugin đọc sẽ dừng bản build với decode source "<file>": và lý do.

Lockfile giữ các đầu vào mà một bản build áp dụng. Lần pull phân giải lockfile của một Release — aggrega pull, hoặc một bản build với --auto-pull — ghi lại thiết lập của mỗi bản gắn kết và nội dung của từng tệp của nó, và bản build áp dụng những gì đã được ghi lại. Sau khi chỉnh sửa thiết lập của một bản gắn kết hoặc một trong các tệp của nó, hãy phân giải lại lockfile; một bản build không làm vậy sẽ tiếp tục ghi các nhãn mà đầu vào đã ghi lại cho ra.

Khi gắn kết mà không có khối with:, cả hai đều không ghi gì, và bản build hoàn tất.

Nhiều bản gắn kết ở label-transform chạy theo thứ tự được liệt kê, mỗi bản đọc các nhãn mà các bản trước đã ghi, nên một quy tắc có thể khớp với nhãn do một bản gắn kết trước đó đặt. examples/policy-label-transform/ gắn kết cả hai plugin sau một chính sách Rego, cùng một verdict đọc những gì cả ba đã ghi.

governance/label-injector

Label injector thêm nhãn vào mọi nút có nhãn khớp với một quy tắc.

Thiết lập của label injector

Thiết lậpLoạiMặc địnhTác dụng
rulesmột danh sách quy tắckhông cócác quy tắc áp dụng cho mọi nút; khi không có quy tắc, plugin không ghi gì

Mỗi quy tắc mang hai map từ khóa nhãn sang giá trị chuỗi:

KhóaMặc địnhTác dụng
matchkhông có cặp nàomột nút khớp khi nó mang mọi cặp được liệt kê, mỗi cặp với giá trị đó; một quy tắc không có cặp nào khớp với mọi nút
setkhông có cặp nàomọi cặp được ghi lên mỗi nút mà quy tắc khớp

Một nhãn mà nút không mang được so sánh như chuỗi rỗng, nên một cặp match có giá trị "" cũng khớp với một nút không mang khóa đó.

Các quy tắc được áp dụng cho mỗi nút theo thứ tự được liệt kê, và nhãn mà một quy tắc sau ghi sẽ thay thế giá trị mà một quy tắc trước đã ghi cho cùng khóa.

Nguồn của các quy tắc

Plugin đọc rules từ thiết lập của nó khi thiết lập chứa ít nhất một quy tắc. Khi không có quy tắc nào, nó đọc các tệp trong sources, theo thứ tự tên tệp, và lấy các quy tắc của tệp đầu tiên có danh sách rules cấp cao nhất chứa ít nhất một quy tắc, với cùng hình dạng:

rules:
- match: {}
set:
ops.example.com/owner: shop-team

Quy tắc của bất kỳ tệp nào sau đó đều không được đọc. Một tệp đứng trước nó mà không phân tích cú pháp được sẽ dừng bản build.

Label injector được gắn kết, và các nhãn nó đã ghi

Bản gắn kết này đặt một chủ sở hữu trên mọi nút, rồi một lịch sao lưu và một chủ sở hữu khác trên các nút thuộc danh mục datastore:

plugins:
governance:
- uri: governance/label-injector:0.9.0
role: label-transform
with:
settings:
rules:
- match: {}
set:
ops.example.com/owner: shop-team
- match:
component.aggrega.ai/category: datastore
set:
backup.example.com/schedule: nightly
ops.example.com/owner: data-team

Khi gắn kết riêng vào Aggregate của examples/policy-label-transform/ — db là core/datastore/mariadb, cache là core/datastore/redis, web là core/devtool/adminer — aggrega build --release release-production.yaml --auto-pull --ir-graph in ra một đồ thị build có các nút mang:

"db": {
"labels": {
"component.aggrega.ai/type": "stateful-server",
"component.aggrega.ai/category": "datastore",
"component.aggrega.ai/upstream-licensing": "osi-approved",
"backup.example.com/schedule": "nightly",
"ops.example.com/owner": "data-team"
},
[… omitted: the node's Component, its version and the rest of the node]
},
"cache": {
"labels": {
"component.aggrega.ai/type": "server",
"component.aggrega.ai/category": "datastore",
"datastore.aggrega.ai/engine": "kv",
"component.aggrega.ai/hosting": "mixed",
"component.aggrega.ai/upstream-licensing": "mixed",
"backup.example.com/schedule": "nightly",
"ops.example.com/owner": "data-team"
},
[… omitted: the node's Component, its version and the rest of the node]
},
"web": {
"labels": {
"component.aggrega.ai/type": "server",
"component.aggrega.ai/category": "devtool",
"component.aggrega.ai/upstream-licensing": "osi-approved",
"ops.example.com/owner": "shop-team"
},
[… omitted: the node's Component, its version and the rest of the node]
}

Mọi nút đều khớp quy tắc đầu tiên và nhận shop-team; db và cache, thuộc danh mục datastore, cũng khớp quy tắc thứ hai, quy tắc này thay giá trị bằng data-team. Mọi nhãn khác đều là nhãn riêng của Component.

governance/selector-tagger

Selector tagger ghi một nhãn tag lên mỗi nút, giá trị của nó được tra cứu theo Component của nút.

Map và thiết lập của selector tagger

Nó luôn ghi khóa tag; khóa này không thể cấu hình.

Map đến từ các tệp trong sources. Mỗi tệp là một map YAML từ tên Component sang thẻ mà các nút của nó nhận:

core/datastore/mariadb: orders
core/datastore/redis: sessions

Mọi tệp đều được đọc, theo thứ tự tên tệp, và một mục trong tệp sau thay thế mục của cùng Component trong tệp trước. Mỗi thẻ là một chuỗi: một giá trị mà YAML đọc thành kiểu khác, chẳng hạn 3, sẽ dừng bản build, vì vậy hãy đặt nó trong dấu nháy — "3".

Thiết lậpLoạiMặc địnhTác dụng
defaultstringrỗngthẻ mà một nút nhận khi map không liệt kê Component của nó; khi rỗng, nút như vậy không có tag

Khi không có sources, mọi nút nhận default.

Selector tagger được gắn kết, và các nhãn nó đã ghi

Bản gắn kết này gắn thẻ cơ sở dữ liệu và bộ nhớ đệm từ tags.yaml, map ở trên, và gắn thẻ untagged cho mọi nút khác:

plugins:
governance:
- uri: governance/selector-tagger:0.9.0
role: label-transform
with:
sources:
- tags.yaml
settings:
default: untagged

Khi gắn kết riêng vào cùng Aggregate đó, aggrega build --release release-production.yaml --auto-pull --ir-graph in ra một đồ thị build có các nút mang:

"db": {
"labels": {
"component.aggrega.ai/type": "stateful-server",
"component.aggrega.ai/category": "datastore",
"component.aggrega.ai/upstream-licensing": "osi-approved",
"tag": "orders"
},
[… omitted: the node's Component, its version and the rest of the node]
},
"cache": {
"labels": {
"component.aggrega.ai/type": "server",
"component.aggrega.ai/category": "datastore",
"datastore.aggrega.ai/engine": "kv",
"component.aggrega.ai/hosting": "mixed",
"component.aggrega.ai/upstream-licensing": "mixed",
"tag": "sessions"
},
[… omitted: the node's Component, its version and the rest of the node]
},
"web": {
"labels": {
"component.aggrega.ai/type": "server",
"component.aggrega.ai/category": "devtool",
"component.aggrega.ai/upstream-licensing": "osi-approved",
"tag": "untagged"
},
[… omitted: the node's Component, its version and the rest of the node]
}

core/devtool/adminer không có trong map, nên web nhận default. Nếu không có thiết lập default, web không mang tag và hai nút còn lại được gắn thẻ như trên.

Nơi trình biên dịch không diễn giải

Cả plugin lẫn trình biên dịch đều không biết một chủ sở hữu, một lịch sao lưu hay một thẻ có ý nghĩa gì. Khóa và giá trị nhãn là các chuỗi do bản gắn kết cung cấp; trình biên dịch chuyển các nút cho mỗi plugin, áp dụng các nhãn nó báo cáo, và mang chúng trong đồ thị build, nơi một chính sách đọc chúng sẽ gán cho chúng ý nghĩa.