troykinsella/concourse-ansible-playbook-resource

Concourse Ansible Playbook Resource

一个用于运行Ansible playbooks的Concourse CI资源。

该资源镜像包含创建镜像时通过pip安装的最新版Ansible，使用Python 3运行Ansible。其他系统和pip包信息可参见Dockerfile。

可在Docker Hub查看可用的镜像标签版本。

源配置

大多数源属性直接映射到ansible-playbook选项。更多详情可参见ansible-playbook --help。

git_*属性与requirements.yml文件中引用的Git仓库相关，在ansible-galaxy install过程中会拉取这些仓库。

• debug：可选。布尔值。默认false。回显命令和其他通常隐藏的输出，便于故障排除。
• env：可选。环境变量列表。用于提供任务配置依赖，例如AWS_ACCESS_KEY_ID，或指定此资源不支持的Ansible配置选项。注意：不支持的Ansible配置也可在playbook源目录的ansible.cfg中应用。
• git_global_config：可选。要应用的Git全局配置列表（使用git config --global）。
• git_https_username：可选。Git HTTP/S访问的用户名。
• git_https_password：可选。Git HTTP/S访问的密码。
• git_private_key：可选。Git SSH私钥。
• git_skip_ssl_verification：可选。布尔值。默认false。不验证TLS证书。
• user：可选。使用此用户连接远程系统。
• requirements：可选。默认requirements.yml。如果playbook源目录中存在此文件，在运行playbook前会与ansible-galaxy --install一起使用。
• ssh_common_args：可选。指定传递给ssh的选项。
• ssh_private_key：可选。用于连接远程系统的ssh私钥。
• vault_password：可选。ansible-vault密码的值。
• verbose：可选。指定v、vv等以增加ansible-playbook执行的详细程度。

示例

yaml
resource_types:
- name: ansible-playbook
  type: docker-image
  source:
    repository: troykinsella/concourse-ansible-playbook-resource
    tag: latest

resources:
- name: ansible
  type: ansible-playbook
  source:
    debug: false
    user: ubuntu
    ssh_private_key: ((ansible_ssh_private_key))
    vault_password: ((ansible_vault_password))
    verbose: v

行为

check：无操作

in：无操作

out：执行ansible Playbook

针对指定的playbook和清单文件执行ansible-playbook，必要时先通过ansible-galaxy install -r requirements.yml安装依赖。

在运行ansible-playbook之前，如果path目录中存在ansible.cfg文件，会对其进行清理，移除与该资源管理的等效命令行选项对应的条目。设置source.debug: true可查看清理结果。

参数

大多数参数直接映射到ansible-playbook选项。更多详情可参见ansible-playbook --help。

• become：可选。布尔值。默认false。以become方式运行操作（权限提升）。
• become_user：可选。使用此用户运行操作。
• become_method：可选。使用的权限提升方法。
• check：可选。布尔值。默认false。不进行任何实际更改，而是尝试预测可能发生的更改。
• diff：可选。布尔值。默认false。更改（小）文件和模板时，显示这些文件的差异；与check: true配合使用效果良好。
• inventory：必填。清单文件的路径，相对于path。
• limit：可选。将playbook运行限制到指定的主机/组。
• playbook：可选。默认site.yml。要运行的playbook文件路径，相对于path。
• skip_tags：可选。仅运行未标记为此列表中值的play和任务。
• setup_commands：可选。执行playbook前要运行的shell命令列表。参见“自定义设置命令”部分了解说明。
• tags：可选。仅运行标记为此列表中值的play和任务。
• vars：可选。传递给ansible-playbook的额外变量对象。与vars_file互斥。
• vars_file：可选。包含传递给ansible-playbook的额外变量JSON对象的文件。与vars互斥。
• path：必填。包含playbook源的目录路径。通常指向从源代码控制拉取的资源。

自定义设置命令

由于Ansible模块众多，每个模块都有特定的系统依赖，因此该资源Docker镜像无法支持所有依赖。put操作的setup_commands参数允许管道管理员安装执行特定playbook所需的系统包。当然，这种灵活性的代价是每次put都需要执行这些命令。尽管如此，此Concourse资源确实打算提供一组依赖项，以支持最常见或基本的Ansible模块。如果认为某个系统包将有益于多种使用场景，可提交工单请求添加。

示例

yaml
# 扩展“源配置”中的示例

jobs:
- name: provision-frontend
  plan:
  - get: master # git资源
  - put: ansible
    params:
      check: true
      diff: true
      inventory: inventory/some-hosts.yml
      playbook: site.yml
      path: master

测试

bash
docker build .

许可证

MIT © Troy Kinsella