giantswarm/yaml-jq

yaml-jq 镜像文档

镜像概述

yaml-jq是一个集成了jq工具的Docker镜像，主要用于对YAML格式文件进行查询、过滤、修改等操作。通过该镜像，用户无需在本地环境安装jq，即可通过容器化方式便捷地处理YAML数据，尤其适用于需要统一YAML处理环境或临时进行YAML操作的场景。

核心功能与特性

• 集成jq工具：内置jq，支持所有jq语法，可对YAML数据执行复杂查询和转换
• 标准输入支持：通过-i参数启用交互模式，支持从标准输入接收YAML内容
• 轻量级：基于精简基础镜像构建，体积小，启动快速
• 无依赖：无需在本地安装jq及相关依赖，直接通过Docker运行

使用场景

• 在没有安装jq的系统环境中处理YAML文件
• 需要统一YAML处理工具版本的团队协作场景
• CI/CD流程中对YAML配置文件进行自动化修改
• 临时对YAML文件进行快速查询或字段修改

使用方法

构建镜像

通过以下命令构建本地镜像：

bash
docker build -t giantswarm/yaml-jq .

运行容器

基本用法

通过管道将YAML内容输入容器，并指定jq表达式进行处理：

bash
cat [YAML文件路径] | docker run -i giantswarm/yaml-jq '[jq表达式]'

参数说明

• -i：启用交互模式，允许容器接收标准输入
• [jq表达式]：用于处理YAML的jq语法表达式
• 标准输入：需处理的YAML内容（通过管道或重定向提供）

示例：修改Kubernetes配置文件

以下示例演示如何向Kubernetes API Server的配置中添加审计日志卷挂载：

bash
# 假设存在example/kube-apiserver.yaml文件
cat example/kube-apiserver.yaml \
  | docker run -i giantswarm/yaml-jq '
    # 向spec.containers[0].volumeMounts添加新挂载
    .spec.containers[0].volumeMounts
      |= .+ [{"mountPath": "/var/log/kubernetes", "name": "audit"}] |
    # 向spec.volumes添加对应卷定义
    .spec.volumes
      |= .+ [{"hostPath": {"path": "/var/log/kubernetes"}, "name": "audit"}]'

上述命令会输出修改后的YAML内容，可通过重定向保存到文件：

bash
cat example/kube-apiserver.yaml | docker run -i giantswarm/yaml-jq '[表达式]' > modified-kube-apiserver.yaml