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 socket Wasm de políticas 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/wasm-policy-v1beta1.schema.json

As formas de transmissão que um plugin de governação anexado num papel de veredicto consome — PolicyInput no papel ir-verdict, RenderPolicyInput no papel render-verdict — e emite (PolicyOutput). Um veredicto de severidade halt para o build com um diagnóstico em tempo de build; um veredicto warn ou info é reportado e o build prossegue. O grafo de entrada da fase IR é o grafo IR completo, agnóstico em relação às capacidades, referenciado a partir de ir-v1beta1.schema.json em vez de declarado novamente aqui, pelo que o plugin de política vê o mesmo detalhe de nós, arestas e anexos que o compilador; os autores de plugins acompanham a versão do esquema IR. A entrada da fase de renderização transporta os ficheiros de saída renderizados em vez do grafo. Os tipos de payload de Go, Rust e TypeScript são gerados a partir deste esquema nos pacotes da ABI de plugins, pelo que as três linguagens leem e escrevem o mesmo formato de transmissão; um guest importa-os desses pacotes, ou através do seu kit de plugins quando o kit os reexporta.

Uma das seguintes formas

  • PolicyInput
  • RenderPolicyInput
  • PolicyOutput

Definições

PolicyInput

O payload que a análise estática entrega ao socket de política: o grafo IR completo (a mesma forma que o Topology Builder emite) mais os caminhos de encaminhamento pré-calculados que o analisador enumera juntamente com ele.

PropriedadeTipoObrigatóriaDescrição
graphIRGraphsimO grafo IR completo, agnóstico em relação às capacidades, com fonte única em ir-v1beta1.schema.json. O plugin de política raciocina sobre o detalhe completo de nós, arestas e anexos em vez de sobre uma projeção estreita.
precalculated_pathsPrecalculatedPath[]simCaminhos de encaminhamento que o analisador enumerou previamente para que as políticas possam raciocinar sobre a alcançabilidade sem voltar a percorrer o grafo.
sourcesPolicySource[]nãoFicheiros de definição que o host lê em tempo de compilação e entrega ao plugin literalmente, como uma lista ordenada por caminho. O host lê os bytes como conteúdo opaco e não os analisa. Ausente quando o anexo não declara nenhuma origem.
settingsobjetonãoUm objeto de definições de forma livre que o host entrega literalmente ao plugin. O host não analisa o seu conteúdo nem age com base nele. Ausente quando o anexo não declara definições.

Não são permitidas propriedades adicionais.

PolicyOutput

A forma de resposta que o plugin de política emite: os veredictos disparados durante a avaliação, um diagnóstico por cada veredicto disparado. Uma regra que permite não emite nada, pelo que um array results vazio significa que nenhum veredicto foi disparado.

PropriedadeTipoObrigatóriaDescrição
resultsDiagnostic[]simOs veredictos disparados, um diagnóstico cada, pela ordem em que o plugin os emite. Vazio quando nenhum veredicto foi disparado.
errorstringnãoUma mensagem de falha definida quando o guest foi executado, mas não conseguiu concluir a operação; ausente em caso de sucesso. É distinta de quaisquer diagnósticos que a saída transporte: os diagnósticos reportam problemas encontrados durante uma execução que ainda assim produziu um resultado, enquanto error reporta que a própria operação não foi concluída. O host apresenta um erro presente como uma invocação de plugin falhada.

Não são permitidas propriedades adicionais.

RenderPolicyInput

O payload que um plugin de governação anexado no papel render-verdict recebe: os ficheiros de saída renderizados sobre os quais a política raciocina, em lugar do grafo IR.

PropriedadeTipoObrigatóriaDescrição
artifactsRenderedArtifact[]simOs ficheiros de saída renderizados sobre os quais a política raciocina, como uma lista ordenada por caminho para que o formato de transmissão seja idêntico byte a byte entre execuções com entrada idêntica.
sourcesPolicySource[]nãoFicheiros de definição que o host lê em tempo de compilação e entrega ao plugin literalmente, como uma lista ordenada por caminho. O host lê os bytes como conteúdo opaco e não os analisa. Ausente quando o anexo não declara nenhuma origem.
settingsobjetonãoUm objeto de definições de forma livre que o host entrega literalmente ao plugin. O host não analisa o seu conteúdo nem age com base nele. Ausente quando o anexo não declara definições.

Não são permitidas propriedades adicionais.

RenderedArtifact

Um ficheiro de saída renderizado: o seu caminho e o conteúdo renderizado nesse caminho.

PropriedadeTipoObrigatóriaDescrição
pathstringsimO caminho de saída do ficheiro renderizado, relativo à raiz de renderização.
contentstringsimO conteúdo renderizado neste caminho.
treeanynãoA árvore estruturada analisada deste artefacto, presente quando o host analisou o conteúdo antes de o entregar ao plugin — a vista JSON canónica de um formato de origem que o plugin não lê nativamente (um artefacto HCL analisado para JSON, por exemplo). O nível superior pode ser um objeto, um array ou um escalar, correspondendo à forma própria do documento analisado. Ausente quando o host não analisou o artefacto, caso em que o plugin lê diretamente o conteúdo nativo. O host passa a árvore de forma opaca, transportando-a literalmente sem interpretar o seu conteúdo.
formatstringnãoO formato em que o artefacto foi renderizado, presente quando o fornecedor que o produziu o declarou. Ausente quando o fornecedor que o produziu não declarou nenhum formato.

Não são permitidas propriedades adicionais.

PolicySource

Um ficheiro de definição entregue ao plugin: o seu caminho de nome base e o conteúdo do ficheiro. Ambos são transportados literalmente; o host não analisa o conteúdo.

PropriedadeTipoObrigatóriaDescrição
pathstringsimO nome base do ficheiro de origem. O host fornece apenas o nome base, nunca um caminho absoluto do host, pelo que o formato de transmissão é portável e determinístico.
contentstringsimO conteúdo do ficheiro de origem, transportado literalmente como uma cadeia opaca.

Não são permitidas propriedades adicionais.

PrecalculatedPath

Um caminho de encaminhamento enumerado previamente que o analisador materializa para que as regras de política possam raciocinar sobre a alcançabilidade sem voltar a percorrer o grafo.

PropriedadeTipoObrigatóriaDescrição
path_idstringsimIdentificador estável deste caminho; determinístico entre execuções com entrada idêntica.
nodesstring[]simSequência ordenada dos IDs de nó que o caminho percorre, da origem ao terminal.
attached_featuresstring[]simUnião, ordenada alfabeticamente, dos URIs de tipo de Feature anexados a qualquer nó ao longo do caminho. Semântica de pertença a um conjunto: uma Feature aparece uma única vez mesmo que vários nós a transportem. Vazia quando nenhum nó ao longo do caminho transporta nenhum anexo de Feature.

Não são permitidas propriedades adicionais.