unaittxu/yq-curl

Docker镜像：yq与curl工具集

镜像概述和主要用途

本镜像是一个预安装了yq和curl工具的Docker镜像，旨在提供轻量级、便携的运行环境。通过该镜像，用户无需在本地系统单独安装yq和curl，即可快速使用这两个工具进行YAML/JSON文件的解析、查询、修改，以及HTTP/HTTPS请求的发送与处理，适用于各类临时操作、自动化流程或受限环境。

核心功能和特性

• 工具集成：预安装yq（YAML/JSON处理工具）和curl（HTTP客户端工具），支持常用命令及参数
• 轻量级设计：基于精简基础镜像构建（如Alpine Linux），镜像体积小，启动速度快
• 即开即用：无需额外配置，拉取镜像后可直接运行工具命令
• 环境隔离：通过容器化方式运行，避免工具依赖与本地系统环境冲突
• 跨平台兼容：可在任何支持Docker的操作系统（Linux、macOS、Windows）中运行

使用场景和适用范围

• CI/CD流程：在自动化流水线中处理配置文件（如Kubernetes YAML、CI配置文件）或发送HTTP请求（如通知、接口测试）
• 临时数据处理：本地无yq环境时，快速解析或修改YAML/JSON文件（如提取配置项、批量替换值）
• HTTP接口测试：无需本地安装curl，直接发送GET/POST/PUT等请求测试API接口
• 受限环境操作：在无法直接安装软件的服务器或开发环境中，通过容器使用必要工具
• 脚本开发辅助：编写依赖yq和curl的脚本时，使用容器进行测试和调试

详细使用方法和配置说明

基本使用方式

通过docker run命令直接调用镜像中的yq或curl工具，格式如下：

bash
docker run --rm [镜像名称] [工具命令] [工具参数]

说明：--rm参数确保容器退出后自动删除，避免残留容器占用资源

常用命令示例

1. 调用yq处理文件

需将本地文件挂载到容器中（通过-v参数），示例如下：

• 解析YAML文件并提取指定字段：

  bash
  docker run --rm -v $(pwd):/data [镜像名称] yq eval '.metadata.name' /data/deployment.yaml
  

• 修改JSON文件并输出结果：

  bash
  docker run --rm -v $(pwd):/data [镜像名称] yq eval '.version = "1.0.0"' -i /data/config.json
  

2. 调用curl发送HTTP请求

直接执行curl命令，示例如下：

• 发送GET请求获取网页内容：

  bash
  docker run --rm [镜像名称] curl https://example.com
  

• 发送POST请求提交数据：

  bash
  docker run --rm [镜像名称] curl -X POST -d '{"key":"value"}' -H "Content-Type: application/json" https://api.example.com/data
  

3. 交互式使用

通过-it参数进入容器交互式shell，手动执行多个命令：

bash
docker run --rm -it -v $(pwd):/data [镜像名称] sh

进入shell后，可直接使用yq和curl命令：

bash
# 在容器内执行
yq --version  # 查看yq版本
curl --help    # 查看curl帮助文档
yq eval '.spec.replicas' /data/deployment.yaml  # 处理挂载的本地文件

配置说明

• 文件挂载：通过-v [本地路径]:[容器路径]将本地文件/目录挂载到容器，供工具读取或修改
• 环境变量：如需传递环境变量（如代理设置），可使用-e参数，例如：

  bash
  docker run --rm -e http_proxy=http://proxy.example.com:8080 [镜像名称] curl https://example.com
  

• 工作目录：通过-w [容器路径]指定容器内工作目录，简化文件路径引用：

  bash
  docker run --rm -v $(pwd):/data -w /data [镜像名称] yq eval '.key' file.yaml
  

注意事项

• 挂载文件时，确保本地路径权限正确（容器内用户需有读取/写入权限）
• 如使用Windows系统，本地路径需转换为Docker兼容格式（如/c/Users/xxx/data）
• 工具版本以镜像内置版本为准，如需特定版本，可通过镜像标签（如:v1.2.3）指定（具体标签需参考镜像仓库说明）