Pular para o conteúdo
AggregaAggrega
Selecionar língua: Português (Brasil)
Esta página foi traduzida automaticamente. Leia o original em inglês.

Esquema do catálogo do Aggrega (ArtifactLibrary)

Referência gerada. Não edite à mão — gere novamente a partir do JSON Schema publicado.

ID do esquema: https://aggrega.ai/schemas/artifactlibrary-v1beta1.schema.json

Uma coleção reutilizável de bundles de artefatos nomeados que Recipes e FeatureRecipes consomem no momento da renderização via artifacts.<name>: { $import: ... }. Cada bundle é um conjunto de arquivos de saída importados como uma única unidade. Camada 3 — opcional, para catálogos que precisam reutilizar artefatos entre uma Recipe e outra. Um único modo de autoria: apenas templates Go.

Consulte a referência de autoria da ArtifactLibrary para orientações em prosa sobre como escrever entidades ArtifactLibrary; esta página documenta o esquema estrutural que essa referência descreve.

Tipo de nível superior: object

Propriedades

PropriedadeTipoObrigatóriaDescrição
apiVersionconst “aggrega.ai/v1beta1”simConstante: "aggrega.ai/v1beta1"
kindconst “ArtifactLibrary”simConstante: "ArtifactLibrary"
metadataobjectsim
specobjectsimO conteúdo da ArtifactLibrary. spec.artifacts é obrigatório e deve declarar pelo menos um bundle. spec carrega additionalProperties: false — nenhum modo de autoria paralelo é aceito no nível do envelope. A postura de modo de autoria único mantém a renderização uniforme (template Go em tudo) e evita obrigar os autores a trocar de modelo de avaliação no meio da renderização ao consumir bundles importados.

Não são permitidas propriedades adicionais.

artifactlibrary.metadata

PropriedadeTipoObrigatóriaDescrição
namestringsimIdentificador PascalCase da biblioteca. É o nome na referência de identidade por nome simples #/artifacts/; a versão é fornecida pelo arquivo de bloqueio de cada Release e nenhum host de registro entra na referência nem em qualquer identificador derivado. Padrão: ^[A-Z][A-Za-z0-9]*$.
versionstringsimVersionamento semântico estrito da biblioteca (por exemplo, 1.0.0). Um consumidor pode exigi-la como versão mínima :<version> opcional em uma referência por nome simples (:#/artifacts/); o arquivo de bloqueio de cada Release detém a versão resolvida. Padrão: ^(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-]+)*))?$.
descriptionstringnãoUm resumo conciso do que a biblioteca abrange.
labelsmapa de stringnãoRótulos declarados pelo autor. O compilador é neutro quanto ao conteúdo e não interpreta os valores dos rótulos: são metadados opacos, carregados para que aquilo que ler a biblioteca possa usá-los na correspondência.
annotationsmapa de stringnãoAnotações declaradas pelo autor. A mesma postura de metadados opacos dos rótulos.

Não são permitidas propriedades adicionais.

artifactlibrary.spec

O conteúdo da ArtifactLibrary. spec.artifacts é obrigatório e deve declarar pelo menos um bundle. spec carrega additionalProperties: false — nenhum modo de autoria paralelo é aceito no nível do envelope. A postura de modo de autoria único mantém a renderização uniforme (template Go em tudo) e evita obrigar os autores a trocar de modelo de avaliação no meio da renderização ao consumir bundles importados.

PropriedadeTipoObrigatóriaDescrição
artifactsmapa de mapas de stringsimMapa nomeado de bundles de artefatos reutilizáveis. Cada bundle agrupa os arquivos de saída que andam juntos (por exemplo, uma CRD, seu RBAC e um ConfigMap). O corpo de cada arquivo é opaco para a validação do envelope — a semântica do conteúdo é tratada pelo parser de templates Go no momento do consumo. Chaves: identificador PascalCase. As chaves das entradas aparecem nas URLs de referência canônicas (#/artifacts/<name>); a restrição no nível do envelope impede que chaves que não sejam PascalCase se propaguem pelo ecossistema do catálogo. O endereça o bundle inteiro, nunca um arquivo individual dentro dele. Padrão: ^[A-Z][A-Za-z0-9]*$. Pelo menos 1 entrada.

Não são permitidas propriedades adicionais.