logimethods/cf-cli-resource

cf cli Concourse资源

![CI构建]([***]

一个仅输出的资源，能够运行大量Cloud Foundry CLI命令。

源配置

• api: 必填。Cloud Foundry部署中Cloud Controller的地址。
• username: 必填。用于身份验证的用户名。
• password: 必填。用于身份验证的密码。
• skip_cert_check: 可选。检查CF SSL证书的有效性。默认为false。
• org: 可选。设置默认目标组织（可在params配置中覆盖）。
• space: 可选。设置默认目标空间（可在params配置中覆盖）。

yaml
resource_types:
- name: cf-cli-resource
  type: docker-image
  source:
    repository: pivotalpa/cf-cli-resource
    tag: latest

resources:
- name: cf-env
  type: cf-cli-resource
  source:
    api: https://api.local.pcfdev.io
    username: admin
    password: admin
    skip_cert_check: true

多命令语法

此资源能够在单独的put步骤中运行单个命令：

yaml
  - put: cf-create-org
    resource: cf-env
    params:
      command: create-org
      org: myorg
  - put: cf-create-space
    resource: cf-env
    params:
      command: create-space
      org: myorg
      space: myspace

或者 可以在单个put步骤中组合多个命令：

yaml
  - put: cf-create-org-and-space
    resource: cf-env
    params:
      commands:
      - command: create-org
        org: myorg
      - command: create-space
        org: myorg
        space: myspace

当然，如果在source配置中定义了org和space，命令会更简单：

yaml
  - put: cf-create-org-and-space
    resource: cf-env
    params:
      commands:
      - command: create-org
      - command: create-space

行为

out: 运行cf cli命令

在Cloud Foundry实例上运行cf命令。

create-org

创建组织

• org: 可选。要创建的组织（如果未在源配置中设置则必填）

yaml
  - put: cf-create-org
    resource: cf-env
    params:
      command: create-org
      org: myorg

delete-org

删除组织

• org: 可选。要删除的组织（如果未在源配置中设置则必填）

yaml
  - put: cf-delete-org
    resource: cf-env
    params:
      command: delete-org
      org: myorg

create-space

创建空间

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。要创建的空间（如果未在源配置中设置则必填）

yaml
  - put: cf-create-space
    resource: cf-env
    params:
      command: create-space
      org: myorg
      space: myspace

delete-space

删除空间

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。要删除的空间（如果未在源配置中设置则必填）

yaml
  - put: cf-delete-space
    resource: cf-env
    params:
      command: delete-space
      org: myorg
      space: myspace

create-user

创建新用户

• username: 必填。要创建的用户名
• password: 可选。密码（必须指定password或origin）
• origin: 可选。身份验证源（例如ldap、provider-alias）（必须指定password或origin）

使用凭据创建用户：

yaml
  - put: prepare-env
    resource: cf-env
    params:
      command: create-user
      username: j.smith@example.com
      password: S3cr3t

创建LDAP用户：

yaml
  - put: prepare-env
    resource: cf-env
    params:
      command: create-user
      username: j.smith@example.com
      origin: ldap

create-users-from-file

从CSV文件批量创建用户

• file: 必填。包含用户信息的CSV文件

yaml
  - put: prepare-env
    resource: cf-env
    params:
      command: create-users-from-file
      file: somepath/users.csv

批量加载文件格式：

注意：

• 文件必须包含标题行
• 文件必须为逗号分隔值格式
• 可多次指定同一用户以分配多个组织/空间
• 如果省略Org，则不分配组织或空间角色
• 如果省略Space，则不分配空间角色

delete-user

删除用户

• username: 必填。要删除的用户名

yaml
  - put: prepare-env
    resource: cf-env
    params:
      command: delete-user
      username: j.smith@example.com

create-service

创建服务实例

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• service: 必填。要创建的市场服务名称
• plan: 必填。要创建的服务计划名称
• service_instance: 必填。服务实例名称
• configuration: 可选。包含服务特定配置参数的有效JSON对象，可内联提供或通过文件提供。有关支持的配置参数列表，请参阅特定服务产品的文档。
• tags: 可选。用户提供的标签
• timeout: 可选。服务创建的最大等待时间（秒）。默认为600（10分钟）
• wait_for_service: 可选。等待异步服务启动。默认为false。

yaml
  - put: cf-create-service
    resource: cf-env
    params:
      command: create-service
      service: p-config-server
      plan: standard
      service_instance: my-config-server
      configuration: '{"count":3}'
      tags: 'list, of, tags'
      timeout: 300
      wait_for_service: true

wait-for-service

等待服务实例启动

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• service_instance: 必填。要等待的服务实例
• timeout: 可选。服务创建的最大等待时间（秒）。默认为600（10分钟）

yaml
  - put: cf-wait-for-service
    resource: cf-env
    params:
      command: wait-for-service
      service_instance: my-config-server
      timeout: 300

delete-service

删除服务实例

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• service_instance: 必填。要删除的服务实例

yaml
  - put: cf-delete-service
    resource: cf-env
    params:
      command: delete-service
      service_instance: my-config-server

bind-service

将服务实例绑定到应用

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• app_name: 必填。要绑定服务的应用
• service_instance: 必填。要绑定到应用的服务实例
• configuration: 可选。包含服务特定配置参数的有效JSON对象，可内联提供或通过文件提供。有关支持的配置参数列表，请参阅特定服务产品的文档。

yaml
  - put: cf-bind-service
    resource: cf-env
    params:
      command: bind-service
      app_name: myapp-ui
      service_instance: mydb
      configuration: '{"permissions":"read-only"}'

push

推送新应用或同步现有应用的更改

注意：可使用清单文件指定必填参数的值。任何指定的参数都将覆盖清单中的值。

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• app_name: 必填。应用名称
• hostname: 可选。主机名（例如my-subdomain）
• memory: 可选。内存限制（例如256M、1024M、1G）
• disk_quota: 可选。磁盘限制（例如256M、1024M、1G）
• instances: 可选。实例数量
• path: 可选。应用目录路径或应用目录内容的zip文件路径
• buildpack: 可选。自定义构建包，可通过名称（例如my-buildpack）、Git URL（例如'https://github.com/cloudfoundry/java-buildpack.git'%EF%BC%89%E6%88%96%E5%B8%A6%E5%88%86%E6%94%AF/%E6%A0%87%E7%AD%BE%E7%9A%84Git URL（例如'https://github.com/cloudfoundry/java-buildpack.git#v3.3.0'%E8%A1%A8%E7%A4%BA'v3.3.0'%E6%A0%87%E7%AD%BE%EF%BC%89%E6%8C%87%E5%AE%9A%E3%80%82%E8%A6%81%E4%BB%85%E4%BD%BF%E7%94%A8%E5%86%85%E7%BD%AE%E6%9E%84%E5%BB%BA%E5%8C%85%EF%BC%8C%E6%8C%87%E5%AE%9A'default'%E6%88%96'null'
• manifest: 可选。清单文件路径
• no_start: 可选。推送后不启动应用。默认为false。

yaml
  - put: cf-push
    resource: cf-env
    params:
      command: push
      app_name: myapp-ui
      hostname: myapp
      memory: 512M
      disk_quota: 1G
      instances: 1
      path: path/to/myapp-*.jar
      buildpack: java_buildpack
      manifest: path/to/manifest.yml
      no_start: true

zero-downtime-push

使用https://github.com/contraband/autopilot%E6%8E%A8%E9%80%81%E5%8D%95%E4%B8%AA%E5%BA%94%E7%94%A8%E3%80%82

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• manifest: 必填。应用清单文件路径。
• path: 可选。要推送的应用路径。如果未设置，将从清单中读取。
• current_app_name: 可选。这应该是将要重新部署的应用名称。如果设置，资源将执行零停机部署。
• environment_variables: 可选。要添加到清单的环境变量键/值对。

yaml
  - put: cf-zero-downtime-push
    resource: cf-env
    params:
      command: zero-downtime-push
      manifest: path/to/manifest.yml
      path: path/to/myapp-*.jar
      current_app_name: myapp-ui
      environment_variables:
        key: value
        key2: value2

start

启动应用

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• app_name: 必填。应用名称
• staging_timeout: 可选。构建包构建的最大等待时间（分钟）
• startup_timeout: 可选。应用实例启动的最大等待时间（分钟）

yaml
  - put: cf-start
    resource: cf-env
    params:
      command: start
      app_name: myapp-ui
      staging_timeout: 15
      startup_timeout: 5

delete

删除应用

• org: 可选。目标组织（如果未在源配置中设置则必填）
• space: 可选。目标空间（如果未在源配置中设置则必填）
• app_name: 必填。应用名称
• delete_mapped_routes: 可选。删除所有映射的路由。默认为false。

yaml
  - put: cf-delete
    resource: cf-env
    params:
      command: delete
      app_name: myapp-ui
      delete_mapped_routes: true