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 contexto de template 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/template-context-v1beta1.schema.json

A vista que o compilador monta e passa aos templates de Recipe e FeatureRecipe durante a renderização. Ao renderizar uma FeatureRecipe de anexo, o compilador preenche adicionalmente .attachment_name e .inject com o contexto do anexo, .context.render_facts com aquilo que o fornecedor do seu host reportou sobre a renderização do host e, nos templates que produzem os recursos próprios do anexo, .context.used_by com os componentes que usam o seu host. Para uma FeatureRecipe com âmbito de fronteira (spec.executionScope: boundary), os templates que executa uma vez para a fronteira — entre eles os seus locals, provides, source, valuesMapping, artifacts e passos de pipeline — encontram ausentes os pilares .context, .workload, .attachment_name, .inject e .inject_raw e preenchido em seu lugar um pilar .boundary.* — ver o bloco da fronteira no fim das propriedades; o seu injectMapping é executado uma vez para cada componente que o anexo alcança, no contexto desse componente, pelo que lê .context.* e .attachment_name, e .boundary não está definido aí. 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 fase da renderização base, pela ordem em que as fases são executadas:

  • 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 aqui publicados 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 artefactos (artifacts): todos os pilares + .source + .workload (contexto mais completo).

Tipo de nível superior: object

Propriedades

PropriedadeTipoObrigatóriaDescrição
contextobjetosimO contexto de execução montado pelo compilador, que fornece dados de identidade, topologia e entrega.
valuesobjetosimA carga útil cognitiva opaca deste nó, já validada pelo validador de esquema na resolução. Transmitida sem alterações.
infraobjetosimA carga útil de dimensionamento físico injetada a partir da Release para este nó. Contorna totalmente o programador.
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 autossuficiente local ao nó que contém as entradas do mesmo bloco resolvidas até então, pelo 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 a compilação. Uma referência ‘.locals.’ a uma entrada posterior, ou a uma chave que o bloco não declara, provoca uma paragem. A verificação lê o caminho para o qual uma referência SE RESOLVE em vez das teclas premidas, pelo que abrange 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 não abrange: 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. Não é analisada, e uma chave ausente alcançada dessa forma não provoca uma paragem: renderiza o texto literal '' em vez de nada. A única exceção é o próprio ‘index’: em qualquer superfície de template provoca uma paragem, nomeando a chave, quando o mapa que lê não contém a chave pedida, pelo que uma chave ausente alcançada através de ‘index .locals’ provoca uma paragem. 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 através de 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 autossuficiência de provides). Os chamadores resolvem chaves de inject em relação a estes valores.
featuresmapa de template_attachmentnãoCada anexo neste nó, indexado pelo nome de instância que o autor lhe deu. Um único pilar contém todos, seja o que for que produzam — uma Feature operacional, uma Feature de credenciais, uma Feature de identidade — porque o que difere entre anexos é o que produzem, não a forma como um template os lê. Uma Recipe lê-os para adaptar a sua renderização às capacidades anexadas e para consumir aquilo que um anexo publica. Um anexo escrito numa das ligações do nó não está entre eles: é lido sob essa ligação, em .context.uses..features., pelo que um template que percorre este pilar encontra apenas os anexos próprios do nó.
metadataobjetonãoMetadados da Release e da compilação que fornecem uma 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 anexo. Contém o nome de instância do anexo — o slot que 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 anexo, compostos depois do nome do componente host: ’{{ .context.rendered_name }}-{{ .attachment_name | replace ”_” ”-” }}’ quando o fornecedor do host reporta 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 do anexo convertidos em hífenes — e ’{{ .context.instance_id }}-{{ .attachment_name }}’ quando o fornecedor do host não reporta nenhum.
injectobjetonãoPreenchido apenas ao renderizar uma FeatureRecipe de anexo que contém 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 anexos sem inject escrito pelo autor e para Recipes base.
inject_rawobject ou nullnãoA intenção imutável e não mutada do programador para o bloco inject. Cada mecanismo que o bloco indica — 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), pela ordem em que foram escritas, pelo 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 programador omitiu totalmente o bloco inject. Usado por Ops para verificações lógicas (por exemplo, {{ if not .inject_raw }}) para detetar a omissão antes das mutações do mapeamento de inject. Quais os values ou provides próprios do componente que cada entrada entrega lê-se em .context.self_inject, e não a partir do texto das entradas.
stepsmapa de objectnãoComunicação entre passos da pipeline. Disponível apenas dentro dos blocos ‘with:’ de uma pipeline Wasm. Cada chave é o ID de um passo da pipeline, contendo as saídas exportadas por esse passo.
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 a partir do mapeamento de valores (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 aí e em todos os templates avaliados depois dele (omits, workload, artifacts, passos 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 cadeia = 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 a partir da avaliação de artefactos (artifacts), para que os artefactos 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.* num valor null falham com um erro claro no momento da avaliação do template.
boundaryobjetonãoContexto com âmbito de fronteira — preenchido apenas ao avaliar um template que uma FeatureRecipe cujo spec.executionScope é ‘boundary’ executa uma vez para a fronteira. As FeatureRecipes com âmbito de Component não recebem este pilar; os seus context.instance_id, context.inject, context.uses e o pilar .workload contêm em vez disso dados por componente. Os templates de uma FeatureRecipe com âmbito de fronteira executados para a fronteira recebem .boundary.* em vez desses pilares por componente; o seu injectMapping é executado no contexto de cada componente que o anexo 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 o 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 fornecedor deriva um nome — um conjunto de artefactos colocado a partir da Recipe, e um workload sintetizado por um fornecedor que lhe dá o nome da identidade —, pelo que um endereço publicado para um deles é construído a partir deste valor.
rendered_namestringnãoO nome que o fornecedor associado a este nó dá aos recursos que renderiza para o nó — para uma origem fornecida pelo autor, o nome face ao qual os próprios templates fornecidos são renderizados, como o nome de release que um chart lê; para um workload que sintetiza, o nome que dá aos recursos desse workload quando deriva um em vez de escrever a identidade do nó, como faz o fornecedor helm com o mesmo nome de release. Deve ler-se sempre que esta Recipe nomeia um recurso que um chart ou um módulo fornecido declarou ou que um fornecedor desse tipo sintetizou, seja numa entrada de provides, num valuesMapping, num workload, numa entrada de artifacts ou no with ou no when de um passo de pipeline, porque o fornecedor pode escrever esse nome num alfabeto mais pobre do que aquele em que é escrito um nome de componente escrito por um autor, e então os dois diferem. Vazio quando o fornecedor associado não deriva nenhum nome desse tipo: os recursos de um conjunto de artefactos colocado, e de um workload sintetizado por um fornecedor que lhe dá o nome da identidade, transportam a identidade do nó, pelo que para esses se lê ’{{ .context.instance_id }}’, e uma Recipe que escreveu os seus próprios nomes de recursos já os conhece. Ler esta chave onde o fornecedor associado não reporta nenhum nome interrompe a compilação e indica o que escrever em seu lugar. A recusa abrange os templates que uma Recipe escreve inline; um valuesMapping, um workload ou uma entrada de artifacts fornecidos através de ‘$import’ só são resolvidos quando a renderização os alcança, pelo que uma referência dentro de um deles é renderizada como um valor vazio em vez de interromper a compilação. Nos templates de uma FeatureRecipe associada ao anexo de um componente, é o nome do componente HOST tal como o próprio fornecedor do host o reporta — o valor que a própria Recipe do host lê, tal como instance_id é aí a identidade do host —, pelo que um anexo o usa para dar a um recurso o nome do seu host e obtém um nome que a plataforma do host aceita. Quando o fornecedor do host não reporta nenhum nome, é vazio, e lê-lo a partir de um template inline do anexo que não seja o seu injectMapping interrompe a compilação; aí deve ler-se antes ’{{ .context.instance_id }}’.
labelsmapa de stringnãoAs etiquetas de duck-typing e de ontologia do nó atual, incluindo qualquer alteração que um plugin de governação anexado no papel label-transform tenha feito na construção da topologia.
annotationsobjetonãoOs três contentores de anotações em cascata do nó atual, separados por origem.
injectobjetosimO pipe de entrega pré-hidratado e intercetado. Começa como um mapa gerado pelo compilador que resolve as chaves inject do programador para os valores provides do destino. Modificado no próprio local pelos deep merges de injectMapping. No momento em que a Recipe base é renderizada, contém as cadeias físicas totalmente resolvidas.
usesmapa de enriched_edgesimO mapa enriquecido de arestas topológicas. Indexado pelo alias do programador (por exemplo, ‘my_db’, ‘my_api’). Cada entrada é uma vista montada pelo compilador da identidade do nó de destino, dos provides resolvidos, do mapeamento de injeção e das anotações em cascata, e dos anexos escritos nessa ligação — e, para uma FeatureRecipe que declara readsTargetRenderFacts, daquilo que as renderizações do destino reportaram. Esta NÃO é a aresta IR em bruto — é uma projeção enriquecida construída pelo compilador especificamente para utilização em templates. Um template que percorre este mapa vê as ligações por ordem de chave — ordenadas por alias —, não pela ordem em que foram escritas.
self_injectobjetosimQuais dos values e provides próprios do componente o programador já dotou de um nome de entrega, lido do bloco inject: escrito no próprio componente — o bloco que .inject_raw contém tal como escrito e que .context.inject contém resolvido. Cada mecanismo que o bloco indica (env, file, arg ou um personalizado, como ssm_param) faz corresponder cada nome que o programador escreveu à chave própria que essa entrada entrega, tal como .context.uses..inject faz corresponder os nomes de uma ligação às chaves que estes 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, independentemente do texto ou das funções que rodeiem a leitura e da profundidade a que esta lê dentro do valor — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ e ’{{ (default dict .values.config).port }}’ correspondem todos a ‘values.config’; e uma cadeia 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 na íntegra ou o contexto inteiro passado a uma função. Assim, uma Recipe que entrega um valor próprio sob um nome predefinido verifica se alguma entrada já corresponde a ‘values.’ e, se for o caso, ignora o seu nome predefinido, por exemplo, {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Presente e vazio quando o programador não escreveu nenhum bloco; um mecanismo só aparece quando o bloco o indica, e um template encontra os nomes ordenados, seja qual for a forma como os leia. Lido a partir do texto que o programador escreveu, nunca de um valor resolvido.
used_byinbound_edge[]nãoOs componentes que usam este: uma entrada por cada ligação uses que outro componente estabelece com ele, pela ordem em que os componentes que se ligam estão escritos e depois pela ordem das próprias entradas uses de cada um. Um componente que se liga duas vezes aparece duas vezes. Lido apenas por uma FeatureRecipe anexada ao componente, e apenas nos templates que produzem os próprios recursos do anexo — 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 um passo de pipeline, porque a saída de cada um deles pode acabar na própria saída renderizada do componente, que permanece a mesma independentemente de quem se ligue a ele. Cada entrada é um item de lista em vez de uma chave, pelo que um template que o percorre encontra os chamadores por essa ordem.
render_factsrender_factsnãoAquilo que o fornecedor que renderizou este componente reportou sobre a saída que emitiu — os factos de renderização que reporta —, indexado por nome de facto. Que nomes um fornecedor reporta, e o que cada entrada contém, é o contrato documentado próprio desse fornecedor. Cada valor é uma lista, mesmo com uma única entrada, pelo que um template a percorre sempre; quando a renderização do componente exigiu mais de uma chamada ao fornecedor e um nome foi reportado por várias delas, as suas listas são unidas numa só pela ordem em que as chamadas foram executadas. Presente em todos os templates de uma FeatureRecipe anexada ao componente — o seu valuesMapping, workload, artifacts e o with e o when dos passos de pipeline — depois de o componente ter sido renderizado, e vazio quando o seu fornecedor não reporta nada, pelo que um nome que ninguém reportou se lê 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 ter sido renderizado.

Não são permitidas propriedades adicionais.

template-context.context.annotations

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

PropriedadeTipoObrigatóriaDescrição
releasemapa de stringnãoCadeias 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 intercetado. Começa como um mapa gerado pelo compilador que resolve as chaves inject do programador para os valores provides do destino. Modificado no próprio local pelos deep merges de injectMapping. No momento em que a Recipe base é renderizada, contém as cadeias 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 programador, os valores são as cadeias resolvidas do destino.
filemapa de stringnãoEntrega por montagem de ficheiros. As chaves são caminhos de ficheiros locais, os valores são as cadeias resolvidas do destino.
argmapa de stringnãoEntrega por argumentos de linha de comandos. As chaves são prefixos de flags, os valores são as cadeias 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 programador já dotou de um nome de entrega, lido do bloco inject: escrito no próprio componente — o bloco que .inject_raw contém tal como escrito e que .context.inject contém resolvido. Cada mecanismo que o bloco indica (env, file, arg ou um personalizado, como ssm_param) faz corresponder cada nome que o programador escreveu à chave própria que essa entrada entrega, tal como .context.uses..inject faz corresponder os nomes de uma ligação às chaves que estes 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, independentemente do texto ou das funções que rodeiem a leitura e da profundidade a que esta lê dentro do valor — ’{{ .values.config.port }}’, ’{{ index .values.config “port” }}’ e ’{{ (default dict .values.config).port }}’ correspondem todos a ‘values.config’; e uma cadeia 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 na íntegra ou o contexto inteiro passado a uma função. Assim, uma Recipe que entrega um valor próprio sob um nome predefinido verifica se alguma entrada já corresponde a ‘values.’ e, se for o caso, ignora o seu nome predefinido, por exemplo, {{ range $name, $key := .context.self_inject.env }}{{ if eq $key “values.role” }}…{{ end }}{{ end }}. Presente e vazio quando o programador não escreveu nenhum bloco; um mecanismo só aparece quando o bloco o indica, e um template encontra os nomes ordenados, seja qual for a forma como os leia. Lido a partir do texto que o programador 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 programador, os valores são a chave própria que cada entrada entrega.
filemapa de stringnãoEntrega por montagem de ficheiros: as chaves são os caminhos de ficheiro do programador, os valores são a chave própria que cada entrada entrega.
argmapa de stringnãoEntrega por argumentos da linha de comandos: as chaves são os prefixos de flag do programador, os valores são a chave própria que cada entrada entrega.

template-context.metadata

Metadados da Release e da compilação que fornecem uma 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 compilação (por exemplo, ‘prod-billing’). Usado por Ops para construir nomes de recursos na nuvem globalmente únicos (buckets S3, funções IAM). Combinado com .context.instance_id para garantir a unicidade entre ambientes.
release_versionstringnãoA versão semântica da Release.
environmentstringnãoA cadeia 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 anexo que contém 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 anexos sem inject escrito pelo autor e para Recipes base.

PropriedadeTipoObrigatóriaDescrição
envmapa de stringnãoEntrega por variáveis de ambiente com âmbito do anexo.
filemapa de stringnãoEntrega por montagem de ficheiros com âmbito do anexo.
argmapa de stringnãoEntrega por argumentos com âmbito do anexo.
allmapa de stringnãoFusão de conveniência, gerada pelo compilador, de todos os paradigmas de inject do anexo.

template-context.boundary

Contexto com âmbito de fronteira — preenchido apenas ao avaliar um template que uma FeatureRecipe cujo spec.executionScope é ‘boundary’ executa uma vez para a fronteira. As FeatureRecipes com âmbito de Component não recebem este pilar; os seus context.instance_id, context.inject, context.uses e o pilar .workload contêm em vez disso dados por componente. Os templates de uma FeatureRecipe com âmbito de fronteira executados para a fronteira recebem .boundary.* em vez desses pilares por componente; o seu injectMapping é executado no contexto de cada componente que o anexo 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á anexada: os nomes das fronteiras da mais externa para dentro, unidos com ’/’ (por exemplo, ‘bridge’, ‘bridge/frontend’). Nomeia a fronteira, não o diretório no qual a sua saída é escrita, que o directory: da fronteira define.
assembly_pathstringnãoO diretório, relativo ao diretório de saída da compilação, no qual a própria saída deste anexo é montada: o directory: e o subDirectory: avaliados da sua fronteira, o diretório para o qual a compilação encaminha essa saída (por exemplo, ‘bridge/compose’). É igual ao source_assembly_path ou ao target_assembly_path de uma extremidade de ligação exatamente quando essa extremidade é renderizada no mesmo ficheiro montado, pelo que uma FeatureRecipe os compara para distinguir uma ligação dentro do seu próprio ficheiro de uma noutro ficheiro. Dados opacos; o núcleo não os interpreta.
boundary_namestringnãoO nome da fronteira (a chave do mapa em release.spec.boundaries).
componentsobjetonãoMapa de instance_id para uma entrada por cada componente na subárvore da fronteira (recursivo, inclui os componentes de fronteiras aninhadas). Cada entrada transporta 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 de saber quem está a chamar de fora.
cross_boundary_uses_edgesobject[]nãoUnião de conveniência das arestas de saída e de entrada que atravessam a fronteira.
labelsmapa de stringnãoUnião das etiquetas dos componentes na subárvore, com preservação da ordem do autor.
annotationsmapa de stringnãoAs próprias anotações da fronteira depois de a cascata ser resolvida.
feature_attachmentstemplate_attachment[]nãoOs anexos feitos diretamente nesta fronteira (para referências entre anexos dentro do âmbito da fronteira), na mesma forma de anexo que .features transporta.

Não são permitidas propriedades adicionais.

Definições

inbound_edge

Uma ligação que outro componente estabelece com o componente para o qual uma FeatureRecipe anexada renderiza: quem se liga, por que socket, o que o componente que se liga publica, e o namespace e a fronteira em que está colocado. Cada valor é uma cadeia que o compilador transporta sem a interpretar.

PropriedadeTipoObrigatóriaDescrição
component_idstringsimO ID de instância achatado do componente que se liga (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 ligação.
socketstringsimA categoria de usesSchema através da qual o componente que se liga traça esta ligação (por exemplo, ‘databases’, ‘apis’).
providesmapa de stringsimOs provides resolvidos do componente que se liga, restringidos às chaves que o seu Component declara — os mesmos valores que um consumidor desse componente lê em .context.uses..provides. Vazio quando não publica nenhum.
source_namespacestringnãoO namespace em que o componente que se liga 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 em último lugar, pelo que um componente cuja entrada define ou limpa o namespace transporta a sua própria definição em vez da da sua fronteira. É o valor que uma FeatureRecipe com âmbito de fronteira lê como source_namespace na entrada da mesma ligação nas listas de arestas uses de .boundary. Ausente quando nenhum namespace se aplica ao componente que se liga; deve proteger-se com if ou with antes de o imprimir.
source_boundary_pathstringnãoO caminho separado por barras da fronteira da Release que contém o componente que se liga (por exemplo, ‘edge’ ou ‘aws-prod/payments’) — o valor que uma FeatureRecipe com âmbito de fronteira lê como source_boundary_path na entrada da mesma ligação nas listas de arestas uses de .boundary.
render_factsrender_factsnãoAquilo que as renderizações do componente que se liga reportaram sobre a saída que emitiram, indexado por nome de facto: os factos que as suas próprias chamadas ao fornecedor reportaram, depois os de cada Feature anexada a ele que foi renderizada com ele, pela ordem em que foram renderizadas, com as listas que um nome recebe de várias delas unidas numa só por essa ordem. Cada valor é uma lista, mesmo com uma única entrada, pelo que um template a percorre sempre. Presente apenas para uma FeatureRecipe que declara readsCallerRenderFacts — cujos anexos são renderizados depois de todos os componentes terem sido renderizados, pelo que a renderização de cada chamador está completa —, e então em todas as entradas, vazio para um chamador cujos fornecedores não reportam nada. Ausente para qualquer outra FeatureRecipe.

Não são permitidas propriedades adicionais.

render_facts

Factos de renderização indexados por nome: aquilo que os fornecedores que renderizaram um componente reportaram sobre a saída que emitiram. Que nomes um fornecedor reporta, e o que cada entrada contém, é o contrato documentado próprio desse fornecedor; 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 é transportada com as suas chaves pela ordem em que o fornecedor as escreveu, e um template que a percorre encontra-as por ordem de chave, tal como acontece com todos os mapas com chaves deste contexto.

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

template_attachment

Um anexo tal como um template o lê: a vista por instância de uma Feature anexada. Todos os anexos expõem os mesmos campos independentemente do que produzem, pelo que .features. se lê da mesma forma, quer esse nome seja um slot que a entidade declarou, quer seja um anexo livre.

PropriedadeTipoObrigatóriaDescrição
typestringnãoO URI de Feature do catálogo da Feature anexada.
resolved_versionstringnãoA versão da Feature anexada após a resolução do Manifest — a versão efetivamente associada para esta compilação, lida como .features..resolved_version. Espelha .context.uses..resolved_version, pelo que um anexo e uma aresta reportam uma versão associada da mesma forma. Vazio quando o tipo do anexo não se resolve em nenhuma entidade do catálogo.
labelsmapa de stringnãoAs etiquetas de catálogo da Feature anexada, transportadas literalmente pela ordem em que a Feature as declara — nada é filtrado, renomeado ou despojado de prefixo, pelo que um template lê exatamente o que o autor da Feature escreveu. Permite que um template se ramifique consoante aquilo que a Feature anexada é, e não consoante o seu nome ou o seu URI. Espelha .context.uses..labels. A chave fica totalmente ausente quando a Feature não declara etiquetas e quando o tipo do anexo não se resolve em nenhuma entidade do catálogo, pelo que deve proteger-se com if ou percorrer-se o mapa antes de aceder a uma etiqueta individual.
valuesobjetonãoO próprio pilar de intenção do programador do anexo, transportado literalmente a partir da declaração do anexo.
infraobjetonãoO próprio pilar de dimensionamento operacional do anexo, transportado literalmente a partir da declaração do anexo.
providesmapa de stringnãoO contrato público resolvido da FeatureRecipe associada a este anexo — o nome do recurso emitido, a sua chave, uma identidade e quaisquer chaves produzidas adicionais —, exposto ao consumidor como .features..provides.. O consumidor lê estes valores em vez de derivar novamente a identidade física do anexo. Um anexo cuja FeatureRecipe associada não publica nada não transporta nenhuma chave provides, em vez de um mapa vazio, pelo que um template se protege antes de aceder a 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 vistas com âmbito de fronteira que indexam as saídas por consumidor pelo nó consumidor.
source_namespacestringnãoAnotação aggrega.ai/namespace em bruto da extremidade de origem (vazia quando ausente). Preenchida apenas para as vistas com âmbito de fronteira, tal como source; a própria entrada .context.uses de um componente transporta-a vazia. Dados opacos para a resolução da identidade de rede por um fornecedor; 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 vistas com âmbito de fronteira, tal como source; a própria entrada .context.uses de um componente transporta-o vazio.
source_assembly_pathstringnãoCaminho de montagem da extremidade de origem: o diretório, relativo ao diretório de saída da compilação, 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 num único ficheiro montado, e uma extremidade cujo caminho de montagem é igual a .boundary.assembly_path é renderizada no ficheiro no qual é montada a própria saída da FeatureRecipe que o lê. Uma FeatureRecipe com âmbito 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 vistas com âmbito de fronteira, tal como source; a própria entrada .context.uses de um componente transporta-o vazio. Dados opacos; o núcleo não os interpreta.
target_namespacestringnãoAnotação aggrega.ai/namespace em bruto da extremidade de destino (vazia quando ausente). Preenchida apenas para as vistas com âmbito de fronteira, tal como source; a própria entrada .context.uses de um componente transporta-a vazia. Dados opacos para a resolução da identidade de rede por um fornecedor.
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 vistas com âmbito de fronteira, tal como source; a própria entrada .context.uses de um componente transporta-o vazio.
target_assembly_pathstringnãoCaminho de montagem da extremidade de destino: o diretório, relativo ao diretório de saída da compilação, 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 ficheiro no qual é montada a própria saída da FeatureRecipe que o lê. Uma FeatureRecipe com âmbito 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 vistas com âmbito de fronteira, tal como source; a própria entrada .context.uses de um componente transporta-o 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.
injectobjetosimO mapeamento inject original do programador para esta aresta (chaves = nomes das variáveis locais, valores = chaves provides do destino). Este é o mapeamento EM BRUTO, não os valores resolvidos.
labelsmapa de stringnãoAs etiquetas de duck-typing e de ontologia do nó de destino (após as alterações feitas na construção da topologia).
annotationsobjetonãoOs três contentores 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 etiquetadas com feature.aggrega.ai/kind: secret), o nome de instância da Feature. Null/ausente para arestas declaradas pelo programador.
origin_releasebooleananãoÉ true quando foi a Release a estabelecer esta ligação em vez de ser o Aggregate a declará-la. Ausente para uma ligação que o Aggregate declara.
valuesobjetonãoA configuração do programador por ligação escrita na entrada uses do Aggregate para esta ligação, transportada literalmente. Ausente quando a ligação não transporta nenhuma. Chega apenas ao contexto do nó consumidor, nunca ao do destino.
infraobjetonãoA configuração operacional por ligação escrita na entrada uses da Release para esta ligação, transportada literalmente. Ausente quando a ligação não transporta nenhuma. Chega apenas ao contexto do nó consumidor, nunca ao do destino.
featuresmapa de template_attachmentnãoOs anexos escritos nesta ligação, indexados pelo nome de slot que o socket da ligação declara para cada um, cada um na forma de anexo que .features transporta: o seu tipo, a versão resolvida, as etiquetas, values, infra e os provides resolvidos da FeatureRecipe associada a ele. Uma Recipe lê a credencial de uma ligação como .context.uses..features..provides., pelo que um consumidor que alcança vários destinos lê a credencial própria de cada destino. Estes anexos nunca fazem parte dos próprios .features do nó consumidor, pelo que um template que percorre .features para encontrar os anexos do nó por tipo não encontra os de uma ligação. Percorridos num template, os slots chegam por ordem de chave. Ausente quando a ligação não transporta nenhum.
render_factsrender_factsnãoAquilo que as renderizações do destino reportaram sobre a saída que emitiram, indexado por nome de facto, na forma que a entrada de um chamador em .context.used_by transporta: os factos que as suas próprias chamadas ao fornecedor reportaram, depois os de cada Feature anexada a ele que foi renderizada com ele, pela ordem em que foram renderizadas, com as listas que um nome recebe de várias delas unidas numa só por essa ordem. Cada valor é uma lista, mesmo com uma única entrada, pelo que um template a percorre sempre. Presente apenas em .context.uses para uma FeatureRecipe que declara readsTargetRenderFacts — cujos anexos são renderizados depois de todos os componentes terem sido renderizados, pelo que a renderização de cada destino está completa —, e então em todas as entradas, vazio para um destino cujos fornecedores não reportam nada. Ausente para qualquer outra FeatureRecipe, do with e do when de um passo de pipeline, dos templates da própria Recipe do componente e das listas de arestas que uma FeatureRecipe com âmbito de fronteira lê.

Não são permitidas propriedades adicionais.

enriched_edge.inject

O mapeamento inject original do programador para esta aresta (chaves = nomes das variáveis locais, valores = chaves provides do destino). Este é o mapeamento EM 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 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.

enriched_edge.annotations

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

PropriedadeTipoObrigatóriaDescrição
releasemapa de stringnãoCadeias 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.