skyscrapers/yq

yq-jq-alpine 镜像文档

概述

本镜像基于Alpine Linux构建，预装了jq（JSON处理工具）和yq（YAML处理工具），提供轻量级环境用于快速处理JSON和YAML格式数据。Alpine基础确保镜像体积小、启动速度快，适合在CI/CD流水线、自动化脚本或开发环境中使用。

核心功能与特性

• 预装工具：包含jq（用于JSON数据查询、过滤和转换）和yq（用于YAML数据解析、修改和转换）
• 轻量级基础：基于Alpine Linux，镜像体积小（通常<20MB），资源占用低
• 即开即用：无需额外安装依赖，拉取镜像后可直接使用工具处理数据
• 兼容性：支持标准jq和yq语法，与官方工具功能一致

使用场景

• CI/CD流水线中解析JSON/YAML配置文件
• 自动化脚本中处理API响应数据（JSON格式）
• 配置文件批量修改或验证（YAML格式）
• 开发环境中快速测试JSON/YAML数据处理逻辑
• 容器化环境中的数据转换任务

使用方法

基本使用

通过docker run命令启动容器，直接使用jq或yq命令：

bash
# 查看jq版本
docker run --rm yq-jq-alpine jq --version

# 查看yq版本
docker run --rm yq-jq-alpine yq --version

处理本地文件

挂载本地目录到容器，处理主机上的JSON/YAML文件：

bash
# 使用jq处理本地JSON文件（示例：提取JSON中的特定字段）
docker run --rm -v $(pwd):/data yq-jq-alpine jq '.name' /data/example.json

# 使用yq处理本地YAML文件（示例：修改YAML中的值）
docker run --rm -v $(pwd):/data yq-jq-alpine yq eval '.version = "1.0.0"' -i /data/config.yaml

交互式使用

启动交互式shell，进行多步数据处理：

bash
docker run -it --rm -v $(pwd):/data yq-jq-alpine sh
# 在容器内执行命令
jq '.users[] | .name' /data/users.json
yq eval '.services.web.port = 8080' /data/docker-compose.yaml

docker-compose配置示例

在docker-compose.yml中集成该镜像处理配置文件：

yaml
version: '3'
services:
  config-processor:
    image: yq-jq-alpine
    volumes:
      - ./configs:/data
    command: sh -c "yq eval '.env = \"production\"' -i /data/app.yaml && jq '.log.level = \"info\"' /data/app.json > /data/app-processed.json"

注意事项

• 工具语法遵循官方jq和yq规范，可参考其官方文档获取详细用法
• 挂载文件时确保主机目录权限正确，避免容器内无法读写文件
• 如需持久化处理结果，建议通过挂载卷或输出到主机目录实现