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 arquivo de bloqueio de dependências do Aggrega (Manifest)

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

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

Um único arquivo de bloqueio global que vincula os 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 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

PropriedadeTipoObrigatóriaDescrição
apiVersionconst “aggrega.ai/v1beta1”simConstante: "aggrega.ai/v1beta1"
kindconst “Manifest”simConstante: "Manifest"
metadataobjectsim
defsstring[]nãoBloco opcional para âncoras YAML padrão (& e *) que mantém o Manifest DRY enquanto preserva um dicionário plano O(1) para o compilador.
specobjectsimAs declarações de mapeamento do Manifest mais a herança opcional de uma base: mappings conecta 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

PropriedadeTipoObrigatóriaDescrição
namestringsimPelo menos 1 caractere.
versionstringsimVersionamento semântico estrito do arquivo 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-]+)*))?$.
descriptionstringnãoO que esta entidade é e para que serve, escrito para quem está decidindo se vai usá-la. Comece com uma frase que nomeie a coisa e depois acrescente o que um leitor precisa para escolhê-la e usá-la corretamente — o que ela espera da Release que a usa, e qualquer coisa surpreendente sobre como ela se comporta. Um parágrafo curto é o tamanho habitual.
maintainersobject[]nãoLista de mantenedores responsáveis por esta entidade.
licensestringnãoIdentificador SPDX da licença do software que esta entidade descreve, como MIT ou AGPL-3.0. Ele registra os termos desse software, não os termos deste arquivo.
repositorystringnãoA URL do repositório Git onde ficam os arquivos-fonte.
homestringnãoA URL da página inicial, do wiki ou da documentação desta entidade.
keywordsstring[]nãoUma lista de palavras-chave descritivas para facilitar a descoberta na interface do usuário.

Não são permitidas propriedades adicionais.

manifest.metadata.maintainers[]
PropriedadeTipoObrigatóriaDescrição
namestringsim
emailstringnão
urlstringnã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 conecta os tipos abstratos de componente e de funcionalidade a implementações concretas de Recipe e FeatureRecipe; extends herda os mapeamentos de um Manifest base.

PropriedadeTipoObrigatóriaDescrição
extendsstringnãoURI de um Manifest base do qual herdar os mapeamentos. O mapeamento de um filho substitui o da base para a mesma chave.
mappingsobjectsimMapeia interfaces abstratas para implementações concretas. Declare os mapeamentos 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. Essas duas chaves são toda a superfície; nenhuma outra chave é aceita 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 faz o build da Release. Chaves: uma de "components", "features".

Não são permitidas propriedades adicionais.

manifest.spec.mappings

Mapeia interfaces abstratas para implementações concretas. Declare os mapeamentos 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. Essas duas chaves são toda a superfície; nenhuma outra chave é aceita 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 faz o build da Release.

PropriedadeTipoObrigatóriaDescrição
componentsmapping_tiernãoMapeamento do tipo de Component para o URI de Recipe. Um URI de Recipe carrega 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 arquivo 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 ’/’ nomeia o spec.capability da receita) — obrigatório quando mais de uma receita disponibiliza o mesmo nome; uma referência simples ambígua interrompe a resolução de forma bem visível em vez de escolher uma silenciosamente.
featuresmapping_tiernãoMapeamento do tipo de Feature para o URI de FeatureRecipe. Inclui tanto as Features operacionais quanto as Features de credenciais (rotuladas 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 massa, DRY), ‘name’ mapeia por nome de instância (substituição granular). Ambos são opcionais, mas pelo menos um deve estar presente. Durante a resolução, name prevalece sobre type. Chaves type com versão prevalecem sobre as sem versão.

PropriedadeTipoObrigatóriaDescrição
typemapa de stringnãoMapeia URIs de tipos de catálogo para URIs de Recipe. Suporta chaves com versão (‘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 sem versão (‘core/api-server’) para correspondência com qualquer versão.
namemapa de stringnãoMapeia nomes de instância específicos para URIs de Recipe. Tem precedência sobre o mapeamento baseado em tipo.
annotationsmapa de objectnãoAtalhos de Feature orientados por anotações. Mapeia chaves de anotação para um URI de Feature mais uma tabela de roteamento agrupada por pilar, da subchave em caminho pontilhado para o pilar da Feature (values ou infra). A validação deriva da declaração spec.schema.. da Feature de destino; a associação declara apenas o roteamento. O URI de Feature referenciado por ‘feature’ DEVE aparecer também na seção ‘type’ (é ali que fica a associação com a versão da FeatureRecipe).

Não são permitidas propriedades adicionais.