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

Chart przechowywany w repozytorium git

Chart Helm nie musi pochodzić z rejestru chartów. Ten przykład pobiera chart przechowywany w repozytorium git — przykładowy chart hello-world projektu Helm — i buduje z niego manifesty Kubernetes.

Aggregate dewelopera nic o tym nie mówi. Deklaruje jeden core/compute/server, a to, skąd pochodzi pakiet tego serwera, rozstrzyga się w encji Recipe i wiąże w encji Manifest.

Blok źródła

catalog/recipe/helm/hello-world-git/1.0.0/recipe.yaml
source:
kind: git-repository
url: https://github.com/helm/examples.git
ref: hello-world-0.1.0
module_subdir: charts/hello-world

Trzy współrzędne, a każda odpowiada na inne pytanie:

  • url — repozytorium do sklonowania. Akceptowane są https://, ssh:// i git://. Do repozytorium prywatnego dociera się przez SSH za pośrednictwem agenta SSH lub przez HTTPS z wpisem dla jego hosta w pliku netrc — machine github.com login <user> password <token>. Poświadczenie zapisane w samym adresie URL jest odrzucane, jak opisano w sekcji Uwierzytelnianie.
  • ref — referencja, w której należy odczytać repozytorium: tag, gałąź lub commit. Jest to nazwa nadana przez autorów repozytorium, która nie zawsze jest samą wersją — tutaj tag zawiera również nazwę chartu.
  • module_subdir — katalog w repozytorium, który stanowi chart. Repozytorium zawiera chart pod tą ścieżką, a nie samo nim jest, a katalog współokreśla odrębność artefaktu: dwa katalogi jednego repozytorium w jednym commicie to dwa artefakty, nie jeden.

Rodzaj źródła określa transport i lokalizację, a nie format. Ten sam rodzaj pobiera chart, moduł Terraform lub dowolny inny katalog plików; to, co zawiera katalog, jest sprawą konsumującego providera.

Co zapisuje plik blokady

Tylko commit wskazuje treść, która nie może się zmienić bez wiedzy użytkownika. Tag lub gałąź to nazwa, którą repozytorium może przestawić na inny commit, dlatego aggrega pull rozwiązuje referencję i zapisuje obie rzeczy — wpisaną referencję oraz commit, na który została rozwiązana:

# release-chart.lock
source_artifacts:
- kind: git-repository
url: https://github.com/helm/examples.git
module_subdir: charts/hello-world
pinned_version: f3dc419e558e6ccebce2ed447384e5d2e11de2f9
digest: sha256:2bee62cfc2efccc61d8e17efeb72f9f77ad7bd87f3ea4e50b1e4219c8d5a2c78
mediatype: application/gzip
referenced_by:
- entity: recipe
uri: helm/hello-world-git:1.0.0
field: spec.source
requested_ref: hello-world-0.1.0

Obie połówki mają swoje uzasadnienie. Commit jest tym, co pobiera build, więc build jest odtwarzalny. Referencja jest tym, po czym build wyszukuje wpis, co pozwala nadal pisać ref: hello-world-0.1.0 w encji Recipe i wciąż rozwiązywać ją do dokładnie tego commitu, na który wskazywał tag w chwili zapisu pliku blokady.

Generowanie przykładu

Ten przykład można zbudować za pomocą poniższych poleceń albo zlecić jego zbudowanie asystentowi AI.

Należy zapisać przykład w nowym folderze nazwanym tak jak on:

Terminal window
aggrega scaffold --example chart-from-git-repository

Następnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:

Terminal window
cd chart-from-git-repository

Kompilacja

Terminal window
aggrega build --release release-chart.yaml --auto-pull

Ten przykład zawiera dwa wydania, więc należy wskazać to, które ma zostać zbudowane. Pierwszy build wymaga pliku blokady, dlatego przekazano tu --auto-pull; jednorazowe uruchomienie aggrega pull --release release-chart.yaml wcześniej daje ten sam efekt i pozwala uruchamiać każdy kolejny build bez flagi.

Wyrenderowany Deployment zawiera wartości dostarczone przez Release, odwzorowane na własne nazwy wartości chartu:

dist/app/helm/web-deployment-web-hello-world.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: web-hello-world
[… omitted: the chart's own labels, and the labels and annotations every rendered document carries]
spec:
replicas: 2
[… omitted: the selector and the pod template's own labels]
spec:
serviceAccountName: web-hello-world
securityContext: {}
containers:
- name: hello-world
securityContext: {}
image: "nginx:1.27.3"
imagePullPolicy: IfNotPresent
[… omitted: the container port and the two probes]

Każdy build wypisuje jedno ostrzeżenie:

warning: node "web": .infra key "compute" is read by no template in recipe "hello-world-git" — correct the spelling, or remove the key

Jest ono trafne i warto je przeczytać, zamiast je wyciszać. Component core/compute/server oferuje parametr rozmiaru CPU i pamięci; ten konkretny chart nie udostępnia dla niego żadnych wartości, więc Recipe niczego tam nie odwzorowuje. Recipe ze źródłem odwzorowuje to, co chart, z którego korzysta, faktycznie przyjmuje, a kompilator zgłasza wartość, która nigdzie nie trafiła, zamiast udawać, że została użyta.

Z asystentem AI

Asystent AI skonfigurowany z narzędziami Aggrega może zrobić to samo: wystarczy wkleić mu ten prompt.

Używaj wyłącznie narzędzi Aggrega i nie twórz samodzielnie żadnego folderu. Jeśli folder obszaru roboczego nie zawiera jeszcze folderu `chart-from-git-repository`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `chart-from-git-repository` i bez `dir`: zapisze ono przykład w nowym folderze `chart-from-git-repository`. Następnie wywołaj narzędzie `build` z `workspace_root` ustawionym na `chart-from-git-repository`, `release` ustawionym na `release-chart.yaml`, `auto_pull` ustawionym na true i `write` ustawionym na true. Powiedz mi, które pliki zapisało budowanie; znajdują się w `chart-from-git-repository/dist/`.

Gdy referencja się przesuwa

Tag może zostać przestawiony w repozytorium. Gdy tak się stanie, kolejne zwykłe aggrega pull stwierdza, że referencja rozwiązuje się na inny commit niż zapisany, i zatrzymuje się zamiast go przyjąć:

# aggrega pull --release release-chart.yaml
#
# [E0130]
# lockfile: out of date; it no longer matches what its Release resolves to
# ---
# source-artifact kind=git-repository url=https://github.com/helm/examples.git
# module_subdir=charts/hello-world: reference "hello-world-0.1.0" moved — the
# lockfile pins 03f4a18d3c2b77b7ecd91d0324a95910d4f04152, and it now resolves to
# f3dc419e558e6ccebce2ed447384e5d2e11de2f9; adopt where it now points with
# `aggrega pull --upgrade --release <release>`

Komunikat podaje oba commity, więc przed podjęciem decyzji można dokładnie zobaczyć, co się przesunęło. Plik blokady pozostaje bez zmian — zatrzymanie następuje przed jakimkolwiek zapisem — a przyjęcie nowego commitu jest świadomym działaniem:

Terminal window
aggrega pull --upgrade --pin-sources --release release-chart.yaml

Przesunięta referencja to przypadek, do którego służy --upgrade: zwykły pull utrzymuje commit zapisany w pliku blokady i tylko upgrade przyjmuje miejsce, na które referencja teraz wskazuje. Samo --upgrade usuwa wszystkie zapisane przypięcia, dlatego najpierw prosi o potwierdzenie. Potrzebne jest też --pin-sources, ponieważ ta Recipe zapisuje również commit swojego źródła w pliku entity.lock obok niej: upgrade przepisuje to przypięcie na nowy commit, a bez tej flagi pull zatrzymuje się na blokadzie i wskazuje aggrega pin. Przepisany entity.lock należy zatwierdzić razem z encją Recipe.

Zmiana wprowadzona w tym obszarze roboczym, na przykład w encji Aggregate lub Release, to dryf innego rodzaju: kolejny build go zgłasza, a zwykłe aggrega pull --release release-chart.yaml go usuwa.

Przypięcie commitu w ref: zamiast tagu to drugi sposób uzyskania tej samej gwarancji, kosztem współrzędnej nieczytelnej dla człowieka.

Wydanie ochronne

release-negative.yaml ma zakończyć się niepowodzeniem i znajduje się tu, ponieważ ścieżka pobierania sprawdzana tylko w pomyślnym scenariuszu nic nie mówi o swoich zabezpieczeniach. Wdraża ten sam Aggregate przez manifest-negative.yaml, który wiąże Recipe identyczną z działającą z wyjątkiem referencji — wskazuje ona tag, którego repozytorium nie zawiera:

Terminal window
aggrega build --release release-negative.yaml --auto-pull
# exits non-zero
# [E0137]
# auto-pull: resolving the source of each Recipe and FeatureRecipe the Release
# uses: resolve: resolve source for recipe
# "helm/hello-world-git-missing-ref:1.0.0": sourceresolver: kind=git-repository
# url=https://github.com/helm/examples.git version=: oci: artifact not found at
# remote source (cause: reference not found)
[… omitted: the rest of that line, a remediation naming the URL and version to check]

Repozytorium jest osiągalne, a klonowanie się udaje; po prostu nie ma w nim takiej referencji, więc nie ma commitu do przypięcia ani niczego do zarchiwizowania.

Czego ten przykład wymaga od sieci

W odróżnieniu od większości tutejszych obszarów roboczych ten klonuje prawdziwe repozytorium przy pierwszym buildzie, więc ten build wymaga dostępu wychodzącego do hosta podanego w url. Gdy plik blokady i pamięć podręczna rozwiązań już istnieją, kolejne buildy czytają z pamięci podręcznej i działają całkowicie bez sieci — aggrega build --release release-chart.yaml --offline odtwarza te same bajty.