cadence config

关于 Cadence 配置的中文详解：

Cadence（由Uber开源的分布式工作流编排引擎）的配置主要围绕其核心组件（如 Cadence Server、Cadence CLI、Cadence Web UI）进行。配置通常涉及 YAML 文件或环境变量。

主要配置文件与关键配置项

1. 服务端配置文件 (`cadence-server/config/<env>/config.yaml`)

控制 Cadence 服务（History、Matching、Frontend、Worker等）的行为。
核心配置区：
- persistence: 数据存储配置
  - defaultStore: 默认存储名称（如：cassandra）。
  - visibilityStore: 可见性存储名称（如：es）。
  - 数据库类型（如 cassandra, mysql, postgres）及其连接信息（主机、端口、Keyspace/Database、用户、密码）。
- clusterMetadata: 集群元数据
  - enableGlobalDomain: 是否启用全局域（多集群）。
  - failoverVersionIncrement: 故障转移版本增量。
  - masterClusterName: 主集群名称。
  - currentClusterName: 当前集群名称。
- kafka: Kafka 配置 (用于跨集群复制、Archival)
  - brokers: Kafka Broker 列表。
  - topics: 主题配置（如 domainReplication, archival）。
- archival: 归档配置
  - enable: 是否启用归档。
  - provider: 归档存储类型（如 s3, gcloud, file）。
  - s3/store: 对应存储的详细配置（Bucket、Region、凭证等）。
- domainConfig: 域的默认配置
  - retentionDays: 默认工作流历史保留天数。
- log: 日志配置
  - level: 日志级别（debug, info, warn, error）。
  - output: 输出位置（file, stderr）。
- tls: TLS (SSL) 配置
  - 服务端和客户端证书、密钥文件路径。
- publicClient: Web UI / CLI 连接配置
  - 指向 Cadence Frontend 服务的地址（hostPort）。
- dynamicConfigClient: 动态配置客户端 (Nexus)
  - 类型（如 filebased）及配置文件路径。

2. 动态配置文件 (`cadence-server/config/<env>/dynamicconfig.yaml`)

允许运行时动态修改某些配置参数而无需重启服务。
非常强大，可用于：
- 调整各种系统限制（Workflow/Activity 启动率、缓存大小、超时时间等）。
- 开启/关闭实验性功能。
- 根据域名、任务队列等进行细粒度控制。

格式示例：

    "history.numHistoryShards":
      - value: 1024
    "system.enableReadFromArchival": # 根据域名启用特性
      - value: true
        constraints:
          domainName: "special-domain"

3. CLI 配置文件 (`~/.cadence/config.yaml`)

配置 cadence 命令行工具的行为。

常用配置项：

    domain: default # 默认操作的域
    service: # 连接到哪个Cadence集群
        name: cadence-frontend # 服务名
        host: 127.0.0.1:7933    # Frontend地址
    tls: # CLI TLS配置（如果需要）
        enabled: false
        certFile: ""
        keyFile: ""
        caFile: ""

4. 环境变量

Cadence 支持通过环境变量覆盖配置文件中的值。
命名规则：通常是配置项的全大写并用 _ 分隔。例如：
- CADENCE_PERSISTENCE_DEFAULTCASSANDRA_HOST=localhost 覆盖 persistence.default.cassandra.hosts。
查看文档确认具体变量名。

配置步骤 (概述)

选择部署环境： 创建对应环境的目录（如 development, production）在 cadence-server/config/ 下。
编写 config.yaml：
- 设置 persistence：配置连接你的数据库（Cassandra/MySQL/PostgreSQL）和可见性存储（Elasticsearch/Kafka）。
- 设置 clusterMetadata：定义集群名称和基本拓扑。
- 按需配置：kafka（跨集群复制/归档）、archival（归档到S3等）、tls（安全）、log（日志）。
- 配置 publicClient.hostPort（供CLI/Web UI连接）。
(可选) 编写 dynamicconfig.yaml：
- 用于调整系统在运行时的行为参数。通常基于 config/dynamicconfig/legacy.yaml 模板修改。
启动服务： 使用 ./cadence-server --env development start（开发环境）启动服务，它会加载对应目录下的配置。
配置 CLI： 在 ~/.cadence/config.yaml 中设置要连接的 Cadence Frontend 地址和默认域。
(可选) 配置 Web UI： Web UI 通常通过环境变量或自身的配置文件指定要连接的 Cadence Frontend 地址（与 CLI 配置类似）。

配置示例片段 (`config.yaml`)

# cadence-server/config/development/config.yaml
persistence:
  defaultStore: cassandra
  visibilityStore: es
  datastores:
    cassandra:
      cassandra:
        hosts: "localhost"
        keyspace: "cadence"
    es:
      elasticsearch:
        url: "http://localhost:9200"
        indices:
          visibility: cadence_visibility_v1_dev

clusterMetadata:
  enableGlobalDomain: false
  failoverVersionIncrement: 10
  masterClusterName: "active"
  currentClusterName: "active"

kafka:
  brokers: "localhost:9092" # 如果不需要归档和跨集群，此部分非必须

publicClient:
  hostPort: "127.0.0.1:7933"

log:
  level: "info"

重要提示

查阅官方文档： 务必查阅你使用的 Cadence 版本的官方配置文档。不同版本的配置项可能有细微差别。
安全性：
- 永远不要在配置文件或版本控制中硬编码敏感信息（密码、密钥）。使用环境变量或安全的凭证管理系统来注入这些值。
- 生产环境强烈建议启用 tls 配置。
测试： 配置变更后，先在开发/测试环境充分验证再应用到生产环境。
动态配置： dynamicconfig.yaml 是进行高级调优和控制的关键工具，理解其用法非常重要。