管理 Dapr 中的组件 on Dapr 文档库

认证流程

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

注意

认证流程仅适用于内置组件，不适用于可插拔组件。

概述

Dapr 采用模块化设计，功能以组件形式提供。每个组件都有一个接口定义，所有组件都是可互换的，因此理想情况下，您可以用具有相同接口的另一个组件替换一个组件。每个用于生产的组件都需要满足一定的技术要求，以确保功能兼容性和稳健性。

一般来说，一个组件需要：

符合定义的 Dapr 接口
功能正确且稳健
有良好的文档和维护

为了确保组件符合 Dapr 设定的标准，会在 Dapr 维护者管理的环境中对组件进行一系列测试。一旦测试持续通过，就可以确定组件的成熟度级别。

认证级别

级别如下：

Alpha

组件实现了所需的接口，并按规范描述工作
组件有文档
组件可能存在漏洞，或在集成时暴露出漏洞
组件可能无法通过所有一致性测试
组件可能没有一致性测试
由于后续版本中可能出现不兼容的更改，仅推荐用于非关键业务用途

所有组件都从 Alpha 阶段开始。

Beta

组件必须通过所有定义的组件一致性测试以满足组件规范
组件一致性测试已在 Dapr 维护者管理的环境中运行
组件包含由 Dapr 维护者审核和批准的特定 components-contrib 版本的一致性测试结果记录
由于后续版本中可能出现不兼容的更改，仅推荐用于非关键业务用途

注意

如果满足以下条件，组件可以跳过 Beta 阶段和一致性测试要求，由维护者决定：

组件是一个绑定
认证测试是全面的

Stable

组件必须有组件认证测试以验证功能和弹性
组件由 Dapr 维护者维护并由社区支持
组件有良好的文档和测试
组件在之前至少一个 Dapr 运行时的小版本发布中以 Alpha 或 Beta 形式存在
维护者将根据 Dapr 支持政策解决组件安全性、核心功能和测试问题，并发布包含修补的稳定组件的补丁版本

注意

稳定的 Dapr 组件基于 Dapr 认证和一致性测试，并不保证由任何特定供应商支持，其中供应商的 SDK 作为组件的一部分使用。

更新组件

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

在更新应用程序使用的现有已部署组件时，除非启用了 HotReload 功能门控，否则 Dapr 不会自动更新组件。需要重启 Dapr sidecar 才能获取组件的最新版本。具体操作方式取决于托管环境。

Kubernetes

在 Kubernetes 中运行时，更新组件的过程包括以下两个步骤：

将新的组件 YAML 应用到所需的命名空间。
除非启用了 HotReload 功能门控，否则需要对部署执行滚动重启操作以获取最新组件。

自托管

除非启用了 HotReload 功能门控，更新组件的过程包括停止和重启 daprd 进程以获取最新组件的单个步骤。

热重载（预览功能）

此功能目前处于预览状态。热重载通过 HotReload 功能门控启用。

Dapr 可以实现“热重载”组件，从而在不需要重启 Dapr sidecar 进程或 Kubernetes pod 的情况下自动获取组件更新。这意味着创建、更新或删除组件清单将在运行时反映在 Dapr sidecar 中。

更新组件

当组件更新时，它首先被关闭，然后使用新配置重新初始化。这会导致组件在此过程中短时间内不可用。

初始化错误

如果通过热重载创建或更新组件时初始化过程出错，Dapr sidecar 会遵循组件字段 spec.ignoreErrors 的设置。也就是说，行为与 sidecar 在启动时加载组件时相同。

spec.ignoreErrors=false (默认): sidecar 优雅地关闭。
spec.ignoreErrors=true: sidecar 继续运行，既没有注册旧的也没有注册新的组件配置。

除以下类型外，所有组件均支持热重载。这些组件类型的任何创建、更新或删除都将被 sidecar 忽略，需要重启以获取更改。

进一步阅读

操作指南：将组件限定于一个或多个应用程序

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

Dapr组件具有命名空间（这与Kubernetes的命名空间概念不同），这意味着一个Dapr运行时实例只能访问部署在相同命名空间中的组件。

Dapr运行时，会将其配置的命名空间与加载的组件的命名空间进行匹配，并仅初始化与其命名空间匹配的组件。其他命名空间中的组件将不会被加载。

命名空间

命名空间可以用来限制组件对特定Dapr实例的访问。

在自托管模式下，开发者可以通过设置NAMESPACE环境变量来为Dapr实例指定命名空间。如果设置了NAMESPACE环境变量，Dapr将不会加载任何在其元数据中未指定相同命名空间的组件。

例如，假设在production命名空间中有以下组件：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: statestore
 namespace: production
spec:
 type: state.redis
 version: v1
 metadata:
 - name: redisHost
 value: redis-master:6379

要告诉Dapr它被部署到哪个命名空间，设置环境变量：

MacOS/Linux:

export NAMESPACE=production
# 像往常一样运行Dapr

Windows:

setx NAMESPACE "production"
# 像往常一样运行Dapr

让我们考虑以下在Kubernetes中的组件：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: statestore
 namespace: production
spec:
 type: state.redis
 version: v1
 metadata:
 - name: redisHost
 value: redis-master:6379

在这个例子中，Redis组件仅对运行在production命名空间内的Dapr实例可访问。

操作指南：在组件中引用secret

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

概述

在组件定义的spec.metadata部分中，可以引用secret。

要引用secret，你需要设置auth.secretStore字段来指定保存secret的secret存储的名称。

在Kubernetes中运行时，如果auth.secretStore为空，则默认使用Kubernetes secret存储。

支持的secret存储

访问此链接查看Dapr支持的所有secret存储，以及如何配置和使用它们的信息。

引用secret

虽然你可以选择使用纯文本secret（如MyPassword），如下面yaml中redisPassword的value所示，但这不建议用于生产环境：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: statestore
spec:
 type: state.redis
 version: v1
 metadata:
 - name: redisHost
 value: localhost:6379
 - name: redisPassword
 value: MyPassword

相反，建议在你的secret存储中创建secret并在组件定义中引用它。下面展示了两种情况——“secret包含嵌入的key”和“secret是一个字符串”。

“secret包含嵌入的key”适用于secret中嵌入了一个key的情况，即secret不是一个完整的连接字符串。这在以下组件定义yaml中展示。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: statestore
spec:
 type: state.redis
 version: v1
 metadata:
 - name: redisHost
 value: localhost:6379
 - name: redisPassword
 secretKeyRef:
 name: redis-secret
 key: redis-password
auth:
 secretStore: <SECRET_STORE_NAME>

SECRET_STORE_NAME是配置的secret存储组件的名称。在Kubernetes中运行并使用Kubernetes secret存储时，字段auth.SecretStore默认为kubernetes，可以留空。

状态存储组件

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

Dapr 集成现有数据库，为应用提供 CRUD 操作、事务等状态管理功能。它还支持为每个应用配置多个独立的状态存储组件。

状态存储具有可扩展性，可以在 components-contrib 仓库中找到。

在 Dapr 中，状态存储通过 Component 文件进行描述：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: statestore
spec:
 type: state.<DATABASE>
 version: v1
 metadata:
 - name: <KEY>
 value: <VALUE>
 - name: <KEY>
 value: <VALUE>
...

数据库的类型由 type 字段决定，连接字符串和其他元数据信息放在 .metadata 部分。即使元数据值可以包含明文的密钥，仍建议使用密钥存储。

请参考本指南了解如何配置状态存储组件。

支持的状态存储

请访问此参考查看 Dapr 中支持的所有状态存储。

Secret 存储组件

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

Dapr 集成了 Secret 存储，为应用程序和其他组件提供安全的 Secret 存储和访问，例如访问密钥和密码。每个 Secret 存储组件都有一个名称，用于访问 Secret 时使用。

与其他构建块组件类似，Secret 存储组件是可扩展的，相关代码可以在 components-contrib 仓库中找到。

在 Dapr 中，Secret 存储通过一个 Component 文件进行描述，包含以下字段：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: secretstore
spec:
 type: secretstores.<NAME>
 version: v1
 metadata:
 - name: <KEY>
 value: <VALUE>
 - name: <KEY>
 value: <VALUE>
...

Secret 存储的类型由 type 字段指定，连接字符串和其他元数据信息放在 .metadata 部分。

不同的支持的 Secret 存储会有不同的特定字段需要配置。例如，配置使用 AWS Secrets Manager 的 Secret 存储时，文件格式如下：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: awssecretmanager
spec:
 type: secretstores.aws.secretmanager
 version: v1
 metadata:
 - name: region
 value: "[aws_region]"
 - name: accessKey
 value: "[aws_access_key]"
 - name: secretKey
 value: "[aws_secret_key]"
 - name: sessionToken
 value: "[aws_session_token]"

重要

在 EKS (AWS Kubernetes) 上运行 Dapr sidecar (daprd) 时，如果节点/Pod 已附加了允许访问 AWS 资源的 IAM 策略，则不应在组件配置中提供 AWS access-key、secret-key 和 tokens。

应用配置

创建组件的 YAML 文件后，请根据您的托管环境按照以下说明应用它：

Bindings 组件

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

Dapr 可以与外部资源集成，使应用程序既能被外部事件触发，也能与资源进行交互。每个 bindings 组件都有一个名称，用于与资源进行交互时使用。

与其他构建块组件一样，bindings 组件是可扩展的，相关代码可以在 components-contrib 仓库中找到。

在 Dapr 中，bindings 使用一个 Component 文件描述，包含以下字段：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
 namespace: <NAMESPACE>
spec:
 type: bindings.<NAME>
 version: v1
 metadata:
 - name: <KEY>
 value: <VALUE>
 - name: <KEY>
 value: <VALUE>
...

bindings 的类型由 type 字段指定，连接字符串和其他元数据则在 .metadata 部分定义。

不同的支持的 bindings会有不同的特定字段需要配置。例如，当为 Azure Blob Storage 配置 bindings 时，文件看起来像这样：

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: <NAME>
spec:
 type: bindings.azure.blobstorage
 version: v1
 metadata:
 - name: storageAccount
 value: myStorageAccountName
 - name: storageAccessKey
 value: ***********
 - name: container
 value: container1
 - name: decodeBase64
 value: <bool>
 - name: getBlobRetryCount
 value: <integer>

应用配置

一旦创建了组件的 YAML 文件，请根据您的托管环境按照以下步骤进行配置：

如何：注册一个可插拔组件

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

组件注册过程

使用 gRPC 的可插拔组件通常作为容器或进程运行，需要通过Unix 域套接字（简称 UDS）与 Dapr 运行时通信。它们会通过以下步骤自动被发现并注册到运行时中：

组件监听放置在共享卷上的Unix 域套接字。
Dapr 运行时列出共享卷中的所有Unix 域套接字。
Dapr 运行时连接每个套接字，并使用 gRPC 反射从组件实现的给定构建块 API 中发现所有 proto 服务。

一个组件可以同时实现多个组件接口。

虽然 Dapr 的内置组件已经集成在运行时中，但可插拔组件在与 Dapr 一起使用之前需要进行一些设置步骤。

可插拔组件需要在 Dapr 本身启动之前启动并准备好接收请求。
用于可插拔组件通信的Unix 域套接字文件需要对 Dapr 和可插拔组件都可访问。

在独立模式下，可插拔组件可以作为进程或容器运行。在 Kubernetes 上，可插拔组件作为容器运行，并由 Dapr 的 sidecar 注入器自动注入到应用程序的 pod 中，允许通过标准的Kubernetes 容器规范进行自定义。

这也改变了在 Dapr 和可插拔组件之间共享Unix 域套接字文件的方法。

注意

作为前提条件，操作系统必须支持 Unix 域套接字，任何 UNIX 或类 UNIX 系统（Mac、Linux 或用于本地开发的 WSL 对于 Windows 用户）都应该足够。

选择您的环境以开始使您的组件可被发现。

运行组件

在 Dapr 启动之前，您的组件和 Unix 套接字必须正在运行。

配置中间件组件

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

Dapr 允许通过串联一系列中间件组件来定义自定义处理管道。您可以在以下两种场景中使用中间件管道：

基础模块 API - 在调用任何 Dapr HTTP API 时执行 HTTP 中间件组件。
服务间调用 - HTTP 中间件组件应用于服务间调用。

配置 API 中间件管道

启动时，Dapr sidecar 会为传入的 HTTP 调用构建一个中间件处理管道。默认情况下，管道由追踪和 CORS 中间件组成。可以通过 Dapr configuration 配置的其他中间件按定义顺序添加到管道中。该管道适用于所有 Dapr API 端点，包括 state、pubsub、service-invocation、bindings、secret、configuration、分布式锁等。

请求在路由到用户代码之前会依次经过所有定义的中间件组件，然后在返回给客户端之前以相反的顺序再次经过这些中间件，如下图所示。

在使用 httpPipeline 配置调用 Dapr HTTP API 时，HTTP 中间件组件会被执行。

以下配置示例定义了一个自定义管道，使用了 OAuth 2.0 中间件和大写中间件组件。在这种情况下，所有请求在转发到用户代码之前都通过 OAuth 2.0 协议进行授权，并转换为大写文本。

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
 name: pipeline
 namespace: default
spec:
 httpPipeline:
 handlers:
 - name: oauth2
 type: middleware.http.oauth2
 - name: uppercase
 type: middleware.http.uppercase

与其他组件一样，中间件组件可以在支持的中间件参考和dapr/components-contrib 仓库中找到。

管理 Dapr 中的组件 on Dapr 文档库

认证流程

注意

概述

认证级别

Alpha

Beta

注意

Stable

注意

更新组件

Kubernetes

自托管

热重载（预览功能）

更新组件

初始化错误

进一步阅读

操作指南：将组件限定于一个或多个应用程序

命名空间

操作指南：在组件中引用secret

概述

支持的secret存储

引用secret

状态存储组件

支持的状态存储

相关主题

Secret 存储组件

重要

应用配置

Bindings 组件

应用配置

如何：注册一个可插拔组件

组件注册过程

注意

运行组件

配置中间件组件

配置 API 中间件管道