cycloid/cycloid-resource

Cycloid Concourse 资源镜像

镜像概述

本镜像为Concourse CI/CD平台提供专用资源支持，旨在集成并执行Cycloid平台的核心功能。通过该资源，用户可在Concourse流水线中自动化触发terracost（基础设施成本估算）和infrapolicy（基础设施策略检查）等Cycloid特性，实现部署前的成本管控与合规性验证。

核心功能与特性

主要功能

• terracost集成：支持基于Terraform配置文件执行基础设施成本估算，提供资源部署前的成本预览与分析。
• infrapolicy支持：实现基础设施策略合规性检查，验证资源配置是否符合预设的安全、架构或合规标准。

关键特性

• 专为Concourse流水线设计，可直接作为资源类型集成至管道配置。
• 轻量级架构，聚焦核心功能执行，减少CI/CD流程资源消耗。
• 与Cycloid平台功能接口同步更新，确保兼容性与功能完整性。

使用场景

• CI/CD前置检查：在基础设施部署流水线中，作为前置步骤执行成本估算与策略检查，避免高成本或不合规配置进入生产环境。
• 多环境一致性保障：在开发、测试、生产等环境的部署流程中集成该资源，确保各环境基础设施配置满足统一标准。
• DevOps流程优化：在代码合并或部署触发阶段自动执行检查，为团队提供即时反馈，缩短问题修复周期。

使用方法与配置说明

前置条件

• 已部署Concourse CI/CD平台。
• 具备Cycloid平台访问权限（需API密钥等认证信息）。
• 流水线中已配置基础设施代码（如Terraform文件）的获取方式。

资源配置步骤

1. 定义资源类型

在Concourse管道配置中声明资源类型，指定镜像来源：

yaml
resource_types:
- name: cycloid-resource
  type: docker-image
  source:
    repository: [镜像仓库地址]  # 替换为实际镜像仓库路径
    tag: [版本标签]  # 如"latest"或具体版本号

2. 配置资源实例

定义资源实例，设置Cycloid连接参数：

yaml
resources:
- name: cycloid-feature-check
  type: cycloid-resource
  source:
    cycloid_api_url: https://[cycloid-instance].com  # Cycloid实例API地址
    cycloid_api_token: ((cycloid-api-token))  # 通过Concourse变量存储API令牌
    timeout: "300s"  # 可选，设置功能执行超时时间
    log_level: "info"  # 可选，设置日志级别（debug/info/warn/error）

3. 流水线中使用资源

在Job计划中通过get或put步骤触发功能执行：

yaml
jobs:
- name: infrastructure-validation
  plan: 
  - get: infrastructure-code  # 获取基础设施代码（如Terraform文件）
  - get: cycloid-feature-check
    params:
      action: "terracost"  # 指定执行功能："terracost"或"infrapolicy"
      tf_plan_path: "./infrastructure-code/terraform.plan"  # Terraform计划文件路径
      policy_path: "./infrastructure-code/policy"  # 策略文件路径（infrapolicy时需指定）

参数说明

使用示例：完整流水线片段

yaml
resource_types:
- name: cycloid-resource
  type: docker-image
  source:
    repository: cycloid/concourse-resource
    tag: latest

resources:
- name: terraform-code
  type: git
  source:
    uri: https://github.com/example/terraform-repo.git
    branch: main

- name: cycloid-checker
  type: cycloid-resource
  source:
    cycloid_api_url: https://cycloid.example.com
    cycloid_api_token: ((cycloid-token))
    log_level: "debug"

jobs:
- name: pre-deploy-validation
  plan:
  - get: terraform-code
    trigger: true
  - task: generate-tf-plan
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: hashicorp/terraform, tag: 1.6.0}
      inputs:
      - name: terraform-code
      outputs:
      - name: tf-plan
      run:
        path: sh
        args:
        - -c
        - |
          cd terraform-code
          terraform init
          terraform plan -out=../tf-plan/terraform.plan
  - get: cycloid-checker
    params:
      action: "terracost"
      tf_plan_path: "./tf-plan/terraform.plan"
  - get: cycloid-checker
    params:
      action: "infrapolicy"
      policy_path: "./terraform-code/policy"
      tf_plan_path: "./tf-plan/terraform.plan"

注意事项

• 确保Cycloid API令牌具有足够权限执行terracost和infrapolicy操作。
• Terraform计划文件需提前生成并通过流水线输入传递给资源。
• 策略文件需符合Cycloid infrapolicy的格式要求（如Rego或HCL格式）。
• 大规模基础设施配置建议适当延长超时时间，避免执行中断。