typositoire/concourse-helm3-resource

Concourse的Helm资源

从Concourse部署https://github.com/helm/helm%E3%80%82

基于https://github.com/linkyard/concourse-helm-resource的工作开发。

Docker镜像

可从https://hub.docker.com/repository/docker/typositoire/concourse-helm3-resource拉取资源镜像。 !"Dockerhub Pull Badge"

使用方法

yaml
resource_types:
- name: helm
  type: docker-image
  source:
    repository: typositoire/concourse-helm3-resource

源配置

• cluster_url: 可选。Kubernetes主API服务的URL。使用kubeconfig_path参数时不设置，否则为必填项。
• cluster_ca: 可选。集群CA证书PEM，可选Base64编码。（当insecure_cluster为false时必填）
• insecure_cluster: 可选。跳过集群API的TLS验证。（当cluster_ca为nil时必填）
• token: 可选。Kubernetes的Bearer令牌。如果cluster_url为https，此参数、token_path或admin_key/admin_cert为必填项。
• token_path: 可选。包含Kubernetes Bearer令牌的文件路径。如果cluster_url为https，此参数、token或admin_key/admin_cert为必填项。
• admin_key: 可选。Base64编码的PEM。如果cluster_url为https且未提供token或token_path，则为必填项。
• admin_cert: 可选。Base64编码的PEM。如果cluster_url为https且未提供token或token_path，则为必填项。
• release: 可选。发布名称（字符串，非文件）。（默认：由Helm自动生成）
• namespace: 可选。Chart将安装到的Kubernetes命名空间。（默认：default）
• helm_history_max: 可选。限制最大修订版本数。（默认：0 = 无限制）
• repos: 可选。要初始化的Helm仓库数组，每个仓库定义为包含name、url（必填）、username和password（可选）属性的对象。
• plugins: 可选。要安装的Helm插件数组，每个定义为包含url（必填）、version（可选）属性的对象。
• stable_repo: 可选。值为false时禁用默认Helm稳定仓库。其他值将覆盖默认Helm稳定仓库URL <[***]>。在无互联网访问环境部署Helm时有用。
• tracing_enabled: 可选。为此资源启用极度详细的跟踪。在开发资源本身时有用。可能会显示敏感信息。（默认：false）
• helm_setup_purge_all: 可选。删除并清除所有Helm发布。使用时需极度谨慎。（默认：false）

Google Cloud的源选项

• gcloud_cluster_auth: 可选。设为true以使用gcloud服务账号文件进行Kubernetes集群认证。
• gcloud_service_account_key_file: 可选。当gcloud_cluster_auth设为true时必填。传入gcloud服务账号json内容或包含service_account json的文件路径。
• gcloud_project_name: 可选。当gcloud_cluster_auth设为true时必填。传入集群所在的gcloud项目名称。
• gcloud_k8s_cluster_name: 可选。当gcloud_cluster_auth设为true时必填。传入gcloud集群名称。
• gcloud_k8s_zone: 可选。当gcloud_cluster_auth设为true时必填。传入gcloud Kubernetes集群区域。

DigitalOcean的源选项

• digitalocean.cluster_id: 可选。DigitalOcean上用于获取kubeconfig的集群ID。
• digitalocean.access_token: 可选。用于获取kubeconfig的读访问令牌。

行为

check: 检查发布状态，不支持动态发布。

in: 不支持

out: 部署Helm Chart（仅V3）

部署Helm Chart

参数

• chart: 必填。包含要部署的Helm Chart的文件（以.tgz结尾）、包含Chart的本地目录路径或仓库中的Chart名称（例如stable/mysql）。
• namespace: 可选。包含命名空间名称的文件或命名空间名称。（默认：取自源配置）
• create_namespace: 可选。如果命名空间不存在则创建。（默认：false）
• release: 可选。包含发布名称的文件或发布名称。（默认：取自源配置）
• values: 可选。包含部署values.yaml的文件。支持使用数组设置多个值文件。
• override_values: 可选。可覆盖values.yaml中定义的值的数组。数组中的每个条目是包含key和value或path的映射。Value直接设置，path读取该路径文件的内容。hide: true参数确保值不被记录，而是替换为***HIDDEN***。type: string参数确保Helm始终将值视为字符串（使用Helm的--set-string选项；当值变化且可能看起来像数字时有用，例如Git提交哈希）。verbatim: true参数转义反斜杠，使值按原样传递给Helm Chart（对((credentials))有用）。--set中反斜杠的默认行为是引用下一个字符，因此val\ue被Helm视为value。
• token_path: 可选。包含Kubernetes Bearer令牌的文件路径。如果cluster_url为https，此参数、token或admin_key/admin_cert为必填项。
• version: 可选。要部署的Chart版本，可以是文件或值。仅当chart不是文件时适用。
• test: 可选。测试发布而不是安装。需要release。（默认：false）
• test_logs: 可选。运行test时显示pod日志。（默认：false）
• delete: 可选。删除发布而不是安装。需要release。（默认：false）
• replace: 可选。用相同名称替换已删除的发布。（默认：false）
• force: 可选。必要时通过删除/重新创建强制资源更新。（默认：false）
• devel: 可选。允许安装Chart的开发版本。在需要安装预发布Chart（即1.0.2-rc1）而无需指定版本时有用。（默认：false）
• debug: 可选。使用debug标志 dry run Helm安装，记录插值后的Chart模板。（默认：false）
• check_is_ready: 可选。要求wait设为默认值。应用--wait无超时。（默认：false）
• atomic: 可选。此标志将导致失败的安装清除发布，失败的升级回滚到上一版本。（默认：false）
• reuse_values: 可选。升级时，重用上次发布的值。（默认：false）
• reset_values: 可选。升级时，将值重置为Chart内置的值。（默认：false）
• timeout: 可选。此标志设置等待任何单个Kubernetes操作的最大时间。（默认：5m0s）
• wait: 可选。允许部署任务在继续下一个任务前休眠X秒。允许pod重启并变得稳定，在pod之间存在依赖关系时有用。（默认：0）
• kubeconfig_path: 可选。包含kubeconfig的文件。覆盖集群、令牌和管理员配置的源配置。
• show_diff: 可选。显示升级现有成功发布时应用的差异。设置devel时不使用。（默认：false）
• skip_missing_values: 可选。如果在values中指定但不存在的 values 文件将被跳过。（默认：false）

示例

Out

定义资源：

通用

yaml
resources:
- name: myapp-helm
  type: helm
  source:
    cluster_url: https://kube-master.domain.example
    cluster_ca: _base64编码的CA pem_
    admin_key: _base64编码的key pem_
    admin_cert: _base64编码的certificate pem_
    repos:
      - name: some_repo
        url: https://somerepo.github.io/charts

DigitalOcean

yaml
resources:
- name: myapp-helm
  type: helm
  source:
    digitalocean:
      cluster_id: XXXXXXXXXXXXXX
      access_token: XXXXXXXXXXX
    repos:
      - name: some_repo
        url: https://somerepo.github.io/charts

Google Cloud

yaml
resources:
- name: myapp-helm
  type: helm
  source:
    gcloud_cluster_auth: true
    gcloud_service_account_key_file: _纯文本服务账号json文件_ 或 _json文件路径
    gcloud_project_name: _项目名称_
    gcloud_k8s_cluster_name: _k8s集群名称_
    gcloud_k8s_zone: _k8s区域_
    repos:
      - name: some_repo
        url: https://somerepo.github.io/charts

添加到任务：

yaml
jobs:
  # ...
  plan:
  - put: myapp-helm
    params:
      chart: source-repo/chart-0.0.1.tgz
      values: source-repo/values.yaml
      override_values:
      - key: replicas
        value: 2
      - key: version
        path: version/number # 从version/number读取值
      - key: secret
        value: ((my-top-secret-value)) # 从Vault等凭证后端获取
        hide: true # 在输出中隐藏值
      - key: image.tag
        path: version/image_tag # 从version/number读取值
        type: string            # 确保Helm将其解释为字符串（非数字）