clapclapexcitement/concourse-consul-kv-resource

concourse-consul-kv-resource

这是一个Concourse资源镜像，用于与Consul的KV存储进行交互。concourse-consul-kv-resource可用于获取或设置Consul KV存储中的键值对。

镜像概述

该镜像作为Concourse的自定义资源类型，允许用户在Concourse流水线中集成Consul KV存储的操作，实现键值数据的读取和写入，适用于需要动态管理配置或状态信息的场景。

核心功能

• 获取键值：读取Consul KV存储中指定键的值，并写入文件。
• 设置键值：将指定值或文件内容设置为Consul KV存储中指定键的值。

使用场景

• 在Concourse流水线中获取Consul中的配置信息，用于后续任务。
• 在流水线执行过程中更新Consul中的状态或配置数据。

配置说明

源配置（Source configuration）

• host：必填。Consul主机地址。
• key：必填。要交互的Consul键。注意需包含/v1/kv后的所有路径部分，例如键为my-consul:8500/v1/kv/my/key时，key应填写"my/key"。
• token：可选。Consul ACL令牌。
• tls_cert：可选。Consul的TLS证书。
• tls_key：可选。Consul的TLS证书密钥。
• ca：可选。Consul的CA证书。
• port：可选。Consul API的端口，默认值为8500。
• protocol：可选。调用Consul API的协议，默认值为https。
• skip_cert_check：可选。是否跳过SSL证书有效性检查。

行为（Behavior）

in：获取Consul KV键的值

获取源配置中指定Consul KV键的值，并将其明文写入<resource-get>/<key-name>文件。

示例流水线中，get-my-consul-key任务会将指定键的值写入对应文件：

yaml
...
resources:
- name: my-consul-key
  type: consul-kv
  source:
    token: my-acl-token
    host: my-consul.com
    tls_cert: my-cert-string
    tls_key: my-cert-key-string
    key: my/key

jobs:
- name: get-my-consul-key
  plan:
  - get: my-consul-key

out：设置Consul KV键的值

将源配置中指定的Consul KV键设置为参数中指定的值。

参数

必须设置value或file，两者不能同时设置。

• value：可选。要设置的键值。
• file：可选。包含目标值的文件路径。

示例流水线

yaml
resources:
- name: my-consul-key
  type: consul-kv
  source:
    token: my-acl-token
    host: my-consul.com
    tls_cert: my-cert-string
    tls_key: my-cert-key-string
    key: my/key

resource_types:
- name: consul-kv
  type: docker-image
  source:
    repository: clapclapexcitement/concourse-consul-kv-resource
    tag: latest

jobs:
- name: get-my-consul-key
  plan:
  - get: my-consul-key

- name: set-my-consul-key
  plan:
  - put: my-consul-key
    params:
      value: 'foobar'

- name: set-my-consul-key-from-a-file
  plan:
  - put: my-consul-key
    params:
      file: my-new-key/my-key-file