Tự viết một plugin quản trị
Trang này dẫn một plugin quản trị đi từ bộ khung adapter của bộ công cụ phát triển plugin đến một bản build mà nó từ chối. Bạn sao chép bộ khung, viết một quy tắc vào đó, build tệp .wasm, gọi thủ công từng export của nó trên các tệp payload đi kèm bộ khung, khai báo nó là một thực thể Plugin trong catalog riêng của workspace, gắn kết nó ở một vai trò, và quan sát nó dừng một bản build vi phạm quy tắc.
Đây là phần thực hành đi kèm socket quản trị, nơi mô tả bốn vai trò, payload mà mỗi vai trò mang và các verdict mà host thực thi, và đi kèm hướng dẫn dành cho nhà phát triển plugin, nơi mô tả thực thể Plugin và vòng đời của nó. Viết một provider là hướng dẫn cùng loại cho một guest provider.
Về các khối trên trang này. Mọi khối hiển thị đầu ra đều được sao chép từ một lần chạy thật các bước bên dưới, theo thứ tự xuất hiện, tuân theo quy ước về đầu ra: một khối hoặc là đầy đủ, hoặc là một đoạn trích có đánh dấu chỗ các dòng bị lược bỏ. Hai placeholder thay cho các đường dẫn tuyệt đối khác nhau trên mỗi máy: <guest> là thư mục bản sao bộ khung của bạn, và <workspace> là thư mục của workspace nơi plugin được gắn kết.
Những gì bạn cần
- Bộ công cụ Go, có khả năng biên dịch sang WebAssembly mà không cần thêm công cụ nào khác.
- Một bản checkout của bộ công cụ phát triển plugin, nơi chứa bộ khung, và của gói ABI mà bộ công cụ dựa trên:
go.modcủa bản sao trỏ tới cả hai. - Tệp nhị phân
aggrega.
Bộ công cụ cung cấp cùng bộ khung đó cho Rust, tại rust/examples/governance-adapter-skeleton, và cho TypeScript, tại typescript/examples/governance-adapter-skeleton. Mỗi bộ mang cùng bốn tệp payload, và một bản sao chưa sửa đổi của mỗi bộ trả lời chúng theo cùng một cách; mọi lệnh aggrega trên trang này đều áp dụng cho bất kỳ bộ nào với tên artifact riêng của nó, và README của mỗi bộ cho biết cách build.
Hình dạng của sản phẩm hoàn chỉnh
Một plugin quản trị, như mọi plugin, gồm hai artifact: một guest .wasm, và một thực thể Plugin đưa nó vào catalog. Gắn kết nó chỉ là một mục trong cấu hình workspace. Không có gì trong trình biên dịch thay đổi.
Hai thư mục mà hướng dẫn này tạo ra ở cuối, không tính những gì bản build ghi vào workspace:
category-guard/ your copy of the skeleton: the Go module that compiles to the .wasm .gitignore README.md the skeleton's own guide go.mod go.sum main.go the describe() self-report and the shared plumbing evaluator.go the seam, where the rule goes annotations.go the annotation-transform role labels.go the label-transform role verdicts.go the ir-verdict and render-verdict roles build.sh annotation-payload.json label-payload.json ir-verdict-payload.json render-verdict-payload.json my-payload.json a copy you edit in section 4 wrong-payload.json a copy you break in section 5 overlay.yaml the identity you supply to the entity generator dist/governance-adapter-skeleton-go.wasm the compiled guestshop/ the workspace the plugin is attached in catalog/component/example/compute/api/1.0.0/component.yaml catalog/component/example/devtool/db-console/1.0.0/component.yaml catalog/recipe/compose/api/1.0.0/recipe.yaml catalog/recipe/compose/db-console/1.0.0/recipe.yaml catalog/plugin/governance/category-guard/0.1.0/plugin.yaml catalog/plugin/governance/category-guard/0.1.0/governance--category-guard.wasm aggregate.yaml manifest.yaml release.yaml .aggrega-config.yamlQuy tắc mà plugin thực thi là một quy tắc phổ biến: một workspace nêu tên các danh mục component mà nó không phát hành — ở đây là devtool, danh mục của một bảng điều khiển quản trị — và một bản build chứa component thuộc một trong các danh mục đó sẽ dừng lại, nêu tên component đó.
1. Sao chép bộ khung
cp -r /path/to/aggrega-pdk/go/examples/governance-adapter-skeleton category-guardcd category-guardgo.mod của bộ khung tham chiếu bộ công cụ và gói ABI bằng đường dẫn tương đối so với vị trí của nó bên trong bộ công cụ, nên một bản sao bên ngoài bộ công cụ phải tự nêu chúng. Hãy đặt cho module một đường dẫn của riêng bạn và trỏ hai dòng replace tới các bản checkout của bạn:
module example.com/category-guard
go 1.26.0
require ( github.com/aggrega-ai/aggrega-abi/go v0.0.0 github.com/aggrega-ai/aggrega-pdk/go v0.0.0 github.com/extism/go-pdk v1.1.3)
replace github.com/aggrega-ai/aggrega-pdk/go => /path/to/aggrega-pdk/go
replace github.com/aggrega-ai/aggrega-abi/go => /path/to/aggrega-abi/gogo.sum của bộ khung giữ nguyên.
2. Build nó và gọi thủ công từng vai trò
Build bản sao trước khi thay đổi bất cứ điều gì, để thứ đầu tiên bạn chạy là phần kết nối mà bạn không viết:
./build.shWrote <guest>/dist/governance-adapter-skeleton-go.wasmaggrega plugin run-local tải một guest từ một đường dẫn, kiểm tra rằng export bạn nêu tên là một export mà bản tự báo cáo describe() của guest khai báo — và, với --type governance, rằng guest tự báo cáo là một plugin quản trị — gọi nó với một payload bạn cung cấp, rồi in ra câu trả lời. Bộ khung cung cấp một tệp payload cho mỗi vai trò, mỗi tệp là một đầu vào nhỏ, hợp lệ cho export của nó. Payload được viết bằng JSON; giao thức truyền của mọi vai trò quản trị dùng một mã hóa nhị phân, nên lệnh chuyển payload sang mã hóa đó trước khi gọi export và in câu trả lời của export dưới dạng JSON.
aggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export transform_annotations --with @annotation-payload.json{ "injections": []}run-local đọc guest và payload từ các đường dẫn bạn đưa và không cần workspace, nên có thể chạy nó từ bất kỳ thư mục nào.
aggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export mutate --with @label-payload.json{ "patches": []}aggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export verdict_ir --with @ir-verdict-payload.json{ "results": [ { "severity": "info", "message": "this adapter has no policy engine yet: the seam received rules.policy (43 bytes) and some settings" } ]}aggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export verdict_render --with @render-verdict-payload.json{ "results": [ { "severity": "info", "message": "this adapter has no policy engine yet: the seam received rules.policy (43 bytes) and some settings" } ]}Mỗi câu trả lời có hình dạng mà vai trò của nó được phép trả về: các annotation cần thêm, các thay đổi nhãn, và các verdict. Hai vai trò biến đổi không trả về gì, và mỗi vai trò verdict trả về một verdict info — một ghi chú ghi lại một quan sát và giữ nguyên kết quả của bản build. Ghi chú đó là bằng chứng phần kết nối của bộ khung hoạt động. Mỗi tệp payload mang hai đầu vào của một bản gắn kết đúng như bản build chuyển giao chúng: một tệp chính sách, rules.policy, trong sources, và một đối tượng settings. Ghi chú cho biết cả hai đã đến được điểm nối — hàm duy nhất mà phần còn lại của bộ khung gọi với bất cứ thứ gì vai trò nhận được.
Đây là payload mà quy tắc bên dưới sẽ đọc, ir-verdict-payload.json, đầy đủ:
{ "graph": { "apiVersion": "aggrega.ai/v1beta1", "kind": "IR", "metadata": { "aggregate_name": "shop" }, "spec": { "nodes": { "api": { "component": "example/compute/api", "resolved_version": "1.0.0", "labels": { "component.aggrega.ai/type": "server", "component.aggrega.ai/category": "compute" } } }, "edges": [], "values_mapping": {}, "infra_mapping": {}, "feature_values_mapping": {}, "provenance": { "schema_version": "aggrega.ai/v1beta1", "compiler_version": "0.0.0", "aggregate_version": "1.0.0", "manifest_version": "1.0.0", "release_version": "1.0.0" } } }, "precalculated_paths": [], "sources": [ { "path": "rules.policy", "content": "policy text, handed to the engine verbatim\n" } ], "settings": { "max_nodes": 50 }}Đó là đầu vào của vai trò ir-verdict: một đồ thị build có một component, các đường định tuyến được liệt kê trên đồ thị, cùng sources và settings của bản gắn kết. Mọi trường đều được mô tả trên trang tham chiếu của vai trò, schema socket chính sách, còn bản thân đồ thị ở schema đồ thị build; ba tệp còn lại tuân theo schema annotation-transform, schema mutator và, với verdict_render, RenderPolicyInput của schema socket chính sách.
3. Viết một quy tắc
Quy tắc nằm trong evaluator.go, điểm nối của bộ khung. Mỗi vai trò giải mã payload của nó, ghi ra thành một tài liệu JSON, và gọi Evaluate với các tệp chính sách của bản gắn kết, thiết lập của nó, tài liệu đó và tên quyết định mà nó muốn nhận lại. Các vai trò verdict lần lượt yêu cầu ba quyết định — deny, warn và audit — và báo cáo câu trả lời của mỗi quyết định ở mức nghiêm trọng halt, warn và info; hai vai trò biến đổi yêu cầu annotations và labels. Vì vậy, một quy tắc dừng bản build sẽ trả lời deny.
Thay evaluator.go bằng:
package main
import ( "encoding/json" "fmt" "slices" "sort")
// Program is one policy program the attachment carried.type Program struct { Path string Text string}
// categoryLabel is the label a catalog Component states its category in.const categoryLabel = "component.aggrega.ai/category"
// Evaluate refuses every component whose category the attachment's settings// list under forbidden_categories.func Evaluate(programs []Program, settings json.RawMessage, payload json.RawMessage, decision string) ([]json.RawMessage, error) { if decision != denyDecision { return nil, nil }
var config struct { ForbiddenCategories []string `json:"forbidden_categories"` } if len(settings) > 0 { if err := json.Unmarshal(settings, &config); err != nil { return nil, fmt.Errorf("reading the settings: %w", err) } }
var input struct { Graph struct { Spec struct { Nodes map[string]struct { Labels map[string]string `json:"labels"` } `json:"nodes"` } `json:"spec"` } `json:"graph"` } if err := json.Unmarshal(payload, &input); err != nil { return nil, fmt.Errorf("reading the build graph: %w", err) }
// A Go map has no order, so the node ids are sorted: identical input must // yield an identical sequence of decisions. ids := make([]string, 0, len(input.Graph.Spec.Nodes)) for id := range input.Graph.Spec.Nodes { ids = append(ids, id) } sort.Strings(ids)
var decisions []json.RawMessage for _, id := range ids { category := input.Graph.Spec.Nodes[id].Labels[categoryLabel] if !slices.Contains(config.ForbiddenCategories, category) { continue } message, err := json.Marshal(fmt.Sprintf( "component %q is a %s component, and this workspace ships none", id, category)) if err != nil { return nil, err } decisions = append(decisions, message) } return decisions, nil}Program được giữ lại, vì các tệp vai trò dùng nó để dựng danh sách chương trình. Phần còn lại là quy tắc, và có bốn điểm trong đó đáng đọc kỹ.
- Nó đọc payload theo các tên mà giao thức truyền đặt cho nó. Các nút nằm ở
graph.spec.nodes, được đánh khóa theo id nút, mỗi nút cólabelscủa nó — cùng đường dẫn mà Những gì payload của mỗi vai trò cung cấp đưa cho một chính sách Rego dưới dạnginput.graph.spec.nodes. Một quy tắc viết cho vai trò này không đọc được gì ở các vai trò khác: payload củarender-verdictkhông mang đồ thị, nên ở đó vòng lặp không tìm thấy nút nào. - Những gì nó cấm là do người vận hành quyết định, không phải plugin. Các danh mục đến từ
settingscủa bản gắn kết, nên cùng một.wasmphục vụ được cả workspace cấmdevtoollẫn workspace không cấm gì. - Nó sắp xếp trước khi trả lời. Đầu ra của một bản build giống hệt nhau từng byte giữa các lần chạy với đầu vào giống hệt nhau, và một guest trả lời theo thứ tự của một map Go sẽ phá vỡ điều đó từ bên trong.
- Nó thất bại một cách rõ ràng. Thiết lập hoặc payload mà nó không đọc được sẽ trả về lỗi thay vì một danh sách rỗng, và vai trò biến lỗi đó thành một lời gọi thất bại. Một danh sách rỗng là một chính sách không tìm thấy gì để nói; một lời gọi thất bại là một chính sách đã không chạy, và bản build chỉ phân biệt được hai trường hợp nếu guest phân biệt chúng.
Quy tắc không bao giờ đọc programs. Quy tắc của plugin này được biên dịch vào guest, nên một bản gắn kết cung cấp thiết lập và không có tệp chính sách nào — cùng hình dạng với một guest được xây quanh một engine đã biên dịch sẵn, và ngược lại với một guest tải quy tắc từ sources.
Cuối cùng, hãy cho biết plugin là gì. Trong main.go, thay đổi mô tả trong descriptor():
Description: "Refuse a build that carries a component of a category the attachment forbids.",Trình tạo thực thể ở mục 6 sao chép nó vào thực thể Plugin.
4. Build lại và đọc câu trả lời của quy tắc
./build.shWrote <guest>/dist/governance-adapter-skeleton-go.wasmGọi lại bốn export trên cùng các tệp:
aggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export transform_annotations --with @annotation-payload.jsonaggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export mutate --with @label-payload.jsonaggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export verdict_ir --with @ir-verdict-payload.jsonaggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export verdict_render --with @render-verdict-payload.json{ "injections": []}{ "patches": []}{ "results": []}{ "results": []}Ghi chú placeholder đã biến mất khỏi cả hai vai trò verdict, và không vai trò nào trả về verdict: settings của payload đi kèm không cấm danh mục nào, nên quy tắc cho phép nó. Một danh sách results rỗng là cách một vai trò verdict cho biết bản build có thể tiếp tục.
Để thấy quy tắc kích hoạt, hãy cho nó thiết lập cấm những gì payload mang. Sao chép ir-verdict-payload.json thành my-payload.json và thay settings của nó bằng:
"settings": { "forbidden_categories": [ "compute" ] }aggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export verdict_ir --with @my-payload.json{ "results": [ { "severity": "halt", "message": "component \"api\" is a compute component, and this workspace ships none" } ]}Quyết định deny đến dưới dạng một verdict halt mang thông báo riêng của quy tắc. Trong một bản build, halt dừng bản build với thông báo đó làm lý do.
5. Khi payload không khớp
Lệnh chuyển từng trường mà payload mang sang kiểu mà hình dạng của nó khai báo, và từ chối một trường không chuyển được trước khi guest chạy. Hãy viết labels của một nút thành danh sách thay vì đối tượng, trong một bản sao tên là wrong-payload.json:
"labels": [ "server", "compute" ]aggrega plugin run-local --plugin dist/governance-adapter-skeleton-go.wasm \ --type governance --export verdict_ir --with @wrong-payload.jsonunder key "api": expected JSON object, found [Lệnh thoát với mã khác không, và guest không bao giờ được gọi.
Phép chuyển đổi kiểm tra kiểu của mọi trường mà payload mang; nó không kiểm tra rằng payload mang mọi trường mà hình dạng yêu cầu. Một payload thiếu một trường vẫn được chuyển đổi và chuyển cho guest như thường, và một guest có quy tắc đọc trường đó sẽ không tìm thấy gì ở đó. Vì vậy, hãy đối chiếu payload bạn viết tay với trang tham chiếu schema của nó: việc lệnh im lặng không có nghĩa là payload đầy đủ.
6. Khai báo nó là một thực thể Plugin trong catalog của workspace
Các trường hợp đồng của thực thể được đọc ra từ guest thay vì viết tay, nên thực thể không thể tuyên bố một export mà tệp nhị phân không có. Bạn cung cấp danh tính trong một overlay nhỏ, overlay.yaml:
apiVersion: aggrega.ai/v1beta1kind: Pluginmetadata: name: category-guardaggrega plugin gen-catalog --plugin dist/governance-adapter-skeleton-go.wasm \ --overlay overlay.yaml --output-dir ../shop/catalog/plugingenerated ../shop/catalog/plugin/governance/category-guard/0.1.0/plugin.yamlEntity được tạo ra:
# Generated from the plugin by `aggrega plugin gen-catalog`. You may narrow its capability lists; edit nothing else here.apiVersion: aggrega.ai/v1beta1kind: Pluginmetadata: name: category-guard version: 0.1.0 pluginType: governance description: Refuse a build that carries a component of a category the attachment forbids.spec: abiVersion: v1beta1 exports: - name: transform_annotations - name: mutate - name: verdict_ir - name: verdict_renderversion là phiên bản mà build.sh của bộ khung ghi vào guest, là 0.1.0 trừ khi AGGREGA_PLUGIN_VERSION chỉ định phiên bản khác; pluginType và bốn export là những gì describe() báo cáo. Một plugin quản trị không khai báo năng lực nào: những gì nó có thể trả về đến từ vai trò mà nó được gắn kết, không phải từ thực thể.
Trong khi phát triển plugin, chưa có gì được xuất bản để tải về, nên bản build đọc nó từ một thư mục catalog, với .wasm nằm cạnh thực thể của nó. Tệp cạnh thực thể được đặt tên theo loại plugin và tên của thực thể, trong thư mục chứa tài liệu của thực thể — với governance/category-guard là governance--category-guard.wasm:
cp dist/governance-adapter-skeleton-go.wasm \ ../shop/catalog/plugin/governance/category-guard/0.1.0/governance--category-guard.wasmHãy sao chép tệp thay vì tạo liên kết tới nó. Một liên kết ở vị trí đó chỉ được đi theo tới một nơi bên trong workspace — hoặc, với một thư mục catalog được liệt kê bên ngoài workspace, tới một nơi bên trong thư mục đó; một liên kết dẫn xa hơn sẽ dừng bản build và lần pull, nêu tên liên kết, như ranh giới workspace trình bày. Một lần pull không tìm thấy .wasm dưới tên đó sẽ dừng và nêu tên tệp mà nó mong đợi, như A plugin’s .wasm is not on this machine (Tệp của plugin không có trên máy này) mô tả.
7. Workspace mà plugin bảo vệ
Workspace là một cửa hàng nhỏ: một API, và các tài liệu build nó bằng Docker Compose. Catalog của nó cũng chứa bảng điều khiển quản trị mà quy tắc sẽ từ chối, một Component có danh mục là devtool.
catalog/component/example/compute/api/1.0.0/component.yaml:
apiVersion: aggrega.ai/v1beta1kind: Componentmetadata: name: example/compute/api version: 1.0.0 description: The shop's HTTP API. labels: component.aggrega.ai/type: server component.aggrega.ai/category: computespec: schema: infra: port: type: integer default: 8080 description: The port the API listens on.catalog/component/example/devtool/db-console/1.0.0/component.yaml:
apiVersion: aggrega.ai/v1beta1kind: Componentmetadata: name: example/devtool/db-console version: 1.0.0 description: A database administration console in the browser. labels: component.aggrega.ai/type: server component.aggrega.ai/category: devtoolspec: schema: infra: port: type: integer default: 8081 description: The port the console listens on.catalog/recipe/compose/api/1.0.0/recipe.yaml:
apiVersion: aggrega.ai/v1beta1kind: Recipemetadata: name: api version: 1.0.0 description: Runs the API as a Docker Compose service.spec: capability: compose implements: example/compute/api:1.0.0 workload: | apiVersion: aggrega.ai/v1beta1 kind: Workload containers: main: image: "registry.example.com/shop/api:1.0.0" ports: http: {{ .infra.port }}catalog/recipe/compose/db-console/1.0.0/recipe.yaml:
apiVersion: aggrega.ai/v1beta1kind: Recipemetadata: name: db-console version: 1.0.0 description: Runs the database console as a Docker Compose service.spec: capability: compose implements: example/devtool/db-console:1.0.0 workload: | apiVersion: aggrega.ai/v1beta1 kind: Workload containers: main: image: "adminer:4" ports: http: {{ .infra.port }}aggregate.yaml:
apiVersion: aggrega.ai/v1beta1kind: Aggregatemetadata: name: shop version: "1.0.0" description: The shop's API.spec: components: api: type: example/compute/apimanifest.yaml:
apiVersion: aggrega.ai/v1beta1kind: Manifestmetadata: name: shop-manifest version: "1.0.0" description: Binds each component type to its Docker Compose recipe.spec: mappings: components: type: example/compute/api:1.0.0: api:1.0.0 example/devtool/db-console:1.0.0: db-console:1.0.0release.yaml:
apiVersion: aggrega.ai/v1beta1kind: Releasemetadata: name: shop-staging environment: staging version: "1.0.0"spec: aggregate: shop manifest: shop-manifest components: api: {}8. Gắn kết và build
Người vận hành gắn kết một plugin quản trị trong cấu hình workspace, nêu tên vai trò và thiết lập của bản gắn kết. .aggrega-config.yaml:
workspace: catalog_dirs: - catalogauto_pull: trueplugins: governance: - uri: governance/category-guard:0.1.0 role: ir-verdict with: settings: forbidden_categories: - devtooluri nêu tên thực thể theo loại plugin, tên và phiên bản. Vai trò là ir-verdict, nên host gọi verdict_ir với đồ thị build sau khi đồ thị được dựng và trước khi bất cứ thứ gì được render. auto_pull cho phép bản build tự phân giải Release, nên bản build đầu tiên không cần bước riêng.
cd ../shopaggrega build --release release.yaml warning: plugin "governance/category-guard" resolved from local with no recorded digest to check it against, so it runs unverified; it is read from beside its Plugin entity in a catalog directory on every build, and a pull records its digest only for a plugin attached at a transform role; otherwise publish the plugin and reference the published entity to have its digest recordedPull complete: release.lock (entities=7, source_artifacts=0, external_inputs=0)[… omitted: a line reporting total build time, which differs on every run]Build completed: 1 file written to <workspace>/distCửa hàng không chứa component devtool nào, nên quy tắc cho phép bản build, và đầu ra Compose được ghi vào dist/compose/docker-compose.yaml.
Cảnh báo này là dự kiến, và nó còn đó chừng nào plugin còn ở cục bộ. Nó cho biết guest đã chạy mà không có digest nội dung nào được ghi lại để đối chiếu — đúng với thực tế của một guest vừa build một phút trước và được đọc từ cạnh thực thể của nó ở mỗi lần build. Một plugin được gắn kết ở vai trò verdict không định hình đầu ra nào, nên lần pull không ghi digest cho nó từ một thư mục catalog; việc xuất bản plugin và tham chiếu thực thể đã xuất bản mới ghi lại một digest.
9. Cài một vi phạm
Thêm bảng điều khiển quản trị vào Aggregate, và đặt nó vào Release:
spec: components: api: type: example/compute/api console: type: example/devtool/db-console components: api: {} console: {}aggrega build --release release.yaml[… omitted: the unverified-plugin warning, and the pull's lines saying the Release could not be rendered to discover its external inputs, which carry the refusal below][POLICY_ERROR E0005] policy plugin "category-guard" rejected the build: component "console" is a devtool component, and this workspace ships none caused by: policy violationBản build dừng trước khi render bất cứ thứ gì, và không ghi dist/. Thông báo là câu riêng của quy tắc, được đặt tên plugin ở đầu, nên tác giả đọc nó biết phải gỡ component nào và chính sách nào yêu cầu điều đó. Plugin không gỡ bảng điều khiển, không đổi tên nó, cũng không render bản build mà không có nó: một vai trò verdict chấp nhận hoặc từ chối, và host không bao giờ áp dụng câu trả lời của nó như một thay đổi.
Tiếp theo nên thay đổi gì
- Thêm quy tắc, hoặc một ngôn ngữ chính sách. Một quy tắc viết bằng Go được biên dịch vào guest. Để tải quy tắc từ tệp thay vào đó, hãy đọc
programstrongEvaluate— cácsourcescủa bản gắn kết, mỗi mục có tên cơ sở và văn bản — và chuyển chúng cho một engine. ABI là của riêng Aggrega mô tả một guest bọc một engine chính sách bên ngoài. - Các vai trò khác. Cùng một
Evaluatephục vụ mọi vai trò; trả lờiannotationshoặclabelskhiến plugin định hình bản build ở một vai trò biến đổi. Hình dạng quyết định có trong README của bộ khung, còn những gì mỗi vai trò có thể thay đổi có trong bốn vai trò. - Ít export hơn. Một plugin chỉ phục vụ
ir-verdictsẽ xóa các tệp vai trò khác và các mục của chúng trongdescriptor(). Khi đó, một bản gắn kết trỏ một vai trò tới một export mà guest không khai báo sẽ bị từ chối theo tên, trước khi guest chạy. - Thiết lập có kiểu. Một guest có thể khai báo một JSON Schema cho thiết lập của nó trong
describe(), và khi đó host kiểm tra thiết lập của bản gắn kết theo schema đó trước khi guest chạy; xem Thiết lập có kiểu. - Xuất bản, biến cách sắp xếp thư mục catalog thành một artifact được ghim bằng digest mà một Release phân giải và xác minh. Hướng dẫn dành cho nhà phát triển plugin trình bày vòng đời đó.
Tài liệu tham khảo liên quan
- Socket quản trị — bốn vai trò, payload của chúng, các mức nghiêm trọng của verdict và cách người vận hành gắn kết một plugin.
- Hợp đồng Plugin — hình dạng đầu vào và đầu ra của mọi socket, và cách mã hóa mà mỗi hình dạng mang theo.
- Hướng dẫn dành cho nhà phát triển plugin Wasm — thực thể
Plugin, phạm vi năng lực và vòng đời xuất bản. - Viết một provider — hướng dẫn tương tự cho một guest provider.
- Đọc đầu ra trên các trang này — quy ước mà các khối đầu ra ở trên tuân theo.