nulldriver/cf-cli-resource

cf-cli-resource 镜像文档

镜像概述和主要用途

cf-cli-resource 是一个Concourse资源类型，专门用于在Concourse CI/CD流水线中与Cloud Foundry平台交互。它允许用户在流水线中执行各类cf cli（Cloud Foundry命令行工具）命令，实现对Cloud Foundry部署的自动化操作，如应用推送、服务管理、环境配置等，简化Cloud Foundry相关的CI/CD流程。

核心功能和特性

• 多命令支持：兼容多种cf cli命令，包括cf login、cf push、cf create-service、cf bind-service、cf scale等常用操作
• Concourse集成：作为Concourse原生资源类型，可直接集成到流水线配置中，实现自动化流程编排
• 灵活配置：支持自定义Cloud Foundry连接参数（API地址、组织、空间等）和命令参数
• 认证支持：支持通过用户名/密码方式进行Cloud Foundry平台认证
• 版本兼容性：可指定cf cli版本，适配不同Cloud Foundry环境需求

使用场景和适用范围

• 自动化应用部署：在CI/CD流水线中自动将应用推送至Cloud Foundry平台
• 服务生命周期管理：自动化创建、绑定、更新和删除Cloud Foundry服务实例
• 环境维护操作：执行应用扩缩容、环境变量配置、健康检查等日常维护命令
• 适用对象：使用Concourse作为CI/CD工具且需要与Cloud Foundry平台交互的开发和运维团队

使用方法和配置说明

1. 定义资源类型

在Concourse pipeline配置中声明cf-cli-resource资源类型：

yaml
resource_types:
- name: cf-cli-resource
  type: docker-image
  source:
    repository: nulldriver/cf-cli-resource
    tag: latest  # 可指定具体版本，如"v1.2.3"

2. 配置资源实例

定义具体的资源实例，配置Cloud Foundry连接信息：

yaml
resources:
- name: cf-deploy-action
  type: cf-cli-resource
  source:
    api: https://api.run.pivotal.io  # Cloud Foundry API端点
    username: ((cf-username))       # Cloud Foundry用户名（建议使用Concourse变量存储）
    password: ((cf-password))       # Cloud Foundry密码（建议使用Concourse变量存储）
    org: my-organization            # 目标组织名称
    space: my-space                 # 目标空间名称
    # 可选配置
    skip_cert_check: false          # 是否跳过SSL证书检查（默认false）
    cf_cli_version: "8.6.0"         # 指定cf cli版本（默认使用最新版）

3. 在Job中使用资源

在Concourse Job中通过put步骤执行cf cli命令：

yaml
jobs:
- name: deploy-to-cloudfoundry
  plan:
  - get: application-source  # 获取应用源代码（假设已配置代码资源）
  - put: cf-deploy-action
    params:
      command: push my-app -p application-source  # 执行cf push命令部署应用
      working_dir: /tmp  # 可选，命令执行的工作目录
      environment:       # 可选，设置环境变量
        - APP_ENV=production
        - LOG_LEVEL=info

4. 常用命令示例

可在params.command中指定各类cf cli命令：

• 推送应用：push my-app -p ./app --no-start
• 创建服务实例：create-service p-mysql 100mb my-database
• 绑定服务到应用：bind-service my-app my-database
• 启动应用：start my-app
• 扩展应用实例：scale my-app -i 3
• 设置环境变量：set-env my-app API_KEY ((api-key))

配置参数说明

资源源配置（source）

操作参数（params）

相关链接

• GitHub仓库：https://github.com/nulldriver/cf-cli-resource
• Concourse Pipeline示例：[***]