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 bloqueio de entidade 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/entity-lock-v1beta1.schema.json

O arquivo entity.lock que fica junto a uma entidade e registra as fixações de conteúdo dos elementos que essa entidade busca fora do seu próprio documento: os arquivos que seus artefatos importam, os arquivos de uma fonte local e as fontes remotas cuja identidade a entidade escreve por completo — e, para uma fonte local que é um diretório, as regras que decidiram quais dos seus arquivos pertencem à entidade. Uma única etapa o escreve: aggrega pin, que o autor da entidade executa e que não precisa de nenhuma Release. aggrega pull e aggrega push executam essa mesma etapa, e escrevem os mesmos bytes, quando solicitados — com --pin-sources, ou com pin_sources_at_pull ou pin_sources_at_push do espaço de trabalho. Um pull que não foi solicitado a fixar não escreve nada aqui: sobre uma entidade nos próprios diretórios de catálogo do espaço de trabalho, ele compara o que a etapa registraria com o que o arquivo contém, e é interrompido, nomeando aggrega pin, onde uma fixação está ausente ou não corresponde mais ao seu elemento — para uma fonte local, um arquivo adicionado, alterado ou removido desde a fixação interrompe o pull como qualquer outra fixação desatualizada. aggrega build o lê de volta e é interrompido quando o que está em disco não produz mais o digest registrado. Seu escopo é dado pelo diretório em que ele fica — ele fixa os elementos da entidade nesse diretório — de modo que um único nome de arquivo serve a todo tipo, em vez de cada tipo ter uma grafia própria. A etapa remove o bloqueio de uma entidade que não lê nenhum elemento assim, em vez de deixar um vazio para trás. O próprio documento da entidade nunca é escrito pela máquina: o que um autor digitou fica exatamente como foi digitado, e o que a máquina derivou fica aqui. Essa separação é o que torna o bloqueio seguro para commit e legível como diff, porque cada linha nomeia um elemento e um digest alterado nomeia o elemento que mudou. Ele não traz nenhum carimbo de tempo nem metadados de resolução, então executar novamente a etapa sobre elementos inalterados deixa o arquivo idêntico byte a byte. Um único formato de linha serve a todo tipo que pode registrar uma fixação, de modo que uma fixação é lida da mesma forma, seja qual for o tipo a que pertence. O formato serializado é fechado (additionalProperties: false). Disciplina de evolução do esquema: adicionar um novo campo opcional é SemVer-MINOR (aditivo); remover um campo ou tornar uma restrição mais rígida é SemVer-MAJOR.

Tipo de nível superior: object

Propriedades

PropriedadeTipoObrigatóriaDescrição
versionconst 1simVersão do esquema do bloqueio de entidade: 1. Uma alteração SemVer-MAJOR no esquema a incrementa. Constante: 1
sourceDigestsobject[]nãoFixações de conteúdo das fontes remotas que esta entidade referencia e cuja identidade a entidade escreve por completo, congeladas na resolução a partir dos bytes baixados e lidas de volta no build para verificar que a fonte em cache não se desviou. Cada entrada espelha a identidade da fonte resolvida {kind, url, chart, moduleSubdir, version} mais o digest de conteúdo (e, para uma fonte distribuída via OCI, o digest do manifesto). Uma fonte cuja identidade é preenchida a partir de um template — uma versão lida dos valores de infraestrutura de uma Release, por exemplo — não tem nenhuma entrada aqui: qual artefato ela nomeia é decidido por cada Release que usa a entidade, então cada identidade para a qual ela é resolvida é fixada, em vez disso, no arquivo de bloqueio dessa Release. Uma fonte local (relativa ao sistema de arquivos) também não tem entrada aqui: ela nomeia um caminho em vez de algo baixado, então não há nenhum arquivo compactado obtido a fixar, e seus arquivos são fixados um a um em localSourceDigests em vez disso.
artifactDigestsobject[]nãoFixações de conteúdo dos arquivos que os artefatos desta entidade importam via $import — para uma Recipe, também os que as suas entradas de boundary.artifacts importam — congeladas na resolução e lidas de volta no build para verificar que o arquivo importado não se desviou. Uma entrada por artefato cujo valor é uma importação de arquivo; um artefato inline (literal) já faz parte da entidade e não tem uma fixação separada, e um artefato obtido de uma biblioteca é fixado pela versão para a qual essa biblioteca foi resolvida. Um build compara da mesma forma uma entrada de qualquer um dos dois blocos com a sua fixação, e recusa na mesma condição um arquivo que não corresponde mais a ela.
localSourceDigestsobject[]nãoFixações de conteúdo dos arquivos da fonte local desta entidade — uma fonte escrita como um caminho junto à entidade em vez de baixada — congeladas quando a entidade é fixada e lidas de volta no build para verificar que os arquivos não se desviaram. Uma entrada por arquivo com que a fonte contribui para o que uma publicação da entidade traz: todo arquivo sob o diretório que a fonte nomeia que as regras registradas em ignore mantêm, ou o único arquivo que ela nomeia. Uma fonte local escrita como template só nomeia seu diretório quando uma Release preenche o template, então ela contribui com todo arquivo do próprio diretório da entidade que as regras registradas mantêm, e cada um deles é fixado. O documento da entidade, o .aggregaignore do autor junto a ele e este arquivo nunca são entradas: o documento é a própria entidade, as regras do arquivo de exclusão são registradas em ignore e o bloqueio não pode registrar seu próprio digest. Assim que o bloqueio registra alguma entrada aqui, um build recusa uma fonte que contém um arquivo sem entrada, um arquivo cujo conteúdo não produz mais o digest da sua entrada, ou da qual falta um arquivo que uma entrada nomeia.
ignoreobjectnãoAs regras que decidem quais arquivos sob o diretório da fonte local desta entidade pertencem a ela, registradas quando a entidade é fixada. Toda leitura posterior desse diretório aplica estas regras e nada mais: uma publicação da entidade, a comparação a que um pull ou uma publicação submete o bloqueio, a linha de entidade do autor, a comparação de um build e sua renderização, e um pull de verificação. Assim, uma alteração no .aggregaignore do autor, na associação do provedor do espaço de trabalho ou no binário aggrega não move nenhum digest até que a entidade seja fixada de novo, e fixá-la de novo mostra a alteração aqui como um diff. Presente apenas onde a entidade declara uma fonte local que é um diretório, ou uma escrita como template. Um bloqueio que não registra regras mantém todo arquivo sob esse diretório. Um link simbólico em qualquer ponto abaixo dele é recusado em vez de seguido.

Não são permitidas propriedades adicionais.

entity-lock.sourceDigests[]

PropriedadeTipoObrigatóriaDescrição
kindenumsimO tipo da fonte resolvida. Um de um conjunto fechado — o mesmo conjunto que o kind do artefato de fonte do arquivo de bloqueio e o kind dos metadados do cache trazem — porque os três registram as mesmas identidades de fontes resolvidas e um build lê o tipo para escolher o carregador. terraform-module-oci pertence ao conjunto, e nenhum adaptador de fonte o serve: uma Recipe ou uma FeatureRecipe que o nomeie é recusada assim que é lida. Valores permitidos: "helm-oci-chart", "helm-https-chart", "compose-https-fragment", "git-repository", "terraform-module-oci"
urlstringsimA URL da fonte escrita pelo autor que o digest fixa — a URL de identidade como está escrita em spec.source.url (uma raiz de repositório ou um .tgz direto para helm-https-chart). O build reconstrói essa mesma URL offline, então ela é a identidade estável pela qual a fixação é indexada, e não um local resolvido do artefato.
chartstringnãoO nome do chart para uma fonte helm de raiz do repositório (spec.source.chart), parte da identidade da fonte resolvida, de modo que dois charts servidos a partir de uma mesma raiz de repositório na mesma versão são fixados separadamente. Ausente para uma fonte .tgz direta, OCI, compose ou git, nenhuma das quais seleciona um chart dentro da URL.
moduleSubdirstringnãoO diretório dentro de um repositório obtido via git que é o artefato (spec.source.module_subdir), parte da identidade da fonte resolvida, de modo que dois diretórios de um mesmo repositório no mesmo commit são fixados separadamente. Ausente quando o repositório inteiro é o artefato, e para todo tipo que chega ao seu artefato por URL em vez de descer em um clone.
versionstringsimA versão concreta fixada para a qual a fonte foi resolvida — uma versão de chart para um tipo helm-*, o commit para o qual uma referência git-repository foi resolvida. Registrada como um único segmento de caminho, porque ela forma o slot do cache do qual o build lê a fonte de volta, então não contém /, nem \, nem ... Padrão: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringsimO digest de conteúdo do arquivo compactado da fonte baixado, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos, verificado em relação aos bytes em cache no build. Padrão: ^sha256:[a-f0-9]{64}$.
manifestDigeststringnãoO digest do manifesto OCI para uma fonte distribuída via OCI — a raiz de confiança independente — no formato sha256: seguido de 64 caracteres hexadecimais minúsculos. Presente apenas para uma fonte OCI (um helm-oci-chart); ausente para uma fonte https ou git, que por construção não traz nenhum manifesto. Padrão: ^sha256:[a-f0-9]{64}$.

Não são permitidas propriedades adicionais.

entity-lock.artifactDigests[]

PropriedadeTipoObrigatóriaDescrição
namestringsimO artefato cujo arquivo $import esta entrada fixa: a chave do mapa artifacts: para uma entrada de artifacts, e boundary/ seguido da chave para uma entrada de boundary.artifacts de uma Recipe — de modo que uma entrada de cada bloco escrita sob uma mesma chave é fixada separadamente.
digeststringsimO digest de conteúdo dos bytes do arquivo importado, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos, verificado no build. Padrão: ^sha256:[a-f0-9]{64}$.

Não são permitidas propriedades adicionais.

entity-lock.localSourceDigests[]

PropriedadeTipoObrigatóriaDescrição
pathstringsimO caminho do arquivo relativo ao diretório que contém o documento da entidade, escrito com barras normais — charts/app/templates/deployment.yaml, por exemplo.
digeststringsimO digest de conteúdo dos bytes do arquivo, no formato sha256: seguido de 64 caracteres hexadecimais minúsculos, verificado no build. Padrão: ^sha256:[a-f0-9]{64}$.

Não são permitidas propriedades adicionais.

entity-lock.ignore

As regras que decidem quais arquivos sob o diretório da fonte local desta entidade pertencem a ela, registradas quando a entidade é fixada. Toda leitura posterior desse diretório aplica estas regras e nada mais: uma publicação da entidade, a comparação a que um pull ou uma publicação submete o bloqueio, a linha de entidade do autor, a comparação de um build e sua renderização, e um pull de verificação. Assim, uma alteração no .aggregaignore do autor, na associação do provedor do espaço de trabalho ou no binário aggrega não move nenhum digest até que a entidade seja fixada de novo, e fixá-la de novo mostra a alteração aqui como um diff. Presente apenas onde a entidade declara uma fonte local que é um diretório, ou uma escrita como template. Um bloqueio que não registra regras mantém todo arquivo sob esse diretório. Um link simbólico em qualquer ponto abaixo dele é recusado em vez de seguido.

PropriedadeTipoObrigatóriaDescrição
pluginobjectnãoO plugin que servia a capacidade da entidade no espaço de trabalho do autor quando a entidade foi fixada — a associação do provedor do espaço de trabalho para essa capacidade ou, caso contrário, o plugin embutido no binário aggrega — nomeado sem versão, e as regras de exclusão que ele declarou. Nenhuma versão e nenhum digest do plugin são registrados: as regras são o que toda leitura aplica, então fixar de novo com outra versão do mesmo plugin deixa o bloqueio inalterado, a menos que as regras tenham mudado. Um pull cujo próprio plugin para a capacidade declara regras diferentes informa isso em um aviso, nomeando os dois plugins e a diferença, e nunca é interrompido por causa disso. Ausente onde nenhum plugin servia a capacidade.
rulesobject[]nãoAs regras exatas compostas, na ordem em que se aplicam: os padrões do plugin, depois as linhas de cada arquivo de exclusão que o plugin nomeia e que o percurso encontrou, o arquivo próprio de um diretório antes dos que estão abaixo dele, depois as linhas do .aggregaignore do autor junto à entidade. Uma correspondência posterior prevalece sobre uma anterior, então o arquivo do autor tem a última palavra sobre qualquer caminho que nomeie, e uma linha que começa com ! traz de volta o que uma regra anterior excluiu. Um diretório que uma regra exclui não é percorrido, então um arquivo sob ele só volta quando o diretório volta.

Não são permitidas propriedades adicionais.

entity-lock.ignore.plugin

O plugin que servia a capacidade da entidade no espaço de trabalho do autor quando a entidade foi fixada — a associação do provedor do espaço de trabalho para essa capacidade ou, caso contrário, o plugin embutido no binário aggrega — nomeado sem versão, e as regras de exclusão que ele declarou. Nenhuma versão e nenhum digest do plugin são registrados: as regras são o que toda leitura aplica, então fixar de novo com outra versão do mesmo plugin deixa o bloqueio inalterado, a menos que as regras tenham mudado. Um pull cujo próprio plugin para a capacidade declara regras diferentes informa isso em um aviso, nomeando os dois plugins e a diferença, e nunca é interrompido por causa disso. Ausente onde nenhum plugin servia a capacidade.

PropriedadeTipoObrigatóriaDescrição
namestringsimO plugin que servia a capacidade da entidade quando ela foi fixada, como <pluginType>/<name>, sem versão: as regras abaixo são o que uma leitura aplica, e o nome diz de quem elas eram. Pelo menos 1 caractere de comprimento.
patternsstring[]nãoOs padrões de exclusão que o plugin declarou, como ele os declarou.
filesstring[]nãoOs nomes dos arquivos de exclusão que o plugin declarou que o seu ecossistema respeita dentro de uma fonte.

Não são permitidas propriedades adicionais.

entity-lock.ignore.rules[]
PropriedadeTipoObrigatóriaDescrição
patternstringsimUm padrão de exclusão na sintaxe gitignore.
withinstringsimO diretório ao qual o escopo do padrão se limita, relativo ao diretório que contém o documento da entidade e escrito com barras normais; . nomeia esse próprio diretório. Um padrão que o plugin declara tem como escopo o diretório da fonte local, uma linha de um arquivo de exclusão o diretório que contém esse arquivo, e uma linha do .aggregaignore do autor o diretório da entidade.
fromstringsimOnde o padrão foi declarado: plugin para um que o plugin declarou e, caso contrário, o caminho do arquivo de exclusão do qual ele foi lido, relativo ao diretório que contém o documento da entidade.

Não são permitidas propriedades adicionais.