serversideup/ansible 镜像文档

概述

serversideup/ansible 是在容器化环境中运行Ansible的轻量级解决方案。该项目基于 willhallonline/docker-ansible 的经验构建，提供安全隔离的Ansible任务运行环境，支持Alpine和Debian两种基础发行版，并允许以非特权用户身份运行，避免文件权限配置难题。

核心功能和特性

• 🐧 Debian 和 Alpine - 选择你的操作系统
• 🐍 基于官方Python镜像 - 选择你的Python版本
• 🔒 非特权用户 - 可选择以root或非特权用户身份运行
• 📌 固定Ansible版本 - 可精确到补丁版本设置Ansible版本
• 🔧 自定义"运行身份"用户 - 自定义运行Ansible的用户名
• 🔑 设置自定义PUID和PGID - 可匹配主机用户的PUID和PGID
• 📦 支持DockerHub和GitHub容器 registry - 可选择镜像拉取源
• 🤖 多架构支持 - 所有镜像均提供x86_64和arm64架构版本

镜像选择

该项目提供两种镜像变体，可在Docker Hub和GitHub容器 registry获取：

DockerHub

• serversideup/ansible
• serversideup/ansible-core

GitHub Container Registry

• ghcr.io/serversideup/ansible
• ghcr.io/serversideup/ansible-core

镜像标签系统

镜像采用全面的标签系统，提供灵活性和精确性：

标签组件

标签示例

使用方法

运行Playbook

重要
几乎所有情况下，你都需要挂载Ansible"工作目录"(默认: /ansible)和SSH配置(通常为~/.ssh)作为卷。

docker run --rm -it \
  -v "$HOME/.ssh:/ssh" \
  -v "$(pwd):/ansible" \
  serversideup/ansible:latest ansible-playbook playbook.yml

更改"运行身份"用户、PUID和PGID

docker run --rm -it \
  -v "$HOME/.ssh:/ssh" \
  -v "$(pwd):/ansible" \
  -e PUID=9999 -e PGID=9999 \
  -e RUN_AS_USER=bob \
  serversideup/ansible:latest ansible-playbook playbook.yml

运行shell

docker run --rm -it \
  -v "$HOME/.ssh:/ssh" \
  -v "$(pwd):/ansible" \
  serversideup/ansible:latest /bin/sh

SSH配置

注意
SSH密钥配置可能比较复杂，尤其是动态设置RUN_AS_USER时。我们提供了一些机制来简化配置过程。

/ssh目录

默认情况下，容器中有一个/ssh目录，通过符号链接链接到~/.ssh。/ssh目录用作SSH密钥和配置的单一数据源。

如果设置了RUN_AS_USER，入口点脚本将在/home/${RUN_AS_USER}创建主目录，然后将/home/${RUN_AS_USER}/.ssh符号链接到/ssh。这使你可以将RUN_AS_USER设置为任何值，无需提前预测。

挂载SSH认证套接字

SSH认证套接字是SSH代理用于与其他进程通信的Unix套接字，允许安全的密钥管理。在Docker中使用方法如下：

macOS:

docker run --rm -it \
  -v "$HOME/.ssh:/ssh:ro" \
  -v "$HOME/.ssh/known_hosts:/ssh/known_hosts:rw" \
  -v "$(pwd):/ansible" \
  -v "/run/host-services/ssh-auth.sock:/run/host-services/ssh-auth.sock" \
  -e SSH_AUTH_SOCK="/run/host-services/ssh-auth.sock" \
  serversideup/ansible:latest ansible-playbook playbook.yml

注意我们将SSH_AUTH_SOCK与主机的套接字匹配，这是SSH代理与容器通信所必需的。

Linux:

docker run --rm -it \
  -v "$HOME/.ssh:/ssh:ro" \
  -v "$HOME/.ssh/known_hosts:/ssh/known_hosts:rw" \
  -v "$(pwd):/ansible" \
  -v "$SSH_AUTH_SOCK:$SSH_AUTH_SOCK" \
  -e SSH_AUTH_SOCK=$SSH_AUTH_SOCK \
  serversideup/ansible:latest ansible-playbook playbook.yml

环境变量

可通过以下环境变量自定义镜像行为：

资源链接

• DockerHub - 浏览镜像
• ******* - 获取社区和团队支持
• GitHub - 源代码、问题报告和项目管理
• 专业支持 - 直接从核心贡献者获取视频+屏幕共享帮助

贡献指南

作为开源项目，我们致力于开发过程的透明度和协作性。我们非常感谢社区成员提供的任何贡献。无论是修复错误、提出功能建议、改进文档还是宣传项目，你的参与都将增强项目的质量。请查看我们的行为准则以了解我们如何相互尊重地合作。

• 错误报告: 如果你在使用这些镜像时遇到问题，请创建issue。
• 功能请求: 通过提交功能请求改进此项目。
• 文档改进: 通过提交文档更改改进我们的文档。
• 社区支持: 在GitHub Discussions或***上帮助他人。
• 安全报告: 通过我们的负责任披露政策报告严重安全问题。