Plik compose.yaml lub plik wdrożeniowy często musi nagle zmienić się: obraz, adres URL, liczba replik. Z yq możesz odczytać docelowy klucz, wygenerować nową wersję YAML, a następnie sprawdzić różnice przed zastąpieniem pliku.
Użyteczna ostrożność polega na tym, aby wykonać następujące kroki: zidentyfikować zainstalowaną wersję, zachować oryginał, pisać w pliku tymczasowym i ponownie sprawdzić wynik. Komenda -i uruchomiona zbyt szybko modyfikuje jedyną dostępną kopię.
Zidentyfikuj wersję yq przed pierwszym zapisem
Nazwa yq nie zawsze odnosi się do tego samego narzędzia. Poniższe przykłady dotyczą yq autorstwa Mike’a Faraha, binarki Go, której składnia używa eval i wyrażeń podobnych do jq. Pakiet Pythona kislyuk/yq owija jq, zależy od niego i wykorzystuje własne opcje.
Zacznij więc od sprawdzenia wersji i przeczytania wartości, nie dotykając pliku. Jeśli Twoje narzędzie nie rozpoznaje eval, zatrzymaj się: komenda zaplanowana dla yq v4 nie powinna uruchamiać się w tej innej implementacji.
yq --version
yq eval '.services.api.image' compose.yaml
W tym przykładzie ścieżka opisuje klucz image w services.api. Komenda wyświetla aktualną wartość. Jeśli zwraca null, najpierw sprawdź wcięcie i nazwy kluczy: yq może stworzyć nieobecny ścieżkę podczas przypisania.
Przygotuj kopię i wygeneruj zmodyfikowany YAML
W repozytorium Git, diff zapewnia już użyteczną ochronę. Poza repozytorium, lokalna kopia pozostaje punktem powrotu. Wybrałbym plik tymczasowy zamiast -i dla konfiguracji usługi: zachowujesz wynik, który można sprawdzić, nawet jeśli wyrażenie celuje w niewłaściwy klucz.
cp -a compose.yaml compose.yaml.before-yq
yq eval '.services.api.image = "registry.example.net/acme/api:2.4.1"'
compose.yaml > compose.yaml.next
Operator = przypisuje wartość po lewej stronie. Oficjalna dokumentacja yq szczegółowo opisuje również |=, przydatne, gdy nowa wartość zależy od starej. W przypadku zmiany obrazu, jawny ciąg znacznie łatwiej jest przeczytać niż kompaktowe wyrażenie.
Unikaj globalnej zamiany z sed na tego typu plikach. Ten sam tag może występować w wielu usługach, w komentarzu lub w zmiennej. Przewodnik po sed w Linuxie przypomina, dlaczego kopia zapasowa i diff poprzedzają każde zapisanie na miejscu.
Zweryfikuj plik, a następnie sprawdź różnice
Dobry wcięty YAML może pozostać funkcjonalny, modyfikując niewłaściwą usługę. Sprawdź więc zarówno składnię, celowaną wartość, jak i rzeczywiście zmienione linie.
yq eval '.' compose.yaml.next >/dev/null
yq eval '.services.api.image' compose.yaml.next
diff -u compose.yaml compose.yaml.next
Pierwsza linia zmusza yq do analizy dokumentu. Kod wyjściowy równy zero potwierdza poprawność odczytu YAML, nie jednak konfiguracji Docker Compose, Kubernetes lub Ansible. Druga powinna wyświetlić registry.example.net/acme/api:2.4.1. Różnica powinna ograniczać się do oczekiwanego klucza.
Jeśli plik znajduje się w repozytorium, zastąp lub uzupełnij ten ostatni krok o git diff -- compose.yaml.next. Dla manifestu Kubernetes uruchom następnie validator specyficzny dla Twojego narzędzia, na przykład kubectl apply --dry-run=client -f compose.yaml.next, gdy plik jest zgodny z manifestem.
Zastąp plik po kontroli
Gdy różnice są czyste, zastąp plik, a następnie zachowaj kopię do momentu ponownego uruchomienia lub udanego wdrożenia.
mv compose.yaml.next compose.yaml
yq eval '.services.api.image' compose.yaml
# Następnie uruchom kontrolę specyficzną dla Twojej usługi.
Ostatni odczyt dowodzi, że plik na miejscu zawiera oczekiwaną wartość. Nie dowodzi jednak, że aplikacja zaakceptuje swoją konfigurację. Plik Docker Compose wymaga na przykład docker compose config, podczas gdy rola Ansible wymaga co najmniej ansible-playbook --syntax-check.
Ta metoda jest odpowiednia dla pliku YAML, który jest czytelny przez yq autorstwa Mike’a Faraha. Pliki oparte na tagach, złożonych kotwicach lub wersji Pythona yq wymagają przetestowania w kopii oraz kontroli renderowania przed wdrożeniem.