本页面由机器翻译。阅读英文原文。
Aggrega Catalog(ArtifactLibrary)schema
自动生成的参考文档。请勿手动编辑——请从发布的 JSON Schema 重新生成。
Schema id:https://aggrega.ai/schemas/artifactlibrary-v1beta1.schema.json
一组可复用的具名制品包,Recipes 和 FeatureRecipes 在渲染时通过 artifacts.<name>: { $import: ... } 使用它们。每个包是作为一个单元导入的一组输出文件。第 3 层——供需要跨 Recipe 复用制品的目录选择启用。单一编写模式:仅限 Go 模板。
关于编写 ArtifactLibrary 实体的文字指南,请参阅 ArtifactLibrary 编写参考;本页记录该参考所描述的结构化 schema。
顶层类型: object
属性
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | 是 | 常量:"aggrega.ai/v1beta1" |
kind | const “ArtifactLibrary” | 是 | 常量:"ArtifactLibrary" |
metadata | object | 是 | |
spec | object | 是 | 该 ArtifactLibrary 的内容。spec.artifacts 为必填项,且必须声明至少一个包。spec 带有 additionalProperties: false——在信封层级不接受并行的编写模式。单一编写模式的做法使渲染保持统一(全程使用 Go 模板),并避免作者在使用导入的包时被迫在渲染过程中切换求值模型。 |
不允许其他属性。
artifactlibrary.metadata
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
name | string | 是 | 该库的 PascalCase 标识符。它是裸名称身份引用 ^[A-Z][A-Za-z0-9]*$。 |
version | string | 是 | 该库的严格语义化版本(例如 1.0.0)。使用方可以在裸名称引用(:<version> 最低版本下限;解析后的版本由每个 Release 的锁文件决定。模式:^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$。 |
description | string | 否 | 对该库涵盖内容的简要概述。 |
labels | map of string | 否 | 作者声明的标签。编译器对内容保持中立,不解释标签值:它们是不透明的元数据,供读取该库的任何程序用来匹配。 |
annotations | map of string | 否 | 作者声明的注解。与标签一样,作为不透明元数据处理。 |
不允许其他属性。
artifactlibrary.spec
该 ArtifactLibrary 的内容。spec.artifacts 为必填项,且必须声明至少一个包。spec 带有 additionalProperties: false——在信封层级不接受并行的编写模式。单一编写模式的做法使渲染保持统一(全程使用 Go 模板),并避免作者在使用导入的包时被迫在渲染过程中切换求值模型。
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
artifacts | map of map of string | 是 | 可复用制品包的具名映射。每个包将属于一组的输出文件归在一起(例如一个 CRD、它的 RBAC 和一个 ConfigMap)。每个文件正文对信封校验而言是不透明的——内容语义由 Go 模板解析器在使用时处理。键:PascalCase 标识符。条目键出现在规范引用 URL(#/artifacts/<name>)中;信封层级的约束可防止非 PascalCase 的键在目录生态中扩散。^[A-Z][A-Za-z0-9]*$。至少 1 个条目。 |
不允许其他属性。