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 grafo IR agnóstico em relação às capacidades do Aggrega

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

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

O grafo achatado, totalmente resolvido e unidimensional emitido pelo Topology Builder.

Tipo de nível superior: object

Propriedades

PropriedadeTipoObrigatóriaDescrição
apiVersionconst “aggrega.ai/v1beta1”simConstante: "aggrega.ai/v1beta1"
kindconst “IR”simConstante: "IR"
metadataIRMetadatasimIdentidade do grafo: o Aggregate a partir do qual foi construído.
specIRSpecsimO próprio grafo: os seus nós, as suas arestas e os payloads indexados por nó.

Não são permitidas propriedades adicionais.

Definições

Maintainer

PropriedadeTipoObrigatóriaDescrição
namestringsimO nome do responsável pela manutenção.
emailstringnãoO endereço de e-mail do responsável pela manutenção.
urlstringnãoO endereço web do responsável pela manutenção.

FieldProvenance

Origem de uma folha no payload values ou infra de um anexo.

PropriedadeTipoObrigatóriaDescrição
originstringsimSe a folha foi escrita explicitamente ou contribuída pela passagem de expansão orientada por anotações.
sidestringnãoSuperfície de autoria na qual a anotação foi declarada; ausente para folhas explícitas.
annotation_keystringnãoNome da anotação que contribuiu com esta folha; ausente para folhas explícitas.
annotation_sourcestringnãoLocalização na fonte da declaração da anotação como :; ausente para folhas explícitas.
overridden_annotationFieldProvenancenãoA contribuição de anotação que perdeu esta folha para uma explícita: quando uma folha explícita sobrescreveu uma folha contribuída por uma anotação, a proveniência suprimida que substituiu. Singular — nunca é retida mais do que exatamente uma contribuição suprimida.

Não são permitidas propriedades adicionais.

AttachmentConnection

A ligação a que um anexo pertence, para um anexo escrito numa ligação que um componente traça em vez de no bloco de anexos do próprio componente: o socket através do qual a ligação é cablada e o alias sob o qual está escrita. O par nomeia uma das arestas do grafo — a aresta cuja origem é o nó que contém o anexo e cujo socket e alias são estes — pelo que um consumidor junta o anexo a essa aresta e, através dela, ao destino ao qual o anexo é apresentado.

PropriedadeTipoObrigatóriaDescrição
socketstringsimO socket através do qual a ligação é cablada: o socket da aresta a que o anexo pertence.
aliasstringsimO alias sob o qual a ligação está escrita: o alias da aresta a que o anexo pertence.

Não são permitidas propriedades adicionais.

IRFeatureEntry

Um anexo resolvido para um nó, contido em feature_values_mapping. Todas as famílias de anexos partilham esta forma — uma Feature operacional, uma Feature de credenciais, uma Feature de identidade — pelo que nenhuma família recebe uma projeção com mais perdas do que outra. Aquilo que o values de um anexo de credenciais contém é escolha do autor: uma credencial por referência contém um ponteiro para um repositório de segredos, uma por valor contém o próprio material, e o compilador transporta literalmente a que foi escrita, sem resolver nenhuma das duas.

PropriedadeTipoObrigatóriaDescrição
typestringsimURI da Feature do catálogo que este anexo solicita.
resolved_versionstringsimA versão semântica exata resolvida durante a compilação.
labelsmapa de stringnãoAs etiquetas de catálogo da Feature anexada, contidas literalmente pela ordem em que a sua entidade de catálogo as declara — nunca filtradas, normalizadas ou despojadas de prefixo, pelo que um consumidor lê exatamente aquilo que o autor do catálogo escreveu. O compilador não lê nenhuma delas. Ausente quando a Feature não declara etiquetas, e quando o seu tipo não se resolve em nenhuma entidade de catálogo.
catalog_annotationsmapa de stringnãoAs anotações de catálogo da Feature anexada — as metadata.annotations da entidade Feature que este anexo nomeia — contidas literalmente pela ordem em que essa entidade as declara, nunca filtradas, normalizadas ou despojadas de prefixo, pelo que um consumidor lê exatamente aquilo que o autor do catálogo escreveu, incluindo chaves no próprio espaço de nomes do autor. O compilador não lê nenhuma delas. Distinto de annotation_key e annotation_source, que nomeiam e localizam a anotação que fez este anexo existir: esses dois reportam como o anexo surgiu, este reporta os metadados da entidade que nomeia, e um anexo escrito num bloco features: contém estas anotações sem conter nenhum daqueles dois. Ausente quando a Feature não declara anotações, e quando o seu tipo não se resolve em nenhuma entidade de catálogo.
bindingstringnãoNomeia o slot de anexo que este anexo ocupa, ou “free” quando não ocupa nenhum slot declarado. Um slot é declarado num de dois locais, e o local onde o anexo foi escrito decide qual: um anexo do bloco de anexos do próprio nó ocupa um slot que o Component host declara no seu featuresSchema, e um anexo escrito numa ligação ocupa um slot que o socket da ligação declara no featuresSchema desse socket no Component host. O emparelhamento é por nome em ambos os casos — um anexo ocupa um slot quando a Feature é anexada sob o nome do slot, no bloco do componente ou na ligação — pelo que o valor é uma chave exata do conjunto de slots declarados, nunca algo lido a partir da chave do anexo. O conjunto de slots de um socket é fechado, uma vez que um anexo escrito numa ligação sob um nome que o seu socket não declara interrompe a compilação, pelo que um anexo que contém uma ligação nunca reporta free. É transportado o nome do slot em vez de um simples booleano porque saber que slot foi ocupado é a metade mais útil da resposta. Vazio quando o conjunto de slots declarados do Component host não pôde ser resolvido, o que é distinto de “free”: free é a constatação positiva de que nenhum slot declarado tem este nome.
valuesobjetonãoPayload de configuração operacional do anexo. Para uma credencial, a forma que o autor tiver declarado — um ponteiro para um repositório de segredos, ou o próprio material.
infraobjetonãoDimensionamento físico por instância para este anexo.
injectobjetonãoEncaminhamento de injeção agnóstico. Mapeia variáveis locais para as chaves provides do destino.
originstring (enum)nãoDistingue anexos escritos num bloco features: (explicit) de anexos sintéticos produzidos pela passagem de expansão orientada por anotações (annotation), ou mixed quando as folhas value/infra do anexo contêm uma mistura de ambos (o detalhe por folha fica então nos mapas de proveniência). Valores permitidos: "explicit", "annotation", "mixed"
annotation_keystringnãoNome da anotação que desencadeou um anexo sintético. Ausente quando origin é explicit.
annotation_sourcestringnãoLocalização na fonte da declaração da anotação como :. Ausente quando origin é explicit.
values_provenancemapa de FieldProvenancenãoOrigem por folha do payload values, indexada pelo caminho com pontos da folha.
infra_provenancemapa de FieldProvenancenãoOrigem por folha do payload infra, indexada pelo caminho com pontos da folha.
sensitivebooleananãoÉ true quando este anexo lida com material que um autor declarou sensível — ou a Feature anexada declara uma folha sensível no seu pilar values, infra ou provides, ou o slot que o anexo ocupa declara sensível o material que contém: o slot de anexo com o mesmo nome do Component host ou, para um anexo escrito numa ligação, o slot com esse nome que o socket da ligação declara. Derivado dessas declarações sobre o anexo fundido, nunca do conteúdo de um valor ou de um nome. Não definido quando nenhuma das duas declarações está presente.
sensitive_injectmapa de mapas de stringnãoAs chaves de entrega de inject cuja chave provides referenciada a Feature anexada declara sensível, na forma própria de inject: mecanismo, depois chave de entrega, com a chave provides referenciada como valor. Um subconjunto de inject. Ausente quando o anexo não declara nenhum mecanismo de entrega ou não referencia nenhuma chave provides sensível.
sensitive_payload_leavesstring[]nãoAs folhas que o payload values e infra deste anexo transporta e que a Feature anexada declara sensíveis, cada uma como o caminho com pontos prefixado pelo pilar que o dado ocupa: values. ou infra.. O payload lido aqui é o que o anexo acaba por transportar, pelo que uma folha situada num valor que o esquema da Feature declara como predefinição é nomeada ao lado de uma que um autor escreveu — uma predefinição preenchida é um dado que o payload transporta, e uma marcação lida apenas a partir do bloco escrito deixá-la-ia sem nome. Esta é a unidade por folha da marcação de sensibilidade, e responde a uma pergunta a que nenhum dos outros dois campos responde — sensitive dá uma única resposta para o anexo inteiro, sensitive_inject dá uma por chave de entrega de inject, e nenhum dos dois nomeia uma folha individual. Uma folha aparece onde um caminho que o esquema da Feature declara sensível a cobre: a declaração nomeia essa folha, ou nomeia um objeto que a contém, pelo que uma folha sob um objeto que uma declaração cobre é nomeada por essa declaração. A correspondência é feita segmento a segmento sobre o caminho com pontos, sem ler nada do próprio texto do caminho e sem inspecionar nenhum valor, pelo que uma declaração em db cobre db.password e não alcança uma folha irmã chamada dbPassword. A resposta por anexo nunca é distribuída pelas folhas individuais, o que afirmaria algo falso sobre uma folha deixada legível. Uma chave ausente afirma que este anexo não nomeia nenhuma folha que a sua Feature declare sensível. Não afirma que o payload não é sensível, e não distingue um anexo que não tem uma tal folha para nomear de um produtor que não reporta de todo este eixo — um guest que lê uma chave ausente como permissão para mostrar ou emitir um valor em claro leu-a ao contrário. As folhas chegam pela ordem em que o payload as contém, as do pilar values antes das do pilar infra — a mesma ordem que os próprios payloads values e infra transportam, e o que torna o payload idêntico byte a byte entre execuções com entrada idêntica. Ausente quando o anexo não transporta nenhuma folha que a sua Feature declare sensível.
connectionAttachmentConnectionnãoA ligação a que este anexo pertence: presente em todos os anexos escritos numa das ligações do nó, e ausente em todos os anexos do bloco de anexos próprio do nó. Um anexo escrito numa ligação é, em todos os outros aspetos, um dos anexos do nó — indexado pelo seu nome qualificado, o alias da ligação e o slot unidos por um ponto, e tomando a sua associação e a sua sensibilidade do slot que o socket da ligação declara —, pelo que este campo é o que distingue os dois, e transporta a ligação como dado em vez de a deixar para ser lida a partir da chave. Um consumidor junta-o às arestas do grafo por socket e alias: a aresta cuja origem é o nó que transporta este anexo e cujo socket e alias são estes é a ligação na qual o anexo é apresentado, e o destino dessa aresta é aquilo a que é apresentado. Um anexo de uma ligação que um anexo de Feature traça nunca transporta um, porque uma ligação assim não transporta anexos.
realizationstringnãoA FeatureRecipe que realiza este anexo, como :: aquela que o Manifest lhe associa — pelo nome próprio do anexo onde o nível de nomes do Manifest mapeia esse nome, caso contrário pelo seu tipo de Feature —, que é aquela com que uma compilação dos mesmos documentos o renderiza. Para um anexo escrito numa ligação, o nome pelo qual o nível de nomes é lido é o seu nome qualificado, o alias da ligação e o slot unidos por um ponto. O valor é o par que aggrega inspect imprime como a realização do anexo e, onde um destino carimba a proveniência no que renderiza, o valor aggrega.ai/recipe-uri nos documentos que essa FeatureRecipe renderiza, pelo que um consumidor junta um anexo ao que este renderiza sem traduzir entre formas. Nomeia a FeatureRecipe por nome e versão e não por capacidade. O campo regista qual a FeatureRecipe que o Manifest associa, lida a partir do Manifest e do catálogo quando o grafo é construído: nada é obtido para o produzir, e a FeatureRecipe só é renderizada quando a compilação renderiza. Ausente quando o Manifest não associa o anexo a nenhuma FeatureRecipe que o catálogo contenha.

Não são permitidas propriedades adicionais.

IRFeatureEntry.inject

Encaminhamento de injeção agnóstico. Mapeia variáveis locais para as chaves provides do destino.

PropriedadeTipoObrigatóriaDescrição
envmapa de stringnãoEntrega por variáveis de ambiente: as chaves são os nomes das variáveis locais do consumidor, e os valores são as chaves provides do destino.
filemapa de stringnãoEntrega por montagem de ficheiros: as chaves são os caminhos de ficheiro locais do consumidor, e os valores são as chaves provides do destino.
argmapa de stringnãoEntrega por argumentos da linha de comandos: as chaves são os prefixos de flag do consumidor, e os valores são as chaves provides do destino.

IRBoundaryFeature

Um anexo de Feature ao nível da fronteira projetado na IR: o URI do tipo de Feature mais a infra da fronteira face à qual uma FeatureRecipe com âmbito boundary renderiza e resolve a sua fonte. Os anexos ao nível da fronteira não transportam nenhum payload values.

PropriedadeTipoObrigatóriaDescrição
typestringsimURI da Feature do catálogo anexada nesta fronteira.
infraobjetonãoDimensionamento físico para o anexo a uma fronteira; a infra face à qual uma FeatureRecipe com âmbito boundary avalia os seus templates e a sua fonte.
sensitive_payload_leavesstring[]nãoAs folhas que o payload infra deste anexo a uma fronteira transporta e que a Feature anexada declara sensíveis, cada uma como o caminho com pontos prefixado pelo pilar que o dado ocupa. Apenas coordenadas infra. aparecem aqui, porque um anexo ao nível da fronteira não transporta nenhum payload values. O payload lido aqui é o que o anexo acaba por transportar, pelo que uma folha situada num valor que o esquema da Feature declara como predefinição é nomeada ao lado de uma que uma fronteira escreveu — uma predefinição preenchida é um dado que o payload transporta, e uma marcação lida apenas a partir do bloco escrito deixá-la-ia sem nome. Uma folha aparece onde um caminho que o esquema da Feature declara sensível a cobre: a declaração nomeia essa folha, ou nomeia um objeto que a contém, pelo que uma folha sob um objeto que uma declaração cobre é nomeada por essa declaração. A correspondência é feita segmento a segmento sobre o caminho com pontos, sem ler nada do próprio texto do caminho e sem inspecionar nenhum valor, pelo que uma declaração em db cobre db.password e não alcança uma folha irmã chamada dbPassword. Uma chave ausente afirma que este anexo não nomeia nenhuma folha que a sua Feature declare sensível, o que inclui o caso em que a Feature anexada não se resolve em nenhum esquema que este leitor tenha conseguido ler. Não afirma que o payload infra não é sensível, e não distingue um anexo que não tem uma tal folha para nomear de um produtor que não reporta de todo este eixo. Um consumidor que lê uma chave ausente como permissão para mostrar ou emitir um valor em claro leu-a ao contrário. As folhas chegam pela ordem em que o payload as contém, que é a mesma ordem que o próprio payload infra transporta e o que mantém o grafo idêntico byte a byte entre execuções com entrada idêntica. Ausente quando o anexo não transporta nenhuma folha que a sua Feature declare sensível.
realizationstringnãoA FeatureRecipe que realiza este anexo a uma fronteira, como :: aquela que o Manifest lhe associa — pelo nome próprio do anexo onde o nível de nomes do Manifest mapeia esse nome, caso contrário pelo seu tipo de Feature —, que é aquela com que uma compilação dos mesmos documentos o renderiza. É o mesmo campo, lido da mesma forma, que a realização de uma entrada de anexo sob feature_values_mapping. Ausente quando o Manifest não associa o anexo a nenhuma FeatureRecipe que o catálogo contenha.

Não são permitidas propriedades adicionais.

CatalogMetadata

A suite de metadados empresariais extraída explicitamente da entidade do catálogo, que expõe dados de ciclo de vida e de propriedade aos linters Wasm.

PropriedadeTipoObrigatóriaDescrição
maintainersMaintainer[]nãoOs responsáveis pela manutenção que a entidade do catálogo lista como seus proprietários.
licensestringnãoO identificador de licença SPDX que a entidade do catálogo declara para o software que descreve.
repositorystringnãoO URL do repositório Git que a entidade do catálogo indica como aquele que contém os seus ficheiros de origem.
homestringnãoO URL da página inicial, da wiki ou da documentação da entidade do catálogo.
keywordsstring[]nãoAs palavras-chave descritivas que a entidade do catálogo declara.

Não são permitidas propriedades adicionais.

IRNode

PropriedadeTipoObrigatóriaDescrição
descriptionstringnãoDocumentação opcional escrita pelo programador que descreve o papel desta instância de componente na aplicação. Transportada a partir do Aggregate para a renderização e para os diagnósticos de lint.
labelsmapa de stringsimAs etiquetas de duck typing e de ontologia da entidade.
componentstringsimO nome do Component subjacente.
resolved_versionstringsimA versão semântica exata do Component resolvida durante a compilação.
sync_waveintegernãoA wave de implementação herdada do campo syncWave da fronteira que o contém (predefinição 0; valores negativos permitidos). Em K8s e Helm, a wave é o que ordena a implementação: torna-se uma anotação argocd.argoproj.io/sync-wave e, num recurso que o chart já marca como hook do Helm, torna-se também o helm.sh/hook-weight desse hook. Em compose, o valor é registado como etiqueta do serviço e também ordena os serviços do ficheiro no qual é renderizado, através de depends_on entre eles. Em cloudformation, ordena o aprovisionamento da stack na qual um grupo de despacho se monta, sendo cada recurso de uma wave declarado como dependente dos recursos da wave anterior: a ordem pela qual são criados e, inversamente, a ordem pela qual são eliminados, nunca a prontidão, porque um template de stack não exprime nenhuma noção de um recurso estar pronto. Em terraform, ordena os blocos module da configuração raiz na qual uma fronteira se monta, sendo cada módulo de uma wave declarado como dependente dos módulos da wave anterior: a ordem pela qual o motor executa as suas ações, nunca a prontidão, porque uma configuração não exprime nenhuma noção de um recurso estar pronto. O valor acompanha também a proveniência de compilação do nó.
boundary_pathstringnãoO caminho da fronteira da Release na qual este nó está colocado: os nomes das fronteiras da mais exterior para dentro, unidos com / (p. ex., ‘data/inner’ para um componente colocado numa fronteira inner declarada dentro de uma fronteira data). Um nome de fronteira não pode conter /, pelo que o caminho se decompõe novamente nas suas fronteiras sem ambiguidade. Um nó de um Aggregate importado que a Release encaminha para uma fronteira transporta o caminho dessa fronteira. Permite que os plugins de renderização gerem identificadores únicos que têm em conta a fronteira.
subsystem_pathstringnãoO caminho do subsistema do Aggregate no qual o componente deste nó é declarado: os nomes dos subsistemas do mais exterior para dentro, unidos com . (p. ex., ‘backend.storage’ para um componente declarado num subsistema storage aninhado dentro de um subsistema backend). Um nome de subsistema não pode conter ., pelo que o caminho se decompõe novamente nos seus subsistemas sem ambiguidade. Um componente de um Aggregate que declara components de nível superior transporta o default sintetizado, marcado por synthesized_subsystem. O caminho é relativo ao Aggregate que declara o componente: um nó com que um Aggregate importado contribui transporta o seu caminho dentro desse Aggregate, sem o nome sob o qual é importado (p. ex., ‘tier’ para um componente no subsistema tier do Aggregate importado), pelo que nós de Aggregates diferentes podem partilhar um mesmo caminho. O ID do nó, que começa pelo nome de importação, e source_file distinguem-nos.
synthesized_subsystembooleananãoÉ true quando o subsistema deste nó foi sintetizado pelo compilador — o subsistema default criado para um Aggregate que declara components de nível superior em vez de subsystems com nome. Proveniência derivada, nunca escrita pelo autor: distingue o default sintetizado de um subsistema a que um utilizador deu explicitamente o nome default. Independente de synthesized_boundary (um nó pode ser sintetizado em qualquer um dos eixos ou em ambos). Ausente (false) para todos os subsistemas escritos pelo autor.
synthesized_boundarybooleananãoÉ true quando a fronteira deste nó foi sintetizada pelo compilador — a fronteira default criada para uma Release que declara components de nível superior em vez de boundaries com nome. Proveniência derivada, nunca escrita pelo autor: distingue o default sintetizado de uma fronteira a que um utilizador deu explicitamente o nome default, e encaminha os artefactos do nó para dist/ de forma plana em vez de dist/boundaries/default/. Ausente (false) para todas as fronteiras escritas pelo autor.
catalog_metadataCatalogMetadatanãoA suite de metadados empresariais extraída explicitamente da entidade do catálogo, que expõe dados de ciclo de vida e de propriedade aos linters Wasm.
catalog_annotationsmapa de stringnãoCaracterísticas imutáveis e intrínsecas do componente, escritas pelo arquiteto de plataforma no domínio 2.
release_annotationsmapa de stringnãoCadeias de topologia física e realidades de Ops que descem em cascata a partir das fronteiras na Release.
aggregate_annotationsmapa de stringnãoMetadados cognitivos, intenção do programador e FinOps que descem em cascata a partir dos subsistemas no Aggregate.
self_injectobjetonãoBloco de self-inject ao nível do Component transportado a partir do Aggregate; o encaminhamento de injeção agnóstico que o nó declara para si próprio. Opaco nesta camada do esquema; um plugin de política que o lê analisa os bytes.
source_filestringnãoCaminho, relativo ao espaço de trabalho, do ficheiro do Aggregate no qual este nó foi escrito. Os nós do nível raiz transportam o caminho do Aggregate raiz; os nós de subagregados transportam o caminho de ficheiro do Aggregate importado. O caminho é relativo à raiz do espaço de trabalho (o diretório que contém .aggrega-config.yaml), pelo que o grafo é idêntico byte a byte em máquinas cujos espaços de trabalho se encontram em caminhos absolutos diferentes. Os consumidores que filtram diagnósticos por ficheiro resolvem o campo face à mesma raiz do espaço de trabalho antes da comparação. Ausente quando o grafo foi construído sem uma raiz do espaço de trabalho.
usesobjetonãoO bloco uses do nó exatamente como foi escrito: cada nome de socket corresponde a uma lista de nomes de instâncias de destino ou a um mapa de entradas de ligação indexado por alias, pela ordem em que o autor os declarou. Este é o bloco tal como escrito, que é um facto diferente das ligações resolvidas em edges: um socket que o autor povoou aparece aqui mesmo onde não produziu nenhuma ligação, pelo que um leitor consegue distinguir um socket que o autor preencheu de um socket que alcança um destino. Ausente quando o nó não escreveu nenhum bloco uses. Opaco nesta camada do esquema; um plugin de política que o lê analisa os bytes.
sensitive_payload_leavesstring[]nãoAs folhas que o payload values e infra deste nó transporta e que o seu Component declara sensíveis, cada uma como o caminho com pontos prefixado pelo pilar que o dado ocupa: values. ou infra.. Nomeia os dados PRÓPRIOS do nó — o que values_mapping e infra_mapping transportam para este nó — e é um assunto diferente da marcação numa entrada de anexo, que nomeia dados que um anexo transporta face à declaração da sua Feature. Nenhum dos dois pode ser recuperado a partir do outro: o Component de um nó e a Feature de um anexo declaram esquemas diferentes, e um nó que não anexa nada continua a transportar values. O payload lido aqui é o que esses dois mapeamentos transportam, pelo que uma folha situada num valor que o esquema do Component declara como predefinição é nomeada ao lado de uma que um autor escreveu — uma predefinição preenchida é um dado que o grafo transporta, e uma marcação lida apenas a partir dos blocos escritos deixá-la-ia sem nome. Uma folha aparece onde um caminho que o esquema do Component declara sensível a cobre: a declaração nomeia essa folha, ou nomeia um objeto que a contém, pelo que uma folha sob um objeto que uma declaração cobre é nomeada por essa declaração. A correspondência é feita segmento a segmento sobre o caminho com pontos, sem ler nada do próprio texto do caminho e sem inspecionar nenhum valor, pelo que uma declaração em db cobre db.password e não alcança uma folha irmã chamada dbPassword. Uma chave ausente afirma que este nó não nomeia nenhuma folha que o seu Component declare sensível, o que inclui o caso em que o Component do nó não se resolve em nenhum esquema que este leitor tenha conseguido ler. Não afirma que o payload do nó não é sensível, e não distingue um nó que não tem uma tal folha para nomear de um produtor que não reporta de todo este eixo. Um consumidor que lê uma chave ausente como permissão para mostrar ou emitir um valor em claro leu-a ao contrário. As folhas chegam pela ordem em que o payload as contém, as do pilar values antes das do pilar infra, que é a mesma ordem que esses próprios payloads transportam e o que mantém o grafo idêntico byte a byte entre execuções com entrada idêntica. Ausente quando o nó não transporta nenhuma folha que o seu Component declare sensível.

Não são permitidas propriedades adicionais.

IREdge

PropriedadeTipoObrigatóriaDescrição
sourcestringsimO ID do nó consumidor, onde a ligação começa.
targetstringsimO ID do nó que a ligação alcança.
socketstringnãoA categoria de usesSchema à qual esta aresta pertence (p. ex., ‘databases’, ‘tools’).
aliasstringnãoO alias definido pelo programador para esta ligação (p. ex., ‘primary_db’).
socket_declarationstring (enum)simDe onde veio o socket: declared quando a entidade do catálogo que detém o socket o lista em usesSchema (o Component consumidor, ou a Feature de origem para uma aresta escrita por uma Feature), ad-hoc quando o autor do Aggregate nomeou um socket que o catálogo não declarou. Este é um terceiro eixo, independente da autoria da aresta: diz de onde veio o socket, não quem traçou a aresta, pelo que uma aresta escrita por uma Release num socket declarado e uma aresta escrita por um Aggregate num socket ad hoc diferem nos dois eixos de forma independente. Um socket declarado transporta a sua entrada de usesSchema, incluindo o seletor que restringe os destinos que a aresta pode alcançar; um socket ad hoc não tem entrada de catálogo e, portanto, nenhum seletor, pelo que aquilo que a aresta pode transportar é limitado apenas pelos provides declarados do destino. Sempre presente, pelo que um consumidor nunca tem de ler um valor ausente como declared, e uma política pode exigir que todas as arestas sejam declaradas. Distinto do marcador de associação de um anexo, que responde à mesma forma de pergunta sobre um assunto diferente. Valores permitidos: "declared", "ad-hoc"
origin_featurestringnãoSe esta aresta foi declarada de forma autónoma por uma Feature (incluindo Features de credenciais etiquetadas com feature.aggrega.ai/kind: secret), isto identifica o URI do tipo de Feature. Permite que os plugins Wasm isolem a sua própria topologia.
origin_feature_instancestringnãoO nome de instância por anexo da Feature que declarou esta aresta. Localiza por instância os provides resolvidos de uma FeatureRecipe com âmbito boundary, distinguindo dois anexos do mesmo tipo de Feature numa mesma fronteira.
origin_releasebooleananãoÉ true quando esta aresta foi criada por uma Release que liga um socket declarado, mas não associado, a um componente existente. Marca a AUTORIA da aresta, não a configuração: uma aresta declarada pelo programador para a qual uma Release apenas forneceu infra mantém a origem Aggregate (origin_release não definido; a infra da sua Release aparece no mapa infra da aresta). origin_feature definido => origem Feature; origin_release true => origem Release; nenhum dos dois => origem Aggregate.
valuesobjetonãoValores do programador por ligação resolvidos para esta aresta (a partir da aresta do Aggregate), validados na resolução face ao valueSchema declarado pelo socket de origem (o socket no componente consumidor, que é a origem da aresta) e projetados no contexto de renderização do nó consumidor em .context.uses..values. As chaves que o autor omitiu são preenchidas a partir das predefinições declaradas do socket; um valor escrito pelo autor prevalece.
infraobjetonãoInfra por ligação resolvida para esta aresta, fornecida por uma entrada de aresta de uma Release, validada na resolução face ao infraSchema declarado pelo socket de origem (o socket no componente consumidor, que é a origem da aresta) e projetada em .context.uses..infra. As chaves que o autor omitiu são preenchidas a partir das predefinições declaradas do socket; um valor escrito pelo autor prevalece.
injectobjetonãoEncaminhamento de injeção agnóstico. Mapeia variáveis locais para as chaves provides do destino.
sensitive_payload_leavesstring[]nãoAs folhas que os values e a infra desta aresta transportam e que o socket face ao qual são escritos declara sensíveis, cada uma como o caminho com pontos prefixado pelo pilar que o dado ocupa: values. ou infra.. A declaração lida é o contrato por ligação no componente CONSUMIDOR — a origem da aresta — sob o socket ao qual esta aresta está ligada: o seu valueSchema rege values e o seu infraSchema rege infra, que é o mesmo contrato face ao qual ambos os payloads são validados. As declarações do destino não entram em jogo: aquilo que o destino publica é um dado diferente da configuração que o consumidor escreve para a ligação. É o mesmo campo, lido da mesma forma, que a marcação num nó, e um assunto diferente dela: a marcação de um nó nomeia os dados próprios do nó face ao esquema do seu Component, e esta nomeia a configuração da ligação face ao contrato do socket, pelo que nenhuma das duas pode ser recuperada a partir da outra. Os payloads lidos aqui são os que esta aresta transporta, pelo que uma folha situada num valor que o contrato do socket declara como predefinição é nomeada ao lado de uma que um autor escreveu. Uma folha aparece onde um caminho que o contrato declara sensível a cobre: a declaração nomeia essa folha, ou nomeia um objeto que a contém. A correspondência é feita segmento a segmento sobre o caminho com pontos, sem ler nada do próprio texto do caminho e sem inspecionar nenhum valor, pelo que uma declaração em db cobre db.password e não alcança uma folha irmã chamada db_password. Uma superfície que retém do grafo os valores declarados sensíveis retém estas folhas nos values e na infra desta aresta, e na entrada uses do nó consumidor para a mesma ligação, que transporta os valores tal como o autor os escreveu. Uma chave ausente afirma que esta aresta não nomeia nenhuma folha que o contrato do seu socket declare sensível, o que inclui o caso em que o socket não declara nenhum contrato que este leitor tenha conseguido ler. Não afirma que a configuração não é sensível, e um consumidor que lê uma chave ausente como permissão para mostrar ou emitir um valor em claro leu-a ao contrário. As folhas chegam pela ordem em que os payloads as contêm, as do pilar values antes das do pilar infra, que é o que mantém o grafo idêntico byte a byte entre execuções com entrada idêntica. Ausente quando a aresta não transporta nenhuma folha que o contrato do seu socket declare sensível.

Não são permitidas propriedades adicionais.

IREdge.inject

Encaminhamento de injeção agnóstico. Mapeia variáveis locais para as chaves provides do destino.

PropriedadeTipoObrigatóriaDescrição
envmapa de stringnãoEntrega por variáveis de ambiente: as chaves são os nomes das variáveis locais do consumidor, e os valores são as chaves provides do destino.
filemapa de stringnãoEntrega por montagem de ficheiros: as chaves são os caminhos de ficheiro locais do consumidor, e os valores são as chaves provides do destino.
argmapa de stringnãoEntrega por argumentos da linha de comandos: as chaves são os prefixos de flag do consumidor, e os valores são as chaves provides do destino.

IRMetadata

Identidade do grafo: o Aggregate a partir do qual foi construído.

PropriedadeTipoObrigatóriaDescrição
aggregate_namestringsimO metadata.name do Aggregate.

Não são permitidas propriedades adicionais.

IRProvenance

Metadados de rastreabilidade para diagnóstico e auditoria.

PropriedadeTipoObrigatóriaDescrição
schema_versionstringsimA versão do esquema IR com a qual o grafo está em conformidade — aggrega.ai/v1beta1, o mesmo valor que a apiVersion do grafo transporta.
compiler_versionstringsimCarimbo de conformidade obrigatório. Identifica, pela sua versão, o binário aggrega que construiu este grafo.
aggregate_versionstringsimA versão semântica exata da intenção do Aggregate raiz usada durante a compilação.
manifest_versionstringsimA versão semântica exata do ficheiro de bloqueio do Manifest usado durante a compilação.
release_versionstringsimA versão semântica exata do ficheiro de encaminhamento da Release usado durante a compilação.

São permitidas propriedades adicionais.

IRSpec

O próprio grafo: os seus nós, as suas arestas e os payloads indexados por nó.

PropriedadeTipoObrigatóriaDescrição
nodesmapa de IRNodesimDicionário de todos os nós do grafo, indexados pelo seu ID absoluto. Puramente topológico. Chaves: uma ou mais letras, algarismos, sublinhados, pontos ou hífenes. Padrão: ^[a-zA-Z0-9_.-]+$.
edgesIREdge[]simCaminhos de rede lógicos explícitos e dependências entre nós.
values_mappingobjetosimA única fonte de verdade para os payloads cognitivos opacos transmitidos sem alteração, mapeados por ID do nó.
infra_mappingobjetosimO payload de dimensionamento físico injetado a partir da Release, mapeado por ID do nó.
feature_values_mappingmapa de mapa de IRFeatureEntrysimMapa normalizado dos IDs de nó para as suas configurações de Feature anexadas. Um único contentor transporta todos os anexos de um nó, seja o que for que produzam — Features operacionais, Features de credenciais, Features de identidade —, indexados pelo nome de instância que o autor deu a cada anexo. Um anexo escrito numa das ligações do nó é indexado pelo seu nome qualificado, o alias da ligação e o slot unidos por um ponto, e nomeia a sua ligação no seu próprio campo connection. Chaves: uma ou mais letras, algarismos, sublinhados, pontos ou hífenes. Padrão: ^[a-zA-Z0-9_.-]+$.
boundary_featuresmapa de mapa de IRBoundaryFeaturenãoOs anexos de Feature de cada fronteira, indexados pelo caminho da fronteira e depois pelo nome de instância. Presente apenas quando o grafo tem anexos de Feature ao nível da fronteira. Chaves: uma ou mais letras, algarismos, sublinhados, pontos, barras ou hífenes. Padrão: ^[a-zA-Z0-9_./-]+$.
provenanceIRProvenancesimMetadados de rastreabilidade para diagnóstico e auditoria.

Não são permitidas propriedades adicionais.

IRGraph

PropriedadeTipoObrigatóriaDescrição
apiVersionconst “aggrega.ai/v1beta1”simConstante: "aggrega.ai/v1beta1"
kindconst “IR”simConstante: "IR"
metadataIRMetadatasimIdentidade do grafo: o Aggregate a partir do qual foi construído.
specIRSpecsimO próprio grafo: os seus nós, as suas arestas e os payloads indexados por nó.

Não são permitidas propriedades adicionais.