Ir al contenido
AggregaAggrega
Seleccionar idioma: Español
Esta página se tradujo automáticamente. Lee el original en inglés.

Esquema del bloqueo de entidad de Aggrega

Referencia generada. No la edites a mano — regenérala a partir del JSON Schema publicado.

ID del esquema: https://aggrega.ai/schemas/entity-lock-v1beta1.schema.json

El archivo entity.lock que está junto a una entidad y registra las fijaciones de contenido de los elementos que esa entidad busca fuera de su propio documento: los archivos que importan sus artefactos, los archivos de una fuente local y las fuentes remotas cuya identidad la entidad escribe por completo — y, para una fuente local que es un directorio, las reglas que decidieron cuáles de sus archivos pertenecen a la entidad. Lo escribe un único paso: aggrega pin, que ejecuta el autor de la entidad y que no necesita ninguna Release. aggrega pull y aggrega push ejecutan ese mismo paso, y escriben los mismos bytes, cuando se les pide — con --pin-sources, o con pin_sources_at_pull o pin_sources_at_push del espacio de trabajo. Un pull al que no se le pide fijar no escribe nada aquí: sobre una entidad de los propios directorios de catálogo del espacio de trabajo compara lo que registraría el paso con lo que contiene el archivo, y se detiene, nombrando aggrega pin, donde falta una fijación o ya no coincide con su elemento — para una fuente local, un archivo añadido, modificado o eliminado desde la fijación detiene el pull como cualquier otra fijación desactualizada. aggrega build lo vuelve a leer y se detiene cuando lo que hay en disco ya no produce el digest registrado. Su ámbito lo da el directorio en el que está — fija los elementos de la entidad de ese directorio — de modo que un único nombre de archivo sirve a todos los tipos en lugar de que cada tipo lleve una grafía propia. El paso elimina el bloqueo de una entidad que no lee ningún elemento así, en lugar de dejar uno vacío. El documento de la entidad en sí nunca lo escribe la máquina: lo que un autor tecleó queda exactamente como lo tecleó, y lo que la máquina derivó vive aquí. Esa separación es lo que hace que el bloqueo sea seguro de confirmar en un commit y legible como diff, porque cada fila nombra un elemento y un digest que cambia nombra el elemento que cambió. No lleva ninguna marca de tiempo ni metadatos de resolución, así que volver a ejecutar el paso sobre elementos sin cambios deja el archivo idéntico byte a byte. Una única forma de fila sirve a todos los tipos que pueden registrar una fijación, de modo que una fijación se lee igual sea cual sea el tipo al que pertenece. La forma serializada es cerrada (additionalProperties: false). Disciplina de evolución del esquema: añadir un nuevo campo opcional es SemVer-MINOR (aditivo); eliminar un campo o endurecer una restricción es SemVer-MAJOR.

Tipo de nivel superior: object

Propiedades

PropiedadTipoObligatoriaDescripción
versionconst 1síVersión del esquema del bloqueo de entidad: 1. Un cambio SemVer-MAJOR en el esquema la incrementa. Constante: 1
sourceDigestsobject[]noFijaciones de contenido de las fuentes remotas a las que hace referencia esta entidad y cuya identidad la entidad escribe por completo, congeladas en la resolución a partir de los bytes descargados y releídas en tiempo de compilación para verificar que la fuente en caché no se ha desviado. Cada entrada refleja la identidad de la fuente resuelta {kind, url, chart, moduleSubdir, version} más el digest de contenido (y, para una fuente distribuida mediante OCI, el digest del manifiesto). Una fuente cuya identidad se completa a partir de una plantilla — una versión leída de los valores de infraestructura de una Release, por ejemplo — no tiene ninguna entrada aquí: qué artefacto nombra lo decide cada Release que usa la entidad, así que cada identidad a la que se resuelve se fija en su lugar en el archivo de bloqueo de esa Release. Tampoco una fuente local (relativa al sistema de archivos) tiene una entrada aquí: nombra una ruta en lugar de algo descargado, así que no hay ningún archivo comprimido obtenido que fijar, y sus archivos se fijan uno a uno en localSourceDigests en su lugar.
artifactDigestsobject[]noFijaciones de contenido de los archivos que importan los artefactos de esta entidad mediante $import — para una Recipe, también los que importan sus entradas de boundary.artifacts — congeladas en la resolución y releídas en tiempo de compilación para verificar que el archivo importado no se ha desviado. Una entrada por cada artefacto cuyo valor es una importación de archivo; un artefacto inline (literal) ya forma parte de la entidad y no lleva una fijación aparte, y un artefacto tomado de una biblioteca se fija por la versión a la que se resolvió esa biblioteca. Una compilación compara del mismo modo una entrada de cualquiera de los dos bloques con su fijación, y rechaza en la misma condición un archivo que ya no coincide con ella.
localSourceDigestsobject[]noFijaciones de contenido de los archivos de la fuente local de esta entidad — una fuente escrita como una ruta junto a la entidad en lugar de descargada — congeladas cuando se fija la entidad y releídas en tiempo de compilación para verificar que los archivos no se han desviado. Una entrada por cada archivo que la fuente aporta a lo que lleva una publicación de la entidad: cada archivo bajo el directorio que nombra la fuente que conservan las reglas registradas en ignore, o el único archivo que nombra. Una fuente local escrita como plantilla solo nombra su directorio cuando una Release completa la plantilla, así que aporta cada archivo del propio directorio de la entidad que conservan las reglas registradas, y cada uno de ellos se fija. El documento de la entidad, el .aggregaignore del autor junto a él y este archivo nunca son entradas: el documento es la propia entidad, las reglas del archivo de exclusión se registran en ignore y el bloqueo no puede registrar su propio digest. En cuanto el bloqueo registra alguna entrada aquí, una compilación rechaza una fuente que contiene un archivo sin entrada, un archivo cuyo contenido ya no produce el digest de su entrada, o a la que le falta un archivo que nombra una entrada.
ignoreobjectnoLas reglas que deciden qué archivos bajo el directorio de la fuente local de esta entidad le pertenecen, registradas cuando se fija la entidad. Cada lectura posterior de ese directorio aplica estas reglas y nada más: una publicación de la entidad, la comparación con la que un pull o una publicación contrasta el bloqueo, la fila de entidad del autor, la comparación de una compilación y su renderizado, y un pull de verificación. Así, un cambio en el .aggregaignore del autor, en el enlace del proveedor del espacio de trabajo o en el binario aggrega no mueve ningún digest hasta que la entidad se vuelve a fijar, y volver a fijarla muestra aquí el cambio como un diff. Presente solo donde la entidad declara una fuente local que es un directorio, o una escrita como plantilla. Un bloqueo que no registra reglas conserva cada archivo bajo ese directorio. Un enlace simbólico en cualquier lugar por debajo de él se rechaza en lugar de seguirse.

No se permiten propiedades adicionales.

entity-lock.sourceDigests[]

PropiedadTipoObligatoriaDescripción
kindenumsíEl tipo de la fuente resuelta. Uno de un conjunto cerrado — el mismo conjunto que llevan el kind del artefacto fuente del archivo de bloqueo y el kind de los metadatos de la caché — porque los tres registran las mismas identidades de fuentes resueltas y una compilación lee el tipo para elegir el cargador. terraform-module-oci pertenece al conjunto, y ningún adaptador de fuente lo sirve: una Recipe o una FeatureRecipe que lo nombre se rechaza en cuanto se lee. Valores permitidos: "helm-oci-chart", "helm-https-chart", "compose-https-fragment", "git-repository", "terraform-module-oci"
urlstringsíLa URL de la fuente escrita por el autor que fija el digest — la URL de identidad tal como está escrita en spec.source.url (una raíz de repositorio o un .tgz directo para helm-https-chart). La compilación reconstruye esta misma URL sin conexión, así que es la identidad estable por la que se indexa la fijación, no una ubicación resuelta del artefacto.
chartstringnoEl nombre del chart para una fuente helm de raíz del repositorio (spec.source.chart), parte de la identidad de la fuente resuelta, de modo que dos charts servidos desde una misma raíz de repositorio en la misma versión se fijan por separado. Ausente para una fuente .tgz directa, OCI, compose o git, ninguna de las cuales selecciona un chart dentro de la URL.
moduleSubdirstringnoEl directorio dentro de un repositorio obtenido de git que es el artefacto (spec.source.module_subdir), parte de la identidad de la fuente resuelta, de modo que dos directorios de un mismo repositorio en el mismo commit se fijan por separado. Ausente cuando el repositorio entero es el artefacto, y para todo tipo que llega a su artefacto por URL en lugar de descender a un clon.
versionstringsíLa versión concreta fijada a la que se resolvió la fuente — una versión de chart para un tipo helm-*, el commit al que se resolvió una referencia git-repository. Se registra como un único segmento de ruta, porque construye la ranura de la caché desde la que la compilación vuelve a leer la fuente, así que no lleva /, ni \, ni ... Patrón: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringsíEl digest de contenido del archivo comprimido de la fuente descargado, en la forma sha256: seguido de 64 caracteres hexadecimales en minúsculas, verificado contra los bytes en caché en tiempo de compilación. Patrón: ^sha256:[a-f0-9]{64}$.
manifestDigeststringnoEl digest del manifiesto OCI para una fuente distribuida mediante OCI — la raíz de confianza independiente — en la forma sha256: seguido de 64 caracteres hexadecimales en minúsculas. Presente solo para una fuente OCI (un helm-oci-chart); ausente para una fuente https o git, que por construcción no lleva ningún manifiesto. Patrón: ^sha256:[a-f0-9]{64}$.

No se permiten propiedades adicionales.

entity-lock.artifactDigests[]

PropiedadTipoObligatoriaDescripción
namestringsíEl artefacto cuyo archivo $import fija esta entrada: la clave del mapa artifacts: para una entrada de artifacts, y boundary/ seguido de la clave para una entrada de boundary.artifacts de una Recipe — de modo que una entrada de cada bloque escrita bajo una misma clave se fija por separado.
digeststringsíEl digest de contenido de los bytes del archivo importado, en la forma sha256: seguido de 64 caracteres hexadecimales en minúsculas, verificado en tiempo de compilación. Patrón: ^sha256:[a-f0-9]{64}$.

No se permiten propiedades adicionales.

entity-lock.localSourceDigests[]

PropiedadTipoObligatoriaDescripción
pathstringsíLa ruta del archivo relativa al directorio que contiene el documento de la entidad, escrita con barras normales — charts/app/templates/deployment.yaml, por ejemplo.
digeststringsíEl digest de contenido de los bytes del archivo, en la forma sha256: seguido de 64 caracteres hexadecimales en minúsculas, verificado en tiempo de compilación. Patrón: ^sha256:[a-f0-9]{64}$.

No se permiten propiedades adicionales.

entity-lock.ignore

Las reglas que deciden qué archivos bajo el directorio de la fuente local de esta entidad le pertenecen, registradas cuando se fija la entidad. Cada lectura posterior de ese directorio aplica estas reglas y nada más: una publicación de la entidad, la comparación con la que un pull o una publicación contrasta el bloqueo, la fila de entidad del autor, la comparación de una compilación y su renderizado, y un pull de verificación. Así, un cambio en el .aggregaignore del autor, en el enlace del proveedor del espacio de trabajo o en el binario aggrega no mueve ningún digest hasta que la entidad se vuelve a fijar, y volver a fijarla muestra aquí el cambio como un diff. Presente solo donde la entidad declara una fuente local que es un directorio, o una escrita como plantilla. Un bloqueo que no registra reglas conserva cada archivo bajo ese directorio. Un enlace simbólico en cualquier lugar por debajo de él se rechaza en lugar de seguirse.

PropiedadTipoObligatoriaDescripción
pluginobjectnoEl plugin que servía la capacidad de la entidad en el espacio de trabajo del autor cuando se fijó la entidad — el enlace del proveedor del espacio de trabajo para esa capacidad o, si no, el plugin integrado en el binario aggrega — nombrado sin versión, y las reglas de exclusión que declaró. No se registra ninguna versión ni ningún digest del plugin: las reglas son lo que aplica cada lectura, así que volver a fijar con otra versión del mismo plugin deja el bloqueo sin cambios salvo que las reglas hayan cambiado. Un pull cuyo propio plugin para la capacidad declara reglas distintas lo indica en un aviso, nombrando ambos plugins y la diferencia, y nunca se detiene por ello. Ausente donde ningún plugin servía la capacidad.
rulesobject[]noLas reglas exactas compuestas, en el orden en que se aplican: los patrones del plugin, luego las líneas de cada archivo de exclusión que nombra el plugin y que el recorrido encontró, el archivo propio de un directorio antes que los que están por debajo, y luego las líneas del .aggregaignore del autor junto a la entidad. Una coincidencia posterior prevalece sobre una anterior, así que el archivo del autor tiene la última palabra sobre cualquier ruta que nombre, y una línea que empieza por ! recupera lo que una regla anterior excluyó. En un directorio que una regla excluye no se entra, así que un archivo bajo él solo vuelve cuando vuelve el directorio.

No se permiten propiedades adicionales.

entity-lock.ignore.plugin

El plugin que servía la capacidad de la entidad en el espacio de trabajo del autor cuando se fijó la entidad — el enlace del proveedor del espacio de trabajo para esa capacidad o, si no, el plugin integrado en el binario aggrega — nombrado sin versión, y las reglas de exclusión que declaró. No se registra ninguna versión ni ningún digest del plugin: las reglas son lo que aplica cada lectura, así que volver a fijar con otra versión del mismo plugin deja el bloqueo sin cambios salvo que las reglas hayan cambiado. Un pull cuyo propio plugin para la capacidad declara reglas distintas lo indica en un aviso, nombrando ambos plugins y la diferencia, y nunca se detiene por ello. Ausente donde ningún plugin servía la capacidad.

PropiedadTipoObligatoriaDescripción
namestringsíEl plugin que servía la capacidad de la entidad cuando se fijó, como <pluginType>/<name>, sin versión: las reglas de abajo son lo que aplica una lectura, y el nombre dice de quién eran. Al menos 1 carácter de longitud.
patternsstring[]noLos patrones de exclusión que declaró el plugin, tal como los declaró.
filesstring[]noLos nombres de los archivos de exclusión que el plugin declaró que su ecosistema respeta dentro de una fuente.

No se permiten propiedades adicionales.

entity-lock.ignore.rules[]
PropiedadTipoObligatoriaDescripción
patternstringsíUn patrón de exclusión en sintaxis gitignore.
withinstringsíEl directorio al que se limita el ámbito del patrón, relativo al directorio que contiene el documento de la entidad y escrito con barras normales; . nombra ese mismo directorio. Un patrón que declara el plugin tiene como ámbito el directorio de la fuente local, una línea de un archivo de exclusión el directorio que contiene ese archivo, y una línea del .aggregaignore del autor el directorio de la entidad.
fromstringsíDónde se declaró el patrón: plugin para uno que declaró el plugin y, si no, la ruta del archivo de exclusión del que se leyó, relativa al directorio que contiene el documento de la entidad.

No se permiten propiedades adicionales.