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

As formas de transmissão que um plugin de governança vinculado em um papel de veredito consome — PolicyInput no papel ir-verdict, RenderPolicyInput no papel render-verdict — e emite (PolicyOutput). Um veredito de severidade halt interrompe o build com um diagnóstico em tempo de build; um veredito warn ou info é informado e o build continua. 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, de modo que o plugin de política vê o mesmo detalhe de nós, arestas e vinculações que o compilador; os autores de plugins acompanham a versão do esquema IR. A entrada da fase de renderização carrega os arquivos 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, de modo que as três linguagens leem e escrevem o mesmo formato de transmissão; um guest os importa desses pacotes, ou por meio 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 roteamento pré-calculados que o analisador enumera junto 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 vinculações em vez de sobre uma projeção estreita.
precalculated_pathsPrecalculatedPath[]simCaminhos de roteamento que o analisador enumerou previamente para que as políticas possam raciocinar sobre a alcançabilidade sem percorrer o grafo novamente.
sourcesPolicySource[]nãoArquivos 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 a vinculação não declara nenhuma origem.
settingsobjectnãoUm objeto de configurações de formato livre que o host entrega literalmente ao plugin. O host não analisa o seu conteúdo nem age com base nele. Ausente quando a vinculação não declara configurações.

Não são permitidas propriedades adicionais.

PolicyOutput

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

PropriedadeTipoObrigatóriaDescrição
resultsDiagnostic[]simOs vereditos disparados, um diagnóstico cada, na ordem em que o plugin os emite. Vazio quando nenhum veredito 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. Ela é distinta de quaisquer diagnósticos que a saída carregue: os diagnósticos informam problemas encontrados durante uma execução que ainda assim produziu um resultado, enquanto error informa que a própria operação não foi concluída. O host apresenta um erro presente como uma invocação de plugin com falha.

Não são permitidas propriedades adicionais.

RenderPolicyInput

O payload que um plugin de governança vinculado no papel render-verdict recebe: os arquivos de saída renderizados sobre os quais a política raciocina, no lugar do grafo IR.

PropriedadeTipoObrigatóriaDescrição
artifactsRenderedArtifact[]simOs arquivos 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ãoArquivos 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 a vinculação não declara nenhuma origem.
settingsobjectnãoUm objeto de configurações de formato livre que o host entrega literalmente ao plugin. O host não analisa o seu conteúdo nem age com base nele. Ausente quando a vinculação não declara configurações.

Não são permitidas propriedades adicionais.

RenderedArtifact

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

PropriedadeTipoObrigatóriaDescrição
pathstringsimO caminho de saída do arquivo renderizado, relativo à raiz de renderização.
contentstringsimO conteúdo renderizado neste caminho.
treeanynãoA árvore estruturada analisada deste artefato, presente quando o host analisou o conteúdo antes de entregá-lo ao plugin — a visão JSON canônica de um formato de origem que o plugin não lê nativamente (um artefato 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 artefato, caso em que o plugin lê diretamente o conteúdo nativo. O host repassa a árvore de forma opaca, carregando-a literalmente sem interpretar o seu conteúdo.
formatstringnãoO formato em que o artefato foi renderizado, presente quando o provedor que o produziu o declarou. Ausente quando o provedor que o produziu não declarou nenhum formato.

Não são permitidas propriedades adicionais.

PolicySource

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

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

Não são permitidas propriedades adicionais.

PrecalculatedPath

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

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 vinculados a qualquer nó ao longo do caminho. Semântica de pertencimento a um conjunto: uma Feature aparece uma única vez mesmo que vários nós a carreguem. Vazia quando nenhum nó ao longo do caminho carrega nenhuma vinculação de Feature.

Não são permitidas propriedades adicionais.