kvivan/concourse-ansible-resource

Ansible Concourse资源镜像

镜像概述

本镜像为Concourse CI/CD平台提供Ansible资源支持，可在Concourse中执行Ansible playbooks。它采用纯Python实现，直接调用Ansible API，无需依赖二进制命令，并通过自定义输出插件将执行日志发送至stderr，满足Concourse的日志输出要求（详见ansible/callbacks/concourse.py）。Ansible默认配置位于ansible文件夹下的/etc/ansible路径。

核心功能

1. 在Concourse中执行Ansible playbooks
2. 支持SSH私钥、远程用户、密码等认证方式
3. 灵活配置inventory（静态/动态、主机组、变量等）
4. 支持Ansible Vault密码解密加密文件
5. 提供become权限提升、并行执行线程数控制
6. 通过标签（tags/skip_tags）过滤任务执行范围

使用场景

• CI/CD流程中自动化服务器配置管理
• 应用部署前的环境初始化
• 批量服务器运维操作（如软件安装、配置更新）

配置说明

源配置（Source Configuration）

以下参数用于资源定义，无必填项，但通常需配置private_key、remote_user和inventory：

• private_key: SSH私钥字符串，用于SSH连接
• remote_user: 远程SSH连接用户
• remote_pass: 远程用户密码（若未提供private_key）
• vault_password: Ansible Vault密码，用于解密加密变量文件
• extra_vars: 键值对字典，传递playbook所需变量
• inventory: inventory配置字典：
  • file: 静态inventory文件名，默认inventory.ini
  • path: inventory文件所在目录，默认inventory（支持group_vars/host_vars）
  • hosts: 静态inventory定义（含主机、组、变量）
  • executable: 动态inventory可执行文件路径
• become: 是否启用权限提升（默认否）
• become_method: 权限提升方式（默认sudo）
• become_user: 提升后的用户（默认root）
• become_pass: 权限提升密码
• ssh_common_args: SSH客户端额外参数
• forks: 并行执行线程数
• tags: 仅执行标记该标签的任务
• skip_tags: 跳过标记该标签的任务

行为（Behavior）

• check/in: 目前仅支持put阶段，这两个阶段为无操作（no-ops）
• out: 执行Ansible playbook，通过自定义插件输出日志到stderr

out参数

除private_key外，源配置参数均可在out阶段使用，新增以下参数：

• src: Ansible资源（inventory、playbook等）的基础目录
• playbook: 需执行的playbook文件名

示例Pipeline

基础示例

yml
---
resource_types:
- name: ansible
  type: docker-image
  source:
    repository: platformengineering/concourse-ansible-resource

resources:
- name: ansible-playbook
  type: git
  source:
    uri: git@github.com:springerpe/repository.git
    branch: master
    private_key: {{github-private-key}}
- name: ansible-executor
  type: ansible
  source:
    private_key: {{ansible-private-key}}
    remote_user: ansible
    inventory:
      hosts:
        webservers: 
        - "host2.example.com"
        - "host3.example.com"
        atlanta:
            hosts:
            - "host1.example.com"
            - "host4.example.com"
            - "host5.example.com"
            vars:
              b: false
            children:
            - marietta
        marietta:
        - "host-six.example.com"

jobs:
- name: run-ansible
  plan:
  - get: ansible-playbook
  - put: ansible-executor
    params:
      src: "ansible-playbook"
      playbook: "site.yml"

含Vault密码的示例

yml
---
resource_types:
- name: ansible
  type: docker-image
  source:
    repository: platformengineering/concourse-ansible-resource

resources:
- name: ansible-playbook
  type: git
  source:
    uri: git@github.com:springernature/ee-ansible-ironic-standalone.git
    branch: master
    private_key: |
        -----BEGIN RSA PRIVATE KEY-----
        ..................................................................
        -----END RSA PRIVATE KEY-----

- name: ansible-executor
  type: ansible
  source:
    private_key: {{ansible-private-key}}
    remote_user: {{ansible-remote-user}}
    vault_password: {{ansible-vault-password}}

jobs:
- name: run-ansible
  plan:
  - get: ansible-playbook
    params:
      submodules: all
  - put: ansible-executor
    params:
      src: "ansible-playbook"
      inventory:
        path: "inventory"
        file: "pe-prod-dogo-ironic-01.ini"
      playbook: "setup.yml"

Ansible Playbook仓库结构示例

.
├── playbook.yml
├── inventory
│   ├── static_inventory.ini
│   └── group_vars
│       └── group.yml
├── roles
│   ├── role1
│   └── role2
├── tasks
│   ├── task1.yml
│   └── task2.yml
├── files
│   └── file.bin
└── vars
    ├── secrets.yml
    └── other_vars.yml

作者

Jose Riguera <***>
(c) 2017 Springer Nature Platform Engineering