yokogawa/ansible-lint

ansible-lint Docker镜像

镜像概述和主要用途

本镜像基于https://github.com/ansible/ansible-lint%E9%A1%B9%E7%9B%AE%E6%9E%84%E5%BB%BA%EF%BC%8C%E6%8F%90%E4%BE%9B%E4%BA%86%E5%9C%A8%E5%AE%B9%E5%99%A8%E7%8E%AF%E5%A2%83%E4%B8%AD%E8%BF%90%E8%A1%8Cansible-lint%E5%B7%A5%E5%85%B7%E7%9A%84%E4%BE%BF%E6%8D%B7%E6%96%B9%E5%BC%8F%E3%80%82ansible-lint%E6%98%AF%E4%B8%80%E6%AC%BE%E9%9D%99%E6%80%81%E5%88%86%E6%9E%90%E5%B7%A5%E5%85%B7%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%A3%80%E6%9F%A5Ansible%E5%89%A7%E6%9C%AC%E3%80%81%E8%A7%92%E8%89%B2%E3%80%81%E4%BB%BB%E5%8A%A1%E6%96%87%E4%BB%B6%E7%AD%89%E6%98%AF%E5%90%A6%E7%AC%A6%E5%90%88%E8%AF%AD***%E8%8C%83%E3%80%81%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5%E5%8F%8A%E5%B8%B8%E8%A7%81%E9%94%99%E8%AF%AF%EF%BC%8C%E5%B8%AE%E5%8A%A9%E5%BC%80%E5%8F%91%E5%92%8C%E8%BF%90%E7%BB%B4%E4%BA%BA%E5%91%98%E6%8F%90%E5%8D%87Ansible%E4%BB%A3%E7%A0%81%E8%B4%A8%E9%87%8F%E3%80%82

核心功能和特性

• 集成最新版ansible-lint，支持对Ansible内容进行全面的静态分析
• 无需在本地安装Python及ansible-lint依赖，通过容器化方式快速使用
• 支持多种文件查找方式（如find命令、git ls-files），灵活适配不同项目结构
• 轻量级设计，基于Python 3环境构建，确保运行效率

支持的标签及对应Dockerfile链接

• https://github.com/yokogawa-k/docker-ansible-lint/blob/master/Dockerfile

使用场景和适用范围

• Ansible剧本开发过程中的本地代码检查
• CI/CD流程集成，在代码提交或部署前自动检测Ansible代码质量
• 团队协作中统一Ansible代码检查标准，确保风格一致性
• 快速验证第三方Ansible角色或剧本的合规性

使用方法和配置说明

查看工具使用帮助

console
$ docker run --rm yokogawa/ansible-lint

检查项目中的Ansible文件示例

使用find命令查找文件并检查

console
$ docker run --rm -v ${PWD}:/work -w /work yokogawa/ansible-lint sh -c 'find . -name "*.yml" | xargs -r ansible-lint --force-color'

说明：

• -v ${PWD}:/work：将当前目录挂载到容器内的/work目录
• -w /work：设置容器的工作目录为/work
• find . -name "*.yml"：查找当前目录下所有.yml文件
• xargs -r ansible-lint --force-color：将找到的文件作为参数传递给ansible-lint，并强制显示彩色输出

使用git ls-files命令查找版本控制中的文件并检查

console
$ docker run --rm -v ${PWD}:/work -w /work yokogawa/ansible-lint sh -c 'git ls-files -z "*.yml" | xargs -r -0 ansible-lint'

说明：

• git ls-files -z "*.yml"：列出Git版本控制中所有.yml文件，使用-z选项确保文件名包含特殊字符时正确处理
• xargs -r -0 ansible-lint：通过-0选项与git ls-files -z配合，安全处理包含空格或特殊字符的文件名