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

Stos Harbor — rejestr kontenerów wdrażany jako jedno wydanie

Ten przykład kompiluje rzeczywisty rejestr kontenerów do manifestów Kubernetes z jednej encji Aggregate napisanej przez programistę.

Rejestr kontenerów to wiele współpracujących usług — płaszczyzna sterowania złożona z API i usługi tokenów, magazyn obiektów blob OCI wraz z kontrolerem, konsola webowa, warstwa asynchronicznych procesów roboczych, skaner podatności, relacyjny backend, pamięć podręczna klucz-wartość oraz odwrotne proxy stojące przed nimi. Katalog opisuje to wszystko jako jeden Component, ponieważ sami opiekunowie rejestru publikują chart Helm, który wdraża całość jako jedno wydanie, w kolejności wymaganej przez jego usługi. Component deklaruje rejestr; Recipe opakowuje ten chart.

Rejestr jest importowany jako moduł: wielokrotnego użytku podagregat, który komponuje encję Component i eksportuje jej opublikowany adres. Aggregate najwyższego poziomu importuje moduł po nazwie i przekazuje mu trzy klucze rejestru; operator określa rozmiar komponentu modułu w encji Release.

Pliki

PlikRola
aggregate.yamlIntencja dewelopera: importuje moduł rejestru kontenerów (core/harbor) i przekazuje mu trzy klucze rejestru z własnych parametrów.
manifest-helm-synth.yamlMapuje typ komponentu rejestru na Recipe opakowujący jego chart Helm, a Feature poświadczeń na realizację odczytującą Secret istniejący już w przestrzeni nazw — z wyjątkiem hasła administratora, które wiąże po nazwie z realizacją emitującą Secret z parametru modułu.
release-helm-synth.yamlZapis operatora dla celu Kubernetes. Wskazuje Secrets przechowujące trzy klucze przekazywane przez Aggregate, ustala rozmiar komponentu modułu na podstawie jego identyfikatora w zakresie modułu oraz dołącza do niego klucz podpisywania tokenów, wspólny sekret usług i klucz, którym szyfrowane są przechowywane poświadczenia, wskazując przechowujące je Secrets; wszystko inne pozostaje przy wartościach domyślnych schematu.

Co demonstruje

  • Produkt wielousługowy jako jeden Component. O tym, że rejestr jest jednym Component, a nie kilkoma, decyduje nie jego rozmiar, lecz miejsce, w którym utrzymywane są jego powiązania: routing odwrotnego proxy, klucz usługi tokenów, względem którego płaszczyzna sterowania sprawdza każde pobranie i wypchnięcie, ustawienia połączeń, które każda usługa odczytuje dla backendu i pamięci podręcznej, podział na logiczne bazy danych rozdzielający przestrzenie kluczy pamięci podręcznej usług oraz kolejność uruchamiania — wszystko to jest utrzymywane w zgodzie z produktem przez osoby, które go dostarczają, wewnątrz chartu. Konsument deklaruje rejestr i otrzymuje te elementy wzajemnie uzgodnione.
  • Opakowany chart. Recipe wskazuje chart w source: i nakłada na niego valuesMapping: — szablon wartości stanowi całą implementację, a provider Helm renderuje względem niego własne szablony chartu. Żaden workload nie jest tu syntetyzowany.
  • Przypięte wejście zewnętrzne. Chart jest wejściem pobieranym przez kompilację, dlatego przypina się go jak każdą zależność: plik blokady zapisuje wersję chartu, jego rozwiązany URL i skrót archiwum tarball w source_artifacts. Kompilacja z wypełnionym plikiem blokady serwuje chart z magazynu treści i weryfikuje go względem tego skrótu.
  • Jeden opublikowany adres dla całej platformy. Odwrotne proxy chartu kieruje ścieżkę przeglądarki / do konsoli, a ścieżki rejestru i API (/v2/, /api/, /service/, /c/) do płaszczyzny sterowania, dzięki czemu klient kontenerów loguje się, wypycha i pobiera obrazy na tym samym hoście, na którym przeglądarka otwiera konsolę. To właśnie ten Service publikuje provides.host, a konsument nie potrzebuje drugiego adresu, aby dotrzeć do którejkolwiek grupy ścieżek.
  • Dwie publiczne nazwy. Moduł eksportuje ten jeden adres jako registry, punkt końcowy, z którym komunikują się klienci obrazów i API, oraz jako ui, punkt końcowy interfejsu webowego. Obie nazwy wskazują adres obsługujący obie grupy ścieżek, więc konsument podłącza się do tej nazwy, która opisuje jego zamiar.
  • Wymiarowanie komponentu modułu przez operatora. Release adresuje komponent modułu przez jego identyfikator o zasięgu modułu (harbor.registry), aby ustawić zasoby obliczeniowe, bez powtarzania fizycznego wymiarowania w encji Aggregate dewelopera.
  • Reguły kompletności dla wartości grupowej. infra.compute zawiera klucz CPU i klucz pamięci, a Recipe zatrzymuje się na grupie, która pozostawia którykolwiek z nich pusty. Płaszczyzna sterowania wyrenderowana z limitem CPU i bez limitu pamięci istotnie różni się od tej, którą opisują zadeklarowane wartości domyślne encji Component, a nic w wyrenderowanym wyniku by o tym nie świadczyło — dlatego kompilacja zatrzymuje się i wskazuje brakujący klucz. Klucz pominięty w grupie przyjmuje wartość domyślną encji Component.
  • Sześć kluczy bez wartości domyślnej. Klucz, którym usługa tokenów podpisuje tokeny rejestru, wraz z jego certyfikatem; trzy sekrety, którymi własne usługi rejestru uwierzytelniają się wzajemnie i podpisują stan przesyłania; klucz ochrony przed fałszowaniem żądań oraz klucz, którym płaszczyzna sterowania szyfruje przechowywane poświadczenia, nie mają wartości domyślnej: klucz znany każdemu czytelnikowi katalogu pozwoliłby każdemu wystawiać tokeny, którym rejestr ufa, lub odczytywać to, co przechowuje. Component deklaruje te sloty jako wymagane, więc kompilacja, która pozostawi jeden pusty, zatrzymuje się i wskazuje ten slot. Kompilacja nie odczytuje żadnej z sześciu wartości i żadnej nie renderuje: każdy workload odczytuje każdą z nich z sekretu Secret, który wskazuje.
  • Trzy klucze dołączane przez Release. Moduł nie dołącza ani klucza podpisującego tokeny, ani współdzielonego sekretu płaszczyzny sterowania, ani klucza, którym szyfrowane są przechowywane poświadczenia, dlatego Release dołącza wszystkie trzy do komponentu modułu, token_key, core_secret i secret_key, każdy przez core/referenced-secret z infra.origin wskazującym sekret Secret, a Manifest wiąże encję Feature z k8s-existing-secret. Płaszczyzna sterowania montuje klucz podpisujący tokeny i klucz szyfrujący z sekretów Secret, które wskazują, a usługi odczytują współdzielony sekret ze swoich.
  • Poświadczenia wypełniane przez moduł. Hasło konta administratora, klucz ochrony przed fałszowaniem żądań międzywitrynowych, współdzielony sekret warstwy workerów i sekret stanu przesyłania magazynu blobów również są slotami poświadczeń encji Component, a moduł wypełnia każdy z nich z własnego parametru (admin_password, csrf_key, jobservice_secret, registry_http_secret) przez credential Feature core/referenced-secret, więc każdy workload odczytuje je z sekretu Secret po nazwie. Ponieważ moduł dołącza tę encję Feature, Manifest ją mapuje. Te trzy klucze nie mają wartości domyślnej również w module, dlatego Aggregate deklaruje własne parametry i przekazuje je dalej przez aggregates.harbor.parameters, Release je wypełnia, a k8s-existing-secret odczytuje każdy jako nazwę sekretu Secret, który już istnieje w przestrzeni nazw; Release, który nie podaje wartości, zatrzymuje kompilację, wskazując parametr. Ten przykład pozostawia hasło administratora na deweloperskiej wartości domyślnej modułu, a Manifest wiąże to jedno dołączenie po nazwie z k8s-secret-from-parameter, który emituje zawierający je sekret Secret. Pozostałe hasła są zapisywane w konfiguracji renderowanej przez Release, więc zastępuje się je, ustawiając infra; jeśli nie zostaną ustawione, każde przyjmuje wartość deweloperską podaną przez Recipe.
  • Deterministyczny wynik z chartu, który w przeciwnym razie generowałby materiał. Pozostawiony sam sobie chart wystawia własne sekrety, gdy żadne nie zostaną podane — współdzielony sekret i sekret podpisujący tokeny płaszczyzny sterowania, sekrety warstwy workerów i magazynu blobów, klucz ochrony przed fałszowaniem żądań oraz zahaszowane hasło magazynu blobów, które przy każdym renderowaniu haszuje ponownie ze świeżą solą. Każdy z nich jest więc podawany: sześć kluczy zawsze z sekretów Secret wskazanych przez Release, a hasła z dołączonego poświadczenia po nazwie tam, gdzie slot jest wypełniony, i ze stałej wartości deweloperskiej tam, gdzie nie jest, dzięki czemu dwa renderowania identycznego wejścia emitują identyczne bajty.
  • Odtwarzalne obrazy. Każdy obraz uruchamiany przez rejestr jest przypięty do jawnego tagu. Produkt dostarcza je wszystkie z jednym tagiem, więc infra.engine_version wybiera wszystkie naraz; infra.overrides.image zastępuje przypięcie pojedynczej usługi, a infra.overrides.image_prefix przenosi je wszystkie razem dla encji Release pobierającej obrazy z mirrora.

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 harbor-stack

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

Terminal window
cd harbor-stack

Kompilacja

Ta przestrzeń robocza nie zawiera pliku .aggrega-config.yaml, więc encje biblioteki standardowej są rozwiązywane z rejestru hub, hub.aggrega.ai, i nie jest potrzebna żadna flaga katalogu. Recipe pobiera chart, dlatego najpierw należy rozwiązać zależności do pliku blokady:

Terminal window
aggrega pull --release release-helm-synth.yaml
aggrega build --release release-helm-synth.yaml

Wyrenderowane artefakty trafiają do dist/.

Przed ich zastosowaniem należy utworzyć sześć obiektów Secret, które Release wskazuje, w przestrzeni nazw, do której wdrażany jest rejestr: harbor-token-key, zawierający klucz prywatny RSA pod kluczem danych tls.key oraz certyfikat dla tego klucza pod tls.crt; harbor-core-secret, zawierający 16-znakowy sekret pod kluczem danych secret; harbor-secret-key, zawierający 16-znakowy klucz pod secretKey; harbor-csrf-key, zawierający 32-znakowy klucz pod CSRF_KEY; oraz harbor-jobservice-secret i harbor-registry-http-secret, zawierające 16-znakowy sekret pod JOBSERVICE_SECRET i REGISTRY_HTTP_SECRET. Na przykład:

Terminal window
openssl req -x509 -newkey rsa:4096 -nodes -days 3650 -subj "/CN=harbor-token-ca" \
-keyout tls.key -out tls.crt
kubectl create secret tls harbor-token-key --key tls.key --cert tls.crt
kubectl create secret generic harbor-core-secret --from-literal=secret="$(openssl rand -hex 8)"
kubectl create secret generic harbor-secret-key --from-literal=secretKey="$(openssl rand -hex 8)"
kubectl create secret generic harbor-csrf-key --from-literal=CSRF_KEY="$(openssl rand -hex 16)"
kubectl create secret generic harbor-jobservice-secret --from-literal=JOBSERVICE_SECRET="$(openssl rand -hex 8)"
kubectl create secret generic harbor-registry-http-secret --from-literal=REGISTRY_HTTP_SECRET="$(openssl rand -hex 8)"

Rejestr, którego usługi nie mogą znaleźć tych obiektów Secret, nie uruchomi się.

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 `harbor-stack`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `harbor-stack` i bez `dir`: zapisuje ono przykład w nowym folderze `harbor-stack`. Następnie wywołaj narzędzie `build` z `workspace_root` ustawionym na `harbor-stack`, `release` ustawionym na `release-helm-synth.yaml`, `auto_pull` ustawionym na true i `write` ustawionym na true. Podaj mi, które pliki zapisała kompilacja; znajdują się w `harbor-stack/dist/`.

Jak wygląda złożony rejestr

Kompilacja emituje zasoby, które chart definiuje dla tej konfiguracji: obiekty Deployment dla odwrotnego proxy, konsoli, płaszczyzny sterowania, warstwy workerów i magazynu blobów; obiekty StatefulSet dla backendu, pamięci podręcznej i skanera; żądania trwałych woluminów dla magazynu blobów i dla logów warstwy workerów; obiekty ConfigMap i Secret odczytywane przez poszczególne usługi; oraz obiekty Service udostępniające je na zewnątrz. Obok nich encja Feature odpowiedzialna za poświadczenia emituje jeden obiekt Secret, harbor-zdregistry-admin-password, zawierający domyślną wartość deweloperską modułu dla hasła administratora, którą płaszczyzna sterowania odczytuje z niego, a nie z obiektu Secret samego chartu. Dla żadnego z sześciu kluczy nie jest emitowany obiekt Secret: płaszczyzna sterowania montuje klucz podpisujący tokeny z harbor-token-key, a klucz szyfrujący z harbor-secret-key, natomiast usługi odczytują pozostałe z harbor-core-secret, harbor-csrf-key, harbor-jobservice-secret i harbor-registry-http-secret, czyli z obiektów Secret wskazanych przez encję Release.

Dokładnie jeden z tych obiektów Service jest adresem, do którego podłączają się konsumenci — dist/app/helm/harbor.registry-service-default-harbor-zdregistry.yaml:

apiVersion: v1
kind: Service
metadata:
name: harbor-zdregistry
[… omitted: the namespace, the chart's labels, and the labels and annotations every rendered document carries]
spec:
type: ClusterIP
ports:
- name: http
port: 80
targetPort: 8080
selector:
release: harbor-zdregistry
app: "harbor"
component: nginx

Jego selektor wskazuje odwrotne proxy, dzięki czemu rejestr ma jeden adres. port podąża za infra.port; proxy za nim nasłuchuje na porcie ustalonym przez chart, a Service przekierowuje do niego ruch, więc zmiana infra.port zmienia opublikowany adres, a nie port nasłuchiwania.

Nazewnictwo: przełącznik, który publikuje adres, nie jest przełącznikiem, który nadaje nazwy zasobom

Ten chart wyprowadza większość nazw swoich zasobów z przełącznika nazwy najwyższego poziomu, a następnie dodaje do nich sufiksy — Service warstwy sterowania to <instance>-core, konsoli <instance>-portal, magazynu blobów <instance>-registry i tak dalej dla warstwy workerów, skanera, backendu i cache. Żaden zasób nie nosi samej nazwy bez sufiksu.

Publikowany Service otrzymuje nazwę z osobnego przełącznika, ograniczonego do ekspozycji, którego własną wartością domyślną jest stały literał niezależny od nazwy najwyższego poziomu. Recipe ustalający tylko przełącznik najwyższego poziomu publikowałby adres, pod którym nie odpowiada żaden Service, a dwie instancje w jednej przestrzeni nazw emitowałyby Service pod tym samym stałym literałem i kolidowałyby ze sobą. Dlatego Recipe ustawia oba przełączniki na podstawie ID instancji, i właśnie dlatego wyemitowany powyżej Service nosi nazwę instancji, a provides.host wskazuje adres, który istnieje.

Warto przeczytać to uważnie przy opakowywaniu dowolnego chartu platformowego: provides.host musi wskazywać Service, który chart faktycznie tworzy, a to, który przełącznik o tym decyduje, jest właściwością danego chartu, a nie konwencją wspólną dla chartów.

Czego ta konfiguracja nie obejmuje

Ingress chartu pozostaje wyłączony, a reverse proxy jest zamiast tego wystawione jako Service wewnętrzny dla klastra, ponieważ encja Component publikuje adres wewnątrz klastra, a nie zewnętrzną nazwę hosta. Pojedynczy zewnętrzny punkt końcowy jest składany w warstwie ingress i kieruje ruch na adres eksportowany przez ten moduł. Szyfrowanie transportu jest wyłączone, ponieważ własne źródło certyfikatów chartu generuje urząd certyfikacji i podpisany certyfikat w czasie renderowania, czego dwa renderowania identycznego wejścia by nie odtworzyły. Monitor operatora Prometheus jest wyłączony.

Metryki rejestru również są wyłączone. Klucz values.metrics_enabled encji Component włącza je dla warstwy sterującej, warstwy workerów, magazynu blobów i dodatkowego eksportera oraz publikuje cztery obiekty Service do wykrycia przez scraper; to samo ustawienie chartu otwiera też listener debugowania magazynu blobów — profilowanie, ślady wykonania i zmienne środowiska uruchomieniowego, bez sprawdzania wywołującego — dla każdego wywołującego wewnątrz klastra. Moduł pozostawia tę wartość przy domyślnym false, więc ten przykład nie renderuje metryk; może ją ustawić encja Aggregate, która sama deklaruje encję Component. Obraz eksportera jest mimo to przypięty razem z pozostałymi.