Esquema do ficheiro de bloqueio de dependências do Aggrega (Manifest)
Referência gerada. Não editar à mão — gerar novamente a partir do JSON Schema publicado.
ID do esquema: https://aggrega.ai/schemas/manifest-v1beta1.schema.json
Um único ficheiro de bloqueio global que associa tipos abstratos de componente e de Feature a implementações concretas de Recipe e FeatureRecipe, por tipo, com uma substituição por instância pelo nome.
Consulte-se a referência de autoria do Manifest para orientações em prosa sobre como escrever entidades Manifest; esta página documenta o esquema estrutural que essa referência descreve.
Tipo de nível superior: object
Propriedades
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | sim | Constante: "aggrega.ai/v1beta1" |
kind | const “Manifest” | sim | Constante: "Manifest" |
metadata | objeto | sim | |
defs | string[] | não | Bloco opcional para as âncoras normalizadas do YAML (& e *), que mantém o Manifest DRY e conserva para o compilador um dicionário plano O(1). |
spec | objeto | sim | As declarações de mapeamento do Manifest mais a herança opcional de uma base: mappings liga os tipos abstratos de componente e de funcionalidade a implementações concretas de Recipe e FeatureRecipe; extends herda os mapeamentos de um Manifest base. |
Não são permitidas propriedades adicionais.
manifest.metadata
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
name | string | sim | Pelo menos 1 carácter. |
version | string | sim | Versionamento semântico estrito do ficheiro de bloqueio do manifesto (por exemplo, 1.0.0). 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-]+)*))?$. |
description | string | não | O que esta entidade é e para que serve, escrito para quem está a decidir se a vai usar. Convém começar por uma frase que nomeie a coisa e acrescentar depois o que um leitor precisa para a escolher e usar corretamente — o que espera da Release que a usa, e tudo o que seja surpreendente no seu comportamento. Um parágrafo curto é a extensão habitual. |
maintainers | object[] | não | Lista dos responsáveis pela manutenção desta entidade. |
license | string | não | Identificador SPDX da licença do software que esta entidade descreve, como MIT ou AGPL-3.0. Regista os termos desse software, não os termos deste ficheiro. |
repository | string | não | O URL do repositório Git onde se encontram os ficheiros de origem. |
home | string | não | O URL da página inicial, da wiki ou da documentação desta entidade. |
keywords | string[] | não | Uma lista de palavras-chave descritivas para facilitar a descoberta na interface do utilizador. |
Não são permitidas propriedades adicionais.
manifest.metadata.maintainers[]
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
name | string | sim | |
email | string | não | |
url | string | não |
Não são permitidas propriedades adicionais.
manifest.spec
As declarações de mapeamento do Manifest mais a herança opcional de uma base: mappings liga os tipos abstratos de componente e de funcionalidade a implementações concretas de Recipe e FeatureRecipe; extends herda os mapeamentos de um Manifest base.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
extends | string | não | URI de um Manifest base do qual herdar os mapeamentos. O mapeamento de um filho substitui o da base para a mesma chave. |
mappings | objeto | sim | Mapeia interfaces abstratas para implementações concretas. Os mapeamentos declaram-se sob as chaves de nível superior ‘components’ e ‘features’, cada uma mapeando URIs de tipo de componente / tipo de funcionalidade diretamente para URIs de Recipe / FeatureRecipe. Estas duas chaves são toda a superfície; nenhuma outra chave é aceite aqui. O mapeamento é agnóstico em relação à capacidade na camada do Manifest — a determinação da capacidade decorre do spec.capability de cada Recipe resolvida quando o Aggrega compila a Release. Chaves: uma de "components", "features". |
Não são permitidas propriedades adicionais.
manifest.spec.mappings
Mapeia interfaces abstratas para implementações concretas. Os mapeamentos declaram-se sob as chaves de nível superior ‘components’ e ‘features’, cada uma mapeando URIs de tipo de componente / tipo de funcionalidade diretamente para URIs de Recipe / FeatureRecipe. Estas duas chaves são toda a superfície; nenhuma outra chave é aceite aqui. O mapeamento é agnóstico em relação à capacidade na camada do Manifest — a determinação da capacidade decorre do spec.capability de cada Recipe resolvida quando o Aggrega compila a Release.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
components | mapping_tier | não | Mapeamento do tipo de Component para o URI de Recipe. Um URI de Recipe contém no máximo dois segmentos — uma capacidade inicial opcional e, depois, o nome da receita — mais uma versão opcional; uma referência com um terceiro segmento não corresponde a nenhuma receita. Formas de versão: exata (‘postgres-bitnami:1.2.0’), intervalo (‘postgres-bitnami:^1.2.0’) ou sem versão (‘postgres-bitnami’); o resolvedor fixa a versão resolvida no ficheiro de bloqueio na primeira resolução. Uma referência pode, além disso, ser qualificada pela capacidade (‘terraform/mariadb-rds:1.0.0’, em que o segmento antes da primeira ’/’ indica o spec.capability da receita) — obrigatória quando mais do que uma receita disponibiliza o mesmo nome; uma referência simples ambígua interrompe ruidosamente a resolução, em vez de escolher uma silenciosamente. |
features | mapping_tier | não | Mapeamento do tipo de Feature para o URI de FeatureRecipe. Inclui tanto as Features operacionais como as Features de credenciais (etiquetadas com feature.aggrega.ai/kind: secret). |
Chaves: uma de "components", "features".
Não são permitidas propriedades adicionais.
Definições
mapping_tier
Resolução em dois níveis: ‘type’ mapeia por tipo de catálogo (em bloco, DRY), ‘name’ mapeia por nome de instância (substituição granular). Ambos são opcionais, mas pelo menos um tem de estar presente. Durante a resolução, name prevalece sobre type. As chaves type versionadas prevalecem sobre as não versionadas.
| Propriedade | Tipo | Obrigatória | Descrição |
|---|---|---|---|
type | mapa de string | não | Mapeia URIs de tipos de catálogo para URIs de Recipe. Suporta chaves versionadas (‘core/api-server:1.0.0’) para correspondência exata, chaves de intervalo (‘core/api-server:^1.0.0’) para correspondência compatível com a versão principal, ou chaves não versionadas (‘core/api-server’) para correspondência com qualquer versão. |
name | mapa de string | não | Mapeia nomes de instância específicos para URIs de Recipe. Tem precedência sobre o mapeamento baseado no tipo. |
annotations | mapa de object | não | Atalhos de Feature orientados por anotações. Mapeia chaves de anotação para um URI de Feature mais uma tabela de encaminhamento agrupada por pilar, da subchave em caminho com pontos para o pilar da Feature (values ou infra). A validação deriva da declaração spec.schema. |
Não são permitidas propriedades adicionais.