配置存储组件说明 on Dapr 文档库

Azure 应用配置

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要设置 Azure 应用配置，需创建一个类型为 configuration.azure.appconfig 的组件。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: configuration.azure.appconfig
 version: v1
 metadata:
 - name: host # 使用 Azure 身份验证时应使用此项。
 value: <HOST>
 - name: connectionString # 使用 Azure 身份验证时不应使用此项。
 value: <CONNECTIONSTRING>
 - name: maxRetries
 value: # 可选
 - name: retryDelay
 value: # 可选
 - name: maxRetryDelay
 value: # 可选
 - name: azureEnvironment # 可选，默认为 AZUREPUBLICCLOUD
 value: "AZUREPUBLICCLOUD"
 # 请参阅下方的身份验证部分以了解所有选项
 - name: azureTenantId # 可选
 value: "[your_service_principal_tenant_id]"
 - name: azureClientId # 可选
 value: "[your_service_principal_app_id]"
 - name: azureCertificateFile # 可选
 value : "[pfx_certificate_file_fully_qualified_local_path]"
 - name: subscribePollInterval # 可选
 value: #可选 [格式示例 - 24h]

警告

上述示例中，secret 以明文字符串形式使用。建议使用 secret 存储来存储 secret，详见此处。

规格元数据字段

字段	必需	详情	示例
connectionString	Y*	Azure 应用配置实例的连接字符串。无默认值。可以使用 `secretKeyRef` 引用 secret。与 host 字段互斥。在使用 Azure 身份验证时不使用	`Endpoint=https://foo.azconfig.io;Id=osOX-l9-s0:sig;Secret=00000000000000000000000000000000000000000000`
host	N*	Azure 应用配置实例的端点。无默认值。与 connectionString 字段互斥。在使用 Azure 身份验证时使用	`https://dapr.azconfig.io`
maxRetries	N	最大重试次数，默认为 `3`	`5`, `10`
retryDelay	N	初始重试延迟时间，默认为 `4` 秒；`"-1"` 禁用重试延迟。延迟会随着每次重试呈指数增长，直到达到 maxRetryDelay 指定的最大值。	`4s`
maxRetryDelay	N	允许的最大重试延迟时间，通常大于或等于 retryDelay。默认为 `120` 秒；`"-1"` 禁用限制	`120s`
subscribePollInterval	N	轮询订阅键以检测更改的间隔时间（以纳秒为单位）。未来将更新为 Go 时间格式。默认间隔为 `24` 小时。	`24h`

注意：必须指定 host 或 connectionString。

PostgreSQL

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要配置 PostgreSQL 作为配置存储，您需要创建一个类型为 configuration.postgresql 的组件。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: configuration.postgresql
 version: v1
 metadata:
 # 连接字符串
 - name: connectionString
 value: "host=localhost user=postgres password=example port=5432 connect_timeout=10 database=config"
 # 存储配置信息的表名
 - name: table
 value: "[your_configuration_table_name]" 
 # 数据库操作的超时时间，以秒为单位（可选）
 #- name: timeoutInSeconds
 # value: 20
 # 存储状态的表名（可选）
 #- name: tableName
 # value: "state"
 # 存储 Dapr 使用的元数据的表名（可选）
 #- name: metadataTableName
 # value: "dapr_metadata"
 # 清理过期行的间隔时间，以秒为单位（可选）
 #- name: cleanupIntervalInSeconds
 # value: 3600
 # 该组件池化的最大连接数（可选）
 #- name: maxConns
 # value: 0
 # 连接关闭前的最大空闲时间（可选）
 #- name: connectionMaxIdleTime
 # value: 0
 # 控制查询执行的默认模式。（可选）
 #- name: queryExecMode
 # value: ""
 # 如果希望使用 PostgreSQL 作为 actor 的状态存储，请取消注释此项（可选）
 #- name: actorStateStore
 # value: "true"

警告

上述示例中使用了明文字符串来存储 secret。建议使用 secret 存储来保护这些信息，具体方法请参阅这里。

规格元数据字段

使用连接字符串进行身份验证

以下元数据选项是通过 PostgreSQL 连接字符串进行身份验证时必需的。

Redis

Mon, 01 Jan 0001 00:00:00 +0000

组件格式

要设置 Redis 配置存储，请创建一个类型为 configuration.redis 的组件。请参阅本指南了解如何创建和应用配置存储配置。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: configuration.redis
 version: v1
 metadata:
 - name: redisHost
 value: <address>:6379
 - name: redisPassword
 value: **************
 - name: useEntraID
 value: "true"
 - name: enableTLS
 value: <bool>

警告

上述示例使用明文字符串作为秘密。建议使用秘密存储来存储秘密，如此处所述。

规格元数据字段

字段	必需	说明	示例
redisHost	Y	Redis 主机地址	`"localhost:6379"`
redisPassword	N	Redis 密码	`"password"`
redisUsername	N	Redis 主机的用户名。默认为空。确保您的 Redis 服务器版本为 6 或更高，并已正确创建 acl 规则。	`"username"`
enableTLS	N	如果 Redis 实例支持带有公共证书的 TLS，则可以配置启用或禁用 TLS。默认为 `"false"`	`"true"`, `"false"`
clientCert	N	客户端证书的内容，用于需要客户端证书的 Redis 实例。必须与 `clientKey` 一起使用，并且 `enableTLS` 必须设置为 true。建议使用秘密存储，如此处所述	`"----BEGIN CERTIFICATE-----\nMIIC..."`
clientKey	N	客户端私钥的内容，与 `clientCert` 一起用于身份验证。建议使用秘密存储，如此处所述	`"----BEGIN PRIVATE KEY-----\nMIIE..."`
failover	N	启用故障转移配置的属性。需要设置 sentinelMasterName。默认为 `"false"`	`"true"`, `"false"`
sentinelMasterName	N	Sentinel 主名称。请参阅 Redis Sentinel 文档	`""`, `"127.0.0.1:6379"`
redisType	N	Redis 的类型。有两个有效值，一个是 `"node"` 表示单节点模式，另一个是 `"cluster"` 表示 Redis 集群模式。默认为 `"node"`。	`"cluster"`
redisDB	N	连接到 Redis 后选择的数据库。如果 `"redisType"` 是 `"cluster"`，则忽略此选项。默认为 `"0"`。	`"0"`
redisMaxRetries	N	在放弃之前重试命令的最大次数。默认情况下不重试失败的命令。	`"5"`
redisMinRetryInterval	N	每次重试之间 Redis 命令的最小回退。默认为 `"8ms"`; `"-1"` 禁用回退。	`"8ms"`
redisMaxRetryInterval	N	每次重试之间 Redis 命令的最大回退。默认为 `"512ms"`;`"-1"` 禁用回退。	`"5s"`
dialTimeout	N	建立新连接的拨号超时。默认为 `"5s"`。	`"5s"`
readTimeout	N	套接字读取的超时。如果达到，Redis 命令将因超时而失败而不是阻塞。默认为 `"3s"`，`"-1"` 表示无超时。	`"3s"`
writeTimeout	N	套接字写入的超时。如果达到，Redis 命令将因超时而失败而不是阻塞。默认为 readTimeout。	`"3s"`
poolSize	N	最大套接字连接数。默认情况下，每个 CPU 的连接数为 10 个，由 runtime.NumCPU 报告。	`"20"`
poolTimeout	N	如果所有连接都忙，客户端在返回错误之前等待连接的时间。默认值为 readTimeout + 1 秒。	`"5s"`
maxConnAge	N	客户端退役（关闭）连接的连接年龄。默认情况下不关闭老化连接。	`"30m"`
minIdleConns	N	保持打开的最小空闲连接数，以避免与创建新连接相关的性能下降。默认为 `"0"`。	`"2"`
idleCheckFrequency	N	空闲连接清理器进行空闲检查的频率。默认为 `"1m"`。`"-1"` 禁用空闲连接清理器。	`"-1"`
idleTimeout	N	客户端关闭空闲连接的时间。应小于服务器的超时。默认为 `"5m"`。`"-1"` 禁用空闲超时检查。	`"10m"`

设置 Redis

Dapr 可以使用任何 Redis 实例：无论是容器化的、在本地开发机器上运行的，还是托管的云服务。