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

Esquema do catálogo do Aggrega (ArtifactLibrary)

Referência gerada. Não editar à mão — gerar 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 artefactos com nome que as Recipes e FeatureRecipes consomem no momento da renderização através de artifacts.<name>: { $import: ... }. Cada bundle é um conjunto de ficheiros de saída importados como uma única unidade. Camada 3 — opcional, para catálogos que precisem de reutilizar artefactos entre uma Recipe e outra. Um único modo de autoria: apenas templates Go.

Consulte-se 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"
metadataobjetosim
specobjetosimO conteúdo da ArtifactLibrary. spec.artifacts é obrigatório e tem de declarar pelo menos um bundle. spec tem additionalProperties: false — não é aceite nenhum modo de autoria paralelo ao nível do envelope. A opção por um único modo de autoria mantém a renderização uniforme (template Go em todo o lado) e evita obrigar os autores a mudar de modelo de avaliação a 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 ficheiro de bloqueio de cada Release e nenhum host de registo 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 numa referência por nome simples (:#/artifacts/); o ficheiro 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ãoEtiquetas declaradas pelo autor. O compilador é neutro quanto ao conteúdo e não interpreta os valores das etiquetas: são metadados opacos, transportados para que aquilo que ler a biblioteca os possa usar na correspondência.
annotationsmapa de stringnãoAnotações declaradas pelo autor. A mesma postura de metadados opacos das etiquetas.

Não são permitidas propriedades adicionais.

artifactlibrary.spec

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

PropriedadeTipoObrigatóriaDescrição
artifactsmapa de mapas de stringsimMapa com nome de bundles de artefactos reutilizáveis. Cada bundle agrupa os ficheiros de saída que andam juntos (por exemplo, uma CRD, o seu RBAC e um ConfigMap). O corpo de cada ficheiro é 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 nos URL de referência canónicos (#/artifacts/<name>); a restrição ao 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 ficheiro individual dentro dele. Padrão: ^[A-Z][A-Za-z0-9]*$. Pelo menos 1 entrada.

Não são permitidas propriedades adicionais.