Коротко о главном

YAML широко используется в Kubernetes, CI, Ansible и конфигурациях приложений. yq даёт предсказуемый способ выбрать поле, изменить значение и проверить результат. В статье разберём синтаксис mikefarah yq версии 4, преобразование форматов и работу с несколькими документами. Примеры подходят для разработчиков и администраторов, которые автоматизируют работу с конфигурациями.

Ручная правка YAML легко приводит к ошибкам отступов и типов. yq сохраняет структуру и позволяет менять только нужный ключ. Его удобно использовать в скриптах и проверках перед применением манифеста. В результате конфигурации становятся воспроизводимыми и удобными для ревью.

В этой подборке — практические приёмы для yq, которые можно применить сразу после установки. Каждый пункт объясняет не только «что нажать», но и зачем это нужно.

С чего начать

Не пытайтесь применить всё сразу. Сначала настройте окружение так, чтобы команды было удобно повторять, а результаты — проверять. Для yq это важнее, чем кажется: половина ускорения даёт предсказуемый рабочий процесс.

1. Проверьте версию и синтаксис

У yq существует несколько реализаций с разным синтаксисом. Примеры в статье рассчитаны на mikefarah yq версии 4. Проверьте вывод yq —version перед выполнением команд.

yq --version

2. Прочитайте значение из YAML

Путь к ключам записывается через точку, а индексы массивов — в квадратных скобках. yq печатает найденное значение без изменения файла. Если ключ отсутствует, результатом будет null.

yq '.services.web.image' compose.yaml
yq '.items[].name' config.yaml

3. Измените значение на месте

Флаг -i записывает результат обратно в файл. Перед массовой правкой сохраните копию или используйте Git, потому что резервная копия автоматически не создаётся. Проверьте результат отдельным чтением.

yq -i '.services.web.ports = ["8080:80"]' compose.yaml
yq '.services.web.ports' compose.yaml

Практические советы

Эти рекомендации проверены на повседневных задачах. Начните с тех, которые закрывают вашу текущую боль, а не со всего списка сразу.

Совет 1. Всегда проверяйте yq —version: Python-обёртка и Go-версия mikefarah и

Всегда проверяйте yq —version: Python-обёртка и Go-версия mikefarah используют разные флаги и синтаксис.

Совет 2. Ключи с точками и слэшами берите в квадратные скобки: .[«app.kubernete

Ключи с точками и слэшами берите в квадратные скобки: .[«app.kubernetes.io/name»].

Совет 3. Перед yq -i делайте коммит в Git или копию файла: флаг меняет документ

Перед yq -i делайте коммит в Git или копию файла: флаг меняет документ без автоматического backup.

Совет 4. Для безопасной подстановки строк из скрипта используйте —arg, а не ко

Для безопасной подстановки строк из скрипта используйте —arg, а не конкатенацию в выражении.

Совет 5. Флаг -o=json удобен для последующей обработки через jq, а -o=yaml возв

Флаг -o=json удобен для последующей обработки через jq, а -o=yaml возвращает читаемый YAML.

Совет 6. Удаляйте ненужное поле функцией del, например yq ‘del(.metadata.creati

Удаляйте ненужное поле функцией del, например yq ‘del(.metadata.creationTimestamp)’ file.yaml.

Совет 7. YAML не допускает табуляцию для отступов; ошибки отступов проявляются

YAML не допускает табуляцию для отступов; ошибки отступов проявляются ещё до выполнения запроса.

Типичные ошибки

Ниже — сбои, которые встречаются чаще всего. Перед исправлением сохраните текущие конфиги и запишите, какие изменения вносите: так проще откатиться.

1. yq не найден после установки.

Проверьте имя пакета и PATH для своего дистрибутива. Убедитесь, что установлена именно нужная реализация yq, а не другая утилита с тем же именем.

2. Команда с -i или eval-all завершается ошибкой unknown flag.

Скорее всего, установлена другая версия yq. Проверьте yq —version и используйте синтаксис своей версии либо установите mikefarah yq 4.

3. Ошибка mapping values are not allowed in this context.

Проверьте отступы и двоеточия в YAML. Табуляция недопустима, а вложенные ключи должны иметь согласованный сдвиг.

Практический сценарий

Представьте типовую задачу: нужно развернуть yq на одной машине, проверить работу и передать доступ коллеге. Начните с чистой системы или снапшота, чтобы результат был воспроизводим. Запишите все команды в отдельный файл — это одновременно шпаргалка и черновик будущей автоматизации.

Дальше действуйте короткими шагами: установка, минимальная конфигурация, проверка, затем расширение. После каждого шага фиксируйте, что именно изменилось и как это проверить. Такой журнал экономит время, когда через месяц понадобится повторить настройку на другом сервере или объяснить её коллеге.

Порядок работ для этого сценария выглядит так:

  1. Проверьте версию и синтаксис
  2. Прочитайте значение из YAML
  3. Измените значение на месте
  4. Преобразуйте YAML в JSON и обратно
  5. Обработайте несколько документов

Отдельно продумайте, что произойдёт при сбое. Для yq важно заранее знать, где хранятся данные, как их скопировать и сколько времени займёт восстановление. Если ответа нет, не двигайтесь дальше: сначала закройте этот пробел, потом добавляйте новые возможности.

Что проверить перед вводом в работу

Перед тем как считать настройку завершённой, пройдитесь по короткому списку. Он не заменяет полноценный аудит, но отсекает большинство очевидных проблем.

Чек-лист

  • Версия yq зафиксирована, а обновления не применяются вслепую.
  • Есть резервная копия конфигурации и данных, восстановление проверено.
  • Доступ ограничен нужными пользователями и сетями, лишние порты закрыты.
  • Логи и метрики собираются, понятно, куда смотреть при сбое.
  • Изменения описаны в документации и могут быть повторены на другой машине.
  • Есть план отката и понятный критерий, по которому вы решите его применить.

Если какой-то пункт вызывает затруднение, это сигнал вернуться к соответствующему разделу, а не откладывать проверку. Настройка, которую нельзя повторить, плохо работает не только у коллег, но и у вас самих через полгода.

Итог

Главная ценность приёмов выше — в экономии внимания. Выберите два-три, доведите до автоматизма, и yq перестанет отнимать время на рутину.

Насколько публикация полезна?

Нажмите на звезду, чтобы оценить!

Средняя оценка 0 / 5. Количество оценок: 0

Оценок пока нет. Поставьте оценку первым.

Поделиться: Telegram ВКонтакте