Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Schemat Aggrega Entity Lock

Dokumentacja wygenerowana automatycznie. Nie należy jej edytować ręcznie — należy ją wygenerować ponownie z opublikowanego JSON Schema.

Identyfikator schematu: https://aggrega.ai/schemas/entity-lock-v1beta1.schema.json

Plik entity.lock, który leży obok encji i zapisuje przypięcia treści dla danych wejściowych, po które encja sięga poza własny dokument: plików importowanych przez jej artefakty, plików źródła lokalnego oraz źródeł zdalnych, których tożsamość encja zapisuje w pełni — a w przypadku źródła lokalnego będącego katalogiem także reguł, które zdecydowały, które z jego plików należą do encji. Zapisuje go jeden krok: aggrega pin, który uruchamia autor encji i który nie wymaga encji Release. aggrega pull i aggrega push wykonują ten sam krok i zapisują te same bajty, gdy zostaną o to poproszone — za pomocą --pin-sources albo ustawień pin_sources_at_pull lub pin_sources_at_push obszaru roboczego. Operacja pull, której nie poproszono o przypinanie, niczego tu nie zapisuje: dla encji w katalogach katalogu własnego obszaru roboczego porównuje to, co krok by zapisał, z zawartością pliku, i zatrzymuje się, wskazując aggrega pin, gdy brakuje przypięcia lub przestało ono odpowiadać swoim danym wejściowym — w przypadku źródła lokalnego plik dodany, zmieniony lub usunięty od czasu przypięcia zatrzymuje operację pull tak samo jak każde inne nieaktualne przypięcie. aggrega build odczytuje go z powrotem i zatrzymuje się, gdy skrót tego, co jest na dysku, przestaje odpowiadać zapisanemu. Jego zakres wyznacza katalog, w którym leży — przypina dane wejściowe encji z tego katalogu — dzięki czemu jedna nazwa pliku służy wszystkim rodzajom, zamiast każdego rodzaju z własną pisownią. Krok usuwa plik blokady encji, która nie odczytuje żadnych takich danych wejściowych, zamiast zostawiać pusty. Sam dokument encji nigdy nie jest zapisywany maszynowo: to, co wpisał autor, pozostaje dokładnie tak, jak zostało wpisane, a to, co wyprowadziła maszyna, znajduje się tutaj. To rozdzielenie sprawia, że plik blokady można bezpiecznie commitować i czytać jako diff, ponieważ każdy wiersz wskazuje jedno dane wejściowe, a zmieniony skrót wskazuje dane wejściowe, które się zmieniły. Nie zawiera znacznika czasu ani metadanych rozwiązywania, więc ponowne wykonanie kroku na niezmienionych danych wejściowych pozostawia plik identyczny co do bajtu. Jeden kształt wiersza służy każdemu rodzajowi, który może zapisać przypięcie, więc przypięcie wygląda tak samo niezależnie od rodzaju, do którego należy. Kształt formatu jest zamknięty (additionalProperties: false). Dyscyplina ewolucji schematu: dodanie nowego opcjonalnego pola to zmiana SemVer-MINOR (addytywna); usunięcie pola lub zaostrzenie ograniczenia to zmiana SemVer-MAJOR.

Typ najwyższego poziomu: object

Właściwości

WłaściwośćTypWymaganaOpis
versionconst 1takWersja schematu blokady encji: 1. Zmiana schematu na poziomie SemVer-MAJOR ją zwiększa. Stała: 1
sourceDigestsobject[]niePrzypięcia treści dla zdalnych źródeł, do których odwołuje się ta encja i których tożsamość encja zapisuje w całości, zamrożone podczas rozwiązywania na podstawie pobranych bajtów i odczytywane podczas budowania w celu sprawdzenia, czy źródło w pamięci podręcznej nie uległo zmianie. Każdy wpis odzwierciedla tożsamość rozwiązanego źródła {kind, url, chart, moduleSubdir, version} wraz ze skrótem treści (a dla źródła dystrybuowanego przez OCI także ze skrótem manifestu). Źródło, którego tożsamość jest uzupełniana z szablonu — na przykład wersja odczytywana z wartości infrastruktury encji Release — nie ma tu wpisu: to, który artefakt wskazuje, rozstrzyga każda encja Release używająca tej encji, więc każda tożsamość, do której zostaje rozwiązane, jest przypinana w pliku blokady tej encji Release. Lokalne źródło (względne wobec systemu plików) również nie ma tu wpisu: wskazuje ścieżkę, a nie coś pobieranego, więc nie ma pobranego archiwum do przypięcia, a jego pliki są przypinane pojedynczo w localSourceDigests.
artifactDigestsobject[]niePrzypięcia treści dla plików, które artefakty tej encji importują przez $import — w przypadku encji Recipe także plików importowanych przez jej wpisy boundary.artifacts — zamrożone podczas rozwiązywania i odczytywane podczas budowania w celu sprawdzenia, czy zaimportowany plik nie uległ zmianie. Jeden wpis na każdy artefakt, którego wartością jest import pliku; artefakt wbudowany (literał) jest już częścią encji i nie ma osobnego przypięcia, a artefakt pobrany z biblioteki jest przypięty wersją, do której ta biblioteka została rozwiązana. Budowanie porównuje wpis z każdego z bloków z jego przypięciem w ten sam sposób i odrzuca plik, który już mu nie odpowiada, pod tym samym warunkiem.
localSourceDigestsobject[]niePrzypięcia treści dla plików lokalnego źródła tej encji — źródła zapisanego jako ścieżka obok encji, a nie pobieranego — zamrożone przy przypinaniu encji i odczytywane podczas budowania w celu sprawdzenia, czy pliki nie uległy zmianie. Jeden wpis na każdy plik, który źródło wnosi do zawartości publikacji encji: każdy plik w katalogu wskazanym przez źródło, który zachowują reguły zapisane w ignore, albo jedyny plik, który źródło wskazuje. Lokalne źródło zapisane jako szablon wskazuje swój katalog dopiero wtedy, gdy encja Release uzupełni szablon, więc wnosi każdy plik we własnym katalogu encji, który zachowują zapisane reguły, i każdy z nich jest przypinany. Dokument encji, plik .aggregaignore autora obok niego oraz ten plik nigdy nie są wpisami: dokument jest samą encją, reguły pliku ignorowania są zapisane w ignore, a blokada nie może zapisać własnego skrótu. Gdy blokada zapisze tu jakikolwiek wpis, budowanie odrzuca źródło zawierające plik bez wpisu, plik, którego treść nie daje już skrótu zgodnego z wpisem, lub źródło, w którym brakuje pliku wskazanego we wpisie.
ignoreobjectnieReguły rozstrzygające, które pliki w katalogu lokalnego źródła tej encji do niej należą, zapisywane przy przypinaniu encji. Każdy późniejszy odczyt tego katalogu stosuje te reguły i nic innego: publikacja encji, porównanie z blokadą wykonywane przez pull lub publikację, wiersz encji autora, porównanie i renderowanie podczas budowania oraz weryfikujący pull. Zmiana pliku .aggregaignore autora, powiązania dostawcy w przestrzeni roboczej lub pliku binarnego aggrega nie zmienia więc żadnego skrótu, dopóki encja nie zostanie ponownie przypięta, a ponowne przypięcie pokazuje tę zmianę tutaj jako diff. Występuje tylko wtedy, gdy encja deklaruje lokalne źródło będące katalogiem lub zapisane jako szablon. Blokada bez zapisanych reguł zachowuje każdy plik w tym katalogu. Dowiązanie symboliczne w dowolnym miejscu tego katalogu jest odrzucane, a nie śledzone.

Dodatkowe właściwości są niedozwolone.

entity-lock.sourceDigests[]

WłaściwośćTypWymaganaOpis
kindenumtakRodzaj rozwiązanego źródła. Jedna z wartości zamkniętego zbioru — tego samego, który zawierają kind artefaktu źródłowego w pliku blokady oraz kind metadanych pamięci podręcznej — ponieważ wszystkie trzy zapisują te same tożsamości rozwiązanych źródeł, a budowanie odczytuje rodzaj, aby wybrać moduł ładujący. terraform-module-oci należy do tego zbioru, ale żaden adapter źródła go nie obsługuje: encja Recipe lub FeatureRecipe, która go wskazuje, jest odrzucana przy odczycie. Dozwolone wartości: "helm-oci-chart", "helm-https-chart", "compose-https-fragment", "git-repository", "terraform-module-oci"
urlstringtakZapisany przez autora URL źródła, który przypina skrót — URL tożsamości w postaci zapisanej w spec.source.url (katalog główny repozytorium lub bezpośredni plik .tgz dla helm-https-chart). Budowanie odtwarza ten sam URL w trybie offline, więc jest to stabilna tożsamość, według której kluczowane jest przypięcie, a nie lokalizacja rozwiązanego artefaktu.
chartstringnieNazwa chartu dla źródła helm z katalogu głównego repozytorium (spec.source.chart), będąca częścią tożsamości rozwiązanego źródła, dzięki czemu dwa charty serwowane z jednego katalogu głównego repozytorium w tej samej wersji są przypinane oddzielnie. Nie występuje dla bezpośredniego pliku .tgz ani źródeł OCI, compose czy git, z których żadne nie wybiera chartu w obrębie URL.
moduleSubdirstringnieKatalog w repozytorium pochodzącym z git, który jest artefaktem (spec.source.module_subdir), będący częścią tożsamości rozwiązanego źródła, dzięki czemu dwa katalogi jednego repozytorium w tym samym commicie są przypinane oddzielnie. Nie występuje, gdy artefaktem jest całe repozytorium, ani dla żadnego rodzaju, który dociera do swojego artefaktu przez URL, a nie przez zejście do klonu.
versionstringtakKonkretna przypięta wersja, do której zostało rozwiązane źródło — wersja chartu dla rodzaju helm-*, commit, do którego została rozwiązana referencja git-repository. Zapisywana jako pojedynczy segment ścieżki, ponieważ tworzy miejsce w pamięci podręcznej, z którego budowanie odczytuje źródło, więc nie zawiera /, \ ani ... Wzorzec: ^([^/\\.]|\.[^/\\.])*\.?$.
digeststringtakSkrót treści pobranego archiwum źródła w postaci sha256:, po którym następuje 64 małych znaków szesnastkowych, weryfikowany podczas budowania względem bajtów w pamięci podręcznej. Wzorzec: ^sha256:[a-f0-9]{64}$.
manifestDigeststringnieSkrót manifestu OCI dla źródła dystrybuowanego przez OCI — niezależny korzeń zaufania — w postaci sha256:, po którym następuje 64 małych znaków szesnastkowych. Występuje tylko dla źródła OCI (helm-oci-chart); nie występuje dla źródła https ani git, które z założenia nie mają manifestu. Wzorzec: ^sha256:[a-f0-9]{64}$.

Dodatkowe właściwości są niedozwolone.

entity-lock.artifactDigests[]

WłaściwośćTypWymaganaOpis
namestringtakKtóry plik $import artefaktu przypina ten wpis: klucz mapy artifacts: dla wpisu z artifacts oraz boundary/, po którym następuje klucz, dla wpisu z boundary.artifacts encji Recipe — dzięki temu wpisy z obu bloków zapisane pod tym samym kluczem są przypinane oddzielnie.
digeststringtakSkrót treści bajtów zaimportowanego pliku w postaci sha256:, po którym następuje 64 małych znaków szesnastkowych, weryfikowany podczas budowania. Wzorzec: ^sha256:[a-f0-9]{64}$.

Dodatkowe właściwości są niedozwolone.

entity-lock.localSourceDigests[]

WłaściwośćTypWymaganaOpis
pathstringtakŚcieżka pliku względem katalogu zawierającego dokument encji, zapisana z ukośnikami — na przykład charts/app/templates/deployment.yaml.
digeststringtakSkrót treści bajtów pliku w postaci sha256:, po którym następuje 64 małych znaków szesnastkowych, weryfikowany podczas budowania. Wzorzec: ^sha256:[a-f0-9]{64}$.

Dodatkowe właściwości są niedozwolone.

entity-lock.ignore

Reguły rozstrzygające, które pliki w katalogu lokalnego źródła tej encji do niej należą, zapisywane przy przypinaniu encji. Każdy późniejszy odczyt tego katalogu stosuje te reguły i nic innego: publikacja encji, porównanie z blokadą wykonywane przez pull lub publikację, wiersz encji autora, porównanie i renderowanie podczas budowania oraz weryfikujący pull. Zmiana pliku .aggregaignore autora, powiązania dostawcy w przestrzeni roboczej lub pliku binarnego aggrega nie zmienia więc żadnego skrótu, dopóki encja nie zostanie ponownie przypięta, a ponowne przypięcie pokazuje tę zmianę tutaj jako diff. Występuje tylko wtedy, gdy encja deklaruje lokalne źródło będące katalogiem lub zapisane jako szablon. Blokada bez zapisanych reguł zachowuje każdy plik w tym katalogu. Dowiązanie symboliczne w dowolnym miejscu tego katalogu jest odrzucane, a nie śledzone.

WłaściwośćTypWymaganaOpis
pluginobjectniePlugin, który obsługiwał zdolność encji w obszarze roboczym autora w chwili przypięcia encji — powiązanie dostawcy w obszarze roboczym dla tej zdolności, a w przeciwnym razie plugin wbudowany w plik binarny aggrega — wskazany bez wersji, oraz zadeklarowane przez niego reguły ignorowania. Nie jest zapisywana ani wersja, ani skrót pluginu: każdy odczyt stosuje reguły, więc ponowne przypięcie przy innym wydaniu tego samego pluginu pozostawia blokadę bez zmian, chyba że zmieniły się reguły. Pobranie, którego własny plugin dla tej zdolności deklaruje inne reguły, zgłasza to w komunikacie doradczym, podając oba pluginy i różnicę, i nigdy nie zatrzymuje się z tego powodu. Nieobecne, gdy żaden plugin nie obsługiwał tej zdolności.
rulesobject[]nieDokładne złożone reguły w kolejności ich stosowania: wzorce pluginu, następnie wiersze każdego pliku ignorowania wskazanego przez plugin, który został znaleziony podczas przeglądania, przy czym plik danego katalogu poprzedza pliki położone niżej, a na końcu wiersze pliku .aggregaignore autora obok encji. Późniejsze dopasowanie zastępuje wcześniejsze, więc plik autora ma ostatnie słowo w sprawie każdej ścieżki, którą wskazuje, a wiersz zaczynający się od ! przywraca to, co wykluczyła wcześniejsza reguła. Katalog wykluczony przez regułę nie jest przeglądany, więc plik w nim wraca dopiero wtedy, gdy wróci sam katalog.

Dodatkowe właściwości są niedozwolone.

entity-lock.ignore.plugin

Plugin, który obsługiwał zdolność encji w obszarze roboczym autora w chwili przypięcia encji — powiązanie dostawcy w obszarze roboczym dla tej zdolności, a w przeciwnym razie plugin wbudowany w plik binarny aggrega — wskazany bez wersji, oraz zadeklarowane przez niego reguły ignorowania. Nie jest zapisywana ani wersja, ani skrót pluginu: każdy odczyt stosuje reguły, więc ponowne przypięcie przy innym wydaniu tego samego pluginu pozostawia blokadę bez zmian, chyba że zmieniły się reguły. Pobranie, którego własny plugin dla tej zdolności deklaruje inne reguły, zgłasza to w komunikacie doradczym, podając oba pluginy i różnicę, i nigdy nie zatrzymuje się z tego powodu. Nieobecne, gdy żaden plugin nie obsługiwał tej zdolności.

WłaściwośćTypWymaganaOpis
namestringtakPlugin, który obsługiwał zdolność encji w chwili jej przypięcia, w postaci <pluginType>/<name>, bez wersji: odczyt stosuje poniższe reguły, a nazwa mówi, czyje one były. Co najmniej 1 znak.
patternsstring[]nieWzorce ignorowania zadeklarowane przez plugin, w postaci, w jakiej je zadeklarował.
filesstring[]nieNazwy plików ignorowania, które według deklaracji pluginu jego ekosystem respektuje wewnątrz źródła.

Dodatkowe właściwości są niedozwolone.

entity-lock.ignore.rules[]
WłaściwośćTypWymaganaOpis
patternstringtakJeden wzorzec ignorowania w składni gitignore.
withinstringtakKatalog, do którego ograniczony jest wzorzec, względem katalogu zawierającego dokument encji, zapisany z ukośnikami; . oznacza sam ten katalog. Wzorzec zadeklarowany przez plugin jest ograniczony do lokalnego katalogu źródła, wiersz pliku ignorowania — do katalogu zawierającego ten plik, a wiersz pliku .aggregaignore autora — do katalogu encji.
fromstringtakMiejsce deklaracji wzorca: plugin dla wzorca zadeklarowanego przez plugin, a w przeciwnym razie ścieżka pliku ignorowania, z którego go odczytano, względem katalogu zawierającego dokument encji.

Dodatkowe właściwości są niedozwolone.