Salta ai contenuti
AggregaAggrega
Seleziona lingua: Italiano
Questa pagina è stata tradotta automaticamente. Leggi l’originale in inglese.

Schema del lock dell’entità di Aggrega

Riferimento generato. Non modificarlo a mano — rigeneralo a partire dal JSON Schema pubblicato.

Id dello schema: https://aggrega.ai/schemas/entity-lock-v1beta1.schema.json

Il file entity.lock che si trova accanto a un’entità e registra i fissaggi del contenuto per gli input che quell’entità raggiunge al di fuori del proprio documento: i file che i suoi artefatti importano, i file di una sorgente locale e le sorgenti remote la cui identità l’entità scrive per intero — e, per una sorgente locale che è una directory, le regole che hanno deciso quali dei suoi file appartengono all’entità. Lo scrive un solo passo: aggrega pin, che l’autore dell’entità esegue e che non richiede alcuna Release. aggrega pull e aggrega push eseguono quello stesso passo, e scrivono gli stessi byte, quando viene loro chiesto — con --pin-sources, oppure con pin_sources_at_pull o pin_sources_at_push del workspace. Un pull a cui non viene chiesto di fissare non scrive nulla qui: su un’entità nelle directory di catalogo proprie del workspace confronta ciò che il passo registrerebbe con ciò che il file contiene, e si arresta, nominando aggrega pin, dove un fissaggio manca o non corrisponde più al suo input — per una sorgente locale, un file aggiunto, modificato o rimosso dopo il fissaggio arresta il pull come qualsiasi altro fissaggio non aggiornato. aggrega build lo rilegge e si arresta quando ciò che si trova su disco non produce più il digest registrato. Il suo ambito è dato dalla directory in cui si trova — fissa gli input dell’entità in quella directory — così un unico nome di file serve ogni tipo anziché ciascun tipo con una grafia propria. Il passo rimuove il lock di un’entità che non legge alcun input di questo genere, anziché lasciarne uno vuoto. Il documento dell’entità stesso non viene mai scritto dalla macchina: ciò che un autore ha digitato resta esattamente come è stato digitato, e ciò che la macchina ha derivato vive qui. Questa separazione è ciò che rende il lock sicuro da sottoporre a commit e leggibile come diff, perché ogni riga nomina un input e un digest cambiato nomina l’input che è cambiato. Non contiene alcun timestamp né metadati di risoluzione, quindi rieseguire il passo su input invariati lascia il file identico byte per byte. Un’unica forma di riga serve ogni tipo che può registrare un fissaggio, così un fissaggio si legge allo stesso modo a qualunque tipo appartenga. La forma serializzata è chiusa (additionalProperties: false). Disciplina di evoluzione dello schema: aggiungere un nuovo campo opzionale è SemVer-MINOR (additivo); rimuovere un campo o restringere un vincolo è SemVer-MAJOR.

Tipo di primo livello: object

Proprietà

ProprietàTipoObbligatoriaDescrizione
versionconst 1sìVersione dello schema del lock dell’entità: 1. Una modifica SemVer-MAJOR allo schema la incrementa. Costante: 1
sourceDigestsobject[]noFissaggi del contenuto per le sorgenti remote a cui questa entità fa riferimento e la cui identità l’entità scrive per intero, congelati al momento della risoluzione a partire dai byte scaricati e riletti in fase di build per verificare che la sorgente in cache non sia cambiata. Ogni voce rispecchia l’identità della sorgente risolta {kind, url, chart, moduleSubdir, version} più il digest del contenuto (e, per una sorgente distribuita tramite OCI, il digest del manifest). Una sorgente la cui identità viene compilata da un template — ad esempio una versione letta dai valori di infrastruttura di una Release — non ha alcuna voce qui: quale artefatto nomina lo decide ciascuna Release che usa l’entità, quindi ogni identità in cui si risolve viene invece fissata nel file di lock di quella Release. Nemmeno una sorgente locale (relativa al filesystem) ha una voce qui: nomina un percorso anziché qualcosa di scaricato, quindi non c’è alcun archivio acquisito da fissare, e i suoi file vengono invece fissati uno per uno in localSourceDigests.
artifactDigestsobject[]noFissaggi del contenuto per i file che gli artefatti di questa entità importano tramite $import — per una Recipe, anche quelli che importano le sue voci di boundary.artifacts — congelati al momento della risoluzione e riletti in fase di build per verificare che il file importato non sia cambiato. Una voce per ogni artefatto il cui valore è un’importazione da file; un artefatto inline (letterale) fa già parte dell’entità e non ha un fissaggio separato, e un artefatto preso da una libreria è fissato dalla versione in cui quella libreria si è risolta. Una build confronta allo stesso modo una voce di ciascuno dei due blocchi con il suo fissaggio, e rifiuta alle stesse condizioni un file che non vi corrisponde più.
localSourceDigestsobject[]noFissaggi del contenuto per i file della sorgente locale di questa entità — una sorgente scritta come percorso accanto all’entità anziché scaricata — congelati quando l’entità viene fissata e riletti in fase di build per verificare che i file non siano cambiati. Una voce per ogni file con cui la sorgente contribuisce a ciò che porta una pubblicazione dell’entità: ogni file sotto la directory nominata dalla sorgente che le regole registrate sotto ignore mantengono, oppure l’unico file che nomina. Una sorgente locale scritta come template nomina la propria directory solo quando una Release compila il template, quindi contribuisce con ogni file nella directory propria dell’entità che le regole registrate mantengono, e ciascuno di essi viene fissato. Il documento dell’entità, il .aggregaignore dell’autore accanto a esso e questo file non sono mai voci: il documento è l’entità stessa, le regole del file di esclusione sono registrate sotto ignore e il lock non può registrare il proprio digest. Una volta che il lock registra una voce qui, una build rifiuta una sorgente che contiene un file senza voce, un file il cui contenuto non produce più il digest della sua voce, o a cui manca un file nominato da una voce.
ignoreobjectnoLe regole che decidono quali file sotto la directory della sorgente locale di questa entità le appartengono, registrate quando l’entità viene fissata. Ogni lettura successiva di quella directory applica queste regole e nient’altro: una pubblicazione dell’entità, il confronto con il lock eseguito da un pull o da una pubblicazione, la riga dell’entità dell’autore, il confronto di una build e il suo rendering, e un pull di verifica. Così una modifica al .aggregaignore dell’autore, al legame del provider del workspace o al binario aggrega non sposta alcun digest finché l’entità non viene fissata di nuovo, e fissarla di nuovo mostra qui la modifica come un diff. Presente solo dove l’entità dichiara una sorgente locale che è una directory, o una scritta come template. Un lock che non registra regole mantiene ogni file sotto quella directory. Un collegamento simbolico in qualsiasi punto al suo interno viene rifiutato anziché seguito.

Non sono consentite proprietà aggiuntive.

entity-lock.sourceDigests[]

ProprietàTipoObbligatoriaDescrizione
kindenumsìIl tipo della sorgente risolta. Uno di un insieme chiuso — lo stesso insieme che portano il kind dell’artefatto sorgente del file di lock e il kind dei metadati della cache — perché tutti e tre registrano le stesse identità di sorgenti risolte e una build legge il tipo per scegliere il loader. terraform-module-oci appartiene all’insieme, e nessun adattatore di sorgente lo serve: una Recipe o una FeatureRecipe che lo nomina viene rifiutata quando viene letta. Valori consentiti: "helm-oci-chart", "helm-https-chart", "compose-https-fragment", "git-repository", "terraform-module-oci"
urlstringsìL’URL della sorgente scritto dall’autore che il digest fissa — l’URL di identità così come è scritto in spec.source.url (una radice del repository o un .tgz diretto per helm-https-chart). La build ricostruisce questo stesso URL offline, quindi è l’identità stabile su cui è indicizzato il fissaggio, non una posizione risolta dell’artefatto.
chartstringnoIl nome del chart per una sorgente helm con radice del repository (spec.source.chart), parte dell’identità della sorgente risolta, così due chart serviti da un’unica radice del repository alla stessa versione ricevono fissaggi distinti. Assente per una sorgente .tgz diretta, OCI, compose o git, nessuna delle quali seleziona un chart all’interno dell’URL.
moduleSubdirstringnoLa directory all’interno di un repository di origine git che costituisce l’artefatto (spec.source.module_subdir), parte dell’identità della sorgente risolta, così due directory di un unico repository allo stesso commit ricevono fissaggi distinti. Assente quando l’artefatto è l’intero repository, e per ogni tipo che raggiunge il proprio artefatto tramite URL anziché scendendo in un clone.
versionstringsìLa versione concreta fissata in cui si è risolta la sorgente — una versione del chart per un tipo helm-*, il commit in cui si è risolto un riferimento git-repository. Registrata come un singolo segmento di percorso, perché costruisce lo slot della cache da cui la build rilegge la sorgente, quindi non contiene /, \ né ... Pattern: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringsìIl digest del contenuto dell’archivio della sorgente scaricato, nella forma sha256: seguito da 64 caratteri esadecimali minuscoli, verificato rispetto ai byte in cache in fase di build. Pattern: ^sha256:[a-f0-9]{64}$.
manifestDigeststringnoIl digest del manifest OCI per una sorgente distribuita tramite OCI — la radice di fiducia indipendente — nella forma sha256: seguito da 64 caratteri esadecimali minuscoli. Presente solo per una sorgente OCI (un helm-oci-chart); assente per una sorgente https o git, che per costruzione non ha alcun manifest. Pattern: ^sha256:[a-f0-9]{64}$.

Non sono consentite proprietà aggiuntive.

entity-lock.artifactDigests[]

ProprietàTipoObbligatoriaDescrizione
namestringsìL’artefatto il cui file $import viene fissato da questa voce: la chiave della mappa artifacts: per una voce di artifacts, e boundary/ seguito dalla chiave per una voce di boundary.artifacts di una Recipe — così una voce di ciascun blocco scritta sotto la stessa chiave viene fissata separatamente.
digeststringsìIl digest del contenuto dei byte del file importato, nella forma sha256: seguito da 64 caratteri esadecimali minuscoli, verificato in fase di build. Pattern: ^sha256:[a-f0-9]{64}$.

Non sono consentite proprietà aggiuntive.

entity-lock.localSourceDigests[]

ProprietàTipoObbligatoriaDescrizione
pathstringsìIl percorso del file relativo alla directory che contiene il documento dell’entità, scritto con barre normali — charts/app/templates/deployment.yaml, ad esempio.
digeststringsìIl digest del contenuto dei byte del file, nella forma sha256: seguito da 64 caratteri esadecimali minuscoli, verificato in fase di build. Pattern: ^sha256:[a-f0-9]{64}$.

Non sono consentite proprietà aggiuntive.

entity-lock.ignore

Le regole che decidono quali file sotto la directory della sorgente locale di questa entità le appartengono, registrate quando l’entità viene fissata. Ogni lettura successiva di quella directory applica queste regole e nient’altro: una pubblicazione dell’entità, il confronto con il lock eseguito da un pull o da una pubblicazione, la riga dell’entità dell’autore, il confronto di una build e il suo rendering, e un pull di verifica. Così una modifica al .aggregaignore dell’autore, al legame del provider del workspace o al binario aggrega non sposta alcun digest finché l’entità non viene fissata di nuovo, e fissarla di nuovo mostra qui la modifica come un diff. Presente solo dove l’entità dichiara una sorgente locale che è una directory, o una scritta come template. Un lock che non registra regole mantiene ogni file sotto quella directory. Un collegamento simbolico in qualsiasi punto al suo interno viene rifiutato anziché seguito.

ProprietàTipoObbligatoriaDescrizione
pluginobjectnoIl plugin che serviva la capacità dell’entità nel workspace dell’autore quando l’entità è stata fissata — il legame del provider del workspace per quella capacità, oppure il plugin integrato nel binario aggrega — nominato senza versione, e le regole di esclusione che ha dichiarato. Non viene registrata alcuna versione né alcun digest del plugin: le regole sono ciò che ogni lettura applica, quindi fissare di nuovo con un’altra versione dello stesso plugin lascia il lock invariato, a meno che le regole non siano cambiate. Un pull il cui plugin per la capacità dichiara regole diverse lo segnala in un avviso, nominando entrambi i plugin e la differenza, e non si arresta mai per questo. Assente dove nessun plugin serviva la capacità.
rulesobject[]noLe regole esatte composte, nell’ordine in cui si applicano: i pattern del plugin, poi le righe di ogni file di esclusione nominato dal plugin che la visita ha trovato, il file proprio di una directory prima di quelli al di sotto, poi le righe del .aggregaignore dell’autore accanto all’entità. Una corrispondenza successiva prevale su una precedente, quindi il file dell’autore ha l’ultima parola su qualsiasi percorso che nomina, e una riga che inizia con ! ripristina ciò che una regola precedente ha escluso. In una directory esclusa da una regola non si entra, quindi un file al suo interno torna solo quando torna la directory.

Non sono consentite proprietà aggiuntive.

entity-lock.ignore.plugin

Il plugin che serviva la capacità dell’entità nel workspace dell’autore quando l’entità è stata fissata — il legame del provider del workspace per quella capacità, oppure il plugin integrato nel binario aggrega — nominato senza versione, e le regole di esclusione che ha dichiarato. Non viene registrata alcuna versione né alcun digest del plugin: le regole sono ciò che ogni lettura applica, quindi fissare di nuovo con un’altra versione dello stesso plugin lascia il lock invariato, a meno che le regole non siano cambiate. Un pull il cui plugin per la capacità dichiara regole diverse lo segnala in un avviso, nominando entrambi i plugin e la differenza, e non si arresta mai per questo. Assente dove nessun plugin serviva la capacità.

ProprietàTipoObbligatoriaDescrizione
namestringsìIl plugin che serviva la capacità dell’entità quando è stata fissata, come <pluginType>/<name>, senza versione: le regole sottostanti sono ciò che una lettura applica, e il nome dice di chi erano. Lungo almeno 1 carattere.
patternsstring[]noI pattern di esclusione dichiarati dal plugin, così come li ha dichiarati.
filesstring[]noI nomi dei file di esclusione che il plugin ha dichiarato essere rispettati dal suo ecosistema all’interno di una sorgente.

Non sono consentite proprietà aggiuntive.

entity-lock.ignore.rules[]
ProprietàTipoObbligatoriaDescrizione
patternstringsìUn pattern di esclusione nella sintassi gitignore.
withinstringsìLa directory che costituisce l’ambito del pattern, relativa alla directory che contiene il documento dell’entità e scritta con barre normali; . nomina quella directory stessa. Un pattern che il plugin dichiara ha come ambito la directory della sorgente locale, una riga di un file di esclusione la directory che contiene quel file, e una riga del .aggregaignore dell’autore la directory dell’entità.
fromstringsìDove è stato dichiarato il pattern: plugin per uno dichiarato dal plugin, e altrimenti il percorso del file di esclusione da cui è stato letto, relativo alla directory che contiene il documento dell’entità.

Non sono consentite proprietà aggiuntive.