AuthKeys docker-ansible 镜像文档

镜像概述

该Docker镜像用于执行Ansible命令，允许直接向容器传递Ansible参数。用户需将本地Ansible项目目录挂载至容器内的/ansible目录，即可在隔离环境中运行Ansible playbook。

核心功能和特性

• 支持直接传递Ansible命令行参数，与本地执行Ansible命令体验一致
• 可通过环境变量配置SSH密钥，实现安全认证
• 自动安装Python依赖（通过指定 requirements 文件）
• 自动安装Ansible模块（通过 ansible-galaxy）
• 支持预执行指定的playbook，满足前置操作需求（如配置known_hosts）

使用场景

• 本地无Ansible环境时快速执行playbook
• 需要隔离不同项目的Ansible依赖环境
• 自动化部署流程中集成Ansible执行步骤
• 多环境（开发/测试/生产）使用不同SSH密钥或依赖配置时

使用方法

基本要求

需将本地Ansible项目目录挂载至容器的/ansible目录，基本命令格式如下：

docker run -it --rm \
  -v $PWD:/ansible \
  authkeys/docker-ansible [ansible参数] playbook.yml

配置参数

通过环境变量可配置容器行为，支持以下参数：

使用示例

带密码询问

需要手动输入密码时，使用--ask-pass参数：

docker run -it --rm \
  -v $PWD:/ansible \
  authkeys/docker-ansible --ask-pass playbook.yml

使用SSH密钥

指定SSH密钥进行认证（需将本地.ssh目录挂载至容器/root/.ssh）：

docker run -it --rm \
  -e SSH_KEY=id_ed25519 \
  -v $HOME/.ssh:/root/.ssh \
  -v $PWD:/ansible \
  authkeys/docker-ansible playbook.yml

若SSH密钥有密码，容器会提示输入密钥密码。

安装Python依赖

指定自定义Python依赖文件（默认读取requirements-pip.txt）：

docker run -it --rm \
  -e SSH_KEY=id_ed25519 \
  -e PYTHON_REQUIREMENTS=/python/requirements.txt \
  -v requirements.txt:/python/requirements.txt \
  -v $HOME/.ssh:/root/.ssh \
  -v $PWD:/ansible \
  authkeys/docker-ansible playbook.yml

安装Ansible模块

通过ansible-galaxy安装Ansible模块（默认读取requirements.yml）：

docker run -it --rm \
  -e SSH_KEY=id_ed25519 \
  -e ANSIBLE_REQUIREMENTS=/extra/requirements.yaml \
  -v requirements.yaml:/extra/requirements.yaml \
  -v $HOME/.ssh:/root/.ssh \
  -v $PWD:/ansible \
  authkeys/docker-ansible playbook.yml

预执行playbook

执行主playbook前先运行指定的预playbook（如配置known_hosts）：

docker run -it --rm \
  -e ANSIBLE_PRE_PLAYBOOK=ssh_keyscan.yml \
  -e ANSIBLE_PRE_PLAYBOOK_OPTS=--forks=1 \
  -e SSH_KEY=id_ed25519 \
  -v $HOME/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro \
  -v $PWD:/ansible \
  authkeys/docker-ansible playbook.yml