配置存储组件说明

• 1: Azure 应用配置
• 2: PostgreSQL
• 3: Redis

1 - Azure 应用配置

组件格式

要设置 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]

规格元数据字段

注意：必须指定 host 或 connectionString。

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

通过连接字符串访问应用配置实例，该字符串可在 Azure 门户中获取。由于连接字符串包含敏感信息，建议将其视为 secret 并使用 secret 存储。

使用 Microsoft Entra ID 进行身份验证

Azure 应用配置组件还支持使用 Microsoft Entra ID 进行身份验证。在启用此组件之前：

• 阅读Azure 身份验证文档。
• 创建一个 Microsoft Entra ID 应用程序（也称为服务主体）。
• 或者，为您的应用程序平台创建托管身份。

设置 Azure 应用配置

您需要一个 Azure 订阅来设置 Azure 应用配置。

1. 启动 Azure 应用配置创建流程。如有必要，请登录。

2. 点击 创建 以启动 Azure 应用配置实例的部署。

3. 创建实例后，获取 端点 或 连接字符串：

   • 对于端点：导航到资源的 概览 并复制 端点。
   • 对于连接字符串：导航到 设置 > 访问密钥 并复制连接字符串。

4. 将端点或连接字符串添加到 Dapr 的 azappconfig.yaml 文件中。

   将 host 键设置为 [Endpoint] 或将 connectionString 键设置为您之前保存的值。

   注意

   在生产环境中，请遵循秘密管理说明以安全管理您的 secret。

Azure 应用配置请求元数据

在 Azure 应用配置中，您可以为同一键定义不同标签的值。例如，您可以为开发和生产环境定义不同的值。您可以指定在连接到应用配置时要加载的标签。

Azure 应用配置组件支持以下可选的 label 元数据属性：

label：要检索的配置的标签。如果不存在，配置存储将返回指定键和空标签的配置。

标签可以通过请求 URL 中的查询参数指定：

GET curl http://localhost:<daprPort>/v1.0/configuration/<store-name>?key=<key name>&metadata.label=<label value>

相关链接

• Dapr 组件的基本架构
• 配置构建块

2 - PostgreSQL

组件格式

要配置 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"

规格元数据字段

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

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

使用 Microsoft Entra ID 进行身份验证

使用 Microsoft Entra ID 进行身份验证支持 Azure Database for PostgreSQL。Dapr 支持的所有身份验证方法都可以使用，包括客户端凭据（“服务主体”）和托管身份。

使用 AWS IAM 进行身份验证

使用 AWS IAM 进行身份验证支持所有版本的 PostgreSQL 类型组件。 连接字符串中指定的用户必须是数据库中已存在的用户，并且是授予 rds_iam 数据库角色的 AWS IAM 启用用户。 身份验证基于 AWS 身份验证配置文件，或提供的 AccessKey/SecretKey。 AWS 身份验证令牌将在其到期时间之前动态旋转。

其他元数据选项

设置 PostgreSQL 作为配置存储

1. 启动 PostgreSQL 数据库。

2. 连接到 PostgreSQL 数据库并设置具有以下模式的配置表：

   字段	数据类型	可为空	详情
   KEY	VARCHAR	N	持有配置属性的 "Key"
   VALUE	VARCHAR	N	持有配置属性的值
   VERSION	VARCHAR	N	持有配置属性的版本
   METADATA	JSON	Y	以 JSON 形式持有元数据

   CREATE TABLE IF NOT EXISTS table_name (
     KEY VARCHAR NOT NULL,
     VALUE VARCHAR NOT NULL,
     VERSION VARCHAR NOT NULL,
     METADATA JSON
   );
   

3. 在配置表上创建一个 TRIGGER。创建 TRIGGER 的示例函数如下：

   CREATE OR REPLACE FUNCTION notify_event() RETURNS TRIGGER AS $$
       DECLARE 
           data json;
           notification json;
   
       BEGIN
   
           IF (TG_OP = 'DELETE') THEN
               data = row_to_json(OLD);
           ELSE
               data = row_to_json(NEW);
           END IF;
   
           notification = json_build_object(
                             'table',TG_TABLE_NAME,
                             'action', TG_OP,
                             'data', data);
           PERFORM pg_notify('config',notification::text);
           RETURN NULL; 
       END;
   $$ LANGUAGE plpgsql;
   

4. 使用标记为 data 的字段封装数据创建触发器：

   notification = json_build_object(
     'table',TG_TABLE_NAME,
     'action', TG_OP,
     'data', data
   );
   

5. 在订阅配置通知时，应使用作为 pg_notify 属性提到的通道。

6. 由于这是一个通用创建的触发器，将此触发器映射到 configuration table。

   CREATE TRIGGER config
   AFTER INSERT OR UPDATE OR DELETE ON configtable
       FOR EACH ROW EXECUTE PROCEDURE notify_event();
   

7. 在订阅请求中添加一个额外的元数据字段，键为 pgNotifyChannel，值应设置为在 pg_notify 中提到的相同 channel name。从上面的示例中，它应设置为 config。

curl -l 'http://<host>:<dapr-http-port>/configuration/mypostgresql/subscribe?key=<keyname1>&key=<keyname2>&metadata.pgNotifyChannel=<channel name>'

相关链接

• Dapr 组件的基本模式
• 配置构建块

3 - Redis

组件格式

要设置 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>

规格元数据字段

设置 Redis

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

• Self-Hosted
• Kubernetes
• AWS
• Azure
• GCP

相关链接

• Dapr 组件的基本架构
• 阅读如何：从存储中管理配置以获取有关如何使用 Redis 作为配置存储的说明。
• 配置构建块