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 contexto de template do Aggrega

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

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

A visão que o compilador monta e passa aos templates de Recipe e FeatureRecipe enquanto renderiza. Ao renderizar uma FeatureRecipe de vinculação, o compilador preenche além disso .attachment_name e .inject com o contexto da vinculação, .context.render_facts com o que o provedor do seu host informou sobre a renderização do host e, nos templates que produzem os recursos próprios da vinculação, .context.used_by com os componentes que usam o seu host. Para uma FeatureRecipe com escopo de fronteira (spec.executionScope: boundary), os templates que ela executa uma vez para a fronteira — entre eles os seus locals, provides, source, valuesMapping, artifacts e etapas de pipeline — encontram ausentes os pilares .context, .workload, .attachment_name, .inject e .inject_raw e preenchido em seu lugar um pilar .boundary.* — veja o bloco da fronteira no final das propriedades; o seu injectMapping é executado uma vez para cada componente que a vinculação alcança, no contexto desse componente, então lê .context.* e .attachment_name, e .boundary não está definido ali. Isto NÃO é persistido em disco; existe apenas na memória do compilador durante a renderização. Este esquema documenta o contrato entre o compilador e os autores de templates de Ops.

Disponibilidade por estágio da renderização base, na ordem em que os estágios são executados:

  • Avaliação de provides (preâmbulo de locals, depois provides): apenas pilares locais ao nó. Uma entrada de locals lê as entradas acima dela no seu próprio bloco; um template de provides lê todo o .locals resolvido do nó. Autorreferência proibida (nenhuma entrada de provides lê outra).
  • Resolução da fonte (publicação dos locals + avaliação de source): todos os pilares; .source e .workload ausentes. Esses locals são publicados aqui em .locals, depois source: é avaliado em relação a eles.
  • Mapeamento de valores (valuesMapping): todos os pilares + .source; .workload ausente.
  • Síntese do Workload (avaliação de workload): todos os pilares + .source; .workload em avaliação (ausente da autorreferência).
  • Avaliação de artefatos (artifacts): todos os pilares + .source + .workload (contexto mais completo).

Tipo de nível superior: object

Propriedades

PropriedadeTipoObrigatóriaDescrição
contextobjectsimO contexto de execução montado pelo compilador, que fornece dados de identidade, topologia e entrega.
valuesobjectsimA carga útil cognitiva opaca para este nó, já validada pelo validador de esquema na resolução. Repassada sem alterações.
infraobjectsimA carga útil de dimensionamento físico injetada a partir da Release para este nó. Contorna totalmente o desenvolvedor.
localsmapa de stringsimO estado privado próprio da Recipe (por exemplo, primary_compute, volumes_path). Avaliado no preâmbulo de locals — antes dos provides desse nó — e publicado neste pilar na resolução da fonte. Cada entrada é um template Go avaliado em relação a um contexto autocontido local ao nó que traz as entradas do mesmo bloco resolvidas até então, de modo que uma entrada PODE ler uma irmã definida ACIMA dela e recebe o valor resolvido dessa irmã. A ordem do autor faz parte do contrato sempre que uma entrada lê outra: mover uma definição para baixo de quem a lê quebra o build. Uma referência ‘.locals.’ a uma entrada posterior, ou a uma chave que o bloco não declara, provoca uma interrupção. A verificação lê o caminho para o qual uma referência SE RESOLVE em vez das teclas digitadas, então cobre igualmente a forma direta, uma leitura dentro de um bloco ’{{ with .locals }}’, uma leitura através de uma variável associada diretamente a ‘.locals’, e uma chave lida do bloco entre parênteses, ‘(.locals).’ ou ’($.locals).’. Uma grafia que ela não cobre: uma referência cujo caminho o texto do template não determina — uma alcançada através de uma função, como ‘index .locals’ ou ‘(default dict .locals).’, ou através de um bloco ‘with’ ou de uma associação de variável cuja pipeline aplica uma. Ela não é analisada, e uma chave ausente alcançada dessa forma não provoca uma interrupção: renderiza o texto literal '' em vez de nada. A única exceção é o próprio ‘index’: em toda superfície de template ele provoca uma interrupção, nomeando a chave, quando o mapa que lê não contém a chave pedida, de modo que uma chave ausente alcançada através de ‘index .locals’ provoca uma interrupção. Uma entrada de locals não pode ler ‘.provides’. Disponível em provides (na avaliação de provides, após o preâmbulo), source, valuesMapping, workload, artifacts, assertions e para plugins Wasm a jusante via pipeline[].with (e pipeline[].when). Nunca exposto aos chamadores.
providesmapa de stringnãoO contrato de API pública da Recipe. Preenchido a partir da avaliação de provides. Disponível no valuesMapping da renderização base para autorreferência (por exemplo, {{ .provides.host }}). NÃO disponível dentro do próprio template de provides (a invariante de autocontenção de provides). Os chamadores resolvem chaves de inject em relação a estes valores.
featuresmapa de template_attachmentnãoCada vinculação neste nó, indexada pelo nome de instância que o autor lhe deu. Um único pilar traz todas, seja o que for que produzam — uma Feature operacional, uma Feature de credencial, uma Feature de identidade — porque o que difere entre as vinculações é o que elas produzem, não como um template as lê. Uma Recipe as lê para adaptar a sua renderização às capacidades vinculadas e para consumir o que uma vinculação publica. Uma vinculação escrita em uma das conexões do nó não está entre elas: ela é lida sob essa conexão, em .context.uses..features., de modo que um template que percorre este pilar encontra apenas as vinculações próprias do nó.
metadataobjectnãoMetadados da Release e da compilação que fornecem identidade global para nomeação determinística. Disponíveis em todos os blocos de template (valuesMapping, injectMapping, pipeline with).
attachment_namestringnãoPreenchido apenas ao renderizar uma FeatureRecipe de vinculação. Contém o nome de instância da vinculação — o slot que ela preenche no featuresSchema da entidade proprietária, ou o nome livre que o autor lhe deu (por exemplo, ‘admin_password’, ‘db_credentials’). Usado para construir nomes de recursos determinísticos que diferem por vinculação, compostos após o nome do componente host: ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}’ onde o provedor do host informa um nome renderizado, como faz o helm — o nome do host escrito nos caracteres que um nome do Kubernetes permite, com os sublinhados do nome da vinculação convertidos em hifens — e ’{{ .context.instance_id }}-{{ .attachment_name }}’ onde o provedor do host não informa nenhum.
injectobjectnãoPreenchido apenas ao renderizar uma FeatureRecipe de vinculação que traz um bloco inject escrito pelo autor (por exemplo, { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Distinto de .context.inject, que é o pipe de entrega pré-hidratado do componente base a partir das arestas uses. Avalia como null/ausente para vinculações sem inject escrito pelo autor e para Recipes base.
inject_rawobject ou nullnãoA intenção imutável e não mutada do desenvolvedor para o bloco inject. Cada mecanismo que o bloco nomeia — env, file, arg ou um personalizado, como ssm_param — fica sob o seu próprio nome, contendo as entradas exatamente como escritas (in, com from ou value), na ordem em que foram escritas, de modo que .inject_raw.ssm_param lê um mecanismo personalizado da mesma forma que .inject_raw.env lê um mecanismo nativo. Avalia como null se o desenvolvedor omitiu totalmente o bloco inject. Usado por Ops para verificações lógicas (por exemplo, {{ if not .inject_raw }}) para detectar a omissão antes das mutações do mapeamento de inject. Quais values ou provides próprios do componente cada entrada entrega é lido em .context.self_inject, e não a partir do texto das entradas.
stepsmapa de objectnãoComunicação entre etapas da pipeline. Disponível apenas dentro dos blocos ‘with:’ de uma pipeline Wasm. Cada chave é o ID de uma etapa da pipeline, contendo as saídas exportadas por essa etapa.
sourcestring ou object ou nullnãoConteúdo resolvido do campo source. Nos templates de uma Recipe: preenchido na resolução da fonte a partir do campo source: da Recipe após a avaliação do template Go, disponível do mapeamento de valores em diante (valuesMapping, workload, artifacts), e null quando a Recipe não tem source:. Nos templates de uma FeatureRecipe: o próprio campo source: da FeatureRecipe após a avaliação do template Go, avaliado antes do seu valuesMapping e lido ali e em todo template avaliado depois dele (omits, workload, artifacts, etapas de pipeline), nunca o do componente host; null quando a FeatureRecipe não tem source:. O injectMapping de uma FeatureRecipe é avaliado antes da sua fonte e lê a do componente host. Forma de string = caminho URI; forma de objeto = fonte estruturada (por exemplo, descritor OCI com versão resolvida).
workloadworkload-v1beta1.schema.json ou nullnãoEspecificação do Workload analisada para este nó. Preenchida na síntese do workload a partir do campo workload: da Recipe após a avaliação do template Go + a validação JSON Schema do Workload (em relação a workload-v1beta1.schema.json). Disponível da avaliação de artefatos em diante (artifacts), para que os artefatos possam referenciar campos do workload sem duplicação (por exemplo, um ServiceMonitor que lê .workload.services.metrics.ports.prom). Avalia como null quando a Recipe não tem um bloco workload:. Tentativas de um template de desreferenciar .workload.* em um valor null falham com um erro claro no momento da avaliação do template.
boundaryobjectnãoContexto com escopo de fronteira — preenchido apenas ao avaliar um template que uma FeatureRecipe cujo spec.executionScope é ‘boundary’ executa uma vez para a fronteira. FeatureRecipes com escopo de Component não recebem este pilar; os seus context.instance_id, context.inject, context.uses e o pilar .workload trazem em vez disso dados por componente. Os templates de uma FeatureRecipe com escopo de fronteira executados para a fronteira recebem .boundary.* no lugar desses pilares por componente; o seu injectMapping é executado no contexto de cada componente que a vinculação alcança, lê esses pilares por componente e não recebe este.

Não são permitidas propriedades adicionais.

template-context.context

O contexto de execução montado pelo compilador, que fornece dados de identidade, topologia e entrega.

PropriedadeTipoObrigatóriaDescrição
instance_idstringsimO ID absoluto achatado do nó atual (por exemplo, ‘backend’, ou ‘data-layer-zdmain-db’ para o componente main-db da instância de módulo data-layer), escrito no alfabeto que todo nome de componente escrito por um autor satisfaz. Determinístico e estável entre compilações para o mesmo Aggregate. É o nome dos recursos construídos para este nó para os quais nenhum provedor deriva um nome — um conjunto de artefatos colocado a partir da Recipe, e um workload sintetizado por um provedor que o nomeia segundo a identidade —, de modo que um endereço publicado para um deles é construído a partir deste valor.
rendered_namestringnãoO nome que o provedor associado a este nó dá aos recursos que renderiza para o nó — para uma origem fornecida pelo autor, o nome em relação ao qual os próprios templates fornecidos são renderizados, como o nome de release que um chart lê; para um workload que ele sintetiza, o nome que dá aos recursos desse workload quando deriva um em vez de escrever a identidade do nó, como faz o provedor helm com o mesmo nome de release. Leia-o sempre que esta Recipe nomear um recurso que um chart ou um módulo fornecido declarou ou que um provedor desse tipo sintetizou, seja em uma entrada de provides, em um valuesMapping, em um workload, em uma entrada de artifacts ou no with ou no when de uma etapa de pipeline, porque o provedor pode escrever esse nome em um alfabeto mais pobre do que aquele em que um nome de componente escrito por um autor é escrito, e então os dois diferem. Vazio quando o provedor associado não deriva nenhum nome desse tipo: os recursos de um conjunto de artefatos colocado, e de um workload sintetizado por um provedor que o nomeia segundo a identidade, carregam a identidade do nó, portanto leia ’{{ .context.instance_id }}’ para eles, e uma Recipe que escreveu seus próprios nomes de recursos já os conhece. Ler esta chave onde o provedor associado não reporta nenhum nome interrompe o build e diz o que escrever em seu lugar. A recusa cobre os templates que uma Recipe escreve inline; um valuesMapping, um workload ou uma entrada de artifacts fornecidos por meio de ‘$import’ só são resolvidos quando a renderização os alcança, de modo que uma referência dentro de um deles é renderizada como um valor vazio em vez de interromper o build. Nos templates de uma FeatureRecipe associada à vinculação de um componente, é o nome do componente HOST tal como o próprio provedor do host o reporta — o valor que a própria Recipe do host lê, assim como instance_id é ali a identidade do host —, de modo que uma vinculação o usa para nomear um recurso segundo o seu host e obtém um nome que a plataforma do host aceita. Onde o provedor do host não reporta nenhum nome, ele é vazio, e lê-lo a partir de um template inline da vinculação que não seja o seu injectMapping interrompe o build; leia ali ’{{ .context.instance_id }}’ em vez disso.
labelsmapa de stringnãoOs rótulos de duck-typing e de ontologia do nó atual, incluindo qualquer alteração que um plugin de governança vinculado no papel label-transform tenha feito na construção da topologia.
annotationsobjectnãoOs três contêineres de anotações em cascata do nó atual, separados por origem.
injectobjectsimO pipe de entrega pré-hidratado e interceptado. Começa como um mapa gerado pelo compilador que resolve as chaves inject do desenvolvedor para os valores provides do destino. Modificado no próprio lugar pelos deep merges de injectMapping. No momento em que a Recipe base é renderizada, ele contém as strings físicas totalmente resolvidas.
usesmapa de enriched_edgesimO mapa enriquecido de arestas topológicas. Indexado pelo alias do desenvolvedor (por exemplo, ‘my_db’, ‘my_api’). Cada entrada é uma visão montada pelo compilador da identidade do nó de destino, dos provides resolvidos, do mapeamento de injeção e das anotações em cascata, e das vinculações escritas nessa conexão — e, para uma FeatureRecipe que declara readsTargetRenderFacts, do que as renderizações do destino reportaram. Esta NÃO é a aresta IR bruta — é uma projeção enriquecida construída pelo compilador especificamente para uso em templates. Um template que percorre este mapa vê as conexões em ordem de chave — ordenadas por alias —, não na ordem em que foram escritas.
self_injectobjectsimQuais dos values e provides próprios do componente o desenvolvedor já dotou de um nome de entrega, lido do bloco inject: escrito no próprio componente — o bloco que .inject_raw contém como escrito e que .context.inject contém resolvido. Cada mecanismo que o bloco nomeia (env, file, arg ou um personalizado, como ssm_param) mapeia cada nome que o desenvolvedor escreveu para a chave própria que essa entrada entrega, da mesma forma que .context.uses..inject mapeia os nomes de uma conexão para as chaves que eles leem: ‘provides.’ para uma entrada escrita com from: ; ‘values.’ para uma entrada cujo template value: lê exatamente um dos values próprios do componente e nada mais, sendo a chave de nível superior desse valor, qualquer que seja o texto ou as funções em torno da leitura e por mais fundo que ela leia dentro do valor — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ e ’{{ (default dict .values.config).port }}’ são todos mapeados para ‘values.config’; e uma string vazia para qualquer outra entrada — um literal, um template que lê dois valores, um template que lê algo além dos values, ou um template cuja leitura dos values o texto não atribui a uma única chave de nível superior, como ’{{ index .values “role” }}’, os values lidos por inteiro ou o contexto inteiro passado a uma função. Assim, uma Recipe que entrega um valor próprio sob um nome padrão verifica se alguma entrada já está mapeada para ‘values.’ e, se houver, ignora o seu nome padrão, por exemplo, {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Presente e vazio quando o desenvolvedor não escreveu nenhum bloco; um mecanismo aparece apenas quando o bloco o nomeia, e um template encontra os nomes ordenados, seja qual for a forma como os leia. Lido do texto que o desenvolvedor escreveu, nunca de um valor resolvido.
used_byinbound_edge[]nãoOs componentes que usam este: uma entrada por conexão uses que outro componente estabelece com ele, na ordem em que os componentes que se conectam estão escritos e depois na ordem das próprias entradas uses de cada um. Um componente que se conecta duas vezes aparece duas vezes. Lido apenas por uma FeatureRecipe vinculada ao componente, e apenas nos templates que produzem os próprios recursos da vinculação — seu valuesMapping, workload e artifacts. Está ausente dos templates da própria Recipe do componente, de um injectMapping e do with e do when de uma etapa de pipeline, porque a saída de cada um deles pode ir parar na própria saída renderizada do componente, que permanece a mesma seja quem for que se conecte a ele. Cada entrada é um item de lista em vez de uma chave, de modo que um template que o percorre encontra os chamadores nessa ordem.
render_factsrender_factsnãoO que o provedor que renderizou este componente reportou sobre a saída que emitiu — os fatos de renderização que ele reporta —, indexado por nome de fato. Quais nomes um provedor reporta, e o que cada entrada contém, é o contrato documentado próprio desse provedor. Cada valor é uma lista, mesmo com uma única entrada, de modo que um template sempre a percorre; quando a renderização do componente exigiu mais de uma chamada ao provedor e um nome foi reportado por várias delas, suas listas são unidas em uma só na ordem em que as chamadas foram executadas. Presente em todo template de uma FeatureRecipe vinculada ao componente — seu valuesMapping, workload, artifacts e o with e o when das etapas de pipeline — depois que o componente foi renderizado, e vazio quando seu provedor não reporta nada, de modo que um nome que ninguém reportou é lido como uma lista vazia. Ausente dos templates da própria Recipe do componente e de um injectMapping, que são executados antes de o componente ser renderizado.

Não são permitidas propriedades adicionais.

template-context.context.annotations

Os três contêineres de anotações em cascata do nó atual, separados por origem.

PropriedadeTipoObrigatóriaDescrição
releasemapa de stringnãoStrings de topologia física que descem em cascata das fronteiras da Release.
catalogmapa de stringnãoTraços intrínsecos imutáveis escritos pelo Platform Architect no Domínio 2.
aggregatemapa de stringnãoMetadados cognitivos que descem em cascata dos subsistemas do Aggregate.

Não são permitidas propriedades adicionais.

template-context.context.inject

O pipe de entrega pré-hidratado e interceptado. Começa como um mapa gerado pelo compilador que resolve as chaves inject do desenvolvedor para os valores provides do destino. Modificado no próprio lugar pelos deep merges de injectMapping. No momento em que a Recipe base é renderizada, ele contém as strings físicas totalmente resolvidas.

PropriedadeTipoObrigatóriaDescrição
envmapa de stringnãoEntrega por variáveis de ambiente. As chaves são os nomes das variáveis locais do desenvolvedor, os valores são as strings resolvidas do destino.
filemapa de stringnãoEntrega por montagem de arquivos. As chaves são caminhos de arquivos locais, os valores são as strings resolvidas do destino.
argmapa de stringnãoEntrega por argumentos de linha de comando. As chaves são prefixos de flags, os valores são as strings resolvidas do destino.
allmapa de stringnãoFusão plana pré-calculada dos mecanismos env + file + arg + personalizados. Preenchida após a resolução de uses-inject e recalculada após o mapeamento de inject. Os templates usam {{ toJson .context.inject.all }} para uma serialização universal.
template-context.context.self_inject

Quais dos values e provides próprios do componente o desenvolvedor já dotou de um nome de entrega, lido do bloco inject: escrito no próprio componente — o bloco que .inject_raw contém como escrito e que .context.inject contém resolvido. Cada mecanismo que o bloco nomeia (env, file, arg ou um personalizado, como ssm_param) mapeia cada nome que o desenvolvedor escreveu para a chave própria que essa entrada entrega, da mesma forma que .context.uses..inject mapeia os nomes de uma conexão para as chaves que eles leem: ‘provides.’ para uma entrada escrita com from: ; ‘values.’ para uma entrada cujo template value: lê exatamente um dos values próprios do componente e nada mais, sendo a chave de nível superior desse valor, qualquer que seja o texto ou as funções em torno da leitura e por mais fundo que ela leia dentro do valor — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ e ’{{ (default dict .values.config).port }}’ são todos mapeados para ‘values.config’; e uma string vazia para qualquer outra entrada — um literal, um template que lê dois valores, um template que lê algo além dos values, ou um template cuja leitura dos values o texto não atribui a uma única chave de nível superior, como ’{{ index .values “role” }}’, os values lidos por inteiro ou o contexto inteiro passado a uma função. Assim, uma Recipe que entrega um valor próprio sob um nome padrão verifica se alguma entrada já está mapeada para ‘values.’ e, se houver, ignora o seu nome padrão, por exemplo, {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Presente e vazio quando o desenvolvedor não escreveu nenhum bloco; um mecanismo aparece apenas quando o bloco o nomeia, e um template encontra os nomes ordenados, seja qual for a forma como os leia. Lido do texto que o desenvolvedor escreveu, nunca de um valor resolvido.

PropriedadeTipoObrigatóriaDescrição
envmapa de stringnãoEntrega por variáveis de ambiente: as chaves são os nomes de variáveis do desenvolvedor, os valores são a chave própria que cada entrada entrega.
filemapa de stringnãoEntrega por montagem de arquivos: as chaves são os caminhos de arquivo do desenvolvedor, os valores são a chave própria que cada entrada entrega.
argmapa de stringnãoEntrega por argumentos de linha de comando: as chaves são os prefixos de flag do desenvolvedor, os valores são a chave própria que cada entrada entrega.

template-context.metadata

Metadados da Release e da compilação que fornecem identidade global para nomeação determinística. Disponíveis em todos os blocos de template (valuesMapping, injectMapping, pipeline with).

PropriedadeTipoObrigatóriaDescrição
release_namestringnãoO nome da Release em construção (por exemplo, ‘prod-billing’). Usado por Ops para construir nomes de recursos de nuvem globalmente únicos (buckets S3, papéis IAM). Combinado com .context.instance_id para garantir a unicidade entre ambientes.
release_versionstringnãoA versão semântica da Release.
environmentstringnãoA string de ambiente obtida dos metadados da Release (por exemplo, ‘production’, ‘local’).
aggregate_namestringnãoO nome do Aggregate raiz em compilação.

Não são permitidas propriedades adicionais.

template-context.inject

Preenchido apenas ao renderizar uma FeatureRecipe de vinculação que traz um bloco inject escrito pelo autor (por exemplo, { env: [ { in: ‘OPENAI_API_KEY’, from: ‘api_token’ } ] }). Distinto de .context.inject, que é o pipe de entrega pré-hidratado do componente base a partir das arestas uses. Avalia como null/ausente para vinculações sem inject escrito pelo autor e para Recipes base.

PropriedadeTipoObrigatóriaDescrição
envmapa de stringnãoEntrega por variáveis de ambiente com escopo da vinculação.
filemapa de stringnãoEntrega por montagem de arquivos com escopo da vinculação.
argmapa de stringnãoEntrega por argumentos com escopo da vinculação.
allmapa de stringnãoFusão de conveniência, gerada pelo compilador, de todos os paradigmas de inject da vinculação.

template-context.boundary

Contexto com escopo de fronteira — preenchido apenas ao avaliar um template que uma FeatureRecipe cujo spec.executionScope é ‘boundary’ executa uma vez para a fronteira. FeatureRecipes com escopo de Component não recebem este pilar; os seus context.instance_id, context.inject, context.uses e o pilar .workload trazem em vez disso dados por componente. Os templates de uma FeatureRecipe com escopo de fronteira executados para a fronteira recebem .boundary.* no lugar desses pilares por componente; o seu injectMapping é executado no contexto de cada componente que a vinculação alcança, lê esses pilares por componente e não recebe este.

PropriedadeTipoObrigatóriaDescrição
pathstringnãoO caminho da fronteira da Release à qual a FeatureRecipe está vinculada: os nomes das fronteiras da mais externa para dentro, unidos com ’/’ (por exemplo, ‘bridge’, ‘bridge/frontend’). Ele nomeia a fronteira, não o diretório no qual sua saída é escrita, que o directory: da fronteira define.
assembly_pathstringnãoO diretório, relativo ao diretório de saída do build, no qual a própria saída desta vinculação é montada: o directory: e o subDirectory: avaliados da sua fronteira, o diretório para o qual o build encaminha essa saída (por exemplo, ‘bridge/compose’). Ele é igual ao source_assembly_path ou ao target_assembly_path de uma extremidade de conexão exatamente quando essa extremidade é renderizada no mesmo arquivo montado, de modo que uma FeatureRecipe os compara para distinguir uma conexão dentro do seu próprio arquivo de uma em outro arquivo. Dados opacos; o núcleo não os interpreta.
boundary_namestringnãoO nome da fronteira (a chave do mapa em release.spec.boundaries).
componentsobjectnãoMapa de instance_id para uma entrada para cada componente na subárvore da fronteira (recursivo, inclui os componentes de fronteiras aninhadas). Cada entrada carrega o URI de tipo resolvido do componente, o ID de instância e os valores fornecidos pela avaliação de provides por componente.
internal_uses_edgesobject[]nãoArestas uses em que a origem E o destino estão ambos na subárvore desta fronteira.
outgoing_cross_boundary_uses_edgesobject[]nãoArestas uses cuja origem está na subárvore desta fronteira e cujo destino está fora dela.
incoming_cross_boundary_uses_edgesobject[]nãoArestas uses em que o destino está na subárvore e a origem está fora. Usadas por agregadores do tipo ingress que precisam saber quem está chamando de fora.
cross_boundary_uses_edgesobject[]nãoUnião de conveniência das arestas de saída e de entrada que cruzam a fronteira.
labelsmapa de stringnãoUnião dos rótulos dos componentes na subárvore, com preservação da ordem do autor.
annotationsmapa de stringnãoAs próprias anotações da fronteira depois que a cascata é resolvida.
feature_attachmentstemplate_attachment[]nãoAs vinculações feitas diretamente nesta fronteira (para referências entre vinculações dentro do escopo da fronteira), na mesma forma de vinculação que .features carrega.

Não são permitidas propriedades adicionais.

Definições

inbound_edge

Uma conexão que outro componente estabelece com o componente para o qual uma FeatureRecipe vinculada renderiza: quem se conecta, por qual socket, o que o componente que se conecta publica, e o namespace e a fronteira em que ele está colocado. Cada valor é uma string que o compilador carrega sem interpretá-la.

PropriedadeTipoObrigatóriaDescrição
component_idstringsimO ID de instância achatado do componente que se conecta (por exemplo, ‘frontend’ ou ‘data-layer.etl’) — o valor que um template de caminho subDirectory lê como .component_id, escrito como .context.uses..target escreve a outra extremidade de uma conexão.
socketstringsimA categoria de usesSchema pela qual o componente que se conecta traça esta conexão (por exemplo, ‘databases’, ‘apis’).
providesmapa de stringsimOs provides resolvidos do componente que se conecta, restritos às chaves que o seu Component declara — os mesmos valores que um consumidor desse componente lê em .context.uses..provides. Vazio quando ele não publica nenhum.
source_namespacestringnãoO namespace em que o componente que se conecta está colocado: a anotação aggrega.ai/namespace que a sua própria renderização recebe — as anotações das suas fronteiras, com as anotações da sua própria entrada na Release aplicadas por último, de modo que um componente cuja entrada define ou limpa o namespace carrega a sua própria configuração em vez da configuração da sua fronteira. É o valor que uma FeatureRecipe com escopo de fronteira lê como source_namespace na entrada da mesma conexão nas listas de arestas uses de .boundary. Ausente quando nenhum namespace se aplica ao componente que se conecta; proteja-o com if ou with antes de imprimi-lo.
source_boundary_pathstringnãoO caminho separado por barras da fronteira da Release que contém o componente que se conecta (por exemplo, ‘edge’ ou ‘aws-prod/payments’) — o valor que uma FeatureRecipe com escopo de fronteira lê como source_boundary_path na entrada da mesma conexão nas listas de arestas uses de .boundary.
render_factsrender_factsnãoO que as renderizações do componente que se conecta reportaram sobre a saída que emitiram, indexado por nome de fato: os fatos que as suas próprias chamadas ao provedor reportaram, depois os de cada Feature vinculada a ele que foi renderizada com ele, na ordem em que foram renderizadas, com as listas que um nome recebe de várias delas unidas em uma só nessa ordem. Cada valor é uma lista, mesmo com uma única entrada, de modo que um template sempre a percorre. Presente apenas para uma FeatureRecipe que declara readsCallerRenderFacts — cujas vinculações são renderizadas depois que todos os componentes foram renderizados, de modo que a renderização de cada chamador está completa —, e então em todas as entradas, vazio para um chamador cujos provedores não reportam nada. Ausente para qualquer outra FeatureRecipe.

Não são permitidas propriedades adicionais.

render_facts

Fatos de renderização indexados por nome: o que os provedores que renderizaram um componente reportaram sobre a saída que emitiram. Quais nomes um provedor reporta, e o que cada entrada contém, é o contrato documentado próprio desse provedor; o compilador não aprende nada sobre nenhum dos dois além de que cada valor é uma lista. Uma lista mantém a ordem das suas entradas. Uma entrada de objeto é carregada com as suas chaves na ordem em que o provedor as escreveu, e um template que a percorre as encontra em ordem de chave, como acontece com todo mapa com chaves deste contexto.

Objeto de formato livre; os valores são any[].

template_attachment

Uma vinculação tal como um template a lê: a visão por instância de uma Feature vinculada. Toda vinculação expõe os mesmos campos independentemente do que produz, de modo que .features. é lido da mesma maneira, seja esse nome um slot que a entidade declarou ou uma vinculação livre.

PropriedadeTipoObrigatóriaDescrição
typestringnãoO URI de Feature do catálogo da Feature vinculada.
resolved_versionstringnãoA versão da Feature vinculada após a resolução do Manifest — a versão efetivamente associada para este build, lida como .features..resolved_version. Espelha .context.uses..resolved_version, de modo que uma vinculação e uma aresta reportam uma versão associada da mesma maneira. Vazio quando o tipo da vinculação não se resolve em nenhuma entidade do catálogo.
labelsmapa de stringnãoOs rótulos de catálogo da Feature vinculada, carregados literalmente na ordem em que a Feature os declara — nada é filtrado, renomeado ou despojado de prefixo, de modo que um template lê exatamente o que o autor da Feature escreveu. Permite que um template se ramifique de acordo com o que a Feature vinculada é, e não com o seu nome ou o seu URI. Espelha .context.uses..labels. A chave fica totalmente ausente quando a Feature não declara rótulos e quando o tipo da vinculação não se resolve em nenhuma entidade do catálogo, portanto proteja-a com if ou percorra o mapa antes de acessar um rótulo individual.
valuesobjectnãoO próprio pilar de intenção do desenvolvedor da vinculação, carregado literalmente a partir da declaração da vinculação.
infraobjectnãoO próprio pilar de dimensionamento operacional da vinculação, carregado literalmente a partir da declaração da vinculação.
providesmapa de stringnãoO contrato público resolvido da FeatureRecipe associada a esta vinculação — o nome do recurso emitido, a sua chave, uma identidade e quaisquer chaves produzidas adicionais —, exposto ao consumidor como .features..provides.. O consumidor lê esses valores em vez de derivar novamente a identidade física da vinculação. Uma vinculação cuja FeatureRecipe associada não publica nada não carrega nenhuma chave provides, em vez de um mapa vazio, de modo que um template se protege antes de acessar uma chave individual.

Não são permitidas propriedades adicionais.

enriched_edge

Uma única aresta topológica enriquecida montada pelo compilador. Contém a identidade resolvida do destino, os provides e as anotações em cascata.

PropriedadeTipoObrigatóriaDescrição
targetstringsimO ID absoluto achatado do nó de destino (por exemplo, ‘data-layer.main-db’).
socketstringsimA categoria de usesSchema à qual esta aresta pertence (por exemplo, ‘databases’, ‘apis’).
sourcestringnãoO ID absoluto achatado do nó de origem (consumidor). Preenchido para as visões com escopo de fronteira que indexam as saídas por consumidor pelo nó consumidor.
source_namespacestringnãoAnotação aggrega.ai/namespace bruta da extremidade de origem (vazia quando ausente). Preenchida apenas para as visões com escopo de fronteira, assim como source; a própria entrada .context.uses de um componente a carrega vazia. Dados opacos para a resolução da identidade de rede de um provedor; o núcleo não os interpreta.
source_boundary_pathstringnãoCaminho da fronteira da extremidade de origem: o caminho separado por barras da fronteira da Release que a contém (por exemplo, ‘bridge/frontend’). Preenchido apenas para as visões com escopo de fronteira, assim como source; a própria entrada .context.uses de um componente o carrega vazio.
source_assembly_pathstringnãoCaminho de montagem da extremidade de origem: o diretório, relativo ao diretório de saída do build, no qual a sua saída é montada, composto a partir do directory: e do subDirectory: avaliados da sua fronteira (por exemplo, ‘bridge/compose’). Duas extremidades com o mesmo caminho de montagem são renderizadas em um único arquivo montado, e uma extremidade cujo caminho de montagem é igual a .boundary.assembly_path é renderizada no arquivo no qual a própria saída da FeatureRecipe que o lê é montada. Uma FeatureRecipe com escopo de fronteira que coloca extremidades em redes pode lê-lo como a rede da extremidade de origem quando nenhum aggrega.ai/namespace se aplica. Preenchido apenas para as visões com escopo de fronteira, assim como source; a própria entrada .context.uses de um componente o carrega vazio. Dados opacos; o núcleo não os interpreta.
target_namespacestringnãoAnotação aggrega.ai/namespace bruta da extremidade de destino (vazia quando ausente). Preenchida apenas para as visões com escopo de fronteira, assim como source; a própria entrada .context.uses de um componente a carrega vazia. Dados opacos para a resolução da identidade de rede de um provedor.
target_boundary_pathstringnãoCaminho da fronteira da extremidade de destino: o caminho separado por barras da fronteira da Release que a contém (por exemplo, ‘bridge/backend’). Preenchido apenas para as visões com escopo de fronteira, assim como source; a própria entrada .context.uses de um componente o carrega vazio.
target_assembly_pathstringnãoCaminho de montagem da extremidade de destino: o diretório, relativo ao diretório de saída do build, no qual a sua saída é montada, composto a partir do directory: e do subDirectory: avaliados da sua fronteira (por exemplo, ‘bridge/compose’). Uma extremidade cujo caminho de montagem é igual a .boundary.assembly_path é renderizada no arquivo no qual a própria saída da FeatureRecipe que o lê é montada. Uma FeatureRecipe com escopo de fronteira que coloca extremidades em redes pode lê-lo como a rede da extremidade de destino quando nenhum aggrega.ai/namespace se aplica. Preenchido apenas para as visões com escopo de fronteira, assim como source; a própria entrada .context.uses de um componente o carrega vazio. Dados opacos; o núcleo não os interpreta.
providesmapa de stringsimO dicionário provides totalmente resolvido do nó de destino. Avaliado na avaliação de provides, antes da hidratação de inject.
injectobjectsimO mapeamento inject original do desenvolvedor para esta aresta (chaves = nomes das variáveis locais, valores = chaves provides do destino). Este é o mapeamento BRUTO, não os valores resolvidos.
labelsmapa de stringnãoOs rótulos de duck-typing e de ontologia do nó de destino (após as alterações feitas na construção da topologia).
annotationsobjectnãoOs três contêineres de anotações em cascata do nó de destino.
componentstringnãoO URI do tipo de componente do catálogo do nó de destino (por exemplo, ‘core/postgres’).
resolved_versionstringnãoO SemVer resolvido do nó de destino.
boundary_pathstringnãoA hierarquia espacial física do nó de destino obtida da Release (por exemplo, ‘aws-eks-cluster/backend-ns’).
origin_featurestringnãoSe esta aresta foi declarada de forma autônoma por uma Feature (incluindo Features de credenciais rotuladas com feature.aggrega.ai/kind: secret), o nome de instância da Feature. Null/ausente para arestas declaradas pelo desenvolvedor.
origin_releasebooleanonãoÉ true quando foi a Release que cabeou esta conexão em vez de o Aggregate declará-la. Ausente para uma conexão que o Aggregate declara.
valuesobjectnãoA configuração do desenvolvedor por conexão escrita na entrada uses do Aggregate para esta conexão, carregada literalmente. Ausente quando a conexão não carrega nenhuma. Ela alcança apenas o contexto do nó consumidor, nunca o do destino.
infraobjectnãoA configuração operacional por conexão escrita na entrada uses da Release para esta conexão, carregada literalmente. Ausente quando a conexão não carrega nenhuma. Ela alcança apenas o contexto do nó consumidor, nunca o do destino.
featuresmapa de template_attachmentnãoAs vinculações escritas nesta conexão, indexadas pelo nome de slot que o socket da conexão declara para cada uma, cada uma na forma de vinculação que .features carrega: o seu tipo, a versão resolvida, os rótulos, values, infra e os provides resolvidos da FeatureRecipe associada a ela. Uma Recipe lê a credencial de uma conexão como .context.uses..features..provides., de modo que um consumidor que alcança vários destinos lê a credencial própria de cada destino. Essas vinculações nunca fazem parte dos próprios .features do nó consumidor, de modo que um template que percorre .features para encontrar as vinculações do nó por tipo não encontra as de uma conexão. Percorridos em um template, os slots chegam em ordem de chave. Ausente quando a conexão não carrega nenhuma.
render_factsrender_factsnãoO que as renderizações do destino reportaram sobre a saída que emitiram, indexado por nome de fato, na forma que a entrada de um chamador em .context.used_by carrega: os fatos que as suas próprias chamadas ao provedor reportaram, depois os de cada Feature vinculada a ele que foi renderizada com ele, na ordem em que foram renderizadas, com as listas que um nome recebe de várias delas unidas em uma só nessa ordem. Cada valor é uma lista, mesmo com uma única entrada, de modo que um template sempre a percorre. Presente apenas em .context.uses para uma FeatureRecipe que declara readsTargetRenderFacts — cujas vinculações são renderizadas depois que todos os componentes foram renderizados, de modo que a renderização de cada destino está completa —, e então em todas as entradas, vazio para um destino cujos provedores não reportam nada. Ausente para qualquer outra FeatureRecipe, do with e do when de uma etapa de pipeline, dos templates da própria Recipe do componente e das listas de arestas que uma FeatureRecipe com escopo de fronteira lê.

Não são permitidas propriedades adicionais.

enriched_edge.inject

O mapeamento inject original do desenvolvedor para esta aresta (chaves = nomes das variáveis locais, valores = chaves provides do destino). Este é o mapeamento BRUTO, não os valores resolvidos.

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 arquivos: as chaves são os caminhos de arquivo locais do consumidor, e os valores são as chaves provides do destino.
argmapa de stringnãoEntrega por argumentos de linha de comando: as chaves são os prefixos de flag do consumidor, e os valores são as chaves provides do destino.

enriched_edge.annotations

Os três contêineres de anotações em cascata do nó de destino.

PropriedadeTipoObrigatóriaDescrição
releasemapa de stringnãoStrings de topologia física provenientes das fronteiras da Release do nó de destino.
catalogmapa de stringnãoTraços imutáveis provenientes da entidade do catálogo do nó de destino.
aggregatemapa de stringnãoMetadados cognitivos provenientes dos subsistemas do Aggregate do nó de destino.

Não são permitidas propriedades adicionais.