Provider Compose
Provider compose renderuje encje Recipes systemu Aggrega do pliku Docker Compose. Provider składa wynik dla każdej pary (path, provider): kontrybutorzy compose każdej granicy są kierowani do asemblera o kluczu będącym obliczonym directory: granicy połączonym z subDirectory: danego komponentu, a ten asembler emituje jeden plik docker-compose.yaml zawierający wszystkich kontrybutorów pod tą ścieżką. Dwie sąsiednie granice, które dają tę samą ścieżkę, scalają się w jeden połączony plik compose — kanonicznym przykładem jest granica nadrzędna z dwiema granicami podrzędnymi z directory: "{{ .parent_boundary.directory }}" (wzorzec compose-bridge).
Obsługiwane rodzaje wejścia
Provider compose przyjmuje wszystkie trzy rodzaje wejścia encji Recipe:
- Tryb źródłowy. Encja Recipe z
source:wskazującym istniejący plik compose orazvaluesMapping:tworzącym dokument nakładki. Bazowy plik compose jest wczytywany, nakładka jest ewaluowana, a oba dokumenty są głęboko scalane zgodnie z natywną semantyką nakładek docker-compose. - Tryb Workload. Encja Recipe z
workload:(wbudowanym lub wczytanym przez$import:) deklaruje dokumentWorkload. Provider syntetyzuje z jego specyfikacji Workload jedną lub więcej usług compose. - Tryb artefaktów. Wpisy
artifacts:encji Recipe są ewaluowane do fragmentów compose, które scalają się z zestawionym plikiem według zasad opisanych w Fragmenty compose emitowane przez artefakty. Artefakty mogą występować obok źródła lub encji Workload, ale mogą też stanowić całe wyjście encji Recipe: encja Recipe deklarującaartifacts:bezsource:i bezworkload:jest tu renderowana i wnosi to, co deklarują jej fragmenty. W ten sposób komponent składający się wyłącznie z zasobów — wspólnego zestawu sieci i wolumenów, wstępnie wypełnionej konfiguracji — trafia do wdrożenia compose bez zastępczej encji Workload udającej moc obliczeniową, której nie ma.
Trzy rodzaje łączą się przez dodawanie, a encja Recipe, która nie deklaruje żadnego z nich, jest odrzucana przy wczytywaniu. Klucz valuesMapping: bez towarzyszącego mu source: również powoduje odrzucenie encji Recipe przy wczytywaniu, niezależnie od wskazanego providera: nie ma do czego zastosować nakładki, a komunikat diagnostyczny prosi o zadeklarowanie wskaźnika source: lub usunięcie valuesMapping:.
Mapowanie funkcji encji Workload
Gdy Recipe deklaruje workload:, provider tłumaczy kształt Workload należący do platformy na prymitywy compose. Mapowanie jest celowo wąskie — powierzchnia Compose jest uboższa w kształty niż Kubernetes, a kilka funkcji encji Workload degraduje się do najbliższego odpowiednika w compose z udokumentowaną utratą.
Pola kontenera
| Pole encji Workload | Pole Compose |
|---|---|
image | image |
imagePullPolicy: Always / IfNotPresent / Never | pull_policy: always / if_not_present / never |
command | entrypoint (forma listy) — nadpisuje punkt wejścia obrazu, a to robi właśnie ten klucz compose |
args | command (forma listy) — dostarcza argumenty, które otrzymuje punkt wejścia, a to właśnie nadpisuje command w compose |
variables | environment (forma mapy) |
attachments[as: env] | wpis environment z pustą wartością oraz ostrzeżenie wskazujące wpis (zob. Czego provider compose nie dostarcza) |
attachments[as: file] | volumes w formie długiej, bind-mount tylko do odczytu |
volumeMounts | prymityw compose, na który mapuje się wskazany wariant woluminu — wpis volumes w formie długiej, wpis tmpfs: na poziomie usługi lub referencja configs: na poziomie usługi (zob. Woluminy) |
ports | niejawne (kontenery compose udostępniają porty, na których nasłuchuje obraz) |
restartPolicy: Always | restart: unless-stopped |
restartPolicy: OnFailure | restart: on-failure |
restartPolicy: Never | restart: "no" |
variables i attachments[as: env] trafiają do jednej mapy environment: najpierw wpisy attachments, po nich variables, każde w kolejności zapisania — w tej samej kolejności, w jakiej zapisuje je provider helm, więc jeden Workload renderuje jedną sekwencję środowiska na każdym celu. Compose nie rozwija żadnej referencji $(NAME) między wpisami środowiska usługi, więc w compose ta kolejność nie ma znaczenia w czasie działania. Ponieważ mapa przechowuje każdą nazwę raz, kontener podający jedną nazwę zarówno jako wpis variables, jak i jako wpis attachments dostarczany as: env zatrzymuje budowanie, zamiast zachować jedną z dwóch wartości (zob. A container gives one environment variable two values (Kontener nadaje jednej zmiennej środowiskowej dwie wartości)).
Zasoby kontenera
resources kontenera trafiają do bloku deploy.resources w compose, który docker compose respektuje w trybie innym niż swarm. requests w Kubernetes wyrażają gwarantowane minimum, więc stają się reservations w compose; limits wyrażają twardy limit, więc pozostają limits.
| Pole encji Workload | Pole Compose | Tłumaczenie |
|---|---|---|
resources.requests.cpu | deploy.resources.reservations.cpus | Dziesiętna liczba rdzeni. Liczba rdzeni zapisana jako sama liczba (2, 0.5) jest emitowana tak, jak zapisano; każda inna forma jest przeliczana z jej wartości (500m → 0.5, 1500m → 1.5, 5n → 0.000000005, 1e1 → 10) |
resources.limits.cpu | deploy.resources.limits.cpus | To samo przeliczenie |
resources.requests.memory | deploy.resources.reservations.memory | Dokładna liczba bajtów, przeliczona z wartości niezależnie od formy zapisu — 8Gi staje się 8589934592, 1.5Gi staje się 1610612736, 1e3 staje się 1000 |
resources.limits.memory | deploy.resources.limits.memory | To samo przeliczenie |
nvidia.com/gpu w resources.limits, resources.requests lub w obu | deploy.resources.reservations.devices | Jeden wpis urządzenia NVIDIA w usłudze kontenera — driver: nvidia, count: z liczbą GPU, capabilities: [gpu]. Liczba pochodzi z limitu, jeśli limit jest zapisany — to liczba, którą Kubernetes planuje dla zasobu rozszerzonego — a w przeciwnym razie z żądania. Liczba 0 nie żąda żadnego GPU i nie zapisuje wpisu |
każdy inny klucz zasobu rozszerzonego — amd.com/gpu i każdy inny <domain>/<name> | — | Brak odpowiednika w jednohostowym compose. Klucz jest pomijany, a budowanie zgłasza ostrzeżenie unsupported-field wskazujące go, jedno na każdy odrębny klucz, niezależnie od tego, ile spośród requests i limits go zawierało. Jego wartość nie jest emitowana, więc nie jest sprawdzana |
Każda wartość cpu, memory i nvidia.com/gpu jest odczytywana jako ilość, w formie opisanej w Workload → Ilości zasobów, z encji Workload w postaci, w jakiej obliczyły ją szablony encji Recipe. Dwie sytuacje zatrzymują budowanie z TRANSLATION_ERROR, a błąd mówi, którą z nich napotkał, podając ścieżkę kontenera, to, czy wartość jest żądaniem, czy limitem, zasób i wartość:
- wartość, która nie jest ilością —
lots,1.5 coreslubm, które pusty szablon pozostawia w"{{ .infra.cpu }}m"; - ilość, której compose nie potrafi dokładnie przedstawić — wartość ujemna; ilość pamięci, która nie jest całkowitą liczbą bajtów (
1500m,4u) lub przekracza 9223372036854775807 bajtów (8Ei); ilość cpu dokładniejsza niż dziewięć miejsc dziesiętnych rdzenia, czyli najwyższa precyzja, jaką zachowuje sama ilość w Kubernetes, lub większa niż 9223372036.854775807 rdzeni; liczba GPU, która nie jest całkowitą liczbą urządzeń (0.5,500m).
Kontener, którego żądanie i limit nvidia.com/gpu podają różne liczby, zatrzymuje budowanie w ten sam sposób, wskazując obie ścieżki: compose rezerwuje dla usługi jedną liczbę, więc tłumaczenie musiałoby w przeciwnym razie wybrać jedną z nich. Należy zapisać tę samą liczbę w obu miejscach albo tylko limit.
Nic nie jest zaokrąglane i nie jest emitowana żadna wartość, która oznacza coś innego.
Żądanie GPU rezerwuje GPU NVIDIA. Kontener encji Workload żądający nvidia.com/gpu: "1" renderuje usługę z taką rezerwacją, obok wszelkich cpus i memory, które rezerwują jego żądania:
deploy: resources: reservations: devices: - driver: nvidia count: 1 capabilities: - gpuDocker Compose przekazuje zarezerwowane GPU kontenerowi, gdy host Dockera ma tyle GPU NVIDIA i jest skonfigurowany tak, aby udostępniać je kontenerom; budowanie nie widzi hosta, więc plik rezerwujący GPU jest składany tak samo, gdziekolwiek zostanie uruchomiony. Wpis zawsze podaje liczbę, ponieważ Compose odczytuje wpis urządzenia bez liczby jako wszystkie GPU na hoście. Tłumaczony jest tylko klucz NVIDIA: amd.com/gpu i klucze wszystkich innych producentów zachowują ostrzeżenie z wiersza o pominiętym kluczu. Wiersz runtimeClassName w Polach poziomu poda pozostaje bez zmian — compose nie ma odpowiednika klasy środowiska uruchomieniowego, więc Workload wskazujący środowisko uruchomieniowe z obsługą GPU otrzymuje informację, że środowisko zostało pominięte, a jego liczba GPU zostaje zarezerwowana.
Sondy
Trzy sloty sond encji Workload (live, ready, startup) zwijają się do pojedynczego healthcheck na usługę w compose, z priorytetem live > ready > startup (wygrywa najbardziej kanoniczny sygnał żywotności). Gdy to zwinięcie odrzuca slot zadeklarowany przez autora, budowanie zgłasza ostrzeżenie unsupported-field wskazujące przetłumaczony slot i odrzucone sloty, dzięki czemu intencja niedocierająca do żadnej części wyniku jest zgłaszana, a nie gubiona. Blok health deklarujący jeden slot tłumaczy się bez utraty i niczego nie zgłasza, chyba że slot ustawia successThreshold: healthcheck compose nie ma dla niego pola, więc zapisana przez autora wartość — łącznie z 1 — jest pomijana z ostrzeżeniem unsupported-field, które ją wskazuje (containers.<name>.health.<slot>.successThreshold), a reszta slotu tłumaczy się tak, jak pokazuje tabela poniżej.
| Kształt sondy encji Workload | healthcheck.test w Compose |
|---|---|
http: /path | ["CMD-SHELL", "curl -f http://localhost:<port>/path || exit 1"] |
tcp: <port> | ["CMD-SHELL", "nc -z localhost <port>"] |
exec: [cmd, ...] | ["CMD", cmd, ...] |
Forma HTTP wymaga, aby kontener deklarował co najmniej jeden nazwany port; syntezator wybiera pierwszą alfabetycznie nazwę portu i używa jego numeru do zbudowania adresu URL dla curl. Kontenery bez zadeklarowanych portów nie mogą używać sond HTTP — kompilator zatrzymuje się z TRANSLATION_ERROR, wskazując problematyczną sondę.
Pola limitów czasu sond mapują się na ciągi czasu trwania w stylu compose:
| Pole encji Workload | Pole healthcheck w Compose |
|---|---|
periodSeconds | interval: <n>s |
timeoutSeconds | timeout: <n>s |
failureThreshold | retries: <n> |
initialDelaySeconds | start_period: <n>s |
Wolumeny
Compose ma własny prymityw konfiguracji i na niego tłumaczony jest wolumen configmap. Nie ma natomiast odpowiednika Kubernetes dla Secret ani dla szablonów wolumenów per replika, więc te warianty degradują się do najbliższego prymitywu compose:
| Wariant wolumenu Workload | Tłumaczenie w compose | Uwagi o utracie |
|---|---|---|
ephemeral | wpis listy tmpfs: na poziomie usługi | sizeLimit nie jest zachowywany (krótka forma tmpfs w compose nie ma rozmiaru). Podany sizeLimit powoduje ostrzeżenie unsupported-field wskazujące go pod jego współrzędną (volumes.<name>.ephemeral.sizeLimit), niezależnie od tego, czy jakiś kontener montuje wolumen; pominięcie pola nie powoduje niczego |
configmap | odwołanie configs: na poziomie usługi wskazujące configmap, zamontowane w ścieżce montowania wolumenu | 🔴 Ścieżka montowania jest ścieżką pojedynczego pliku, a nie katalogu. Compose zapisuje zawartość konfiguracji dokładnie w ścieżce docelowej, podczas gdy cel Kubernetes montujący ConfigMap w ścieżce tworzy katalog z jednym plikiem na klucz. Ta sama podana path: oznacza więc tutaj plik, a tam katalog: montowanie wolumenu configmap należy kierować na nazwę pliku, który kontener ma odczytać (/seed/config.json), a nie na katalog, który by go zawierał, a encja Recipe tworzona dla obu celów zawiera inną ścieżkę dla każdego celu. Nic w kompilacji nie wykryje ścieżki zapisanej pod kształt drugiego celu — ścieżka jest nieprzezroczystym ciągiem, który kompilator przekazuje dalej, a wygenerowany wynik jest poprawny w obu przypadkach. Odwołanie następuje przez nazwę, dokładnie tak, jak cel Kubernetes odwołuje się do zasobu ConfigMap — nic nie odczytuje zawartości konfiguracji. Odpowiadający wpis configs: najwyższego poziomu pochodzi z wejścia artifacts: encji Recipe, którego fragment compose deklaruje go z wbudowanym content:; odwołanie bez takiego wpisu zatrzymuje kompilację (zob. Fragmenty compose emitowane przez artefakty). Odwołanie configs: zawiera nazwę konfiguracji i ścieżkę montowania i nic więcej, więc readOnly montowania nie ma osobnego wyrazu |
secret | volumes w formie długiej, bind-mount tylko do odczytu | Wolumen sekretu celowo nie korzysta z tłumaczenia configmap: wbudowany wpis configs: zapisałby wartość sekretu w wygenerowanym pliku compose otwartym tekstem, a kompilator nigdy nie rozwiązuje sekretu do otwartego tekstu — sekret pozostaje wskaźnikiem na każdym etapie kompilacji. Źródłem bind jest nazwa source sekretu, rozwiązywana jako ścieżka, którą operator udostępnia na hoście compose niezależnie od kompilacji |
persistent | nazwany wolumen + deklaracja volumes: { <volume-name>: {} } najwyższego poziomu, nazwany zgodnie z Jak wyprowadzana jest nazwa wolumenu | Klasa pamięci, tryby dostępu i rozmiar nie są zachowywane (compose nie ma równoważnej struktury). Zapisane class lub accessModes wywołuje ostrzeżenie unsupported-field, które wskazuje je pod zapisaną współrzędną (volumes.<name>.persistent.class, volumes.<name>.persistent.accessModes); pominięcie któregokolwiek z nich niczego nie wywołuje. Wymagany size nie wywołuje ostrzeżenia — patrz niżej |
persistentTemplate | nazwany wolumen + deklaracja najwyższego poziomu, nazwany w ten sam sposób (tak jak persistent) | Towarzyszy form: stateful; compose nie ma prymitywu szablonów wolumenów per replika, więc zachowanie per replika zostaje utracone, a ostrzeżenie unsupported-field informuje, że wolumen stał się jednym wolumenem współdzielonym przez wszystkie repliki. Klasa pamięci, tryby dostępu i rozmiar nie są zachowywane, dokładnie tak jak dla persistent: zapisane class lub accessModes wywołuje ostrzeżenie unsupported-field pod volumes.<name>.persistentTemplate.class lub volumes.<name>.persistentTemplate.accessModes, a wymagany size nie wywołuje żadnego |
Ustawienie subPath montowania montuje część wolumenu tam, gdzie compose ma na to formę. Wpis volumeMounts wskazujący wolumen persistent lub persistentTemplate z subPath staje się wpisem volumes w formie pełnej zawierającym volume.subpath, dzięki czemu montowanie widzi wskazany katalog lub plik wewnątrz wolumenu zamiast jego katalogu głównego, a dwa montowania jednego wolumenu z dwiema różnymi wartościami subPath widzą dwie różne jego części:
volumes: - type: volume source: store--data target: /var/lib/app/db volume: subpath: db - type: volume source: store--data target: /var/lib/app/uploads volume: subpath: uploadsMontowanie zapisane bez subPath nie zawiera bloku volume:. subPath na montowaniu wolumenu ephemeral, configmap lub secret zatrzymuje kompilację z TRANSLATION_ERROR, podając komponent, kontener, ścieżkę montowania zapisaną przez autora (containers.<name>.volumeMounts[<i>]), wolumen i subPath: te warianty trafiają do compose odpowiednio jako wpis tmpfs, odwołanie configs: i montowanie typu bind, z których żadne nie montuje części tego, co dostarcza, więc w przeciwnym razie montowanie widziałoby cały wolumen. Należy usunąć subPath z takiego montowania albo zamontować wolumen persistent. Docker Compose odczytuje volume.subpath od wydania 2.26.0, w Docker Engine 26.0 lub nowszym; kompilacja nie widzi hosta, który uruchomi plik, więc plik zawierający to pole jest składany tak samo bez względu na to, gdzie zostanie uruchomiony.
Wolumen mówi, jakim jest wariantem, i nic więcej. Wolumen secret ma dokładnie jedno tłumaczenie — powyższy bind mount tylko do odczytu — a wolumen nie ma pola as: do wyboru innego. Dostarczenie tego, co slot opublikował, jako zmiennej środowiskowej to wpis attachments kontenera (as: env), a nie wolumen; co compose z nim robi, opisano w Czego nie dostarcza provider compose.
Trzy warianty mają rozmiar pamięci, a tylko jeden ostrzega, że rozmiar został pominięty. Różnica polega na tym, czy istniał wybór. sizeLimit wolumenu ephemeral jest opcjonalny, więc jego zapisanie było decyzją, a ostrzeżenie informuje, że wartość niczego nie kształtuje na tym celu i można ją usunąć — jest doradcze i poza pasmem, wygenerowany plik jest bajt w bajt taki sam jak bez niego, a --no-unsupported-field-warnings wycisza je wraz z resztą klasy. size wolumenu persistent lub persistentTemplate jest wymagany, więc żadna wersja dokumentu go nie pomija: ostrzeżenie przy każdej kompilacji pojawiałoby się dla każdego stanowego obciążenia, nie wskazując niczego, co można zmienić, dlatego różnica jest wyjaśniona tutaj, a nie zgłaszana przy każdej kompilacji. Przy celu compose size, class i accessModes trwałego wolumenu niczego nie kształtują w wygenerowanym pliku — powstaje zwykły nazwany wolumen o rozmiarze i zapleczu domyślnych dla sterownika wolumenów hosta compose. class i accessModes są opcjonalne, więc każde z nich, które zostanie zapisane, jest zgłaszane tak jak sizeLimit wolumenu ephemeral: jedno ostrzeżenie unsupported-field na pole, doradcze i poza pasmem, wyciszane tą samą flagą. Pamięć bazową należy zwymiarować na hoście lub na celu Kubernetes, gdzie te pola trafiają do wyniku.
Wolumen, którego nie montuje żaden kontener, powoduje ostrzeżenie unsupported-field wskazujące go pod jego współrzędną (volumes.<name>), ponieważ to, co trafia wtedy do wygenerowanego pliku, różni się znacznie zależnie od wariantu. persistent i persistentTemplate nadal tworzą swoją deklarację najwyższego poziomu, więc wolumen zostaje utworzony i nic go nie używa. ephemeral, configmap i secret nie mają wyrazu poza samym montowaniem — każdy tłumaczy się na coś zapisanego w ścieżce montowania: odpowiednio wpis tmpfs, odwołanie configs lub bind mount — więc gdy nic go nie montuje, zadeklarowany wolumen nie zostawia w wyniku żadnego śladu. Ten drugi przypadek jest powodem istnienia ostrzeżenia: bez niego wolumen configmap, o którego montowaniu zapomniano, po prostu by zniknął, a w wygenerowanym pliku nie byłoby nic, co pozwoliłoby to zauważyć. Każdy kontener obciążenia liczy się jako montujący, łącznie z kontenerami init, więc wolumen montowany tylko przez kontener init jest podłączony i nie powoduje niczego. Ostrzeżenie jest doradcze i poza pasmem — wygenerowany plik jest bajt w bajt taki sam jak bez niego — a --no-unsupported-field-warnings wycisza tę klasę.
Jak wyprowadzana jest nazwa wolumenu
Wolumen persistent lub persistentTemplate staje się nazwanym wolumenem compose: jednym wpisem najwyższego poziomu w volumes:, do którego odwołuje się każdy kontener, który go montuje. Wolumen compose to współdzielona pamięć masowa, a blok najwyższego poziomu volumes: scala swoje wpisy według nazwy — dlatego dwa zdefiniowane wolumeny, które otrzymają tę samą nazwę, stają się jednym wolumenem, do którego piszą oba kontenery, a w wygenerowanym pliku nic nie wskazuje, że miały być dwa. Nazwa jest więc budowana z dwóch tożsamości, które razem określają, o który wolumen chodzi: <component>, do którego należy wolumen, oraz nazwy, którą Workload nadał wolumenowi w volumes:.
Nazwa wolumenu compose dopuszcza węższy zbiór znaków niż każda z tożsamości: litery, cyfry, kropki, podkreślenia i łączniki. Zamiast zastępować znak, którego compose nie akceptuje, wyprowadzanie zapisuje go w postaci rozwiniętej, dzięki czemu dwa wolumeny, które w ogóle się różnią, otrzymują dwie nazwy — a złożoną nazwę można odczytać z powrotem jako dwie tożsamości, z których powstała.
- Litera, cyfra, kropka i podkreślenie są przenoszone dokładnie tak, jak je zapisano.
- Łącznik jest zachowywany w zapisanej postaci wszędzie tam, gdzie następujący po nim znak jest przenoszony bezpośrednio i nie jest małą literą
z. Łącznik, po którym następuje mała literaz, otwiera sekwencję ucieczki, więc zapisany na tej pozycji łącznik sam jest zapisywany w postaci rozwiniętej —api-zonestaje sięapi-zhzone, co pozwala odczytać każdą nazwę z powrotem bez zgadywania. Łącznik, po którym nic nie następuje, jest z tego samego powodu zapisywany w postaci rozwiniętej, więcdb-dajedb-zh. - Każdy inny znak jest zapisywany jako
-z, po którym następuje litera go oznaczająca:sdla separatora ścieżki,hdla łącznika, którego powyższa reguła nie zachowuje. Wszystko inne — w tym spacja i litera spoza ASCII — jest zapisywane jakoxi sześciocyfrowy szesnastkowy punkt kodowy znaku, a bajt, który nie rozpoczyna żadnego znaku, jakobi jego własna dwucyfrowa wartość, dzięki czemu nazwa niebędąca poprawnym tekstem nadal jest zapisywana jednoznacznie, a nie scalana. - Pusta wartość jest zapisywana jako
-ze, czego żadna niepusta wartość nie może dać. - Dwie tożsamości są łączone za pomocą
--. Pojedyncza zakodowana tożsamość nigdy nie zawiera tej pary, więc połączona nazwa jednoznacznie wskazuje, gdzie kończy się jedna tożsamość, a zaczyna druga.
Zatem komponent store z wolumenem, który Workload nazywa data, daje nazwę wolumenu store--data, a db-server z data daje db-server--data. Identyczne wejście zawsze daje identyczną nazwę.
To podwójny łącznik sprawia, że para jest jednoznaczna, a łącznik jednoznakowy nie może tego zapewnić. Każda z tożsamości może sama zawierać łącznik, więc połączenie pojedynczym łącznikiem daje nazwę dającą się podzielić w więcej niż jednym miejscu: db z wolumenem data-cache i db-data z wolumenem cache dałyby oba db-data-cache, a ponieważ blok najwyższego poziomu scala według nazwy, oba komponenty współdzieliłyby jeden wolumen, a w wygenerowanym pliku nic by tego nie wskazywało. Zakodowana tożsamość nigdy nie zawiera pary łączników, więc podwójny łącznik nie dopuszcza drugiego odczytania: oba dają db--data-cache i db-data--cache.
Zmiana którejkolwiek tożsamości zmienia nazwę wolumenu compose, a compose nie zmienia nazwy wolumenu w miejscu. Wolumen jest tworzony od nowa pod nową nazwą, a stary pozostaje z danymi, więc kontener uruchamia się z pustą pamięcią masową, a zawartość leży w wolumenie, którego nic nie montuje. Zmianę którejkolwiek tożsamości należy traktować wyłącznie jako zastąpienie wymagające zaplanowania — kopii zapasowej, przeniesienia danych lub harmonogramu — a nie jako zmianę do wdrożenia.
Forma kontrolera
Pole form encji Workload wybiera abstrakcyjny kształt kontrolera (zob. entities/workload.md). Compose renderuje stateless i stateful (oraz pustą wartość domyślną, traktowaną jako stateless) jako długotrwałe usługi; forma stateful dodaje nazwany wolumen dla towarzyszącego persistentTemplate. Formy daemon, scheduled i task nie mają czystego odwzorowania w jednohostowym compose, więc Workload deklarujący jedną z nich i kierowany do granicy compose zatrzymuje się z błędem TRANSLATION_ERROR, podającym formę i obsługiwany zbiór — compose nie degraduje nieobsługiwanej formy do zwykłej usługi, która przeinaczałaby intencję. Encja Workload w formie reference deklaruje zewnętrzny punkt końcowy i nie ma kontenerów, więc compose nie emituje dla niej żadnej usługi.
Ponieważ dla encji Workload typu reference nie jest emitowana żadna usługa, nic nie odczytuje potoku dostarczania komponentu, który ona realizuje: poświadczenie dołączone do tego komponentu — dostarczane w jego potoku przez dotenv-secret lub przez własny blok inject: dołączenia — nie trafiłoby do żadnego emitowanego pliku. Dlatego każda encja Recipe biblioteki standardowej dla Compose, która realizuje w ten sposób usługę zewnętrzną i której encja Component deklaruje slot poświadczeń, odrzuca poświadczenie wypełniające ten slot: kompilacja zatrzymuje się, podając slot i komponent, zamiast zakończyć się sukcesem bez poświadczenia. W compose poświadczenie dla usługi zewnętrznej dołącza się do komponentu, który ją wywołuje, pod zmienną środowiskową odczytywaną przez ten komponent. To odrzucenie jest własną asercją każdej encji Recipe i jest wykonywane, zanim ten dostawca cokolwiek wyrenderuje. Ten dostawca odrzuca także na poziomie samego węzła, bez względu na to, z którego katalogu pochodzi encja Recipe: dołączenie na węźle reference, którego materiał jest zadeklarowany jako wrażliwy — jego encja Feature deklaruje pole jako sensitive: true lub tak deklaruje wypełniany przez nie slot — zatrzymuje kompilację z TRANSLATION_ERROR (E0288), podając węzeł i każde takie dołączenie, niezależnie od tego, czy jakikolwiek slot deklaruje nazwę, pod którą jest ono dołączone. Dołączenie, które nie zawiera niczego zadeklarowanego jako wrażliwe, nie jest tu odrzucane. Te encje Components deklarują swoje sloty poświadczeń jako opcjonalne, więc w compose pozostawiony pusty slot niczego nie zatrzymuje. Tam, gdzie realizacja w Kubernetes potrzebuje poświadczenia — w encjach Recipes helm dla twilio, vonage, telnyx, bland, letta, retell i vapi — ta encja Recipe zamiast tego wymaga slotu i zatrzymuje kompilację, podając go, gdy jest pusty.
Udostępnianie usług
Pole type wpisu services encji Workload decyduje, czy compose publikuje porty i na jakim adresie hosta:
| Typ usługi Workload | Zachowanie compose |
|---|---|
ClusterIP | Brak publikowania ports: — usługa jest osiągalna tylko w sieci compose |
NodePort | Publikowanie ports: [<host>:<container>] na każdym interfejsie hosta |
LoadBalancer | Publikowanie ports: [<host>:<container>] na każdym interfejsie hosta (compose nie ma odpowiednika zarządzanego load balancera; publikacja portu hosta jest najbliższym analogiem) |
Loopback | Publikowanie ports: [127.0.0.1:<host>:<container>] — osiągalne z samego hosta i znikąd indziej |
Headless | Brak publikowania ports: |
Który numer trafia na którą stronę. Wpis usługi wskazuje port kontenera i nadaje mu numer, tak jak obiekt Service Kubernetes mapuje swój port na targetPort. Numer wpisu jest stroną <host> publikowanej pary, a numer portu kontenera, na który rozwiązuje się nazwa, jest stroną <container>. Tak więc kontener deklarujący http: 8080 i wpis NodePort zapisujący http: 8081 publikują 8081:8080: port 8081 hosta prowadzi do portu, na którym działa kontener. Wpis z własnym numerem portu kontenera publikuje ten numer po obu stronach, 8080:8080. Węzeł równorzędny w sieci compose dociera do usługi po jej nazwie usługi na porcie kontenera, nigdy na porcie opublikowanym — opublikowany port należy do hosta — więc encja Recipe publikująca port według własnego wyboru nadal przekazuje swoim konsumentom port kontenera.
Wpis Loopback wiąże wyłącznie adres pętli zwrotnej IPv4. Adres pętli zwrotnej IPv6 ::1 nie jest wiązany: składnia portów compose przenosi jeden adres hosta na wpis, a host, którego interfejs pętli zwrotnej nie ma adresu IPv6, nie mógłby go związać, więc usługa by się tam nie uruchomiła. Klienci na hoście łączą się z portem pod adresem 127.0.0.1.
Gdy wiele usług jednego Workload publikuje ten sam port kontenera pod tym samym numerem, port jest publikowany raz i wygrywa najszerszy zasięg: każde odwołanie NodePort lub LoadBalancer publikuje go na każdym interfejsie hosta, nawet jeśli wskazuje go również wpis Loopback i niezależnie od tego, który wpis zadeklarowano jako pierwszy; port wskazywany tylko przez wpisy Loopback jest publikowany na 127.0.0.1. Jeden port kontenera opublikowany pod dwoma numerami jest publikowany dwukrotnie, raz pod każdym z nich. Opublikowane porty są wymieniane w kolejności portów kontenera, a w obrębie jednego portu kontenera — według portu opublikowanego.
Transport portu. Opublikowany wpis przenosi transport zadeklarowany na wskazywanym porcie kontenera jako sufiks /protocol compose: 53:53/udp lub 127.0.0.1:53:53/udp dla wpisu Loopback. Port, który nie deklaruje transportu, jest publikowany jako <host>:<container> bez sufiksu, co pozostawia w mocy domyślne ustawienie compose. Compose zapisuje transport opublikowanego portu jako tcp lub udp; port deklarujący SCTP nie ma zapisu w compose, więc zatrzymuje się z błędem TRANSLATION_ERROR, zamiast publikować port przenoszący inny transport. Port kontenera, którego żadna usługa nie publikuje, w ogóle nie trafia do pliku compose, więc transport zadeklarowany na takim porcie nie ma gdzie zostać zapisany i nie powoduje zatrzymania.
Wielokontenerowe Workloads
Workload z wieloma kontenerami staje się jedną usługą główną oraz jedną usługą sidecar na każdy kontener inny niż główny. Kontenerem głównym jest kontener o nazwie main (jeśli istnieje) lub pierwszy kontener w kolejności deklaracji. Sidecary współdzielą przestrzeń nazw sieci usługi głównej przez network_mode: "service:<main>" — najbliższy prymityw compose względem modelu współdzielonej sieci poda Kubernetes.
Jak nazywana jest usługa sidecar lub init
Usługa główna nosi nazwę <component> bez zmian. Każda inna usługa tworzona przez definicję Workload — jedna na każdy sidecar i jedna na każdy kontener init — otrzymuje nazwę z dwóch tożsamości jednocześnie: <component> oraz nazwy kontenera, którą dla sidecara jest jego klucz w containers:, a dla kontenera init jego name, albo pozycyjna nazwa init-<index>, którą otrzymuje nienazwany wpis init. Złożony blok services: zawiera jedną usługę na nazwę, więc nazwa jest budowana tak, aby dwa kontenery różniące się którąkolwiek z tożsamości zawsze otrzymywały dwie różne nazwy.
Każda tożsamość jest zapisywana dokładnie tak jak dwie części nazwy wolumenu — litera, cyfra, kropka i podkreślenie tak, jak je zapisano, łącznik zachowany tam, gdzie zachowują go opisane tam reguły, a każdy inny znak zakodowany — a obie są łączone przez --, którego nie zawiera żadna zakodowana tożsamość. Tak więc komponent api z sidecarem logger uruchamia go jako api--logger, kontener init import-seed komponentu platform działa jako platform--import-seed, a nienazwany pierwszy wpis init komponentu api działa jako api--init-0. Nazwa kontenera zawierająca znak niedopuszczalny w nazwie usługi jest kodowana, a nie emitowana w zapisanej postaci: kontener init o nazwie warm cache/x komponentu api działa jako api--warm-zx000020cache-zsx.
Podwójne złączenie rozdziela kontenery dwóch komponentów. api z kontenerem warm-cache i api-warm z kontenerem cache działają jako api--warm-cache i api-warm--cache, dwie usługi, podczas gdy złączenie jednym łącznikiem zapisałoby obie jako api-warm-cache.
Sidecary i kontenery init dzielą ten jeden sposób nazywania, więc wpis containers i wpis initContainers o tej samej nazwie trafiają na tę samą nazwę usługi, a kompilacja zatrzymuje się na tej parze, zamiast uruchomić jeden kontener w miejsce drugiego (zob. Kontenery init).
Własna usługa komponentu nie przyjmuje żadnej z tych nazw. Usługa główna jest nazywana od komponentu, a podwójny łącznik zapisany w nazwie komponentu jest tam również kodowany — komponent o nazwie api--prep działa jako api-zh-prep — więc nigdy nie zawiera złączenia --. Gdy usługi dwóch różnych komponentów mimo to trafią na tę samą nazwę w jednym pliku compose — na przykład przez usługę, którą artefakt nazywa sam dla siebie — kompilacja zatrzymuje się, podając obie, jak opisuje Wynik per (path, provider).
Zmiana nazwy komponentu lub nazwy kontenera zmienia nazwę usługi. Compose traktuje usługę pod nową nazwą jak nową usługę, więc jej kontener jest tworzony od nowa pod nową nazwą.
Pola na poziomie poda
Pola encji Workload na poziomie poda dotyczą wyłącznie usługi głównej — sidecary współdzielą przestrzeń nazw sieci usługi głównej — a usługa init podlega tej samej zasadzie. Jedynym wyjątkiem jest użytkownik poda: pod uruchamia wszystkie swoje kontenery jako podSecurityContext.runAsUser i runAsGroup, więc docierają one do każdej usługi tworzonej przez encję Workload, łącznie z usługami sidecar i init.
Kilka z nich odpowiada polu usługi compose:
| Pole encji Workload | Pole Compose |
|---|---|
podSecurityContext.runAsUser / runAsGroup | user ("1000" lub 1000:3000 z grupą) na każdej usłudze encji Workload. Kontener ustawiający własny securityContext.runAsUser działa zamiast tego jako ten użytkownik na własnej usłudze, z własnym runAsGroup, jeśli go ustawia |
terminationGracePeriodSeconds | stop_grace_period: <n>s |
dnsConfig.nameservers / dnsConfig.searches | dns / dns_search |
hostAliases | jeden wpis extra_hosts na nazwę hosta, w kolejności autora |
hostNetwork: true | network_mode: host |
Uruchamianie w sieci węzła. Workload deklarujący hostNetwork: true otrzymuje network_mode: host we własnej usłudze, a ta usługa nie jest wtedy dołączana do sieci granicy: compose odrzuca usługę deklarującą jednocześnie networks: i network_mode:, więc oba ustawienia są alternatywami, a nie uzupełnieniami. Praktyczna konsekwencja jest ta sama, którą zawsze niesie sieć hosta — pozostałe usługi nie docierają już do tej usługi po nazwie usługi compose w tej sieci, ponieważ już w niej nie jest; docierają do niej pod własnymi adresami hosta, o co prosiła deklaracja. Pozostałe usługi na granicy nie są tym objęte.
Dwa kształty łączą się z tym ustawieniem. Sidecar nadal wskazuje usługę główną (network_mode: "service:<main>"), więc podąża za nią do sieci hosta, niczego sam nie deklarując — tak jak kontenery poda Kubernetes współdzielą jedną przestrzeń nazw. Usługa init tego nie robi: dołącza do sieci granicy samodzielnie, ponieważ współdzielenie przestrzeni nazw usługi głównej uczyniłoby oczekiwanie usługi głównej na nią cyklicznym. Workload z hostNetwork i initContainers uruchamia więc własną usługę w sieci hosta, a jego usługi init pozostają w sieci granicy, co jest węższe niż modelowany kształt poda; ostrzeżenie unsupported-field nazywa tę różnicę, zamiast pozostawiać ją do odkrycia w czasie działania.
Pozostałe nie mają odpowiednika na pojedynczym hoście. Żadne nie jest pomijane po cichu: każde podane przez autora wywołuje ostrzeżenie unsupported-field nazywające pole, dzięki czemu autor dowiaduje się, którego ustawienia cel nie mógł uwzględnić, zamiast odkryć to w działającym stosie.
| Pole encji Workload | Dlaczego compose nie może tego uwzględnić |
|---|---|
scheduling | Rozmieszczanie — nodeSelector, affinity, tolerations, topologySpreadConstraints — zakłada harmonogram wybierający spośród węzłów. Compose działa na jednym hoście |
replicas | Własna liczba replik compose znajduje się pod deploy: i jest funkcją trybu swarm |
runtimeClassName | Wybór alternatywnego środowiska uruchomieniowego kontenerów — na przykład obsługującego GPU — nie ma wyrażenia w compose |
priorityClassName | Kolejność wywłaszczania zakłada harmonogram |
serviceAccount | Tożsamość Workload jest pojęciem klastra |
imagePullSecrets | Poświadczenia rejestru na hoście compose to własny stan logowania hosta, a nie pole pliku |
dnsPolicy, dnsConfig.options | Compose udostępnia dns i dns_search i nic bardziej szczegółowego |
podSecurityContext.fsGroup, podSecurityContext.supplementalGroups | user niesie jednego użytkownika i jedną grupę; grupa, do której należą wolumeny poda, oraz dodatkowe grupy jego procesów nie są tłumaczone |
podSecurityContext.runAsGroup, gdy pod nie ustawia runAsUser lub gdy kontener — główny, sidecar lub init — ustawia własny runAsUser bez runAsGroup | user wskazuje grupę tylko obok użytkownika, a własny użytkownik kontenera zajmuje miejsce użytkownika poda, więc grupa poda nie trafia do żadnej usługi zapisanej w ten sposób |
securityContext na poziomie kontenera jest tłumaczony częściowo: readOnlyRootFilesystem → read_only, capabilities.add / drop → cap_add / cap_drop, runAsUser / runAsGroup → user. runAsNonRoot i allowPrivilegeEscalation nie mają wyrażenia w compose i wywołują to samo ostrzeżenie unsupported-field, podobnie jak runAsGroup kontenera zapisany bez runAsUser obok: usługa działa wtedy jako użytkownik poda, jeśli pod go ustawia, bez tej grupy.
Każde ostrzeżenie w tej sekcji jest informacyjne i poza głównym wynikiem: kompilacja kończy się powodzeniem, a emitowany plik jest bajt w bajt taki, jaki byłby bez niego. --no-unsupported-field-warnings wycisza tę klasę.
Kontenery init
Wpisy initContainers encji Workload stają się osobnymi usługami, zgodnie z idiomem compose „uruchom do zakończenia”. Każdy wpis dodaje jedną usługę, której nazwa powstaje z <component> i name wpisu według tego samego nazewnictwa, którego używają sidecary — <component>--<container-name> dla zwykłej nazwy; wpis bez name otrzymuje pozycyjną nazwę init-<index>, opisaną w dokumentacji encji Workload, i od niej bierze nazwę.
Kolejność, którą obiecuje kontrakt tworzenia — kontenery init działają do zakończenia w kolejności, w jakiej zostały zapisane, a każdy inny kontener uruchamia się dopiero po zakończeniu ich wszystkich — jest wyrażona za pomocą długiej formy depends_on:
- Każda usługa init po pierwszej czeka na swoją poprzedniczkę z warunkiem
condition: service_completed_successfully. - Usługa główna oraz każda usługa sidecar czekają na ostatnią usługę init z tym samym warunkiem. Czekanie na ostatnią wystarcza, ponieważ usługi init tworzą łańcuch.
- Każda usługa init ma
restart: "no". Usługa init uruchamia się raz; usługa, która zostałaby ponownie uruchomiona, nigdy nie osiągnęłaby stanu zakończenia, na który czekają zależne od niej usługi, dlategorestartPolicyzadeklarowane w kontenerze init tego nie zmienia.
services: platform: image: platform:1.0 depends_on: platform--verify-seed: condition: service_completed_successfully platform--import-seed: image: platform:1.0 restart: "no" platform--verify-seed: image: platform:1.0 depends_on: platform--import-seed: condition: service_completed_successfully restart: "no"Kontener init jest tłumaczony dokładnie tak jak każdy inny kontener: jego image (łącznie z przepisaniem rejestru, które stosuje adnotacja aggrega.ai/image-registry), command, args, variables, attachments, volumeMounts i securityContext trafiają do usługi init. Dzięki temu konfiguracja, którą niesie kontener init — najczęściej plik, który montuje i zapisuje do wolumenu montowanego także przez kontener główny — przetrwa w docelowym compose, zamiast przepaść wraz z kontenerem. Kształt, którego compose nie potrafi wyrazić, kończy się błędem tak samo dla kontenera init jak dla zwykłego: zadeklarowane lifecycle lub envFrom zatrzymuje kompilację błędem TRANSLATION_ERROR wskazującym kontener init, z którego pochodzi.
Z faktu, że usługa init nie jest usługą główną, wynikają dwie różnice względem usługi głównej:
- Pola encji Workload na poziomie poda nie są stosowane, zgodnie z tą samą regułą, którą podlegają sidecary — z wyjątkiem użytkownika poda, który dociera do każdej usługi, jak opisano w sekcji Pola na poziomie poda.
- Usługa init dołącza bezpośrednio do sieci swojej granicy, zamiast współdzielić przestrzeń nazw sieci usługi głównej, jak robi to sidecar. Musi tak być: usługa główna czeka na usługę init, a współdzielenie przestrzeni nazw samo w sobie jest zależnością od usługi głównej, co zamknęłoby oczekiwanie w cykl, którego compose odmawia uruchomienia. Kontener init osiąga więc inne usługi w sieci granicy po nazwie usługi, ale nie współdzieli
localhostusługi głównej.
Usługi init i usługi sidecar współdzielą jedną przestrzeń nazw, ponieważ jedno nazewnictwo nadaje nazwy obu, więc wpis initContainers i wpis containers nie mogą mieć tej samej nazwy. W takim przypadku kompilator zatrzymuje się z błędem TRANSLATION_ERROR wskazującym węzeł, nazwę kontenera i nazwę usługi, której oba chciały użyć, zamiast pozwolić, by jedna usługa po cichu zastąpiła drugą.
Emitowanie warunku zakończenia nie podnosi minimalnej wersji Compose. condition i jego wartości należą do podstawowej specyfikacji Compose — w przeciwieństwie do pól restart i required występujących obok w tym samym bloku w długiej formie, które specyfikacja wiąże z konkretnymi wydaniami Compose. Każda minimalna wersja, której wymaga wyjście providera compose, pojawia się wraz z konstrukcją, która jej potrzebuje: ≥ 2.23.1 dla wbudowanego configs.content, ≥ 2.26.0 dla subPath montowania (zob. Wolumeny) i 2.38 dla modeli. Pierwsza z nich dotyczy każdego wyjścia compose zawierającego konfigurację z wbudowanym content:, w ten sposób bowiem trafiają tam zarówno plik stojący za wolumenem configmap, jak i konfiguracja stojąca za mostkowaną krawędzią międzysieciową — nie tylko jedna ścieżka tworzenia.
Do której sieci dołącza usługa
Każda usługa dołącza do sieci Docker; sidecary dziedziczą ją przez swoje odwołanie network_mode do usługi głównej. To, do której sieci trafia węzeł, jest odczytywane z adnotacji aggrega.ai/namespace na tym węźle, a gdy węzeł nie ma takiej adnotacji, ze ścieżki pliku compose — katalogu, do którego plik jest zapisywany w katalogu wyjściowym kompilacji, na przykład bridge/compose dla granicy, której directory: to bridge. Tak więc każdy węzeł bez adnotacji w jednym pliku compose dołącza do jednej sieci nazwanej od ścieżki pliku, niezależnie od granicy, w której się znajduje: granice bez adnotacji współdzielące plik compose współdzielą tę sieć, a tym, co je rozdziela, jest aggrega.ai/namespace. Węzły z różnymi adnotacjami trafiają do jednej sieci na każdą odrębną adnotację. Jak wyprowadzana jest nazwa sieci to nazwa, którą wytwarza ta tożsamość.
Jak wyprowadzana jest nazwa sieci
Sieć compose to współdzielona łączność L3, a blok najwyższego poziomu networks: łączy swoje wpisy według nazwy — więc dwie tożsamości, które dają jedną nazwę, stają się jedną siecią, w której znajdują się oba zestawy usług, osiągające się nawzajem po nazwie usługi, przy czym nic w wygenerowanym pliku nie wskazuje, że zamierzono dwie sieci. Dlatego nazwa jest budowana z tożsamości, która mówi, o którą sieć chodzi: adnotacji aggrega.ai/namespace węzła albo ścieżki pliku compose, gdy węzeł jej nie ma.
Nazwa sieci compose akceptuje węższy zestaw znaków, niż może zawierać którakolwiek z tożsamości: litery, cyfry, kropki, podkreślenia i łączniki. Zamiast zastępować znak, którego compose nie akceptuje, wyprowadzenie zapisuje go jawnie, dzięki czemu dwie tożsamości różniące się w jakikolwiek sposób dają dwie sieci — a nazwę można odczytać z powrotem do tożsamości, z której została zbudowana.
- Litera, cyfra, kropka i podkreślenie są przenoszone dokładnie tak, jak zostały zapisane, z zachowaniem wielkości liter. Zatem
prodiProdto dwie sieci, a nie jedna. - Łącznik jest zachowywany w zapisanej postaci wszędzie tam, gdzie następujący po nim znak jest przenoszony bezpośrednio i nie jest małą literą
z. Łącznik, po którym następuje mała literaz, otwiera sekwencję ucieczki, więc zapisany na tej pozycji łącznik sam jest zapisywany w postaci rozwiniętej —api-zonestaje sięapi-zhzone, co pozwala odczytać każdą nazwę z powrotem bez zgadywania. Łącznik, po którym nic nie następuje, jest z tego samego powodu zapisywany w postaci rozwiniętej, więcdb-dajedb-zh. - Każdy inny znak jest zapisywany jako
-z, po którym następuje litera go oznaczająca:sdla separatora ścieżki,hdla łącznika, którego powyższa reguła nie zachowuje. Wszystko inne — w tym spacja i litera spoza ASCII — jest zapisywane jakoxi sześciocyfrowy szesnastkowy punkt kodowy znaku, a bajt, który nie rozpoczyna żadnego znaku, jakobi jego własna dwucyfrowa wartość, dzięki czemu tożsamość niebędąca poprawnym tekstem nadal jest zapisywana odrębnie, a nie scalana. - Tożsamość całkowicie nieobecna — węzeł bez adnotacji
aggrega.ai/namespacew pliku compose bez ścieżki — jest zapisywana jako-ze, czego nie może wytworzyć żadna tożsamość zapisana przez autora. Sieć bez tożsamości nigdy więc nie współdzieli łączności z siecią, która ma tożsamość zapisaną w jakiś określony sposób.
Zatem przestrzeń nazw prod daje sieć prod, core-net daje core-net, a plik compose pod ścieżką dist/app/compose daje dist-zsapp-zscompose. Identyczne dane wejściowe zawsze dają identyczną nazwę.
Przestrzeń nazw i ścieżka pliku compose są zapisywane w tej samej przestrzeni. To dwa sposoby nazwania tego samego — sieci, w której znajduje się węzeł — więc węzeł z przestrzenią nazw app/compose i węzeł bez przestrzeni nazw w pliku compose pod ścieżką app/compose celowo trafiają do jednej sieci, dokładnie tak jak dwie granice z tą samą adnotacją aggrega.ai/namespace. Aby rozdzielić dwa węzły, należy nadać im różne tożsamości.
Zmiana tożsamości węzła zmienia nazwę sieci compose, a compose nie zmienia nazwy sieci w miejscu. Sieć jest tworzona od nowa pod nową nazwą, a każda usługa w niej jest odtwarzana, aby się do niej podłączyć, natomiast stara sieć pozostaje, dopóki coś jej nie usunie. Sieć nie przechowuje danych, więc nic nie zostaje utracone — ale kontenery w niej są restartowane, a wszystko, co utrzymuje połączenie w trakcie zmiany, traci je. Zmianę adnotacji przestrzeni nazw lub katalogu, do którego zapisywany jest plik compose, należy traktować jako zaplanowane ponowne wdrożenie, a nie jako wartość do skorygowania w miejscu.
Gdy dwie granice zbiegają się w jedną ścieżkę złożenia (wspólne directory:), ich węzły bez adnotacji aggrega.ai/namespace współdzielą jedyną sieć pliku; po nadaniu każdej granicy własnej adnotacji aggrega.ai/namespace scalony docker-compose.yaml deklaruje jeden wpis najwyższego poziomu networks: na każdą adnotację. Usługi z różnych granic w tym samym pliku compose mogą komunikować się po nazwach usług w ramach domyślnego rozwiązywania DNS compose, z zastrzeżeniem własnych reguł osiągalności między sieciami compose. Routing L4 między sieciami w obrębie jednego pliku compose umożliwia encja Feature compose-bridge z biblioteki standardowej, jako zawartość katalogu, której logiki ten dostawca w ogóle nie zawiera: dołączona do granicy będącej wspólnym przodkiem, jej encja FeatureRecipe wyprowadza bramę z krawędzi uses granicy, których oba końce są składane do jej własnego pliku compose i leżą w różnych sieciach tego pliku — usługę aggrega-gw, której konfiguracja nginx stream pośredniczy w każdej mostkowanej krawędzi (jeden blok server na krawędź, na porcie celu z zapasowym rozwiązaniem kolizji portBase) — a jej własne injectMapping przepisuje zmienną środowiskową hosta każdego konsumenta na aggrega-gw:<port> albo, gdy to samo połączenie dostarcza obie wartości, na aggrega-gw, przepisując zmienną portu na port nasłuchu. To przepisanie zastępuje wartość dostarczoną przez własne połączenie konsumenta; jeśli inna encja Feature dołączona do konsumenta dostarczyła tę samą zmienną, kompilacja zostaje przerwana z podaniem obu, zamiast ją zastąpić. valuesMapping encji FeatureRecipe zapisuje tę konfigurację jako montowaną konfigurację compose — wpis najwyższego poziomu configs: z wbudowanym content:, do którego odwołuje się brama i który jest montowany w /etc/nginx/nginx.conf; nie jest to kwestia montowania po stronie operatora — i wymienia każdy mostkowany punkt końcowy pod x-aggrega-networks-of bramy, które ten dostawca rozwiązuje na sieci, w których rozmieszczone są te punkty końcowe (poniżej). Krawędź, której oba końce są składane do dwóch plików compose, nie jest mostkowana i zachowuje własną nazwę celu; granica, która nie ma nic do zmostkowania, nadal zawiera bezczynną bramę, bez konfiguracji i bez sieci poza własną; a most dołączony do granicy, której plik compose nie zawiera żadnego komponentu, zatrzymuje kompilację, zamiast nigdzie nie zapisać bramy. Konfiguracja stream zawiera dyrektywę resolver i pośredniczy przez zmienną per krawędź (set $uN <host>; proxy_pass $uN), dzięki czemu każdy upstream jest rozwiązywany w momencie połączenia, a nie raz przy starcie — gołe proxy_pass do jeszcze niedziałającego celu w przeciwnym razie spowodowałoby awarię bramy przy uruchomieniu. (Znak $ w tych zmiennych jest escapowany do $$ wewnątrz configs.content, aby własna interpolacja $ w Docker Compose pozostawiła dla nginx dosłowny $.) Wbudowane configs.content wymaga Docker Compose ≥ 2.23.1. Zob. wzorzec compose-bridge.
Dołączanie do sieci innych komponentów — x-aggrega-networks-of
Usługa zapisana przez fragment — źródłowy plik compose po scaleniu z jego nakładką albo treść artifacts: — może dołączyć do sieci innych komponentów złożonych do tego samego pliku compose, wymieniając je pod kluczem rozszerzenia x-aggrega-networks-of: jest to lista identyfikatorów komponentów, tych, które encja Aggregate nadaje swoim komponentom, a które encja FeatureRecipe o zakresie granicy odczytuje jako klucze .boundary.components oraz jako source i target swoich list krawędzi .boundary. Dostawca rozwiązuje każdy identyfikator na sieć, w której ten komponent jest rozmieszczony w tym pliku, według tego samego rozmieszczenia, które otrzymuje każdy węzeł, i dodaje te sieci do usługi, każdą raz i w kolejności nazw, przed własną siecią usługi, do której usługa nadal dołącza. Sam klucz jest pomijany w złożonym pliku. Dostawca odczytuje identyfikatory jako odwołania do rozwiązania i nie odczytuje niczego o tym, co robi usługa, więc z klucza może korzystać dowolna encja Recipe lub FeatureRecipe; brama compose bridge w ten sposób dołącza do sieci punktów końcowych, między którymi przekazuje ruch.
# written by a FeatureRecipe attached at the boundary `bridge`, whose file holds adminer (namespace frontend) and db (namespace backend)services: probe-svc: image: busybox x-aggrega-networks-of: ["adminer", "db"]# dist/bridge/compose/docker-compose.yaml (abridged)services: probe-svc: image: busybox networks: - backend - frontend - bridge-zscomposeTrzy sytuacje zatrzymują kompilację z TRANSLATION_ERROR podczas składania pliku, a każda z nich wskazuje usługę:
- Identyfikator, którego nie ma żaden komponent złożony do tego pliku — na przykład komponent złożony do innego pliku compose. Sieć należy do jednego pliku, więc komunikat podaje identyfikator i plik, w którym znajduje się usługa. Należy wymieniać tylko komponenty złożone do tego samego pliku albo usunąć identyfikator.
- Wartość, która nie jest listą łańcuchów. Klucz przyjmuje listę identyfikatorów komponentów, nawet dla jednego identyfikatora.
- Klucz na usłudze, która zapisuje
network_mode. Compose nie pozwala usłudze znetwork_modedołączać do sieci; należy usunąć jedno z dwojga.
Wnioskowanie depends_on
Provider compose automatycznie wyprowadza depends_on z krawędzi uses w IR. Dla każdej krawędzi, której źródło i cel wnoszą usługi do scalonego pliku compose, provider dodaje depends_on: [<target>] do usługi źródłowej.
Zależność trafia do własnej usługi komponentu źródłowego i do żadnej innej usługi, którą ten komponent wnosi. Komponent, który deklaruje również kontenery init, wnosi po jednej usłudze uruchamianej do zakończenia na każdy wpis, a żadna z nich nie otrzymuje zależności wyprowadzonej z krawędzi — krawędź wskazuje komponent, a usługa init ma własną nazwę. Dlatego kontener init, który musi dotrzeć do celu krawędzi, na przykład migracja schematu bazy danych, której komponent używa (uses), nie ma żadnego uporządkowania względem tego celu i może zostać uruchomiony, zanim cel będzie osiągalny, podczas gdy własna usługa komponentu czeka zarówno na zakończenie łańcucha init, jak i na uruchomienie celu.
Wpisy wyprowadzone z krawędzi są emitowane bez bramkowania: mają semantykę service_started niezależnie od tego, czy cel deklaruje healthcheck. Uzależnienie ich od stanu zdrowia celu — co pozwoliłoby środowisku uruchomieniowemu compose wstrzymać start, dopóki healthcheck celu nie zgłosi stanu healthy — jest możliwe do wyrażenia, a krawędź uses tego nie wymaga. Fala wskazująca tę samą parę to jedyna rzecz, która zmienia warunek we wpisie wyprowadzonym z krawędzi, i robi to dlatego, że wymaga tego fala, a nie krawędź.
Wpisy wyprowadzone z krawędzi są emitowane w alfabetycznej kolejności celów, aby wynik był stabilny. Krawędzie, których źródło lub cel obsługuje inny provider (helm lub helm-chart), są pomijane — depends_on dotyczy wyłącznie podzbioru encji Release obsługiwanego przez compose.
depends_on usługi jest emitowane w jednej z dwóch form compose, nigdy w ich mieszance, ponieważ compose wymaga warunku przy każdym wpisie formy długiej:
- Lista w formie krótkiej (
depends_on: [<service-name>]), gdy żaden wpis tej usługi nie ma warunku. Dotyczy to każdej usługi, której jedyne zależności pochodzą z krawędziuses. - Mapowanie w formie długiej, gdy dowolny wpis ma warunek — co ma miejsce, gdy usługa czeka również na kontener init albo gdy porządkuje ją fala wdrożenia. Wówczas wpisy wyprowadzone z krawędzi emitują jawny
condition: service_started, który Compose Specification definiuje jako odpowiednik formy krótkiej, więc ich znaczenie się nie zmienia.
W obrębie usługi źródła zachowują własną kolejność i nie przeplatają się: najpierw emitowane jest oczekiwanie na łańcuch init, w kolejności, w jakiej autor zapisał listę, potem uporządkowane alfabetycznie wpisy wyprowadzone z krawędzi, a następnie uporządkowane alfabetycznie wpisy wyprowadzone z fal.
Kolejność fal wdrożenia
Wartość syncWave: granicy w encji Release porządkuje usługi pliku compose, do którego ta granica jest renderowana. Każdy komponent w granicy dziedziczy falę granicy, a tam, gdzie kilka granic współdzieli jeden directory: — więc ich wkłady łączą się w jeden docker-compose.yaml — scalony plik zawiera więcej niż jedną falę, a provider wyraża kolejność między nimi jako depends_on.
Każda usługa czeka na każdą usługę bezpośrednio poprzedzającej fali, która ma jakiekolwiek usługi, i na żadną wcześniejszą falę. Compose rozwiązuje resztę przechodnio: usługa w fali 2 czeka na falę 1, która czeka na falę 0, więc cała sekwencja jest uporządkowana, a lista każdej usługi ma rozmiar jednej fali, a nie całego pliku. Fale nie muszą być ciągłe, a wartości ujemne są zwyczajne — -1 to częsty wybór dla migracji uruchamianej przed wszystkim innym.
Warunek zależy od tego, co cel może spełnić. Fala oznacza, że wcześniejsza grupa działa, zanim wystartuje późniejsza, co jest gotowością, a nie samym uruchomieniem procesu, więc:
- gdy usługa docelowa deklaruje
healthcheck, oczekiwanie tocondition: service_healthy; - gdy go nie deklaruje, oczekiwanie to
condition: service_started, ponieważ usługa bez healthchecka nigdy nie zgłosi stanu zdrowego, a oczekiwanie uzależnione od zdrowia nigdy nie zostałoby spełnione — plik nigdy by nie wystartował.
Słabszy warunek jest widoczny w wygenerowanym pliku obok silniejszego, a kompilacja dodatkowo wymienia każdą taką usługę w ostrzeżeniu, dzięki czemu autor, który oczekiwał kolejności gotowości, dowiaduje się, która część zadeklarowanej fali jest realizowana jedynie jako kolejność startu. Ostrzeżenie ma charakter informacyjny: kompilacja się powiedzie, a wyrenderowane bajty są dokładnie takie, jakie byłyby bez niego. Dodanie bloku health: do tego kontenera wzmacnia oczekiwanie. --no-unsupported-field-warnings wycisza tę klasę ostrzeżeń.
Fala jest nadal zapisywana jako etykieta. Kolejność jest dodawana obok etykiety aggrega.ai/sync-wave, a nie zamiast niej: to w etykiecie czytelnik przeglądający wygenerowany plik widzi, z której fali pochodzi usługa, czego wpisy depends_on nie podają.
Gdy fala i krawędź uses wskazują tę samą parę, jeden wpis niesie oba. Compose akceptuje jeden wpis na zależność, więc usługa, która zarówno uses cel, jak i znajduje się w fali po nim, generuje jeden wpis z warunkiem fali — wymóg fali jest silniejszy z dwóch i to on zostaje wyrażony.
Granica, której wszystkie komponenty są w jednej fali, nie generuje z tego niczego. Podobnie encja Release, która w ogóle nie deklaruje syncWave: każdy kontrybutor ma domyślną wartość pola 0, scalony plik zawiera jedną falę, a wynik jest dokładnie taki, jak gdyby provider nie wyrażał żadnej kolejności fal.
Kolejności między dwoma plikami compose nie da się wyrazić i nie jest ona przybliżana. depends_on wskazuje usługę w tym samym pliku, a granice, które dają różne ścieżki złożenia, tworzą odrębne pliki docker-compose.yaml, które środowisko uruchomieniowe compose traktuje jako niezależne projekty. Fala porządkuje więc każdą usługę w pliku, do którego jest renderowana, i nic poza nim. Kolejność dwóch projektów compose jest sprawą operatora, tak samo jak routing między plikami; zadeklarowanie wspólnego directory: sprowadza dwie granice do jednego pliku i jest to decyzja o kształcie wyniku, którą należy podejmować z jej własnych powodów, a nie w celu uzyskania kolejności.
Krawędź uses wskazująca na późniejszą falę jest emitowana tak, jak ją zapisano, i zgłaszana. Emitowane depends_on odzwierciedla to, co zadeklarowano — zarówno krawędzie uses, jak i fale. Krawędź, której konsument znajduje się we wcześniejszej fali niż cel, którego używa, wyraża coś przeciwnego niż fale: krawędź każe konsumentowi czekać na cel, podczas gdy fale każą celowi czekać — przez każdą falę między nimi — na konsumenta. Scalony plik wyraża jedno i drugie, co tworzy zbiór zależności cyklicznych, którego Docker Compose odmawia uruchomienia. Kompilacja wskazuje każdą taką krawędź w ostrzeżeniu podającym obie usługi i obie fale, dzięki czemu cykl wychodzi na jaw podczas kompilacji, a nie przy docker compose up. Ostrzeżenie jest doradcze — kompilacja kończy się sukcesem, a wyrenderowane bajty są dokładnie takie, jakie byłyby bez niego — i --no-unsupported-field-warnings go nie wycisza, ponieważ nic nie zostało pominięte: obie deklaracje są wyrażone, a razem nie mogą się uruchomić. Obejmuje ono tylko bezpośrednią parę: wskazuje dwie usługi, które łączy jedna krawędź, zamiast śledzić cały cykl. Każdy cykl zbudowany z krawędzi uses i fal razem przechodzi przez co najmniej jedną taką krawędź, więc zawsze jest zgłaszany; cykl utworzony wyłącznie przez krawędzie uses, bez udziału fal, oraz cykl zamknięty przez wpis depends_on zapisany w pliku compose dostarczonym przez encję Recipe są emitowane tak, jak je zapisano, i nie są zgłaszane. Należy zachować spójność kierunku krawędzi i kolejności fal: umieścić konsumenta w fali celu lub późniejszej albo cel w fali konsumenta lub wcześniejszej.
# release.yaml fragment — three boundaries collapsing onto one compose fileboundaries: data: directory: ./dist/cluster syncWave: -1 components: migrator: {} # no health: block core: directory: ./dist/cluster syncWave: 0 components: store: {} # declares health: edge: directory: ./dist/cluster syncWave: 1 components: frontend: {} # uses: store# dist/cluster/compose/docker-compose.yaml (abridged)services: frontend: labels: aggrega.ai/sync-wave: "1" depends_on: store: condition: service_healthy # store declares a healthcheck migrator: labels: aggrega.ai/sync-wave: "-1" # lowest wave: waits on nothing store: depends_on: migrator: condition: service_started # migrator declares no healthcheck healthcheck: test: [CMD-SHELL, "nc -z localhost 5432"]frontend nie wskazuje migrator: kolejność sięga bezpośrednio poprzedzającej fali, a compose łączy resztę w łańcuch przez store.
Tryb źródłowy
Pole source: dostawcy compose wskazuje plik YAML docker-compose, który dostawca może odczytać i sparsować, i przyjmuje oba kształty, jakie przyjmuje pole source:: goły łańcuch ścieżki w systemie plików oraz obiekt strukturalny, którego url: niesie lokalizację. Wszędzie tam, gdzie ta lokalizacja jest ścieżką w systemie plików, jest ona zakotwiczona w katalogu zawierającym plik recipe.yaml, który ją deklaruje, a nie w katalogu, z którego wywołano kompilację, i musi pozostać wewnątrz tego katalogu: ścieżka, która z niego wychodzi, lub ścieżka bezwzględna jest odrzucana, ponieważ każdy plik, który niesie publikacja encji Recipe, jest pobierany z jej katalogu — zob. entities/recipe.md „Content paths stay inside the Recipe’s own directory”. Plik wskazany w ten sposób jest publikowany wraz z encją Recipe, natomiast plik leżący obok encji Recipe, którego nie wskazuje nic, co ona deklaruje, nie jest.
spec: capability: compose source: ./docker-compose.base.yaml # filesystem path to the base compose file valuesMapping: | services: api: image: "{{ .values.image }}"W kształcie strukturalnym to, co niesie url:, decyduje, czy cokolwiek jest pobierane. Fragment opublikowany przez https:// jest pobierany i przypinany z kind: compose-https-fragment; aggrega pull go pozyskuje, a kompilacja odczytuje go z pamięci podręcznej. url: wskazujący ścieżkę w systemie plików nie jest pobierany — jest odczytywany z dysku, zakotwiczony dokładnie tak jak forma gołego łańcucha powyżej, a aggrega pin zapisuje skrót wskazanego pliku w entity.lock obok encji Recipe, który kompilacja następnie porównuje przed odczytaniem fragmentu. Skopiowanie zdalnego fragmentu lokalnie i skierowanie source: na tę kopię jest obsługiwane jako alternatywa dla pobierania i nie jest wymagane. Schemat przyjmuje otwarty obiekt strukturalny.
Encja Recipe z source: <path-to-compose-file> i valuesMapping: uruchamia następujący potok:
- Bazowy plik compose pod
<path>jest odczytywany i parsowany jako YAML. - Szablon
valuesMappingjest ewaluowany względem kontekstu szablonu encji Recipe. Jego wynik jest traktowany jako dokument nakładki compose — częściowy plik compose, który uzupełnia lub nadpisuje pola w pliku bazowym. - Plik bazowy i nakładka są głęboko scalane zgodnie z natywną semantyką nakładek docker-compose.
Zasady głębokiego scalania:
- Skalary: wygrywa nakładka. Gdy plik bazowy i nakładka ustawiają to samo pole skalarne, wartość z nakładki zastępuje wartość z pliku bazowego.
- Mapy: scalanie rekurencyjne. Gdy plik bazowy i nakładka ustawiają to samo pole mapy, scalanie schodzi rekurencyjnie do mapy. Klucze obecne w obu podlegają tym samym zasadom; klucze obecne tylko w jednym są zachowywane bez zmian.
- Listy: zastąpienie. Gdy plik bazowy i nakładka ustawiają to samo pole listy, lista z nakładki w całości zastępuje listę z pliku bazowego (bez scalania element po elemencie ani dołączania). Odpowiada to zachowaniu
docker compose -f base.yaml -f overlay.yaml config. null: zastępuje i pozostaje. Klucz, który nakładka ustawia nanullna usłudze — jeden z własnych kluczy usługi, taki jakuser,commandczyhealthcheck, wpisenvironment, etykieta albo klucz bezpośrednio podhealthchecklubdeploy— zastępuje wartość z pliku bazowego jak każdy skalar i jest zapisywany w pliku compose jakokey: null; nie usuwa klucza. Gdy dostawca zapisuje w tym kluczu własną wartość, plik zawiera zamiast tego wartość dostawcy:labels: nullpozostawia etykiety pochodzenia, które nadaje dostawca, anetworks: nullsieć, którą dołącza.nullzapisany w dowolnym innym miejscu nakładki nie podlega tej regule. To, co następnie oznaczanull, wynika z interpretacji danego atrybutu przez Compose — na przykład wpisenvironmentbez wartości przyjmuje wartość ze środowiska, w którym uruchomionodocker compose.
Każda etykieta zapisana przez autora usługi zostaje zachowana. labels: usługi w pliku bazowym lub w nakładce można zapisać jako mapę albo jako listę wpisów key=value w stylu Compose, a każda etykieta trafia do pliku compose obok etykiet pochodzenia, które nadaje dostawca. Wpis listy jest odczytywany tak, jak odczytuje go Compose: tekst przed pierwszym = to nazwa etykiety, a tekst po nim to wartość, a wpis bez = jest etykietą z pustą wartością. Liczba lub wartość true/false jest zapisywana jako jej tekst, więc replicas-hint: 2 trafia do pliku jako replicas-hint: "2", a etykieta zapisana jako null pozostaje null. Gdy etykieta autora i etykieta pochodzenia mają ten sam klucz, plik zawiera wartość pochodzenia. Wartość labels:, która nie jest ani mapą, ani listą, oraz wpis listy, który nie jest tekstem, zatrzymują kompilację, podając plik źródłowy i usługę. Etykiety usługi w treści artifacts: przyjmują formę mapy: lista w tym miejscu zatrzymuje kompilację, podając artefakt i usługę.
Scalony dokument trafia następnie do scalania na poziomie encji Release wraz z wkładami z trybu syntetyzowanego, z tą samą siecią per granica i tym samym wnioskowaniem depends_on.
Pomijanie usług, wolumenów i konfiguracji. Nakładka nie może niczego usunąć z pliku bazowego — wartość nakładki zastępuje, nigdy nie usuwa — dlatego do pobranego pliku zawierającego usługę, której encja Release nie może uruchamiać, służą wpisy omits: encji Recipe lub FeatureRecipe. Ten dostawca uwzględnia je w tym trybie i w żadnym innym: syntetyzowana encja Workload i treść artifacts: są renderowane bez nich. Wpis wskazuje jedną jednostkę najwyższego poziomu pliku przez jej kind — service, volume lub config — oraz jej name, czyli klucz jednostki pod services:, volumes: lub configs:, porównywany dokładnie. Plik compose nie ma przestrzeni nazw, więc wpis zawierający namespace, podobnie jak wpis wskazujący dowolny inny rodzaj, zatrzymuje kompilację podczas renderowania komponentu, podając ten wpis i rodzaje akceptowane przez tego dostawcę; każdy wpis jest sprawdzany, zanim cokolwiek zostanie pominięte. Wpisy są dopasowywane do pliku po scaleniu z nim powyższej nakładki, więc jednostka dodana przez nakładkę jest pomijana dokładnie tak jak jednostka zadeklarowana w pliku bazowym, oraz przed dodaniem przez dostawcę czegokolwiek własnego, więc wpis nigdy tego nie wskazuje. Jednostka wskazana przez wpis jest usuwana, a sekcja, której wszystkie jednostki zostały pominięte, jest usuwana razem z nimi; każda inna jednostka jest zapisywana dokładnie tak, jak bez tych wpisów. Wpisy dotyczą pliku encji Recipe lub FeatureRecipe, która je deklaruje, i niczego więcej: to, co inny komponent lub dołączona encja Feature wnosi do tego samego docker-compose.yaml, pozostaje nietknięte, łącznie z jednostką o tym samym kluczu. Dostawca raportuje, ile jednostek pominął każdy wpis, a wpis, który niczego nie pominął, zatrzymuje kompilację; zob. An omits entry left out nothing the source rendered (Wpis omits nie pominął niczego, co wyrenderowało źródło).
Pominięta jednostka nie może pozostać wskazywana przez to, co zostało, ponieważ compose odrzuca plik, który wskazuje usługę, wolumen lub konfigurację, których nie deklaruje. Po usunięciu jednostek każde odwołanie, które plik nadal do którejś z nich zawiera, zatrzymuje kompilację, a komunikat podaje każdą odwołującą się usługę lub zadanie, wskazywaną jednostkę i pole, w którym znajduje się odwołanie. Odwołanie to coś, co Compose Specification definiuje jako wskazanie jednego wpisu pliku przez inny:
- usługa, wskazywana przez
depends_onw dowolnej formie, przezlinks(SERVICElubSERVICE:ALIAS), przezvolumes_from(SERVICElubSERVICE:MODE), przeznetwork_mode,ipc,pidlubutsustawione naservice:<name>, przezextendswskazujące usługę z tego samego pliku lub przez wartośćbuild.additional_contextsrównąservice:<name>; - wolumen, wskazywany jako źródło wpisu
volumes:— w formie krótkiejSOURCE:TARGET, gdy źródło jest nazwą, a nie ścieżką, oraz w formie długiej ztype: volume; - konfiguracja, wskazywana przez wpis
configs:w dowolnej formie.
Odczytywane są także hooki pre_start usługi i każdy wpis najwyższego poziomu jobs: — pod kątem odwołań, które specyfikacja pozwala każdemu z nich zawierać. Niektóre wartości jedynie wyglądają jak odwołania i nie są jako takie odczytywane: wpis volumes_from lub network_mode zaczynający się od container: wskazuje kontener, external_links wskazuje kontener, którego ten plik nie deklaruje, extends z file: wskazuje usługę z innego pliku, a credential_spec.config może wskazywać konfigurację przechowywaną przez platformę, a nie przez plik. Każda wartość jest porównywana w zapisanej postaci, więc odwołanie zapisane przez ${VARIABLE} nie jest widoczne dla tego sprawdzenia, a odwołanie do jednostki, której plik nigdy nie zadeklarował, pozostaje bez zmian.
Sprawdzenie odczytuje wyłącznie własny plik deklarującej encji Recipe lub FeatureRecipe, więc odwołanie do pominiętej usługi zatrzymuje kompilację nawet wtedy, gdy inny współtwórca w tej samej ścieżce złożenia deklaruje usługę o tej nazwie. Aby zachować odwołanie, należy zachować jednostkę. Aby je usunąć, należy zmienić odwołujący się wpis przez valuesMapping: — lista podana tam zastępuje listę z pliku bazowego, więc depends_on: [] ją czyści — albo pominąć również odwołującą się usługę.
Wynik dla każdej pary (path, provider)
Każda ścieżka złożenia compose daje jeden plik docker-compose.yaml. Granice, które ewaluują się do różnych ścieżek, dają różne pliki compose; granice o wspólnej ewaluowanej ścieżce dają jeden scalony plik compose zawierający wszystkich współtwórców pod tą ścieżką. Ścieżka to directory: granicy połączone z subDirectory: danego komponentu (domyślnie {{ .capability }}, dzięki czemu współtwórcy compose trafiają domyślnie do podfolderu compose/).
Kolizje nazw usług w obrębie jednej ścieżki złożenia zatrzymują budowanie. Gdy dwa różne węzły wnoszą usługi o tym samym identyfikatorze instancji w tej samej krotce (path, provider), kompilator przerywa pracę, a diagnostyka wymienia w porządku alfabetycznym wszystkie współtworzące krotki (boundary, node). Autor rozwiązuje kolizję, zmieniając nazwę jednego ze współtwórców (zwykle przez zmianę identyfikatora węzła, tak aby syntezator utworzył inną nazwę usługi), albo kierując współtwórców do różnych ścieżek za pomocą różnych deklaracji directory:.
Wolumeny najwyższego poziomu są sumowane w obrębie ścieżki złożenia, a dwóch współtwórców może zadeklarować jedną nazwę, pod warunkiem że zgadzają się co do niej. Współtwórcą jest fragment, więc dwa fragmenty jednego komponentu — jego własny plik compose i wpis artifacts: albo dwa wpisy artifacts: — są dwoma współtwórcami dokładnie tak jak dwa komponenty. Nazwany wolumen to jeden fizyczny wolumen, więc dwie identyczne deklaracje opisują dokładnie ten wpis, który trafia do złożonego pliku, i pod tą nazwą pozostaje jeden wpis. Wolumen wyprowadzony przez dostawcę nie ma treści, więc dwa takie wolumeny zgadzają się w trywialny sposób, a i tak nie mogą się spotkać (zob. Jak wyprowadzana jest nazwa wolumenu).
Uwagi wymaga wpis volumes: napisany przez autora, ponieważ może mieć własną treść — driver, driver_opts lub labels. Gdy dwóch współtwórców deklaruje jedną nazwę z różnymi treściami, budowanie zatrzymuje się z TRANSLATION_ERROR, wymieniając wolumen i wszystkie współtworzące krotki (boundary, node, fragment). Gdy dwóch autorów nie zgadza się co do jednego wolumenu, asembler nie ma odpowiedzi, którą mógłby wybrać: zachowanie którejkolwiek treści odrzuca to, co napisał drugi autor, w budowaniu, które poza tym by się powiodło. Należy to rozwiązać, ujednolicając obie deklaracje, jeśli obaj autorzy mieli na myśli ten sam wolumen, albo zmieniając nazwę jednej z nich, jeśli mieli na myśli dwa. Sieci najwyższego poziomu są tworzone po jednej na każdą odrębną adnotację aggrega.ai/namespace, plus jedna nazwana od ścieżki pliku compose dla węzłów bez adnotacji, i nazywane zgodnie z Jak wyprowadzana jest nazwa sieci; dwie współtworzące granice z tą samą adnotacją aggrega.ai/namespace scalają się w jedną sieć wspólną dla obu, podobnie jak dwie granice bez adnotacji współdzielące plik.
Każdy klucz zapisany przez fragment jest przenoszony albo odrzucany
Fragment — źródłowy plik compose po scaleniu z jego nakładką albo treść artifacts: ewaluowana do YAML compose — trafia do złożonego docker-compose.yaml wyłącznie przez klucze, które przenosi dostawca, a ten zbiór jest stały. Każdy klucz zapisany przez fragment jest albo przenoszony do złożonego pliku w zapisanej postaci, albo odrzucany z podaniem nazwy; żaden nie jest pomijany bez słowa. Fragment to jeden plik compose, więc jest jednym dokumentem YAML.
- Przenoszone. Na najwyższym poziomie:
services,volumes,configsimodels. Na usłudze:image,pull_policy,command,entrypoint,environment,env_file,ports,labels,volumes,tmpfs,networks,network_mode,depends_on,healthcheck,restart,user,working_dir,privileged,read_only,cap_add,cap_drop,configs,models,deploy,stop_grace_period,dns,dns_search,extra_hostsiprofiles. Wewnątrz bloków opisywanych przez dostawcę:deploy.resourcesz jegolimits(cpus,memory) ireservations(cpus,memory,devices, a w każdym wpisie urządzeniadriver,count,device_ids,capabilitiesioptions); whealthcheck—test,interval,timeout,retriesistart_period; we wpisievolumes:w formie pełnej —type,source,target,read_onlyivolume.subpath; we wpisieconfigs:w formie pełnej —sourceitarget; we wpisiedepends_on:w formie pełnej —condition; w wolumenie najwyższego poziomu —driver,driver_optsilabels; w konfiguracji najwyższego poziomu —content. Treść modelu i wpismodels:usługi w formie pełnej przenoszą każdy element, jak opisano w sekcji Modele. Element rozszerzenia — klucz zaczynający się odx-— jest przenoszony na najwyższym poziomie i na usłudze, jak opisano w sekcji Elementy rozszerzeń. - Odrzucane. Każdy inny klucz —
stdin_openna usłudze,secrets:lubname:najwyższego poziomu,deploy.replicas,restart:lubrequired:wewnątrz wpisudepends_on:w formie pełnej, kluczx-wewnątrz treści wolumenu najwyższego poziomu lubhealthcheck— zatrzymuje kompilację zTRANSLATION_ERROR, podając każdy taki klucz, jego ścieżkę we fragmencie (services.migrate.stdin_open), fragment i komponent, a także dwa miejsca, z których taki klucz pochodzi. Jednym jest sam fragment, a poprawka polega na usunięciu z niego klucza. Drugim jest źródłowa encja Recipe, która nie deklarujevaluesMapping:: wartości węzła są wtedy nakładane na plik compose w niezmienionej postaci, więc każdy klucz wartości trafia jako klucz najwyższego poziomu fragmentu, a poprawka polega na zadeklarowaniuvaluesMapping:, który umieszcza każdą wartość pod kluczem przenoszonym przez dostawcę. Klucz wniesiony do bloku przez klucz scalania YAML (<<: *anchor) jest oceniany tam, gdzie trafia, tak jakby został tam zapisany. Fragment wyrenderowany ze źródła nosi nazwę<component>.compose-fragment.yaml; fragmentartifacts:— nazwę nadaną mu przez jego encję Recipe. - Odrzucane w całości: własna sieć fragmentu. Wpis pod
networks:najwyższego poziomu fragmentu zatrzymuje kompilację zTRANSLATION_ERRORbez względu na treść — pusty wpis,driverczy cokolwiek innego — podając wpis (networks.back), fragment i komponent, ponieważ złożony plik zawiera tylko sieci wyprowadzane przez dostawcę (zob. Do której sieci dołącza usługa). Należy usunąć wpis: usługa dołącza do sieci własnego komponentu bez żadnej deklaracji, adnotacjaaggrega.ai/namespacewybiera, do której sieci dołącza komponent, usługa wymienia komponenty, do których sieci dodatkowo dołącza, podx-aggrega-networks-of, a encja Featurecompose-bridgetrasuje ruch między usługami w różnych sieciach. Pustenetworks: {}niczego nie deklaruje i nie jest odrzucane, a własna listanetworks:usługi jest przenoszona jak wyżej. - Odrzucane w całości: fragment z więcej niż jednym dokumentem. Treść
artifacts:zawierająca dwa lub więcej dokumentów YAML oddzielonych---zatrzymuje kompilację zTRANSLATION_ERROR, podając fragment, komponent i liczbę zawartych w nim dokumentów, ponieważ scalanie odczytuje fragment jako jeden plik compose, a każdy dokument po pierwszym zostałby w przeciwnym razie pominięty w złożonym pliku. Należy zapisać fragment jako jeden dokument albo nadać każdemu dokumentowi własny wpisartifacts:. Dokument niezawierający niczego — pusty dokument otwierany przez końcowe---— nie jest liczony. Źródłowy plik compose z kilkoma dokumentami nigdy nie staje się takim fragmentem: jest odrzucany przy odczycie pliku.
Dostawca nie odczytuje znaczenia żadnego klucza: klucz jest przenoszony, ponieważ należy do powyższego zbioru, a odrzucany, ponieważ do niego nie należy.
Elementy rozszerzeń są przenoszone w zapisanej postaci
Compose Specification rezerwuje klucze zaczynające się od x- dla rozszerzeń: danych, których może używać narzędzie czytające plik, a które sam Compose ignoruje. Elementy rozszerzeń fragmentu na najwyższym poziomie i w usłudze trafiają do zestawionego pliku w zapisanej postaci, po wszystkich kluczach modelowanych przez providera na tym poziomie, w kolejności, w jakiej przechowuje je fragment; provider nie odczytuje niczego w ich wnętrzu, z wyjątkiem x-aggrega-networks-of usługi, który rozwiązuje na sieci, do których dołącza usługa, i pomija w zestawionym pliku (zob. Dołączanie do sieci innych komponentów). Treść artifacts: przechowuje je w kolejności, w jakiej je zapisuje. Klucze źródłowego pliku compose trafiają do jego fragmentu w kolejności nazw po scaleniu nakładki, więc jego elementy rozszerzeń są zapisywane w kolejności nazw.
# an artifacts: bodyx-owner: team-bservices: migrate: image: example/migrate:1 x-schedule: manualElement osiągnięty przez alias YAML jest zapisywany w całości, a żadna kotwica nie jest przenoszona, więc zestawiony plik nigdy nie zawiera aliasu bez jego kotwicy; dzięki temu element najwyższego poziomu może zawierać kotwicę, którą wnosi klucz scalania usługi (<<: *base). Elementy usługi wędrują razem z nią. Elementy najwyższego poziomu są sumowane w obrębie ścieżki zestawienia według reguły, której podlegają wolumeny: dwa fragmenty zapisujące jeden element z tą samą treścią pozostawiają jeden wpis, niezależnie od tego, czy zapisują go w stylu blokowym, czy przepływowym, a dwa zapisujące go z różną treścią zatrzymują kompilację z TRANSLATION_ERROR, wymieniając element i każdą współtworzącą krotkę (boundary, node, fragment) — w tym dwa fragmenty jednego komponentu. Należy ujednolicić obie deklaracje albo nadać jednej z nich inną nazwę.
profiles ukrywa usługę za profilem Compose. Usługi wymieniającej profiles: polecenie docker compose up nie uruchamia, chyba że włączony jest jeden z jej profili, a docker compose run --rm <service> uruchamia ją na żądanie — to kształt, jaki w compose ma zadanie uruchamiane na żądanie. Lista jest przenoszona tak, jak zapisuje ją fragment, w jej kolejności:
# a sourced compose fileservices: migrate: image: example/migrate:1 profiles: [manual]Modele
Sekcja models: najwyższego poziomu w pliku compose deklaruje modele AI używane przez usługi pliku, a usługa otrzymuje model przez własny wpis models:. Dostawca przenosi oba z fragmentu do złożonego pliku docker-compose.yaml, w zapisie samego Compose, niezależnie od tego, czy fragment jest źródłowym plikiem compose, czy treścią artifacts: ewaluowaną do YAML compose. Encja Workload nie deklaruje modelu, więc encja Recipe w trybie Workload nie wnosi żadnego.
- Treść modelu jest zapisywana tak, jak zapisał ją fragment.
model— identyfikator artefaktu OCI modelu —context_sizeiruntime_flagszachowują swoje nazwy, a każdy inny element, w tym rozszerzeniex-, jest przenoszony obok nich. W obrębie modelu trzy nazwane elementy są pierwsze, a pozostałe następują w kolejności kluczy, modele zaś są zapisywane w kolejności nazw, więc identyczne wejście daje plik identyczny co do bajtu. Dostawca niczego w treści nie odczytuje: nie sprawdza identyfikatora i nie wie nic o tym, co będzie serwować model. - Odwołanie usługi zachowuje swoją postać. Postać krótka wymienia nazwy modeli (
models: [llm]); postać długa przypisuje każdemu modelowiendpoint_varimodel_var, czyli nazwy zmiennych, które otrzymują adres runnera modelu i identyfikator modelu. Każda z nich jest zapisywana w postaci i kolejności użytej przez fragment i przemieszcza się razem ze swoją usługą. Gdy postać długa nie nazywa zmiennej, nazywa ją Compose podczas uruchamiania pliku. - Modele są sumowane w obrębie ścieżki złożenia według tej samej reguły co wolumeny. Dwóch współtwórców deklarujących jedną nazwę modelu z treściami emitowanymi identycznie pozostawia pod nią jeden wpis; dwóch deklarujących ją z różnymi treściami zatrzymuje budowanie z
TRANSLATION_ERROR, wymieniając model i wszystkie współtworzące krotki(boundary, node, fragment). Dwa fragmenty jednego komponentu również tutaj są dwoma współtwórcami. Należy ujednolicić deklaracje, jeśli obaj współtwórcy mają na myśli jeden model, albo nadać jednemu z nich inną nazwę. - Każde odwołanie wskazuje zadeklarowany model. Po zsumowaniu fragmentów ścieżki złożenia usługa, której przyznano model niezadeklarowany przez żadnego współtwórcę pod tą ścieżką, zatrzymuje budowanie z
TRANSLATION_ERROR, wymieniając usługę i model. Sprawdzenie obejmuje kompletną sumę, więc jeden komponent może przyznać swojej usłudze model zadeklarowany przez inny komponent pod tą samą ścieżką złożenia. - Wpis
omits:nie może pominąć modelu.service,volumeiconfigto rodzaje akceptowane przez tego dostawcę, a wpis wskazujący model zatrzymuje budowanie tak jak wpis wskazujący dowolny inny rodzaj.
Modele są serwowane podczas uruchamiania pliku, a nie podczas budowania. Docker Compose 2.38 lub nowszy, na platformie obsługującej modele Compose, takiej jak Docker Model Runner, pobiera i uruchamia każdy model przyznany usłudze, pomijając pozostałe, chyba że uruchomiono go z --all-resources, i w każdej usłudze, której przyznano model, ustawia zmienne wskazane w jej odwołaniu na adres runnera modelu i identyfikator modelu. Budowanie nie widzi hosta, który uruchomi plik, więc nie sprawdza ani wersji Compose, ani platformy: plik z modelami składa się tak samo bez względu na to, co go uruchamia.
Encja Feature dołączona do komponentu wnosi wkład do tego samego pliku
Encja Feature dołączona do komponentu wnosi swoje usługi do pliku docker-compose.yaml, do którego składa się jej komponent macierzysty, na tych samych zasadach co własna encja Recipe komponentu macierzystego. Obok nie powstaje drugi plik: jedna ścieżka złożenia daje jeden dokument, więc usługi dołączonej encji Feature albo są w tym dokumencie, albo nie są w ogóle wdrażane. Odłączenie encji Feature usuwa dokładnie te usługi i pozostawia własne usługi komponentu macierzystego nietknięte.
Są one współtwórcami pod tą ścieżką złożenia jak każdy inny, więc wszystko powyżej stosuje się do nich bez zmian — reguła nazw usług oraz wymóg, by dwóch współtwórców deklarujących jedną nazwę wolumenu lub konfiguracji najwyższego poziomu zgadzało się co do tego, czym ona jest. Dołączają też do tej samej sieci co reszta granicy, więc komponent i dołączona do niego encja Feature komunikują się po nazwie usługi bez dodatkowych deklaracji.
Każda usługa wniesiona przez encję Feature nosi tożsamość utworzoną dla tego dołączenia, a nie tożsamość komponentu macierzystego, więc obie pozostają rozróżnialne w dokumencie, do którego obie wniosły wkład. Sposób budowania tej tożsamości opisuje strona Etykiety i adnotacje.
Jest to mechanizm inny niż blok attachments: na poziomie kontenera w encji Workload, a łatwo je pomylić, bo dzielą to samo słowo. Dołączenie encji Feature do komponentu dodaje usługi do złożonego dokumentu; wpis attachments: kontenera odczytuje poświadczenie opublikowane przez slot do tego jednego kontenera i jest opisany w sekcji Pola kontenera.
Fragmenty compose emitowane przez artefakty
Gdy blok artifacts: encji Recipe ewaluuje się do YAML-a compose — fragmentu z własnymi blokami services:, volumes:, configs:, models: lub networks: (każdy wpis zapisany inline lub ładowany osobno przez $import:) — scalanie do zestawienia dla danej pary (path, provider) podlega regułom zależnym od kształtu:
- Bloki
services:z artefaktów są scalane do zestawionego pliku compose obok usług poszczególnych komponentów. Nazwa usługi wniesiona przez dwa różne komponenty w tej samej ścieżce zestawienia zatrzymuje kompilację, a diagnostyka wymienia każdego współtwórcę. Kolizja w obrębie jednego komponentu — między własnym fragmentem artefaktu tego komponentu a usługami syntetyzowanymi dla niego — nie jest wykrywana, a późniejszy wkład zastępuje wcześniejszy, dlatego nazwa usługi zapisanej w artefakcie powinna różnić się od nazw<component>i<component>--<container-name>tworzonych przez syntezator (zob. Jak nazywana jest usługa sidecar lub init). - Bloki
volumes:z artefaktów są scalane do blokuvolumes:najwyższego poziomu. Dwa wpisy o tej samej nazwie pozostawiają pod nią jeden wpis, jeśli deklarują ją identycznie, zgodnie z tą samą regułą co wolumeny poszczególnych komponentów; dwa deklarujące ją różnie zatrzymują kompilację, niezależnie od tego, czy pochodzą z dwóch komponentów, czy z dwóch fragmentów jednego — dwóch jego wpisówartifacts:albo jednego z nich i własnego pliku compose komponentu. Ponieważ fragment artefaktu zapisuje własne treści, właśnie na tej ścieżce dwaj współtwórcy najczęściej się nie zgadzają. Nazwa wolumenu zapisanego w artefakcie powinna różnić się od pozostałych w jego ścieżce zestawienia, w tym od kształtu<component>--<volume-name>tworzonego przez derywację — chyba że dwaj współtwórcy mają opisywać jeden wspólny wolumen, a wtedy ich deklaracje muszą być zgodne. - Bloki
configs:z artefaktów są scalane do blokuconfigs:najwyższego poziomu. W ten sposób plik stojący za wolumenemconfigmaptrafia do zestawienia: wolumen staje się odwołaniemconfigs:na poziomie usługi, wskazującym configmap, a fragment artefaktu deklaruje wpis o tej nazwie z treściącontent:zapisaną inline. Po połączeniu fragmentów ścieżki zestawienia każde odwołanie na poziomie usługi musi wskazywać zadeklarowany wpis, w przeciwnym razie kompilacja zatrzymuje się zTRANSLATION_ERROR, wymieniając każde nierozwiązane odwołanie — usługę, nazwę konfiguracji i ścieżkę montowania. Sprawdzenie obejmuje kompletną sumę, a nie pojedyncze komponenty, więc jeden komponent może odwoływać się do konfiguracji zadeklarowanej przez inny komponent w tej samej ścieżce zestawienia. Suma uzgadnia wpisy po nazwie, gdy współtwórcy są zgodni: dwie deklaracje jednej nazwy konfiguracji z identycznymcontent:pozostawiają jeden wpis, który obie opisywały. Dwie deklaracje jednej nazwy z różnymcontent:zatrzymują kompilację zTRANSLATION_ERROR, wymieniając konfigurację i każdą współtworzącą krotkę(boundary, node, fragment), w tym dwa fragmenty jednego komponentu — wpis konfiguracji zawsze niesie treść, więc zachowanie którejkolwiek deklaracji odrzuciłoby plik napisany przez autora. Nazwa konfiguracji powinna być unikalna wśród wszystkich współtwórców w jej ścieżce zestawienia, albo deklaracje powinny być identyczne, gdy dwaj współtwórcy mają dostarczać jeden wspólny plik. - Bloki
models:z artefaktów są scalane do blokumodels:najwyższego poziomu, a odwołaniemodels:usługi przemieszcza się wraz z nią, zgodnie z regułami opisanymi w sekcji Modele: dwaj współtwórcy deklarujący jedną nazwę modelu muszą zadeklarować ją identycznie, a każde odwołanie musi wskazywać model zadeklarowany przez któregoś współtwórcę w tej ścieżce zestawienia. - Bloki
networks:z artefaktów są odrzucane. Provider compose wyprowadza sieci z adnotacji granic (jedna sieć na każdą odrębną adnotacjęaggrega.ai/namespace, plus jedna nazwana od ścieżki pliku compose, do której dołącza każdy węzeł bez tej adnotacji; każda nazwana zgodnie z Jak wyprowadzana jest nazwa sieci), więc deklaracja sieci dostarczona przez artefakt nie ma miejsca w zestawionym pliku: każdy wpis zatrzymuje kompilację, wymieniając wpis i fragment, zgodnie z regułami z Każdy klucz zapisany przez fragment jest przenoszony albo odrzucany. Należy usunąć wpis i kształtować sieci przez adnotacjęaggrega.ai/namespacealbo dołączyć usługę do sieci wskazanych komponentów przezx-aggrega-networks-of; autorzy potrzebujący routingu między sieciami w obrębie jednego pliku compose używają encji Featurecompose-bridge. - Elementy rozszerzeń z artefaktów są przenoszone. Klucz
x-najwyższego poziomu jest zapisywany po pozostałych sekcjach zestawionego pliku, w kolejności zapisu, zgodnie z regułami z Elementy rozszerzeń są przenoszone w zapisanej postaci. - Każdy inny klucz najwyższego poziomu z artefaktów zatrzymuje kompilację.
services:,volumes:,configs:,models:i elementy rozszerzeń to wszystko, co assembler przenosi z fragmentu. Bloksecrets:i kluczname:najwyższego poziomu zatrzymują kompilację, wymieniając klucz i fragment, zgodnie z regułami z Każdy klucz zapisany przez fragment jest przenoszony albo odrzucany. - Treść
artifacts:to jeden dokument. Treść zawierająca kilka dokumentów YAML zatrzymuje kompilację, wymieniając fragment i liczbę zawartych w nim dokumentów; należy nadać każdemu dokumentowi własny wpisartifacts:.
Asymetria między pierwszymi czterema a networks: jest strukturalna: services:, volumes:, configs: i models: niosą treść poszczególnych encji Recipe, którą assembler gromadzi w zestawionym pliku; networks: to infrastruktura poszczególnych granic, którą assembler wyprowadza ze stanu granicy. Artefakty mogą rozszerzać te pierwsze; tylko adnotacje granic mogą kształtować to drugie, i dlatego własny wpis sieci artefaktu jest odrzucany. Elementy rozszerzeń to dane, które Compose Specification definiuje dla innych narzędzi, więc są przenoszone w zapisanej postaci. Wszystko inne to kształt, dla którego zestawiony dokument nie ma miejsca, i dlatego jest odrzucane, a nie scalane.
Czego provider compose nie zapewnia
- Routing L4 między sieciami w obrębie jednego pliku compose. Provider umieszcza każdy węzeł w jego sieci i dołącza usługę do sieci wskazanych przez
x-aggrega-networks-of, ale sam niczego między sieciami nie trasuje. Aby usługa w sieci A mogła dotrzeć do usługi w sieci B w inny sposób niż przez domyślny DNS docker-compose, potrzebna jest encja Featurecompose-bridge, której encja FeatureRecipe zapisuje bramę i przepisanie. - Routing między plikami compose. Granice, które ewaluują się do różnych ścieżek złożenia, generują osobne pliki
docker-compose.yaml; środowisko uruchomieniowe compose traktuje je jako niezależne projekty, a encja Featurecompose-bridgepozostawia połączenie między dwoma plikami w zapisanej postaci. Komunikacja między plikami należy do operatora (publikowanie portów hosta, współdzielenie sieci zewnętrznych lub scalenie granic na jedną ścieżkę przez wspólnedirectory:). - Pobieranie zmiennej środowiskowej z załącznika. Compose nie ma do tego prymitywu, dlatego wpis
attachmentsencji Workload zas: envemituje nazwę zmiennej z pustą wartością zamiast referencji rozwiązywanej w czasie działania. Ten placeholder jest celowy — zmienna obecna, lecz pusta, jest widoczna dla osoby debugującej kontener, podczas gdy brakująca nie zostawia niczego do obejrzenia — a build informuje o tym, zamiast zostawiać to do odkrycia: każdy taki wpis zgłasza ostrzeżenieunsupported-fieldwskazujące wpis w jego autorskiej współrzędnej (containers.<name>.attachments.<KEY>lubinitContainers[<i>].attachments.<KEY>), dzięki czemu autor wie, która zmienna dociera pusta i do którego kontenera należy. Ostrzeżenie ma charakter informacyjny: build kończy się powodzeniem, a wygenerowany plik jest bajt w bajt taki sam jak bez niego.--no-unsupported-field-warningswycisza tę klasę ostrzeżeń. Nie dotyczy to wpisuattachmentszas: file— compose montuje go jako bind mount i żadne ostrzeżenie nie jest zgłaszane. - Zawartość
deploy:trybu swarm. Repliki, ograniczenia rozmieszczenia i strategia aktualizacji wdeploy:to funkcje trybu swarm, a provider compose obsługuje wyłącznie compose na jednym hoście, więc nie emituje żadnej z nich. Emituje natomiastdeploy.resources— rezerwacje i limity, na które mapują sięresourceskontenera i które docker compose respektuje poza trybem swarm (zob. Zasoby kontenera). depends_onwarunkowane stanem zdrowia z krawędziuses. Zależność wyprowadzona z krawędziusesjest emitowana bez warunku, z semantykąservice_started; nie czeka na to, aż healthcheck celu zgłosi stan zdrowy. Wynika to ze znaczenia krawędziuses, a nie z kształtu, którego provider nie potrafi wygenerować: forma długa jest emitowana dla oczekiwania kontenera init, a fala wdrożenia warunkuje się stanem zdrowia celu, jeśli cel deklaruje healthcheck.
Przykład definicji
Wdrożenie compose z dwiema usługami i krawędzią depends_on wyprowadzoną z uses:
# release.yaml fragmentspec: boundaries: production: annotations: aggrega.ai/namespace: prod components: api: {} db: {}# api RecipeapiVersion: aggrega.ai/v1beta1kind: Recipemetadata: name: api version: 1.0.0spec: capability: compose implements: example/compute/api:1.0.0 workload: | apiVersion: aggrega.ai/v1beta1 kind: Workload containers: main: image: api:1.0 ports: http: 8080 health: live: http: /healthz services: public: type: NodePort ports: http: 8080# Aggregate fragment — api uses db, on a socket api's Component declaresapiVersion: aggrega.ai/v1beta1kind: Aggregatespec: components: api: type: example/compute/api:1.0.0 uses: backend: db: target: db db: type: example/datastore/db:1.0.0Provider compose generuje jeden plik docker-compose.yaml w wyznaczonej ścieżce granicy (domyślnie dist/boundaries/production/compose/docker-compose.yaml, ponieważ directory: granicy ma domyślnie wartość dist/boundaries/<name>, a subDirectory: — {{ .capability }}), zawierający:
services.api(główna usługa api, siećprod, porty8080:8080, healthcheck przezcurl,depends_on: [db])services.db(główna usługa db, siećprod)networks.prod(sieć docker granicy)
Powiązane materiały
- Encja Workload — należący do platformy rodzaj Workload, który tłumaczy provider compose.
- Architektura encji Provider — jak providery wpisują się w potok kompilacji.
- Dobrze znane adnotacje — adnotacje
aggrega.ai/*, z których korzysta provider compose. - Indeks dokumentacji encji Provider — co generuje każdy provider z biblioteki standardowej i która strona odpowiada na które pytanie.
- Kompozycja danych wejściowych encji Recipe — kanoniczna macierz możliwości encji Provider (Provider Capability Matrix).