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 passo de pipeline de FeatureRecipe 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-frp-step-v1beta1.schema.json

As formas de transmissão que um socket de plugin de passo de pipeline feature-recipe consome (FRPStepInput) e emite (FRPStepOutput). Um passo FRP é executado para cada entrada de pipeline inline declarada numa Recipe ou FeatureRecipe: o host entrega ao passo o conjunto de documentos indexado por chave completo, o passo seleciona pelo conteúdo os documentos que visa e devolve patches RFC 6902 endereçados por chave, juntamente com efeitos secundários e diagnósticos. Este é um contrato de guest distinto do papel label-transform, que é executado uma única vez sobre todo o grafo de topologia e devolve patches de etiquetas opacos. 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

  • FRPStepInput
  • FRPStepOutput

Definições

FRPStepInput

O payload que um guest de pipeline feature-recipe recebe para um passo de pipeline: o conjunto de documentos indexado por chave que o host entrega completo, a entrada local ao passo que a Recipe declarou para este passo, o contexto do momento da renderização, a posição do passo no pipeline e um registo dos passos que já foram executados.

PropriedadeTipoObrigatóriaDescrição
documentsDocumentSetsimO conjunto indexado por chave, enraizado num âmbito, de unidades endereçáveis que um guest de pipeline recebe como a sua superfície de entrada. O host entrega o conjunto inteiro e não interpreta o seu conteúdo; o guest seleciona pelo conteúdo os documentos que visa e endereça os seus patches por chave.
step_inputobjetonãoO bloco with renderizado do passo, um conjunto de chaves pela ordem do autor que o guest lê como a sua entrada local ao passo. Preserva a ordem do autor para que o payload seja idêntico byte a byte entre execuções com entrada idêntica.
contextobjetosimO contexto do momento da renderização que o host entrega ao passo, transportado como os bytes do seu documento JSON; este esquema deixa o objeto não declarado, e o host não lê nada de volta dele. Um passo de uma Recipe ou de uma FeatureRecipe com âmbito de componente recebe parameters, os valores de parâmetros da Release ordenados por nome e ausentes quando não há nenhum; annotations, as anotações do nó divididas consoante o local onde cada uma foi escrita, em aggregate, release e catalog, cada um ausente quando vazio; e boundary, a fronteira em que o nó se encontra: name, path (os seus segmentos), sync_wave (ausente quando 0), directory, sub_directory (ausente quando não há nenhum) e annotations (o conjunto que as fronteiras da Release propagam em cascata até ao nó, com a sua própria entrada da Release aplicada por último; ausente quando vazio). Um passo de uma FeatureRecipe com âmbito de fronteira, que não tem componente host, recebe parameters; annotations que transporta apenas o compartimento release, que é o conjunto de anotações próprio da fronteira; e um boundary que transporta o seu name, o seu path e esse mesmo conjunto como as suas annotations. A renderização do fornecedor da mesma FeatureRecipe recebe o mesmo contexto. A largura de indentação, yaml_indent, não é definida para um passo.
step_indexintegersimA posição deste passo no pipeline, a partir de zero.
preceding_stepsPrecedingStep[]nãoOs passos do pipeline que foram executados antes deste passo, para que um guest possa inspecionar o que o precedeu.

Não são permitidas propriedades adicionais.

FRPStepOutput

O payload que um guest de pipeline feature-recipe devolve para um passo de pipeline: os patches RFC 6902 que o host aplica ao conjunto de documentos indexado por chave, os efeitos secundários que este passo produziu e quaisquer diagnósticos que o guest tenha levantado.

PropriedadeTipoObrigatóriaDescrição
patchesJSONPatchOp[]nãoOperações RFC 6902 estruturadas que o passo emite contra documentos do conjunto indexado por chave. Cada uma indica o seu documento de destino por scope e key e depois indica explicitamente op, path e value. Distintas da lista de patches opaca do papel label-transform: os patches de um passo FRP são aplicados pelo host e restaurados por snapshot num passo falhado, pelo que aqui as operações são explícitas em vez de opacas.
side_effectsSideEffect[]nãoOs efeitos que este passo produziu para além de aplicar um patch a um documento existente (por exemplo, emitir um CRD ou escrever um ficheiro).
diagnosticsDiagnostic[]nãoDiagnósticos que o guest levantou. Cada elemento é a forma de diagnóstico partilhada dos plugins Wasm.
outputsobjetonãoAs saídas endereçáveis que o guest devolve para este passo, um conjunto de chaves pela ordem do autor que preenche as saídas do passo para que um passo posterior ou um template as leia. Preserva a ordem do autor para que o payload seja idêntico byte a byte entre execuções com entrada idêntica. Ausente quando o passo não devolve nenhuma saída.
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.

DocumentSet

O conjunto indexado por chave, enraizado num âmbito, de unidades endereçáveis que um guest de pipeline recebe como a sua superfície de entrada. O host entrega o conjunto inteiro e não interpreta o seu conteúdo; o guest seleciona pelo conteúdo os documentos que visa e endereça os seus patches por chave.

PropriedadeTipoObrigatóriaDescrição
ownmapa de UnitsimA saída renderizada própria do nó, indexada por token de unidade. Preserva a ordem das chaves para que o conjunto chegue ao formato de transmissão numa ordem estável e o payload seja idêntico byte a byte entre execuções com entrada idêntica.
hostmapa de UnitnãoA saída renderizada do componente ao qual está anexada uma FeatureRecipe com âmbito de componente — a superfície entre entidades. Ausente para passos de Recipe e passos de FeatureRecipe com âmbito de fronteira, que não têm componente host. Preserva a ordem das chaves para que o conjunto chegue ao formato de transmissão numa ordem estável e o payload seja idêntico byte a byte entre execuções com entrada idêntica.

Não são permitidas propriedades adicionais.

Unit

Uma peça endereçável em que a saída emitida de um fornecedor se divide — a vista híbrida de uma peça de saída. Uma unidade estruturada transporta uma árvore (uma vista endereçável segundo a RFC 6902) e é um destino PATCH; uma unidade opaca transporta apenas o seu tipo de media e os seus bytes (nenhuma árvore) e é um destino SELECT e EMIT, mas não um destino PATCH.

PropriedadeTipoObrigatóriaDescrição
tokenstringsimO endereço posicional opaco que o codec atribui — o nome de ficheiro emitido para um ficheiro com um único documento, ou <filename>#<ordinal> (ordem no ficheiro) quando um ficheiro transporta vários documentos. O guest trata-o como opaco: seleciona uma unidade pelo conteúdo e devolve o token tal como está, sem nunca o analisar.
bytesstringnãoOs bytes originais da unidade, a origem da remontagem. A remontagem é fiel ao byte por construção: os bytes não tocados são reunidos literalmente a partir destes. Cada kit transporta-os no seu próprio tipo de campo — em bruto onde esse tipo é um tipo de bytes, codificados em base64 onde é uma string que o passo descodifica para os recuperar — e o codificador gerado converte entre o campo e a forma em que o formato de transmissão transporta bytes.
media_typestringnãoO tipo de conteúdo da unidade (por exemplo, application/yaml para o codec YAML de série), para que o guest saiba o que está a ver.
treeanynãoA vista normalizada da unidade endereçável segundo a RFC 6902 quando o codec produziu uma, ou ausente quando não produziu. Uma unidade com árvore é estruturada (um destino PATCH); uma unidade sem árvore é opaca. O documento é opaco para o host, que passa os bytes sem os interpretar, pelo que a árvore transporta qualquer valor JSON nesta camada do esquema.

Não são permitidas propriedades adicionais.

JSONPatchOp

Uma operação JSON-Patch RFC 6902 que um passo FRP emite contra um documento do conjunto indexado por chave. Scope e key indicam o documento de destino; op, path, value e from transportam a operação contra uma localização dentro desse documento.

PropriedadeTipoObrigatóriaDescrição
scopestring (enum)simA raiz de documentos que a operação visa: own (os documentos renderizados próprios do nó) ou host (os documentos do componente ao qual está anexada uma FeatureRecipe com âmbito de componente). Valores permitidos: "own", "host"
keystringsimA chave do nome de ficheiro emitido dentro da raiz indicada — a chave que o guest aprendeu em tempo de execução a partir do documento que selecionou pelo conteúdo.
opstringsimA operação RFC 6902: uma de add, remove, replace, move, copy, test.
pathstringsimUm JSON Pointer RFC 6901 para a localização de destino dentro do documento indicado.
valueanynãoO operando para add, replace e test, omitido caso contrário. Um fragmento arbitrário de documento JSON escrito pelo guest, que o host passa de forma opaca; transporta qualquer valor JSON nesta camada do esquema.
fromstringnãoO ponteiro de origem para move e copy, omitido caso contrário.

Não são permitidas propriedades adicionais.

SideEffect

Um efeito que um passo de pipeline feature-recipe produz para além de aplicar um patch a um documento existente. Kind é emit_crd ou emit_file; o esquema deixa-o como uma cadeia aberta para que um novo tipo possa ser acrescentado sem uma quebra da ABI, e uma compilação para perante qualquer outro tipo. Quando kind é emit_crd, crd contém o documento CRD e file é omitido; quando kind é emit_file, file contém o ficheiro a escrever e crd é omitido.

PropriedadeTipoObrigatóriaDescrição
kindstringsimO tipo de efeito: emit_crd ou emit_file. O esquema deixa o campo como uma cadeia aberta para que um novo tipo possa ser acrescentado sem uma quebra da ABI; uma compilação para perante qualquer outro tipo, nomeando o nó, o efeito secundário e o tipo.
scopestring (enum)nãoA raiz de documentos para a qual a emissão contribui: own (o conjunto próprio do nó) ou host (o conjunto do componente host anexado). Um scope ausente significa own no momento da aplicação. Valores permitidos: "own", "host"
crdanynãoO documento CRD que o passo emite quando kind é emit_crd. Opaco para o host, que o transmite sem o interpretar; contém qualquer valor JSON nesta camada do esquema.
fileSideEffectFilenãoO ficheiro que um efeito secundário emit_file escreve: o caminho de destino e o conteúdo do ficheiro.

Não são permitidas propriedades adicionais.

SideEffectFile

O ficheiro que um efeito secundário emit_file escreve: o caminho de destino e o conteúdo do ficheiro.

PropriedadeTipoObrigatóriaDescrição
pathstringsimO caminho de destino em que o ficheiro é escrito.
contentstringsimO conteúdo do ficheiro a escrever.

Não são permitidas propriedades adicionais.

PrecedingStep

Um passo de pipeline que foi executado antes do passo atual, para que um guest possa inspecionar o que veio antes dele: o índice do passo no pipeline, o plugin que nomeou e os efeitos secundários que esse passo emitiu.

PropriedadeTipoObrigatóriaDescrição
indexintegersimA posição, a contar de zero, do passo anterior no pipeline.
plugin_uristringsimO plugin que a entrada anterior do pipeline nomeia no seu campo plugin, tal como está escrito.
side_effectsSideEffect[]nãoOs efeitos secundários que o passo anterior emitiu.

Não são permitidas propriedades adicionais.