fidelityinternational/concourse-teams-resource

Concourse Teams通知资源

镜像概述和主要用途

Concourse Teams通知资源是一个Docker镜像，作为Concourse CI/CD的资源类型，用于向Microsoft Teams发送任务状态通知。它能够将Concourse任务（尤其是失败任务）的日志输出包含在通知中，帮助团队及时了解流水线运行状态。

核心功能和特性

• 向Microsoft Teams发送任务状态通知（成功或失败）
• 支持包含失败Concourse任务的日志输出
• 可配置日志最大长度，以适应Teams消息的字符限制
• 支持通过ATC（Concourse API）认证获取任务日志（需提供ATC外部URL、用户名和密码）

使用场景和适用范围

适用于Concourse CI/CD流水线环境，在任务执行成功或失败时触发通知，特别适合需要实时监控流水线状态的开发和运维团队。

配置说明

资源类型配置

在Concourse流水线中，需先定义该资源类型：

yaml
resource_types:
- name: teams-notification
  type: docker-image
  source:
    repository: fidelityinternational/concourse-teams-resource
    tag: latest

源配置（Source Configuration）

以下字段在需要在Teams通知中显示失败Concourse任务输出时为必填项：

• url：Teams webhook URL（必填）
• atc_external_url：可选，ATC外部URL。若提供了用户名和密码但未提供ATC URL，将尝试使用内置的ATC_EXTERNAL_URL环境变量
• atc_username：可选，ATC用户名，若提供了atc_external_url则必填
• atc_password：可选，ATC密码，若提供了atc_external_url则必填
• log_max_length：可选，日志最大长度配置，用于适应Teams消息的字符限制

源配置示例：

yaml
resources:
- name: teams-alert
  type: teams-notification
  source:
    url: ((teams_webhook))  # 使用Concourse变量存储Teams webhook
    atc_external_url: https://concourse.example.com  # 示例ATC外部URL
    atc_username: concourse-user  # 示例ATC用户名
    atc_password: ((concourse-password))  # 使用Concourse变量存储ATC密码
    log_max_length: 4000  # 示例日志最大长度

行为

发送通知到Teams

根据配置的参数向Teams发送通知。

参数（Parameters）

• status：必填，值为'failure'或'success'，用于指定资源是在任务失败（on_failure）还是成功（on_success）时调用

使用示例

在Concourse流水线的任务中，通过on_failure或on_success触发通知：

yaml
jobs:
- name: example-job
  plan:
  - task: example-task
    config:
      # 任务配置...
  on_failure:  # 或 on_success:
    do:
    - put: teams-alert  # 引用前面定义的teams-alert资源
      params:
        status: failure  # 或 status: success

完整的工作示例可参考test-pipeline.yml。

测试方法

要测试此资源，可通过以下两种方式：

1. 使用测试流水线：将资源、资源类型以及on_failure/on_success示例添加到现有流水线中。

2. 本地Concourse测试：

   • 使用Docker安装测试环境的Concourse
   • 更新Teams资源配置（如webhook URL、ATC信息等）
   • 通过fly命令推送示例流水线：

bash
# 登录到本地Concourse
fly login -t local -c http://localhost:8080 -u <本地用户名> -p <本地密码>

# 设置测试流水线
fly -t local set-pipeline -p test -c test-pipeline.yml

• 访问http://localhost:8080%EF%BC%8C%E8%BF%90%E8%A1%8Cmonitoring-test%E4%BB%BB%E5%8A%A1%E3%80%82%E8%AF%A5%E4%BB%BB%E5%8A%A1%E5%8C%85%E5%90%AB%E4%B8%80%E4%B8%AA%E6%88%90%E5%8A%9F%E4%BB%BB%E5%8A%A1%E5%92%8C%E4%B8%80%E4%B8%AA%E5%A4%B1%E8%B4%A5%E4%BB%BB%E5%8A%A1%EF%BC%8C%E5%A4%B1%E8%B4%A5%E4%BB%BB%E5%8A%A1%E4%BC%9A%E8%A7%A6%E5%8F%91Teams%E9%80%9A%E7%9F%A5%E3%80%82
• 检查Teams接收的通知，其中应包含流水线名称、任务名称、Concourse构建URL以及失败/成功任务的日志输出。