From be3c1049a27726c536d89062b8240e4d08945b6c Mon Sep 17 00:00:00 2001 From: newbe36524 Date: Fri, 19 Apr 2024 02:00:14 +0000 Subject: [PATCH] New Crowdin translations --- src/translated_content/zh_CN/docs/_index.md | 32 ++-- .../docs/concepts/building-blocks-concept.md | 4 +- .../docs/concepts/dapr-services/placement.md | 12 +- .../zh_CN/docs/concepts/overview.md | 22 +-- .../zh_CN/docs/concepts/terminology.md | 12 +- .../zh_CN/docs/contributing/daprbot.md | 10 +- .../zh_CN/docs/contributing/presentations.md | 14 +- .../zh_CN/docs/contributing/roadmap.md | 2 +- .../actors/actors-timers-reminders.md | 8 +- .../actors/howto-actors-partitioning.md | 6 +- .../bindings/bindings-overview.md | 6 +- .../configuration-api-overview.md | 4 +- .../cryptography/cryptography-overview.md | 4 +- .../pubsub/howto-route-messages.md | 6 +- .../pubsub/subscription-methods.md | 4 +- .../secrets/secrets-overview.md | 6 +- .../service-invocation-overview.md | 8 +- .../state-management/howto-share-state.md | 10 +- .../state-management/howto-state-query-api.md | 20 +-- .../state-management-overview.md | 8 +- .../workflow/howto-manage-workflow.md | 12 +- .../workflow/workflow-overview.md | 30 ++-- .../debugging/bridge-to-kubernetes.md | 2 +- .../debug-k8s/debug-dapr-services.md | 2 +- .../pluggable-components/develop-pluggable.md | 4 +- .../pluggable-components-sdks/_index.md | 6 +- .../integrations/AWS/authenticating-aws.md | 6 +- .../Azure/azure-api-management.md | 2 +- .../authenticating-azure.md | 12 +- .../integrations/Azure/azure-functions.md | 2 +- .../azure-kubernetes-service-extension.md | 2 +- .../vscode-how-to-debug-multiple-dapr-apps.md | 46 +++--- .../multi-app-dapr-run/multi-app-template.md | 2 +- .../developing-applications/sdks/_index.md | 20 +-- .../getting-started/quickstarts/_index.md | 6 +- .../docs/getting-started/tutorials/_index.md | 8 +- .../operations/configuration/api-allowlist.md | 8 +- .../configuration/configuration-overview.md | 30 ++-- .../configuration/install-certificates.md | 2 +- .../configuration/invoke-allowlist.md | 28 ++-- .../operations/configuration/secret-scope.md | 8 +- .../hosting/kubernetes/kubernetes-overview.md | 6 +- .../kubernetes/kubernetes-production.md | 8 +- .../kubernetes/kubernetes-volume-mounts.md | 4 +- .../serverless/azure-container-apps/index.md | 4 +- .../observability/logging/newrelic.md | 4 +- .../observability/tracing/setup-tracing.md | 14 +- .../observability/tracing/zipkin.md | 2 +- .../perf-actors-activation.md | 10 +- .../perf-service-invocation.md | 8 +- .../resiliency/health-checks/app-health.md | 10 +- .../docs/operations/resiliency/policies.md | 28 ++-- .../zh_CN/docs/operations/security/oauth.md | 12 +- .../operations/support/alpha-beta-apis.md | 20 +-- .../breaking-changes-and-deprecations.md | 20 +-- .../support/support-preview-features.md | 20 +-- .../support/support-release-policy.md | 150 +++++++++--------- .../zh_CN/docs/reference/api/actors_api.md | 80 +++++----- .../zh_CN/docs/reference/api/bindings_api.md | 4 +- .../docs/reference/api/configuration_api.md | 28 ++-- .../docs/reference/api/cryptography_api.md | 16 +- .../reference/api/distributed_lock_api.md | 18 +-- .../zh_CN/docs/reference/api/error_codes.md | 60 +++---- .../zh_CN/docs/reference/api/metadata_api.md | 64 ++++---- .../zh_CN/docs/reference/api/placement_api.md | 18 +-- .../zh_CN/docs/reference/api/pubsub_api.md | 42 ++--- .../zh_CN/docs/reference/api/state_api.md | 60 +++---- .../zh_CN/docs/reference/api/workflow_api.md | 6 +- .../arguments-annotations-overview.md | 114 ++++++------- .../zh_CN/docs/reference/cli/dapr-annotate.md | 64 ++++---- .../docs/reference/cli/dapr-components.md | 16 +- .../docs/reference/cli/dapr-configurations.md | 16 +- .../docs/reference/cli/dapr-dashboard.md | 16 +- .../zh_CN/docs/reference/cli/dapr-init.md | 40 ++--- .../zh_CN/docs/reference/cli/dapr-list.md | 12 +- .../dapr-mtls/dapr-mtls-renew-certificate.md | 2 +- .../zh_CN/docs/reference/cli/dapr-run.md | 60 +++---- .../zh_CN/docs/reference/cli/dapr-stop.md | 8 +- .../docs/reference/cli/dapr-uninstall.md | 12 +- .../zh_CN/docs/reference/cli/dapr-upgrade.md | 10 +- .../zh_CN/docs/reference/cli/dapr-version.md | 6 +- .../supported-bindings/alicloudoss.md | 12 +- .../supported-bindings/alicloudsls.md | 10 +- .../supported-bindings/alicloudtablestore.md | 14 +- .../supported-bindings/apns.md | 10 +- .../supported-bindings/blobstorage.md | 16 +- .../supported-bindings/cloudflare-queues.md | 10 +- .../supported-bindings/cosmosdb.md | 12 +- .../supported-bindings/cron.md | 6 +- .../supported-bindings/eventgrid.md | 24 +-- .../supported-bindings/eventhubs.md | 34 ++-- .../supported-bindings/gcpbucket.md | 26 +-- .../supported-bindings/gcppubsub.md | 26 +-- .../supported-bindings/graghql.md | 6 +- .../supported-bindings/http.md | 24 +-- .../supported-bindings/kafka.md | 54 +++---- .../supported-bindings/kinesis.md | 18 +-- .../supported-bindings/kubemq.md | 16 +- .../supported-bindings/kubernetes-binding.md | 8 +- .../supported-bindings/mqtt3.md | 20 +-- .../supported-bindings/mysql.md | 4 +- .../supported-bindings/openai.md | 6 +- .../supported-bindings/postgresql.md | 24 +-- .../supported-bindings/rabbitmq.md | 34 ++-- .../supported-bindings/redis.md | 46 +++--- .../supported-bindings/s3.md | 22 +-- .../supported-bindings/sendgrid.md | 12 +- .../supported-bindings/servicebusqueues.md | 48 +++--- .../supported-bindings/ses.md | 12 +- .../supported-bindings/signalr.md | 10 +- .../supported-bindings/smtp.md | 24 +-- .../supported-bindings/storagequeues.md | 22 +-- .../supported-bindings/wasm.md | 4 +- .../supported-bindings/zeebe-command.md | 10 +- .../supported-bindings/zeebe-jobworker.md | 34 ++-- .../azure-appconfig-configuration-store.md | 14 +- .../postgresql-configuration-store.md | 26 +-- .../redis-configuration-store.md | 42 ++--- .../supported-cryptography/azure-key-vault.md | 6 +- .../json-web-key-sets.md | 10 +- .../supported-cryptography/local-storage.md | 4 +- .../supported-locks/redis-lock.md | 48 +++--- .../supported-middleware/middleware-bearer.md | 6 +- .../middleware-oauth2clientcredentials.md | 10 +- .../supported-middleware/middleware-opa.md | 8 +- .../middleware-rate-limit.md | 4 +- .../middleware-routeralias.md | 4 +- .../supported-middleware/middleware-wasm.md | 6 +- .../nr-kubernetes.md | 8 +- .../supported-name-resolution/nr-sqlite.md | 20 +-- .../setup-nr-consul.md | 18 +-- .../supported-pubsub/setup-apache-kafka.md | 68 ++++---- .../supported-pubsub/setup-aws-snssqs.md | 38 ++--- .../supported-pubsub/setup-azure-eventhubs.md | 28 ++-- .../setup-azure-servicebus-queues.md | 24 +-- .../setup-azure-servicebus-topics.md | 38 ++--- .../supported-pubsub/setup-gcp-pubsub.md | 40 ++--- .../supported-pubsub/setup-jetstream.md | 18 +-- .../supported-pubsub/setup-kubemq.md | 16 +- .../supported-pubsub/setup-mqtt.md | 22 +-- .../supported-pubsub/setup-mqtt3.md | 20 +-- .../supported-pubsub/setup-pulsar.md | 62 ++++---- .../supported-pubsub/setup-rabbitmq.md | 54 +++---- .../supported-pubsub/setup-redis-pubsub.md | 50 +++--- .../supported-pubsub/setup-rocketmq.md | 62 ++++---- .../supported-pubsub/setup-solace-amqp.md | 18 +-- .../alicloud-oos-parameter-store.md | 8 +- .../aws-parameter-store.md | 14 +- .../aws-secret-manager.md | 6 +- .../supported-secret-stores/azure-keyvault.md | 12 +- .../envvar-secret-store.md | 4 +- .../file-secret-store.md | 14 +- .../gcp-secret-manager.md | 26 +-- .../hashicorp-vault.md | 34 ++-- .../huaweicloud-csms.md | 6 +- .../kubernetes-secret-store.md | 4 +- .../setup-azure-blobstorage.md | 24 +-- .../setup-azure-cosmosdb.md | 14 +- .../setup-azure-tablestorage.md | 14 +- .../supported-state-stores/setup-cassandra.md | 22 +-- .../setup-cloudflare-workerskv.md | 12 +- .../setup-cockroachdb.md | 18 +-- .../supported-state-stores/setup-consul.md | 8 +- .../supported-state-stores/setup-dynamodb.md | 20 +-- .../supported-state-stores/setup-etcd.md | 16 +- .../supported-state-stores/setup-firestore.md | 28 ++-- .../supported-state-stores/setup-memcached.md | 6 +- .../supported-state-stores/setup-mongodb.md | 6 +- .../supported-state-stores/setup-mysql.md | 18 +-- .../setup-oci-objectstorage.md | 40 ++--- .../setup-oracledatabase.md | 12 +- .../setup-postgresql-v1.md | 32 ++-- .../setup-postgresql-v2.md | 32 ++-- .../supported-state-stores/setup-redis.md | 38 ++--- .../supported-state-stores/setup-rethinkdb.md | 14 +- .../supported-state-stores/setup-sqlite.md | 18 +-- .../supported-state-stores/setup-sqlserver.md | 28 ++-- .../supported-state-stores/setup-zookeeper.md | 8 +- .../docs/reference/environment/_index.md | 44 ++--- .../resource-specs/component-schema.md | 42 ++--- .../resource-specs/configuration-schema.md | 30 ++-- .../resource-specs/resiliency-schema.md | 6 +- .../resource-specs/subscription-schema.md | 16 +- .../zh_CN/sdks_dotnet/_index.md | 14 +- .../dotnet-actors/dotnet-actors-client.md | 6 +- .../dotnet-actors-serialization.md | 2 +- .../zh_CN/sdks_dotnet/dotnet-client/_index.md | 2 +- .../dotnet-troubleshooting-pubsub.md | 8 +- .../dotnet-workflow/dotnet-workflow-howto.md | 2 +- .../zh_CN/sdks_java/_index.md | 4 +- .../zh_CN/sdks_java/java-client/_index.md | 6 +- .../zh_CN/sdks_js/_index.md | 32 ++-- .../php-actors/php-actor-reference.md | 2 +- .../zh_CN/sdks_python/_index.md | 14 +- 194 files changed, 1879 insertions(+), 1885 deletions(-) diff --git a/src/translated_content/zh_CN/docs/_index.md b/src/translated_content/zh_CN/docs/_index.md index 9b52f80a7..5b97c1892 100644 --- a/src/translated_content/zh_CN/docs/_index.md +++ b/src/translated_content/zh_CN/docs/_index.md @@ -21,7 +21,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

如何通过几分钟的时间，在你的操作环境中实现 Dapr 的启动与运行

- }}"> + @@ -30,7 +30,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

包含代码示例的教程集合，可帮助您快速开始使用 Dapr。

- + @@ -39,7 +39,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

开始了解 Dapr，包括其主要的特性及所提供的功能

- + 有关如何构建 Dapr 应用的工具，提示和信息

- + @@ -62,7 +62,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

解决分布式应用程序常见开发挑战的功能。

- + @@ -71,7 +71,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

关于在 Dapr 上运行您的应用程序的托管选项，最佳实践和其他指南

- + 关于 Dapr API，CLI，资源绑定及更多内容的详细文档

- + @@ -94,7 +94,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

如何为 Dapr 及其相关项目做出贡献

- + }}"> + }}"> + }}"> + @@ -165,7 +165,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

- + @@ -180,7 +180,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

- + }}"> + @@ -213,7 +213,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

- + @@ -228,7 +228,7 @@ Dapr 是一个可移植的、事件驱动的运行时，它使任何开发人员

- + -| 构建块 | Endpoint | 说明 | -| ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | +| 构建块 | Endpoint | 说明 | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | [**服务之间的调用**]({{< ref "service-invocation-overview.md" >}}) | `/v1.0/invoke` | 服务调用使应用程序能够以 http 或 gRPC 消息的形式通过已知的端点相互通信。 Dapr 提供了一个终结点，该终结点充当反向代理与内置服务发现的组合，同时利用内置的分布式跟踪和错误处理。 | | [**状态管理**]({{< ref "state-management-overview.md" >}}) | `/v1.0/state` | 应用程序状态是应用程序想要在单个会话之外保留的任何内容。 Dapr 提供基于键/值的状态和查询API ，使用可插拔的状态存储进行持久化。 | | [**发布和订阅**]({{< ref "pubsub-overview.md" >}}) | `/v1.0/publish` `/v1.0/subscribe` | 发布/订阅是松耦合的消息传递模式，发送方 (或发布者) 将消息推送到订阅者订阅的主题。 Dapr 支持应用程序之间的发布/订阅模式。 | diff --git a/src/translated_content/zh_CN/docs/concepts/dapr-services/placement.md b/src/translated_content/zh_CN/docs/concepts/dapr-services/placement.md index 294137f63..d6a3a3deb 100644 --- a/src/translated_content/zh_CN/docs/concepts/dapr-services/placement.md +++ b/src/translated_content/zh_CN/docs/concepts/dapr-services/placement.md @@ -47,12 +47,12 @@ GET http://localhost:/placement/state **Actor 主机信息** -| 名称 | 类型 | 说明 | -| ---------- | --------- | ------------------- | -| name | string | 执行组件的 host：port 地址。 | -| appId | string | app id. | -| actorTypes | json字符串数组 | 托管的 actor 类型列表。 | -| updatedAt | timestamp | Actor 注册/更新的时间戳。 | +| 名称 | 类型 | 说明 | +| ---------- | --------- | ----------------------- | +| name | string | 执行组件的 host：port 地址。 | +| appId | string | app id. | +| actorTypes | json字符串数组 | 托管的 actor 类型列表。 | +| updatedAt | timestamp | Actor 注册/更新的时间戳。 | ### 示例 diff --git a/src/translated_content/zh_CN/docs/concepts/overview.md b/src/translated_content/zh_CN/docs/concepts/overview.md index 0513555be..d812cddc6 100644 --- a/src/translated_content/zh_CN/docs/concepts/overview.md +++ b/src/translated_content/zh_CN/docs/concepts/overview.md @@ -44,8 +44,8 @@ Dapr 提供分布式系统构建块，以便以标准方式构建微服务应用 这些构建块API的每个都是独立的，这意味着您可以在您的应用程序中使用任意数量的它们。 -| 构建块 | 说明 | -| ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 构建块 | 说明 | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | [**服务之间的调用**]({{< ref "service-invocation-overview.md" >}}) | 服务间调用允许进行远程方法调用(包括重试)，无论远程服务处于任何位置，只需该服务托管于受支持的环境即可。 | | [**状态管理**]({{< ref "state-management-overview.md" >}}) | 通过采用存储和查询键/值对机制的状态管理，可以轻松的使长时运行、高可用的有状态服务和无状态服务共同运行在您的应用程序中。 状态存储是可插拔的，示例包括AWS DynamoDB、Azure CosmosDB、Azure SQL Server、GCP Firebase、PostgreSQL或Redis，等等。 | | [**发布和订阅**]({{< ref "pubsub-overview.md" >}}) | 在服务之间发布事件和订阅主题，使事件驱动的架构能够简化水平可伸缩性，并使其能够灵活应对故障。 Dapr 提供至少一次的消息传递保证，消息TTL，消费者组等高级功能。 | @@ -61,8 +61,8 @@ Dapr 提供分布式系统构建块，以便以标准方式构建微服务应用 除了构建基块之外，Dapr 还提供适用于你使用的所有构建基块的跨领域 API。 -| 构建块 | 说明 | -| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | +| 构建块 | 说明 | +| ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | [**弹性**]({{< ref "resiliency-concept.md" >}}) | Dapr 提供了通过弹性规范定义和应用容错弹性策略的能力。 支持的规范定义弹性模式的策略，例如超时、重试/退避和断路器。 | | [**可观测性**]({{< ref "observability-concept.md" >}}) | Dapr会发出各种指标、日志、链路以调试和监控 Dapr 和用户应用的运行状况。 Dapr 支持分布式跟踪，通过使用 W3C 跟踪上下文标准和 Open Telemetry 发送到不同的监控工具，以方便诊断和服务于生产中的服务间调用。 | | [**安全**]({{< ref "security-concept.md" >}}) | Dapr 支持使用 Dapr 控制平面哨兵服务对 Dapr 实例之间的通信进行传输中加密。 您可以引入自己的证书，也可以让 Dapr 自动创建和保留自签名根证书和颁发者证书。 | @@ -141,13 +141,13 @@ Dapr 可以与任何开发框架集成。 下面是一些已经和Dapr集成的 #### Web -| 语言 | 框架 | 说明 | -| --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [.NET]({{< ref dotnet >}}) | [ASP.NET Core](https://github.com/dapr/dotnet-sdk/tree/master/examples/AspNetCore) | 提供有状态路由控制器，相应来自其他服务的发布/订阅事件。 也可以利用[ASP.NET Core gRPC服务](https://docs.microsoft.com/aspnet/core/grpc/)。 | -| [Java]({{< ref java >}}) | [Spring Boot](https://spring.io/) | 使用 Dapr API 构建 Spring boot应用程序。 | -| [Python]({{< ref python >}}) | [Flask]({{< ref python-flask.md >}}) | 使用 Dapr API 构建 Flask 应用程序。 | -| [Javascript](https://github.com/dapr/js-sdk) | [Express](http://expressjs.com/) | 使用 Dapr API 构建 Express 应用程序。 | -| [PHP]({{< ref php >}}) | | 可以使用 Apache, Nginx, 或 Caddyserver 提供服务。 | +| 语言 | 框架 | 说明 | +| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | +| [.NET]({{< ref dotnet >}}) | [ASP.NET Core](https://github.com/dapr/dotnet-sdk/tree/master/examples/AspNetCore) | 提供有状态路由控制器，相应来自其他服务的发布/订阅事件。 也可以利用[ASP.NET Core gRPC服务](https://docs.microsoft.com/aspnet/core/grpc/)。 | +| [Java]({{< ref java >}}) | [Spring Boot](https://spring.io/) | 使用 Dapr API 构建 Spring boot应用程序。 | +| [Python]({{< ref python >}}) | [Flask]({{< ref python-flask.md >}}) | 使用 Dapr API 构建 Flask 应用程序。 | +| [Javascript](https://github.com/dapr/js-sdk) | [Express](http://expressjs.com/) | 使用 Dapr API 构建 Express 应用程序。 | +| [PHP]({{< ref php >}}) | | 可以使用 Apache, Nginx, 或 Caddyserver 提供服务。 | #### 集成和扩展 diff --git a/src/translated_content/zh_CN/docs/concepts/terminology.md b/src/translated_content/zh_CN/docs/concepts/terminology.md index 4b5823e31..25b1a77e8 100644 --- a/src/translated_content/zh_CN/docs/concepts/terminology.md +++ b/src/translated_content/zh_CN/docs/concepts/terminology.md @@ -11,12 +11,12 @@ description: Dapr文档中的通用术语和缩略语的定义 | 术语 | 定义 | 更多的信息 | | :------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | App/Application（应用） | 运行中的服务/二进制文件，通常是由用户创建和运行的。 | | -| Building block (构建块) | Dapr 为用户提供的 API，以帮助创建微服务和应用程序。 | [Dapr构建块]({{< ref building-blocks-concept.md >}}) | -| Component | 由 Dapr 构建块使用的模块化功能类型，可以单独使用，也可以与其他组件的集合一起使用。 | [Dapr组件]({{< ref components-concept.md >}}) | -| Configuration | 一个 YAML 文件，声明 Dapr sidecars 或 Dapr 控制面板的所有设置。 这是您可以配置控制面板mTLS设置，或应用程序实例的跟踪和中间件设置的地方。 | [Dapr配置]({{< ref configuration-concept.md >}}) | -| Dapr | 分布式应用运行时(Distributed Application Runtime 的缩写) | [Dapr概述]({{< ref overview.md >}}) | +| Building block (构建块) | Dapr 为用户提供的 API，以帮助创建微服务和应用程序。 | [Dapr构建块]({{< ref building-blocks-concept.md >}}) | +| Component | 由 Dapr 构建块使用的模块化功能类型，可以单独使用，也可以与其他组件的集合一起使用。 | [Dapr组件]({{< ref components-concept.md >}}) | +| Configuration | 一个 YAML 文件，声明 Dapr sidecars 或 Dapr 控制面板的所有设置。 这是您可以配置控制面板mTLS设置，或应用程序实例的跟踪和中间件设置的地方。 | [Dapr配置]({{< ref configuration-concept.md >}}) | +| Dapr | 分布式应用运行时(Distributed Application Runtime 的缩写) | [Dapr概述]({{< ref overview.md >}}) | | Dapr control plane (Dapr 控制平面) | 在托管平台（如 Kubernetes 集群）上作为 Dapr 安装一部分的服务集合。 允许启用 Dapr 的应用程序在平台上运行，并处理 Dapr 功能，如 actor placement 、Dapr sidecar 注入或证书签发/延续。 | [自托管概述]({{< ref self-hosted-overview >}})
[Kubernetes概述]({{< ref kubernetes-overview >}}) | -| HTTPEndpoint | HTTPEndpoint 是一种 Dapr 资源，用于识别通过服务调用 API 调用的非 Dapr 端点。 | [服务调用API]({{< ref service_invocation_api.md >}}) | -| Self-hosted（自托管） | 您可以在 Windows/macOS/Linux 机器用 Dapr 运行您的应用程序。 Dapr 提供在机器上以"自托管"模式运行的能力。 | [自托管模式]({{< ref self-hosted-overview.md >}}) | +| HTTPEndpoint | HTTPEndpoint 是一种 Dapr 资源，用于识别通过服务调用 API 调用的非 Dapr 端点。 | [服务调用API]({{< ref service_invocation_api.md >}}) | +| Self-hosted（自托管） | 您可以在 Windows/macOS/Linux 机器用 Dapr 运行您的应用程序。 Dapr 提供在机器上以"自托管"模式运行的能力。 | [自托管模式]({{< ref self-hosted-overview.md >}}) | | Service (服务) | 正在运行的应用程序或二进制文件。 可用于指您的应用程序，或 Dapr 应用程序。 | | | Sidecar(边车) | 作为单独的进程或容器与应用程序一起运行的程序。 | [sidecar 边车模式](https://docs.microsoft.com/azure/architecture/patterns/sidecar) | diff --git a/src/translated_content/zh_CN/docs/contributing/daprbot.md b/src/translated_content/zh_CN/docs/contributing/daprbot.md index a48b5af4e..b2997a722 100644 --- a/src/translated_content/zh_CN/docs/contributing/daprbot.md +++ b/src/translated_content/zh_CN/docs/contributing/daprbot.md @@ -10,12 +10,12 @@ Dapr 机器人由一系列命令触发，帮助 Dapr 组织完成常见任务。 ## 命令参考 -| 命令 | 目标 | 说明 | 谁可以使用 | 仓库 | -| ---------------- | --------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `/assign` | Issue | 将问题分配给一个用户或一组用户 | 任何人 | `dapr`，`docs`，`quickstarts`，`cli`，`components-contrib`，`go-sdk`，`js-sdk`，`java-sdk`，`python-sdk`，`dotnet-sdk` | +| 命令 | 目标 | 说明 | 谁可以使用 | 仓库 | +| ---------------- | --------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `/assign` | Issue | 将问题分配给一个用户或一组用户 | 任何人 | `dapr`，`docs`，`quickstarts`，`cli`，`components-contrib`，`go-sdk`，`js-sdk`，`java-sdk`，`python-sdk`，`dotnet-sdk` | | `/ok-to-test` | Pull requests | `dapr`: 触发端到端测试
`components-contrib`: 触发一致性和认证测试 | 列在[bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js)中的用户 | `dapr`，`components-contrib` | -| `/ok-to-perf` | Pull requests | 触发性能测试。 | 列在[bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js)中的用户 | `dapr` | -| `/make-me-laugh` | Issue 或者 pull request | 发布一个随机笑话 | 列在[bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js)中的用户 | `dapr`，`components-contrib` | +| `/ok-to-perf` | Pull requests | 触发性能测试。 | 列在[bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js)中的用户 | `dapr` | +| `/make-me-laugh` | Issue 或者 pull request | 发布一个随机笑话 | 列在[bot](https://github.com/dapr/dapr/blob/master/.github/scripts/dapr_bot.js)中的用户 | `dapr`，`components-contrib` | ## 标签参考 diff --git a/src/translated_content/zh_CN/docs/contributing/presentations.md b/src/translated_content/zh_CN/docs/contributing/presentations.md index 41a8d7da2..6868234d6 100644 --- a/src/translated_content/zh_CN/docs/contributing/presentations.md +++ b/src/translated_content/zh_CN/docs/contributing/presentations.md @@ -18,13 +18,13 @@ description: 如何进行Dapr的演讲和示例 ## 以往的 Dapr 演讲 -| 演示文稿 | 录屏 | 模板 | -| ----------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------- | -| 使用 Dapr 在 Kubernetes 中运行事件驱动的发布/订阅微服务 | [链接](https://youtu.be/-4sHUvfk2Eg) | N/A | -| Ignite 2019: Mark Russinovich Presents 云原生应用的未来 | [链接](https://www.youtube.com/watch?v=LAUDVk8PaCY) | [链接](/presentations/2019IgniteCloudNativeApps.pdf) | -| Azure Community Live：使用 DAPR 与 Mark Fussell 构建微服务应用程序 | [链接](https://www.youtube.com/watch?v=CgqI7nen-Ng) | N/A | -| Ready 2020: Mark Russinovich Presents 云原生应用 | [链接](https://youtu.be/eJCu6a-x9uo?t=1614) | [链接](/presentations/2020ReadyCloudNativeApps.pdf) | -| Ignite 2021： Mark Russinovich Dapr v1.0 Release | [链接](https://youtu.be/69PrhWQorEM?t=3789) | N/A | +| 演示文稿 | 录屏 | 模板 | +| --------------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------- | +| 使用 Dapr 在 Kubernetes 中运行事件驱动的发布/订阅微服务 | [链接](https://youtu.be/-4sHUvfk2Eg) | N/A | +| Ignite 2019: Mark Russinovich Presents 云原生应用的未来 | [链接](https://www.youtube.com/watch?v=LAUDVk8PaCY) | [链接](/presentations/2019IgniteCloudNativeApps.pdf) | +| Azure Community Live：使用 DAPR 与 Mark Fussell 构建微服务应用程序 | [链接](https://www.youtube.com/watch?v=CgqI7nen-Ng) | N/A | +| Ready 2020: Mark Russinovich Presents 云原生应用 | [链接](https://youtu.be/eJCu6a-x9uo?t=1614) | [链接](/presentations/2020ReadyCloudNativeApps.pdf) | +| Ignite 2021： Mark Russinovich Dapr v1.0 Release | [链接](https://youtu.be/69PrhWQorEM?t=3789) | N/A | ## 其他资源 diff --git a/src/translated_content/zh_CN/docs/contributing/roadmap.md b/src/translated_content/zh_CN/docs/contributing/roadmap.md index 2c3c847c0..d4212f40c 100644 --- a/src/translated_content/zh_CN/docs/contributing/roadmap.md +++ b/src/translated_content/zh_CN/docs/contributing/roadmap.md @@ -11,7 +11,7 @@ Dapr 鼓励社区帮助确定优先级。 GitHub 项目委员会可查看和提 [Dapr Roadmap板的截图](https://aka.ms/dapr/roadmap) -{{< button text="查看待办事项" link="https\://aka.ms/dapr/roadmap" color="primary" >}}
+{{< button text="查看待办事项" link="https://aka.ms/dapr/roadmap" color="primary" >}}
请通过添加 GitHub issue 的👍来投票，了解您最希望看到 Dapr 支持的功能。 这将有助于 Dapr 维护人员了解哪些功能将提供最大的价值。 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/actors-timers-reminders.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/actors-timers-reminders.md index 80ba8a7ad..006c46371 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/actors-timers-reminders.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/actors-timers-reminders.md @@ -16,7 +16,7 @@ Timer 和 reminder 的功能非常相似。 主要的区别在于，Dapr actor Timer 和 reminder 的调度配置是相同的，总结如下: -*** +--- `dueTime`是一个可选的参数，它设置了首次调用回调之前的时间或时间间隔。 如果忽略了 `dueTime` ，则在 timer/reminder 注册后立即调用回调。 @@ -26,7 +26,7 @@ Timer 和 reminder 的调度配置是相同的，总结如下: - time.Duration 格式，例如 `2h30m` - [ISO 8601持续时间](https://zh.wikipedia.org/wiki/ISO_8601#持续时间)格式，例如`PT2H30M` -*** +--- `period` 是一个可选参数，用于设置两个连续回调调用之间的时间间隔。 当以`ISO 8601-1 duration`格式指定时，您还可以配置重复次数，以限制回调调用的总次数。 如果`period`被省略，回调函数将只被调用一次。 @@ -36,7 +36,7 @@ Timer 和 reminder 的调度配置是相同的，总结如下: - time.Duration 格式，例如 `2h30m` - [ISO 8601持续时间](https://zh.wikipedia.org/wiki/ISO_8601#持续时间)格式，例如`PT2H30M`，`R5/PT1M30S` -*** +--- `ttl`是一个可选的参数，它设定时间或时间间隔，其后timer/reminder将过期并删除。 如果省略`ttl`，则不应用任何限制。 @@ -46,7 +46,7 @@ Timer 和 reminder 的调度配置是相同的，总结如下: - time.Duration 格式，例如 `2h30m` - [ISO 8601持续时间](https://zh.wikipedia.org/wiki/ISO_8601#持续时间)格式。 示例：`PT2H30M` -*** +--- Actor 运行时验证调度配置的正确性并返回无效输入的错误。 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/howto-actors-partitioning.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/howto-actors-partitioning.md index 3eda211c7..f6a04f082 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/howto-actors-partitioning.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/actors/howto-actors-partitioning.md @@ -18,9 +18,9 @@ aliases: 1. `actors\|\|\|\|metadata` 中的元数据记录被用于存储给定 actor 类型的持久化配置。 2. 同一 actor 类型的 reminder 子集被存储在多个记录中。 -| Key | Value | -| --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `actors\\|\\|\\|\\|metadata` | `{ "id": , "actorRemindersMetadata": { "partitionCount": } }` | +| Key | Value | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `actors\\|\\|\\|\\|metadata` | `{ "id": , "actorRemindersMetadata": { "partitionCount": } }` | | `actors\\|\\|\\|\\|\\|\\|reminders\\|\\|1` | `[ , , ... , ]` | | `actors\\|\\|\\|\\|\\|\\|reminders\\|\\|2` | `[ , , ... , ]` | diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/bindings/bindings-overview.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/bindings/bindings-overview.md index 9d0588bab..92bdd3345 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/bindings/bindings-overview.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/bindings/bindings-overview.md @@ -95,10 +95,10 @@ description: Dapr 绑定API构建块概述 想测试一下 Dapr 绑定 API 吗？ 浏览以下快速入门和教程以查看 绑定 的实际应用： -| 快速入门/教程 | 说明 | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| 快速入门/教程 | 说明 | +| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | | [绑定快速入门]({{< ref bindings-quickstart.md >}}) | 使用输入绑定响应事件，使用输出绑定调用操作，与外部系统协作。 | -| [绑定教程](https://github.com/dapr/quickstarts/tree/master/tutorials/bindings) | 演示如何使用 Dapr 创建与其他组件的输入和输出绑定。 使用与 Kafka 的绑定。 | +| [绑定教程](https://github.com/dapr/quickstarts/tree/master/tutorials/bindings) | 演示如何使用 Dapr 创建与其他组件的输入和输出绑定。 使用与 Kafka 的绑定。 | ### 开始直接在应用程序中使用绑定 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/configuration/configuration-api-overview.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/configuration/configuration-api-overview.md index 5bbec286a..6cb3d39f2 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/configuration/configuration-api-overview.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/configuration/configuration-api-overview.md @@ -34,8 +34,8 @@ description: Dapr 配置管理构建块概述 想测试一下 Dapr 配置 API 吗？ 通过下面的快速入门，了解配置 API 的运行情况： -| 快速入门 | 说明 | -| ------------------------------------------------------------------------------------------------------------------------ | ---------------------- | +| 快速入门 | 说明 | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | | [配置快速入门]({{< ref configuration-quickstart.md >}}) | 使用配置 API 获取配置项或订阅配置更改。 | ### 开始直接在应用程序中使用配置应用程序接口 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/cryptography/cryptography-overview.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/cryptography/cryptography-overview.md index a8b136338..0ce6a7437 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/cryptography/cryptography-overview.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/cryptography/cryptography-overview.md @@ -64,8 +64,8 @@ Dapr 密码学构建块包括两种组件： 想测试一下 Dapr 加密 API 吗？ 通过以下快速入门和教程了解密码学的实际应用： -| 快速入门/教程 | 说明 | -| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | +| 快速入门/教程 | 说明 | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | | [密码学快速入门]({{< ref cryptography-quickstart.md >}}) | 利用加密 API，使用 RSA 和 AES 密钥加密和解密信息和大型文件。 | ### 开始直接在应用程序中使用加密技术 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/howto-route-messages.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/howto-route-messages.md index 13a3dae64..24508ab73 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/howto-route-messages.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/howto-route-messages.md @@ -357,8 +357,8 @@ event.type == "mymessage.v2" - **示例:** - 具有 DNS 权限的互联网范围的唯一 URI。 - - https\://github.com/cloudevents - - mailto:cncf-wg-serverless\@lists.cncf.io + - https://github.com/cloudevents + - mailto:cncf-wg-serverless@lists.cncf.io - 具有 UUID 的普遍唯一的 URN。 - urn:uuid:6e8bc430-9c3a-11d9-9669-0800200c9a66 - 特定应用的标识符: @@ -446,7 +446,7 @@ event.type == "mymessage.v2" - 事件 `type` 用于标识“blob created”事件 - 事件的 `id` 是唯一标识事件实例的，用于区分同名 blob 的独立创建的发生次数。 新创建的 blob 的名称在 `subject` 中传递： - - `source`: https\://example.com/storage/tenant/container + - `source`: https://example.com/storage/tenant/container - `subject`: mynewfile.jpg #### time diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/subscription-methods.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/subscription-methods.md index 836bfdc75..f337a897b 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/subscription-methods.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/pubsub/subscription-methods.md @@ -10,8 +10,8 @@ description: 了解 Dapr 允许您订阅主题的方法。 Dapr 应用程序可以通过两种方法订阅发布的主题，这两种方法支持相同的功能：声明式和编程式。 -| 订阅方法 | 说明 | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| 订阅方法 | 说明 | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | | [**声明式**]({{< ref "subscription-methods.md#declarative-subscriptions" >}}) | 订阅定义在一个**外部文件**中。 声明式方法会从您的代码中移除 Dapr 依赖，并允许现有的应用程序订阅 topics，而无需更改代码。 | | [**编程式**]({{< ref "subscription-methods.md#programmatic-subscriptions" >}}) | 订阅定义在**应用程序代码**中。 编程式方法在代码中实现订阅。 | diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/secrets/secrets-overview.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/secrets/secrets-overview.md index c171e07d5..930290da2 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/secrets/secrets-overview.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/secrets/secrets-overview.md @@ -74,10 +74,10 @@ Dapr的专用密钥构建块API使开发人员更容易从密钥存储中获取 想要测试 Dapr 密钥管理 API？ 通过以下快速入门和教程了解Dapr secrets的实际操作： -| 快速入门/教程 | 说明 | -| -------------------------------------------------------------------------------------------------------------------- | --------------------------------- | +| 快速入门/教程 | 说明 | +| ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | | [秘密管理快速入门]({{< ref secrets-quickstart.md >}}) | 使用密钥管理 API 从配置的密钥存储中检索应用程序代码中的密钥。 | -| [密钥存储教程](https://github.com/dapr/quickstarts/tree/master/tutorials/secretstore) | 演示使用 Dapr Secrets API 来访问密钥存储。 | +| [密钥存储教程](https://github.com/dapr/quickstarts/tree/master/tutorials/secretstore) | 演示使用 Dapr Secrets API 来访问密钥存储。 | ### 开始直接在应用程序中管理密钥 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/service-invocation/service-invocation-overview.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/service-invocation/service-invocation-overview.md index 3522708f9..ef367ea98 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/service-invocation/service-invocation-overview.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/service-invocation/service-invocation-overview.md @@ -138,11 +138,11 @@ Consul名称解析组件特别适用于多机部署，并且可以在包括Kuber Dapr 文档包含多个快速入门，利用不同示例架构中的服务调用构建块。 为了对服务调用 Api 及其功能有一个直观的了解，我们建议从我们的快速入门开始： -| 快速入门/教程 | 说明 | -| ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| 快速入门/教程 | 说明 | +| -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | [配置快速入门]({{< ref serviceinvocation-quickstart.md >}}) | 这个快速入门让您直接与服务调用构建块进行交互。 | -| [Hello world 教程](https://github.com/dapr/quickstarts/blob/master/tutorials/hello-world/README.md) | 本教程展示了如何在本地计算机上同时使用服务调用和状态管理构建块。 | -| [Hello world kubernetes 教程](https://github.com/dapr/quickstarts/blob/master/tutorials/hello-kubernetes/README.md) | 本教程介绍了在 Kubernetes 中使用 Dapr，并涵盖了服务调用和状态管理构建块。 | +| [Hello world 教程](https://github.com/dapr/quickstarts/blob/master/tutorials/hello-world/README.md) | 本教程展示了如何在本地计算机上同时使用服务调用和状态管理构建块。 | +| [Hello world kubernetes 教程](https://github.com/dapr/quickstarts/blob/master/tutorials/hello-kubernetes/README.md) | 本教程介绍了在 Kubernetes 中使用 Dapr，并涵盖了服务调用和状态管理构建块。 | ### 直接在应用中开始使用服务调用 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-share-state.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-share-state.md index 8df9f21ae..e3d317bfa 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-share-state.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-share-state.md @@ -17,12 +17,12 @@ Dapr 为开发者提供了不同的方式来共享应用程序之间的状态。 要启用状态共享， Dapr 支持以下键前缀策略: -| 键前缀 | 说明 | -| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `appid` | 默认策略允许您只能通过指定的 `appid` 来管理状态。 所有状态键都将以`appid`作为前缀，并且仅适用于应用程序。 | -| `name` | 使用状态存储组件的名称作为前缀。 对于一个给定的状态存储，多个应用程序可以共享同一个状态。 | +| 键前缀 | 说明 | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `appid` | 默认策略允许您只能通过指定的 `appid` 来管理状态。 所有状态键都将以`appid`作为前缀，并且仅适用于应用程序。 | +| `name` | 使用状态存储组件的名称作为前缀。 对于一个给定的状态存储，多个应用程序可以共享同一个状态。 | | `namespace` | 如果设置了此设置，将使用配置的命名空间前缀`appid`键，从而产生一个针对特定命名空间范围的键。 这允许具有相同`appid`的不同命名空间中的应用程序重用相同的状态存储。 如果命名空间未配置，则设置将回退到`appid`策略。 有关 Dapr 中命名空间的更多信息，请参阅 [操作方法：将组件范围限定为一个或多个应用程序]({{< ref component-scopes.md >}}) | -| `无验证` | 不使用前缀。 多个应用程序在不同的状态存储中共享状态。 | +| `无验证` | 不使用前缀。 多个应用程序在不同的状态存储中共享状态。 | ## 指定状态前缀策略 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-state-query-api.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-state-query-api.md index c67edfd89..9a3baa4f8 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-state-query-api.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/howto-state-query-api.md @@ -27,17 +27,17 @@ description: 使用查询API查询状态存储 支持以下操作： -| 运算符 | 操作数 | 说明 | -| ----- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `EQ` | key:value | key == value | -| `NEQ` | key:value | key != value | -| `GT` | key:value | key > value | -| `GTE` | key:value | key >= value | -| `LT` | key:value | key < value | -| `LTE` | key:value | key <= value | +| 运算符 | 操作数 | 说明 | +| ----- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `EQ` | key:value | key == value | +| `NEQ` | key:value | key != value | +| `GT` | key:value | key > value | +| `GTE` | key:value | key >= value | +| `LT` | key:value | key < value | +| `LTE` | key:value | key <= value | | `IN` | key:[]value | key == value[0] OR key == value[1] OR ... OR key == value[n] | -| `AND` | []operation | operation[0] AND operation[1] AND ... AND operation[n] | -| `OR` | []operation | operation[0] OR operation[1] OR ... OR operation[n] | +| `AND` | []operation | operation[0] AND operation[1] AND ... AND operation[n] | +| `OR` | []operation | operation[0] OR operation[1] OR ... OR operation[n] | 操作数中的`key`与JSONPath表示法类似。 键中的每个点表示一个嵌套的JSON结构。 例如，考虑这个结构： diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/state-management-overview.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/state-management-overview.md index 795c7b41d..71f1b600d 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/state-management-overview.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/state-management/state-management-overview.md @@ -173,11 +173,11 @@ Dapr 允许[对每个状态设置请求的生存时间(TTL)]({{< ref state-store 想测试一下 Dapr 状态管理 API 吗？ 浏览以下快速入门和教程以查看状态管理的实际应用： -| 快速入门/教程 | 说明 | -| ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| 快速入门/教程 | 说明 | +| -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | [状态管理快速入门]({{< ref statemanagement-quickstart.md >}}) | 使用状态管理 API 创建有状态应用程序。 | -| [Hello world 教程](https://github.com/dapr/quickstarts/blob/master/tutorials/hello-world/README.md) | _推荐_
演示如何在本地运行 Dapr。 重点介绍服务调用和状态管理。 | -| [你好，世界 Kubernetes](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) | _推荐_
演示如何在 Kubernetes 中运行 Dapr。 重点介绍服务调用和_状态管理_。 | +| [Hello world 教程](https://github.com/dapr/quickstarts/blob/master/tutorials/hello-world/README.md) | _推荐_
演示如何在本地运行 Dapr。 重点介绍服务调用和状态管理。 | +| [你好，世界 Kubernetes](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes) | _推荐_
演示如何在 Kubernetes 中运行 Dapr。 重点介绍服务调用和_状态管理_。 | ### 直接在应用中开始使用状态管理 diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/howto-manage-workflow.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/howto-manage-workflow.md index c4bf61be0..9ba58a4ec 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/howto-manage-workflow.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/howto-manage-workflow.md @@ -71,12 +71,12 @@ d.terminate_workflow(instance_id=instanceId, workflow_component=workflowComponen 在代码中管理工作流。 在[编写工作流]({{< ref "howto-author-workflow.md#write-the-application" >}})指南中的工作流示例中，工作流是使用以下API在代码中注册的： -- **client.workflow\.start**: 启动一个工作流实例 -- **client.workflow\.get**: 获取工作流的状态信息 -- **client.workflow\.pause**: 暂停或中止一个工作流实例，稍后可恢复该实例 -- **client.workflow\.resume**: 恢复暂停的工作流实例 -- **client.workflow\.purge**: 删除与特定工作流实例相关的所有元数据 -- **client.workflow\.terminate**: 终止或停止工作流的特定实例 +- **client.workflow.start**: 启动一个工作流实例 +- **client.workflow.get**: 获取工作流的状态信息 +- **client.workflow.pause**: 暂停或中止一个工作流实例，稍后可恢复该实例 +- **client.workflow.resume**: 恢复暂停的工作流实例 +- **client.workflow.purge**: 删除与特定工作流实例相关的所有元数据 +- **client.workflow.terminate**: 终止或停止工作流的特定实例 ```javascript import { DaprClient } from "@dapr/dapr"; diff --git a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/workflow-overview.md b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/workflow-overview.md index 024867638..8ed61348a 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/workflow-overview.md +++ b/src/translated_content/zh_CN/docs/developing-applications/building-blocks/workflow/workflow-overview.md @@ -77,13 +77,13 @@ Dapr 工作流 _创作 SDK_ 是特定于语言的 SDK，其中包含用于实现 您可以使用以下 SDK 创作工作流。 -| 语言栈 | 包 | -| ---------- | -------------------------------------------------------------------------------------------------------- | -| Python | [dapr-ext-workflow](https://github.com/dapr/python-sdk/tree/master/ext/dapr-ext-workflow) | -| JavaScript | [DaprWorkflowClient](https://github.com/dapr/js-sdk/blob/main/src/workflow/client/DaprWorkflowClient.ts) | -| .NET | [Dapr.Workflow](https://www.nuget.org/profiles/dapr.io) | -| Java | [io.dapr.workflows](https://dapr.github.io/java-sdk/io/dapr/workflows/package-summary.html) | -| Go | [工作流](https://github.com/dapr/go-sdk/tree/main/client/workflow.go) | +| 语言栈 | 包 | +| -------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| Python | [dapr-ext-workflow](https://github.com/dapr/python-sdk/tree/master/ext/dapr-ext-workflow) | +| JavaScript | [DaprWorkflowClient](https://github.com/dapr/js-sdk/blob/main/src/workflow/client/DaprWorkflowClient.ts) | +| .NET | [Dapr.Workflow](https://www.nuget.org/profiles/dapr.io) | +| Java | [io.dapr.workflows](https://dapr.github.io/java-sdk/io/dapr/workflows/package-summary.html) | +| Go | [工作流](https://github.com/dapr/go-sdk/tree/main/client/workflow.go) | ## 试用工作流 @@ -91,14 +91,14 @@ Dapr 工作流 _创作 SDK_ 是特定于语言的 SDK，其中包含用于实现 想要测试工作流？ 通过以下快速入门和教程了解工作流的实际操作： -| 快速入门/教程 | 说明 | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [配置快速入门]({{< ref workflow-quickstart.md >}}) | 运行具有四个工作流活动的工作流应用程序，以查看 Dapr 工作流的运行情况 | -| [Workflow Python SDK示例](https://github.com/dapr/python-sdk/tree/master/examples/demo_workflow) | 了解如何创建 Dapr 工作流并使用 Python 的 `DaprClient` 包调用它。 | -| [Workflow JavaScript SDK示例](https://github.com/dapr/js-sdk/tree/main/examples/workflow) | 了解如何使用JavaScript SDK创建Dapr工作流并调用它。 | -| [Workflow .NET SDK示例](https://github.com/dapr/dotnet-sdk/tree/master/examples/Workflow) | 了解如何创建 Dapr 工作流并使用 ASP.NET Core Web API 调用它。 | -| [Workflow Java SDK示例](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/workflows) | 了解如何创建 Dapr 工作流并使用 Java 的 `io.dapr.workflows` 包调用它。 | -| [Workflow Go SDK示例](https://github.com/dapr/go-sdk/tree/main/examples/workflow/README.md) | 了解如何创建 Dapr 工作流并使用 Go 的 `workflow` 包调用它。 | +| 快速入门/教程 | 说明 | +| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [配置快速入门]({{< ref workflow-quickstart.md >}}) | 运行具有四个工作流活动的工作流应用程序，以查看 Dapr 工作流的运行情况 | +| [Workflow Python SDK示例](https://github.com/dapr/python-sdk/tree/master/examples/demo_workflow) | 了解如何创建 Dapr 工作流并使用 Python 的 `DaprClient` 包调用它。 | +| [Workflow JavaScript SDK示例](https://github.com/dapr/js-sdk/tree/main/examples/workflow) | 了解如何使用JavaScript SDK创建Dapr工作流并调用它。 | +| [Workflow .NET SDK示例](https://github.com/dapr/dotnet-sdk/tree/master/examples/Workflow) | 了解如何创建 Dapr 工作流并使用 ASP.NET Core Web API 调用它。 | +| [Workflow Java SDK示例](https://github.com/dapr/java-sdk/tree/master/examples/src/main/java/io/dapr/examples/workflows) | 了解如何创建 Dapr 工作流并使用 Java 的 `io.dapr.workflows` 包调用它。 | +| [Workflow Go SDK示例](https://github.com/dapr/go-sdk/tree/main/examples/workflow/README.md) | 了解如何创建 Dapr 工作流并使用 Go 的 `workflow` 包调用它。 | ### 直接在应用中开始使用工作流 diff --git a/src/translated_content/zh_CN/docs/developing-applications/debugging/bridge-to-kubernetes.md b/src/translated_content/zh_CN/docs/developing-applications/debugging/bridge-to-kubernetes.md index 8ba2ca2c3..86b3709e1 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/debugging/bridge-to-kubernetes.md +++ b/src/translated_content/zh_CN/docs/developing-applications/debugging/bridge-to-kubernetes.md @@ -8,7 +8,7 @@ description: 在本地调试与你的 Kubernetes 集群相连的 Dapr 应用程 Bridge to Kubernetes 允许你在你的开发计算机上运行和调试代码，同时仍然与你的应用程序或服务的其他部分连接到你的 Kubernetes 集群。 这种类型的调试通常称为_本地隧道调试_。 -{{< button text="了解更多关于 Bridge to Kubernetes" link="https\://aka.ms/bridge-vscode-dapr" >}} +{{< button text="了解更多关于 Bridge to Kubernetes" link="https://aka.ms/bridge-vscode-dapr" >}} ## 调试 Dapr 应用 diff --git a/src/translated_content/zh_CN/docs/developing-applications/debugging/debug-k8s/debug-dapr-services.md b/src/translated_content/zh_CN/docs/developing-applications/debugging/debug-k8s/debug-dapr-services.md index 35186629b..9e4be248d 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/debugging/debug-k8s/debug-dapr-services.md +++ b/src/translated_content/zh_CN/docs/developing-applications/debugging/debug-k8s/debug-dapr-services.md @@ -38,7 +38,7 @@ make release GOOS=linux GOARCH=amd64 DEBUG=1 ### 2. 构建 Dapr 调试 Docker 镜像 -使用下面的命令将调试二进制文件打包成 Docker 镜像。 在此之前，你需要登录到你的 docker 账号，如果还没有 docker 账号，可以在 "https\://hub.docker.com/" 中注册。 +使用下面的命令将调试二进制文件打包成 Docker 镜像。 在此之前，你需要登录到你的 docker 账号，如果还没有 docker 账号，可以在 "https://hub.docker.com/" 中注册。 ```bash export DAPR_TAG=dev diff --git a/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/develop-pluggable.md b/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/develop-pluggable.md index 94bd996b4..9033319c4 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/develop-pluggable.md +++ b/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/develop-pluggable.md @@ -23,8 +23,8 @@ description: 学习如何编写和实现可插拔组件 - 绑定 - Secret stores（密钥存储） -| Component | 类型 | gRPC 定义 | 内置参考实现 | 文档 | -| :-------: | :------------: | :------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Component | 类型 | gRPC 定义 | 内置参考实现 | 文档 | +| :-------: | :------------: | :----------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 状态存储 | `state` | [state.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/state.proto) | [Redis](https://github.com/dapr/components-contrib/tree/master/state/redis) | [概念]({{< ref "state-management-overview" >}})，[如何操作]({{< ref "howto-get-save-state" >}})，[API规范]({{< ref "state_api" >}}) | | Pub/sub | `pubsub` | [pubsub.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/pubsub.proto) | [Redis](https://github.com/dapr/components-contrib/tree/master/pubsub/redis) | [概念]({{< ref "pubsub-overview" >}})，[如何操作]({{< ref "howto-publish-subscribe" >}})，[API规范]({{< ref "pubsub_api" >}}) | | 绑定 | `bindings` | [bindings.proto](https://github.com/dapr/dapr/blob/master/dapr/proto/components/v1/bindings.proto) | [Kafka](https://github.com/dapr/components-contrib/tree/master/bindings/kafka) | [概念]({{< ref "bindings-overview" >}})，[输入如何]({{< ref "howto-triggers" >}})，[输出如何]({{< ref "howto-bindings" >}})，[API规范]({{< ref "bindings_api" >}}) | diff --git a/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/_index.md b/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/_index.md index 61474d9ee..51e914169 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/_index.md +++ b/src/translated_content/zh_CN/docs/developing-applications/develop-components/pluggable-components/pluggable-components-sdks/_index.md @@ -12,7 +12,7 @@ Dapr SDK 是创建可插拔组件的最简单方法。 选择你最喜欢的语 ## 可插拔组件 SDK -| 语言 | 状态 | -| ---------------------------------------------------------------------------------------------------------------------- | :------------: | -| [Go]({{< ref pluggable-components-go >}}) | In development | +| 语言 | 状态 | +| -------------------------------------------------------------------------------------------------------------------------------------- | :------------: | +| [Go]({{< ref pluggable-components-go >}}) | In development | | [.NET]({{< ref pluggable-components-dotnet >}}) | In development | diff --git a/src/translated_content/zh_CN/docs/developing-applications/integrations/AWS/authenticating-aws.md b/src/translated_content/zh_CN/docs/developing-applications/integrations/AWS/authenticating-aws.md index 1065aa4e0..14db3777f 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/integrations/AWS/authenticating-aws.md +++ b/src/translated_content/zh_CN/docs/developing-applications/integrations/AWS/authenticating-aws.md @@ -16,9 +16,9 @@ aliases: | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `region` | 要连接到哪个 AWS 区域。 在某些情况下（例如在自托管模式下运行Dapr时），这个标志可以由环境变量`AWS_REGION`提供。 由于Dapr sidecar注入不允许在Dapr sidecar上配置环境变量，建议始终在组件规范中设置`region`属性。 | | `endpoint` | 终端节点通常由 AWS 开发工具包在内部处理。 然而，在某些情况下，将其设置为本地可能是有意义的 - 例如，如果在开发时使用[DynamoDB本地版](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html)。 | -| `accessKey` | AWS Access key id. | -| `secretKey` | AWS Secret access key. 与`accessKey`一起使用，明确指定证书。 | -| `sessionToken` | AWS Session token. 与 `accessKey` 和 `secretKey` 一起使用。 当使用普通IAM用户的 access key和密钥时，通常不需要session token。 | +| `accessKey` | AWS Access key id. | +| `secretKey` | AWS Secret access key. 与`accessKey`一起使用，明确指定证书。 | +| `sessionToken` | AWS Session token. 与 `accessKey` 和 `secretKey` 一起使用。 当使用普通IAM用户的 access key和密钥时，通常不需要session token。 | {{% alert title="重要" color="warning" %}} 在您正在使用的组件规范的定义中**不能**提供AWS访问密钥、秘密密钥和令牌： diff --git a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-api-management.md b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-api-management.md index f278e237e..59edb826a 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-api-management.md +++ b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-api-management.md @@ -14,4 +14,4 @@ weight: 2000 尝试使用[Dapr和Azure API Management集成示例](https://github.com/dapr/samples/tree/master/dapr-apim-integration)。 -{{< button text="了解更多关于Dapr集成策略" link="https\://docs.microsoft.com/azure/api-management/api-management-dapr-policies" >}} +{{< button text="了解更多关于Dapr集成策略" link="https://docs.microsoft.com/azure/api-management/api-management-dapr-policies" >}} diff --git a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-authentication/authenticating-azure.md b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-authentication/authenticating-azure.md index cf052701a..dd1d656e9 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-authentication/authenticating-azure.md +++ b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-authentication/authenticating-azure.md @@ -90,13 +90,13 @@ Microsoft Entra ID 构建在开放标准（如 OAuth 2.0）之上，该标准允 #### 使用证书进行身份验证 -| 字段 | 必填 | Details | 如何使用Dapr扩展来开发和运行Dapr应用程序 | -| -------------------------- | ----------------------------------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `azureTenantId` | 是 | Microsoft Entra ID 租户的ID | `"cd4b2887-304c-47e1-b4d5-65447fdd542b"` | -| `azureClientId` | 是 | 客户端 ID（应用程序 ID） | `"c7dd251f-811f-4ba2-a905-acd4d3f8f08b"` | +| 字段 | 必填 | Details | 如何使用Dapr扩展来开发和运行Dapr应用程序 | +| -------------------------- | ----------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `azureTenantId` | 是 | Microsoft Entra ID 租户的ID | `"cd4b2887-304c-47e1-b4d5-65447fdd542b"` | +| `azureClientId` | 是 | 客户端 ID（应用程序 ID） | `"c7dd251f-811f-4ba2-a905-acd4d3f8f08b"` | | `azureCertificate` | `azureCertificate` 和 `azureCertificateFile` 二选一 | 证书和私钥（PFX/PKCS#12 格式） | `"-----BEGIN PRIVATE KEY-----\n MIIEvgI... \n -----END PRIVATE KEY----- \n -----BEGIN CERTIFICATE----- \n MIICoTC... \n -----END CERTIFICATE-----` | -| `azureCertificateFile` | `azureCertificate` 和 `azureCertificateFile` 二选一 | 包含证书和私钥的 PFX/PKCS#12 文件的路径 | `"/path/to/file.pem"` | -| `azureCertificatePassword` | 否 | 证书的密码（如果已加密） | `"password"` | +| `azureCertificateFile` | `azureCertificate` 和 `azureCertificateFile` 二选一 | 包含证书和私钥的 PFX/PKCS#12 文件的路径 | `"/path/to/file.pem"` | +| `azureCertificatePassword` | 否 | 证书的密码（如果已加密） | `"password"` | 在 Kubernetes 上运行时，您还可以对上述任何或所有值使用对 Kubernetes secret 的引用。 diff --git a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-functions.md b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-functions.md index 8d0402aa3..8bb901332 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-functions.md +++ b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-functions.md @@ -16,4 +16,4 @@ Dapr 通过扩展与 [Azure Functions 运行时](https://learn.microsoft.com/azu 通过此扩展，您可以为无服务器和事件驱动的应用程序同时提供两者。 -{{< button text="尝试使用Dapr扩展程序来使用Azure Functions" link="https\://learn.microsoft.com/azure/azure-functions/functions-bindings-dapr" >}} +{{< button text="尝试使用Dapr扩展程序来使用Azure Functions" link="https://learn.microsoft.com/azure/azure-functions/functions-bindings-dapr" >}} diff --git a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-kubernetes-service-extension.md b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-kubernetes-service-extension.md index 79458459e..e0bf30338 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-kubernetes-service-extension.md +++ b/src/translated_content/zh_CN/docs/developing-applications/integrations/Azure/azure-kubernetes-service-extension.md @@ -22,4 +22,4 @@ weight: 4000 - [一个现有的 AKS 集群](https://learn.microsoft.com/azure/aks/tutorial-kubernetes-deploy-cluster) - [Azure Kubernetes Service RBAC管理员角色](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#azure-kubernetes-service-rbac-admin) -{{< button text="了解更多关于 Dapr 扩展的 AKS" link="https\://learn.microsoft.com/azure/aks/dapr" >}} +{{< button text="了解更多关于 Dapr 扩展的 AKS" link="https://learn.microsoft.com/azure/aks/dapr" >}} diff --git a/src/translated_content/zh_CN/docs/developing-applications/local-development/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md b/src/translated_content/zh_CN/docs/developing-applications/local-development/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md index a5ffd9f8c..ec12b2781 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/local-development/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md +++ b/src/translated_content/zh_CN/docs/developing-applications/local-development/ides/vscode/vscode-how-to-debug-multiple-dapr-apps.md @@ -167,30 +167,30 @@ dapr run --app-id nodeapp --app-port 3000 --dapr-http-port 3500 app.js 以下是VS Code任务所支持的参数。 这些参数与 `daprd` 的参数等效，详见[此参考]({{< ref arguments-annotations-overview.md >}})： -| 参数 | 说明 | 必填 | 如何使用Dapr扩展来开发和运行Dapr应用程序 | -| ---------------------- | ------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------- | -| `allowedOrigins` | 允许的HTTP来源（默认为 "\*"）。 | No | `"allowedOrigins": "*"` | -| `appId` | 应用程序唯一 ID。 用于服务发现、状态封装 和 发布/订阅 消费者ID | Yes | `"appId": "divideapp"` | -| `appMaxConcurrency` | 限制应用程序的并发量。 有效的数值是大于 0 | No | `"appMaxConcurrency": -1` | -| `appPort` | 这个参数告诉Dapr你的应用程序正在监听哪个端口。 | Yes | `"appPort": 4000` | -| `appProtocol` | 告诉 Dapr 你的应用程序正在使用哪种协议。 有效的选项是 `http`，`grpc`，`https`，`grpcs`，`h2c`。 默认值为`http`。 | No | `"appProtocol": "http"` | +| 参数 | 说明 | 必填 | 如何使用Dapr扩展来开发和运行Dapr应用程序 | +| ---------------------- | ------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------ | +| `allowedOrigins` | 允许的HTTP来源（默认为 "\*"）。 | No | `"allowedOrigins": "*"` | +| `appId` | 应用程序唯一 ID。 用于服务发现、状态封装 和 发布/订阅 消费者ID | Yes | `"appId": "divideapp"` | +| `appMaxConcurrency` | 限制应用程序的并发量。 有效的数值是大于 0 | No | `"appMaxConcurrency": -1` | +| `appPort` | 这个参数告诉Dapr你的应用程序正在监听哪个端口。 | Yes | `"appPort": 4000` | +| `appProtocol` | 告诉 Dapr 你的应用程序正在使用哪种协议。 有效的选项是 `http`，`grpc`，`https`，`grpcs`，`h2c`。 默认值为`http`。 | No | `"appProtocol": "http"` | | `args` | 设置要传递给 Dapr 应用的参数列表 | No | "args": [] | -| `componentsPath` | Components 目录的路径. 如果为空，将不会加载组件。 | No | `"componentsPath": "./components"` | -| `config` | 告诉 Dapr 要使用哪个配置资源 | No | `"config": "./config"` | -| `controlPlaneAddress` | Dapr 控制平面的地址 | No | `"controlPlaneAddress": "http://localhost:1366/"` | -| `enableProfiling` | 启用性能分析 | No | `"enableProfiling": false` | -| `enableMtls` | 为 daprd 到 daprd 通信通道启用自动 mTLS | No | `"enableMtls": false` | -| `grpcPort` | dapr API要监听的gRPC端口（默认为 "50001"）。 | 是，如果有多个应用 | `"grpcPort": 50004` | -| `httpPort` | Dapr API 的 HTTP 端口 | Yes | `"httpPort": 3502` | -| `internalGrpcPort` | 用于监听 Dapr 内部 API 的 gRPC 端口 | No | `"internalGrpcPort": 50001` | -| `logAsJson` | 将此参数设置为true以JSON格式输出日志。 默认为 false | No | `"logAsJson": false` | -| `logLevel` | 为 Dapr sidecar设置日志级别。 允许的值是debug, info, warn, error。 默认为info | No | `"logLevel": "debug"` | -| `metricsPort` | 设置 sidecar 度量服务器的端口。 默认值为 9090。 | 是，如果有多个应用 | `"metricsPort": 9093` | -| `mode` | Dapr 的运行时模式（默认"独立"） | No | `"mode": "standalone"` | -| `placementHostAddress` | Dapr Actor Placement 服务器的地址 | No | `"placementHostAddress": "http://localhost:1313/"` | -| `profilePort` | 配置文件服务器端口(默认 "7777”) | No | `"profilePort": 7777` | -| `sentryAddress` | Sentry CA 服务地址 | No | `"sentryAddress": "http://localhost:1345/"` | -| `类型` | 告诉VS Code它将是一个daprd任务类型 | Yes | `"type": "daprd"` | +| `componentsPath` | Components 目录的路径. 如果为空，将不会加载组件。 | No | `"componentsPath": "./components"` | +| `config` | 告诉 Dapr 要使用哪个配置资源 | No | `"config": "./config"` | +| `controlPlaneAddress` | Dapr 控制平面的地址 | No | `"controlPlaneAddress": "http://localhost:1366/"` | +| `enableProfiling` | 启用性能分析 | No | `"enableProfiling": false` | +| `enableMtls` | 为 daprd 到 daprd 通信通道启用自动 mTLS | No | `"enableMtls": false` | +| `grpcPort` | dapr API要监听的gRPC端口（默认为 "50001"）。 | 是，如果有多个应用 | `"grpcPort": 50004` | +| `httpPort` | Dapr API 的 HTTP 端口 | Yes | `"httpPort": 3502` | +| `internalGrpcPort` | 用于监听 Dapr 内部 API 的 gRPC 端口 | No | `"internalGrpcPort": 50001` | +| `logAsJson` | 将此参数设置为true以JSON格式输出日志。 默认为 false | No | `"logAsJson": false` | +| `logLevel` | 为 Dapr sidecar设置日志级别。 允许的值是debug, info, warn, error。 默认为info | No | `"logLevel": "debug"` | +| `metricsPort` | 设置 sidecar 度量服务器的端口。 默认值为 9090。 | 是，如果有多个应用 | `"metricsPort": 9093` | +| `mode` | Dapr 的运行时模式（默认"独立"） | No | `"mode": "standalone"` | +| `placementHostAddress` | Dapr Actor Placement 服务器的地址 | No | `"placementHostAddress": "http://localhost:1313/"` | +| `profilePort` | 配置文件服务器端口(默认 "7777”) | No | `"profilePort": 7777` | +| `sentryAddress` | Sentry CA 服务地址 | No | `"sentryAddress": "http://localhost:1345/"` | +| `类型` | 告诉VS Code它将是一个daprd任务类型 | Yes | `"type": "daprd"` | ## 相关链接 diff --git a/src/translated_content/zh_CN/docs/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md b/src/translated_content/zh_CN/docs/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md index 034f7642f..75e073ce7 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md +++ b/src/translated_content/zh_CN/docs/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md @@ -236,7 +236,7 @@ apps: | ------------------------ | :-: | ---------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ----------- | | `appDirPath` | 是 | 应用代码的路径 | `./webapp/`, `./backend/` | | | `appID` | 否 | 应用程序的应用程序 ID。 如果未提供，将从`appDirPath`派生 | `webapp`, `backend` | | -| `resourcesPath` | 否 | **Deprecated**. Dapr 资源的路径。 可以按照惯例设置为默认值 | `./app/components`, `./webapp/components` | | +| `resourcesPath` | 否 | **Deprecated**. Dapr 资源的路径。 可以按照惯例设置为默认值 | `./app/components`, `./webapp/components` | | | `resourcesPaths` | 否 | 逗号分隔的 Dapr 资源路径。 可以按照惯例设置为默认值 | `./app/components`, `./webapp/components` | | | `appChannelAddress` | 否 | 应用程序监听的网络地址。 可以按照惯例设置为默认值。 | `127.0.0.1` | `localhost` | | `configFilePath` | 否 | 应用程序配置文件的路径 | `./webapp/config.yaml` | | diff --git a/src/translated_content/zh_CN/docs/developing-applications/sdks/_index.md b/src/translated_content/zh_CN/docs/developing-applications/sdks/_index.md index 239c8bcb5..3f14badad 100644 --- a/src/translated_content/zh_CN/docs/developing-applications/sdks/_index.md +++ b/src/translated_content/zh_CN/docs/developing-applications/sdks/_index.md @@ -20,16 +20,16 @@ Dapr SDK 是将 Dapr 应用到您的应用程序中最简单的方法。 选择 ## SDK 语言 -| 语言 | 状态 | Client | 服务扩展 | Actor | Workflow | -| --------------------------------------------------------------------------------------------------- | :------------- | :----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---: | :------: | -| [.NET]({{< ref dotnet >}}) | 已发布 | ✔ | [ASP.NET Core](https://github.com/dapr/dotnet-sdk/tree/master/examples/AspNetCore) | ✔ | ✔ | -| [Python]({{< ref python >}}) | 已发布 | ✔ | [gRPC]({{< ref python-grpc.md >}})
[FastAPI]({{< ref python-fastapi.md >}})
[Flask]({{< ref python-flask.md >}}) | ✔ | ✔ | -| [Java]({{< ref java >}}) | 已发布 | ✔ | Spring Boot | ✔ | | -| [前往]({{< ref go >}}) | 已发布 | ✔ | ✔ | ✔ | | -| [PHP]({{< ref php >}}) | 已发布 | ✔ | ✔ | ✔ | | -| [Javascript]({{< ref js >}}) | 已发布 | ✔ | | ✔ | | -| [C++](https://github.com/dapr/cpp-sdk) | In development | ✔ | | | | -| [Rust](https://github.com/dapr/rust-sdk) | In development | ✔ | | | | +| 语言 | 状态 | Client | 服务扩展 | Actor | Workflow | +| ----------------------------------------------------------------------------------------------------------------- | :------------- | :----: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---: | :------: | +| [.NET]({{< ref dotnet >}}) | 已发布 | ✔ | [ASP.NET Core](https://github.com/dapr/dotnet-sdk/tree/master/examples/AspNetCore) | ✔ | ✔ | +| [Python]({{< ref python >}}) | 已发布 | ✔ | [gRPC]({{< ref python-grpc.md >}})
[FastAPI]({{< ref python-fastapi.md >}})
[Flask]({{< ref python-flask.md >}}) | ✔ | ✔ | +| [Java]({{< ref java >}}) | 已发布 | ✔ | Spring Boot | ✔ | | +| [前往]({{< ref go >}}) | 已发布 | ✔ | ✔ | ✔ | | +| [PHP]({{< ref php >}}) | 已发布 | ✔ | ✔ | ✔ | | +| [Javascript]({{< ref js >}}) | 已发布 | ✔ | | ✔ | | +| [C++](https://github.com/dapr/cpp-sdk) | In development | ✔ | | | | +| [Rust](https://github.com/dapr/rust-sdk) | In development | ✔ | | | | ## 深入阅读 diff --git a/src/translated_content/zh_CN/docs/getting-started/quickstarts/_index.md b/src/translated_content/zh_CN/docs/getting-started/quickstarts/_index.md index 3d2645d49..bdcd00d50 100644 --- a/src/translated_content/zh_CN/docs/getting-started/quickstarts/_index.md +++ b/src/translated_content/zh_CN/docs/getting-started/quickstarts/_index.md @@ -20,8 +20,8 @@ no_list: true ## 快速入门 -| 快速入门 | 说明 | -| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | +| 快速入门 | 说明 | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | | [发布和订阅]({{< ref pubsub-quickstart.md >}}) | 使用消息传递实现两个服务之间的异步通信。 | | [服务调用]({{< ref serviceinvocation-quickstart.md >}}) | 使用HTTP或gRPC进行两个服务之间的同步通信。 | | [状态管理]({{< ref statemanagement-quickstart.md >}}) | 在支持的状态存储中将服务的数据存储为键/值对。 | @@ -29,6 +29,6 @@ no_list: true | [Actors概述]({{< ref actors-quickstart.md >}}) | 运行一个微服务和一个简单的控制台客户端，以演示 Dapr Actors 中的有状态对象模式。 | | [秘密管理]({{< ref secrets-quickstart.md >}}) | 安全地获取密钥。 | | [Dapr配置]({{< ref configuration-quickstart.md >}}) | 获取配置项并订阅配置更新。 | -| [弹性]({{< ref resiliency >}}) | 定义并应用容错策略到你的 Dapr API 请求。 | +| [弹性]({{< ref resiliency >}}) | 定义并应用容错策略到你的 Dapr API 请求。 | | [工作流程]({{< ref workflow-quickstart.md >}}) | 在长时间运行、容错、有状态的应用程序中编排业务工作流活动。 | | [密码学]({{< ref cryptography-quickstart.md >}}) | 使用 Dapr 的加密 API 对数据进行加密和解密。 | diff --git a/src/translated_content/zh_CN/docs/getting-started/tutorials/_index.md b/src/translated_content/zh_CN/docs/getting-started/tutorials/_index.md index b2d53514c..09fd662af 100644 --- a/src/translated_content/zh_CN/docs/getting-started/tutorials/_index.md +++ b/src/translated_content/zh_CN/docs/getting-started/tutorials/_index.md @@ -18,10 +18,10 @@ no_list: true 感谢我们庞大的Dapr社区，我们在Dapr Docs和我们的[GitHub仓库](https://github.com/dapr/quickstarts)上提供教程。 -| Dapr 文档教程 | 说明 | -| -------------------------------------------------------------------------------------------------------------------------- | --------------------------- | -| [定义一个组件]({{< ref get-started-component.md >}}) | 创建组件定义文件以与 Secrets 构建块进行交互。 | -| [配置状态和发布/订阅]({{< ref configure-state-pubsub.md >}}) | 为 Dapr 配置状态存储和发布/订阅消息代理组件. | +| Dapr 文档教程 | 说明 | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | +| [定义一个组件]({{< ref get-started-component.md >}}) | 创建组件定义文件以与 Secrets 构建块进行交互。 | +| [配置状态和发布/订阅]({{< ref configure-state-pubsub.md >}}) | 为 Dapr 配置状态存储和发布/订阅消息代理组件. | | GitHub 教程 | 说明 | | ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | diff --git a/src/translated_content/zh_CN/docs/operations/configuration/api-allowlist.md b/src/translated_content/zh_CN/docs/operations/configuration/api-allowlist.md index 53d103f5b..d89d4889e 100644 --- a/src/translated_content/zh_CN/docs/operations/configuration/api-allowlist.md +++ b/src/translated_content/zh_CN/docs/operations/configuration/api-allowlist.md @@ -114,8 +114,8 @@ The `name` field takes the name of the Dapr API you would like to enable. See this list of values corresponding to the different Dapr APIs: -| API group | HTTP API | [gRPC API](https://github.com/dapr/dapr/blob/master/pkg/grpc/endpoints.go) | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| API group | HTTP API | [gRPC API](https://github.com/dapr/dapr/blob/master/pkg/grpc/endpoints.go) | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | [Service Invocation]({{< ref service_invocation_api.md >}}) | `invoke` (`v1.0`) | `invoke` (`v1`) | | [State]({{< ref state_api.md>}}) | `state` (`v1.0` and `v1.0-alpha1`) | `state` (`v1` and `v1alpha1`) | | [Pub/Sub]({{< ref pubsub.md >}}) | `publish` (`v1.0` and `v1.0-alpha1`) | `publish` (`v1` and `v1alpha1`) | @@ -125,7 +125,7 @@ See this list of values corresponding to the different Dapr APIs: | [Metadata]({{< ref metadata_api.md >}}) | `metadata` (`v1.0`) | `metadata` (`v1`) | | [Configuration]({{< ref configuration_api.md >}}) | `configuration` (`v1.0` and `v1.0-alpha1`) | `configuration` (`v1` and `v1alpha1`) | | [Distributed Lock]({{< ref distributed_lock_api.md >}}) | `lock` (`v1.0-alpha1`)
`unlock` (`v1.0-alpha1`) | `lock` (`v1alpha1`)
`unlock` (`v1alpha1`) | -| Cryptography | `crypto` (`v1.0-alpha1`) | `crypto` (`v1alpha1`) | +| Cryptography | `crypto` (`v1.0-alpha1`) | `crypto` (`v1alpha1`) | | [Workflow]({{< ref workflow_api.md >}}) | `workflows` (`v1.0-alpha1`) | `workflows` (`v1alpha1`) | | [Health]({{< ref health_api.md >}}) | `healthz` (`v1.0`) | n/a | -| Shutdown | `shutdown` (`v1.0`) | `shutdown` (`v1`) | +| Shutdown | `shutdown` (`v1.0`) | `shutdown` (`v1`) | diff --git a/src/translated_content/zh_CN/docs/operations/configuration/configuration-overview.md b/src/translated_content/zh_CN/docs/operations/configuration/configuration-overview.md index 0b18c17c6..e390ec3f3 100644 --- a/src/translated_content/zh_CN/docs/operations/configuration/configuration-overview.md +++ b/src/translated_content/zh_CN/docs/operations/configuration/configuration-overview.md @@ -77,7 +77,7 @@ The following table lists the properties for tracing: | Property | Type | Description | | ------------------------ | ------ | --------------------------------------------------------------------------------- | -| `samplingRate` | string | Set sampling rate for tracing to be enabled or disabled. | +| `samplingRate` | string | Set sampling rate for tracing to be enabled or disabled. | | `stdout` | bool | True write more verbose information to the traces | | `otel.endpointAddress` | string | Set the Open Telemetry (OTEL) server address to send traces to | | `otel.isSecure` | bool | Is the connection to the endpoint address encrypted | @@ -114,10 +114,10 @@ metrics: The following table lists the properties for metrics: -| Property | Type | Description | -| --------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | boolean | When set to true, the default, enables metrics collection and the metrics endpoint. | -| `rules` | array | Named rule to filter metrics. Each rule contains a set of `labels` to filter on and a `regex` expression to apply to the metrics path. | +| Property | Type | Description | +| --------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enabled` | boolean | When set to true, the default, enables metrics collection and the metrics endpoint. | +| `rules` | array | Named rule to filter metrics. Each rule contains a set of `labels` to filter on and a `regex` expression to apply to the metrics path. | | `http.increasedCardinality` | boolean | When set to true, in the Dapr HTTP server each request path causes the creation of a new "bucket" of metrics. This can cause issues, including excessive memory consumption, when there many different requested endpoints (such as when interacting with RESTful APIs).
In Dapr 1.13 the default value is `true` (to preserve the behavior of Dapr <= 1.12), but will change to `false` in Dapr 1.14. | To mitigate high memory usage and egress costs associated with [high cardinality metrics]({{< ref "metrics-overview.md#high-cardinality-metrics" >}}) with the HTTP server, you should set the `metrics.http.increasedCardinality` property to `false`. @@ -153,11 +153,11 @@ logging: The following table lists the properties for logging: -| Property | Type | Description | -| ----------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Property | Type | Description | +| ----------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `apiLogging.enabled` | boolean | The default value for the `--enable-api-logging` flag for `daprd` (and the corresponding `dapr.io/enable-api-logging` annotation): the value set in the Configuration spec is used as default unless a `true` or `false` value is passed to each Dapr Runtime. Default: `false`. | -| `apiLogging.obfuscateURLs` | boolean | When enabled, obfuscates the values of URLs in HTTP API logs (if enabled), logging the abstract route name rather than the full path being invoked, which could contain Personal Identifiable Information (PII). Default: `false`. | -| `apiLogging.omitHealthChecks` | boolean | If `true`, calls to health check endpoints (e.g. `/v1.0/healthz`) are not logged when API logging is enabled. This is useful if those calls are adding a lot of noise in your logs. Default: `false` | +| `apiLogging.obfuscateURLs` | boolean | When enabled, obfuscates the values of URLs in HTTP API logs (if enabled), logging the abstract route name rather than the full path being invoked, which could contain Personal Identifiable Information (PII). Default: `false`. | +| `apiLogging.omitHealthChecks` | boolean | If `true`, calls to health check endpoints (e.g. `/v1.0/healthz`) are not logged when API logging is enabled. This is useful if those calls are adding a lot of noise in your logs. Default: `false` | See [logging documentation]({{< ref "logs.md" >}}) for more information. @@ -314,14 +314,14 @@ A Dapr control plane configuration contains the following sections: The `mtls` section contains properties for mTLS. -| Property | Type | Description | -| ------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `enabled` | bool | If true, enables mTLS for communication between services and apps in the cluster. | +| Property | Type | Description | +| ------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `enabled` | bool | If true, enables mTLS for communication between services and apps in the cluster. | | `allowedClockSkew` | string | Allowed tolerance when checking the expiration of TLS certificates, to allow for clock skew. Follows the format used by [Go's time.ParseDuration](https://pkg.go.dev/time#ParseDuration). Default is `15m` (15 minutes). | | `workloadCertTTL` | string | How long a certificate TLS issued by Dapr is valid for. Follows the format used by [Go's time.ParseDuration](https://pkg.go.dev/time#ParseDuration). Default is `24h` (24 hours). | -| `sentryAddress` | string | Hostname port address for connecting to the Sentry server. | -| `controlPlaneTrustDomain` | string | Trust domain for the control plane. This is used to verify connection to control plane services. | -| `tokenValidators` | array | Additional Sentry token validators to use for authenticating certificate requests. | +| `sentryAddress` | string | Hostname port address for connecting to the Sentry server. | +| `controlPlaneTrustDomain` | string | Trust domain for the control plane. This is used to verify connection to control plane services. | +| `tokenValidators` | array | Additional Sentry token validators to use for authenticating certificate requests. | See the [mTLS how-to]({{< ref "mtls.md" >}}) and [security concepts]({{< ref "security-concept.md" >}}) for more information. diff --git a/src/translated_content/zh_CN/docs/operations/configuration/install-certificates.md b/src/translated_content/zh_CN/docs/operations/configuration/install-certificates.md index dd291ce71..17c5fb3b6 100644 --- a/src/translated_content/zh_CN/docs/operations/configuration/install-certificates.md +++ b/src/translated_content/zh_CN/docs/operations/configuration/install-certificates.md @@ -93,7 +93,7 @@ spec: All the certificates in the directory pointed by `SSL_CERT_DIR` are installed. -1. On Linux containers, all the certificate extensions supported by OpenSSL are supported. For more information, see https\://www\.openssl.org/docs/man1.1.1/man1/openssl-rehash.html +1. On Linux containers, all the certificate extensions supported by OpenSSL are supported. For more information, see https://www.openssl.org/docs/man1.1.1/man1/openssl-rehash.html 2. On Windows container, all the certificate extensions supported by certoc.exe are supported. For more information, see certoc.exe present in [Windows Server Core](https://hub.docker.com/_/microsoft-windows-servercore) ## Example diff --git a/src/translated_content/zh_CN/docs/operations/configuration/invoke-allowlist.md b/src/translated_content/zh_CN/docs/operations/configuration/invoke-allowlist.md index d05f8d821..7c99e349d 100644 --- a/src/translated_content/zh_CN/docs/operations/configuration/invoke-allowlist.md +++ b/src/translated_content/zh_CN/docs/operations/configuration/invoke-allowlist.md @@ -22,29 +22,29 @@ The following tables lists the different properties for access control, policies ### Access Control -| Property | Type | Description | -| ------------- | ------ | ------------------------------------------------------------------------------ | -| defaultAction | string | Global default action when no other policy is matched | -| trustDomain | string | Trust domain assigned to the application. Default is "public". | -| policies | string | Policies to determine what operations the calling app can do on the called app | +| Property | Type | Description | +| ------------- | ------ | ---------------------------------------------------------------------------------------------- | +| defaultAction | string | Global default action when no other policy is matched | +| trustDomain | string | Trust domain assigned to the application. Default is "public". | +| policies | string | Policies to determine what operations the calling app can do on the called app | ### Policies -| Property | Type | Description | -| ------------- | ------ | --------------------------------------------------------------------------------------------------- | -| app | string | AppId of the calling app to allow/deny service invocation from | -| namespace | string | Namespace value that needs to be matched with the namespace of the calling app | +| Property | Type | Description | +| ------------- | ------ | ------------------------------------------------------------------------------------------------------------------- | +| app | string | AppId of the calling app to allow/deny service invocation from | +| namespace | string | Namespace value that needs to be matched with the namespace of the calling app | | trustDomain | string | Trust domain that needs to be matched with the trust domain of the calling app. Default is "public" | -| defaultAction | string | App level default action in case the app is found but no specific operation is matched | -| operations | string | operations that are allowed from the calling app | +| defaultAction | string | App level default action in case the app is found but no specific operation is matched | +| operations | string | operations that are allowed from the calling app | ### Operations -| Property | Type | Description | -| -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Property | Type | Description | +| -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name | string | Path name of the operations allowed on the called app. Wildcard "\*" can be used in a path to match. Wildcard "\*\*" can be used to match under multiple paths. | | httpVerb | list | List specific http verbs that can be used by the calling app. Wildcard "\*" can be used to match any http verb. Unused for grpc invocation. | -| action | string | Access modifier. Accepted values "allow" (default) or "deny" | +| action | string | Access modifier. Accepted values "allow" (default) or "deny" | ## Policy rules diff --git a/src/translated_content/zh_CN/docs/operations/configuration/secret-scope.md b/src/translated_content/zh_CN/docs/operations/configuration/secret-scope.md index 972039f26..7b2021c7a 100644 --- a/src/translated_content/zh_CN/docs/operations/configuration/secret-scope.md +++ b/src/translated_content/zh_CN/docs/operations/configuration/secret-scope.md @@ -27,12 +27,12 @@ secrets: The following table lists the properties for secret scopes: -| Property | Type | Description | -| --------- | ------ | ------------------------------------------------------------------------------- | +| Property | Type | Description | +| --------- | ------ | ----------------------------------------------------------------------------------------------- | | storeName | string | Name of the secret store component. storeName must be unique within the list | | 默认权限 | string | Access modifier. Accepted values "allow" (default) or "deny" | -| 允许的密钥 | list | List of secret keys that can be accessed | -| 被拒绝的密钥 | list | List of secret keys that cannot be accessed | +| 允许的密钥 | list | List of secret keys that can be accessed | +| 被拒绝的密钥 | list | List of secret keys that cannot be accessed | When an `allowedSecrets` list is present with at least one element, only those secrets defined in the list can be accessed by the application. diff --git a/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-overview.md b/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-overview.md index c48a6b55c..c9943fd0f 100644 --- a/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-overview.md +++ b/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-overview.md @@ -8,12 +8,12 @@ description: Overview of how to get Dapr running on your Kubernetes cluster Dapr can be configured to run on any supported versions of Kubernetes. To achieve this, Dapr begins by deploying the following Kubernetes services, which provide first-class integration to make running applications with Dapr easy. -| Kubernetes services | Description | -| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Kubernetes services | Description | +| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dapr-operator` | Manages [component]({{< ref components >}}) updates and Kubernetes services endpoints for Dapr (state stores, pub/subs, etc.) | | `dapr-sidecar-injector` | Injects Dapr into [annotated](#adding-dapr-to-a-kubernetes-deployment) deployment pods and adds the environment variables `DAPR_HTTP_PORT` and `DAPR_GRPC_PORT` to enable user-defined applications to easily communicate with Dapr without hard-coding Dapr port values. | | `dapr-placement` | Used for [actors]({{< ref actors >}}) only. Creates mapping tables that map actor instances to pods | -| `dapr-sentry` | Manages mTLS between services and acts as a certificate authority. For more information read the [security overview]({{< ref "security-concept.md" >}}) | +| `dapr-sentry` | Manages mTLS between services and acts as a certificate authority. For more information read the [security overview]({{< ref "security-concept.md" >}}) | diff --git a/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-production.md b/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-production.md index 6a42d816a..7a817fe8a 100644 --- a/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-production.md +++ b/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-production.md @@ -12,8 +12,8 @@ Dapr support for Kubernetes is aligned with [Kubernetes Version Skew Policy](htt Use the following resource settings as a starting point. Requirements vary depending on cluster size, number of pods, and other factors. Perform individual testing to find the right values for your environment. -| Deployment | CPU | Memory | -| -------------------- | ------------------------- | ---------------------------- | +| Deployment | CPU | Memory | +| -------------------- | --------------------------------------------------------- | ------------------------------------------------------------ | | **Operator** | Limit: 1, Request: 100m | Limit: 200Mi, Request: 100Mi | | **Sidecar Injector** | Limit: 1, Request: 100m | Limit: 200Mi, Request: 30Mi | | **Sentry** | Limit: 1, Request: 100m | Limit: 200Mi, Request: 30Mi | @@ -53,8 +53,8 @@ If not set, the Dapr sidecar runs without resource settings, which may lead to i Example settings for the Dapr sidecar in a production-ready setup: -| CPU | Memory | -| -------------------------- | ----------------------------- | +| CPU | Memory | +| ---------------------------------------------------------- | ------------------------------------------------------------- | | Limit: 300m, Request: 100m | Limit: 1000Mi, Request: 250Mi | The CPU and memory limits above account for Dapr supporting a high number of I/O bound operations. Use a [monitoring tool]({{< ref observability >}}) to get a baseline for the sidecar (and app) containers and tune these settings based on those baselines. diff --git a/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-volume-mounts.md b/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-volume-mounts.md index 9d4a718fe..56b5638de 100644 --- a/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-volume-mounts.md +++ b/src/translated_content/zh_CN/docs/operations/hosting/kubernetes/kubernetes-volume-mounts.md @@ -25,8 +25,8 @@ Within the official container images, Dapr runs as a process with user ID (UID) Although you can mount a Volume in any folder within the Dapr sidecar container, prevent conflicts and ensure smooth operations going forward by placing all mountpoints within one of the following locations, or in a subfolder within them: -| Location | Description | -| -------- | ------------------------------------------------------------------------------------------------------- | +| Location | Description | +| -------- | ----------------------------------------------------------------------------------------------------------------------- | | `/mnt` | Recommended for Volumes containing persistent data that the Dapr sidecar process can read and/or write. | | `/tmp` | Recommended for Volumes containing temporary data, such as scratch disks. | diff --git a/src/translated_content/zh_CN/docs/operations/hosting/serverless/azure-container-apps/index.md b/src/translated_content/zh_CN/docs/operations/hosting/serverless/azure-container-apps/index.md index 6f0019fb2..1d824cf63 100644 --- a/src/translated_content/zh_CN/docs/operations/hosting/serverless/azure-container-apps/index.md +++ b/src/translated_content/zh_CN/docs/operations/hosting/serverless/azure-container-apps/index.md @@ -9,7 +9,7 @@ description: "Learn how to run your Dapr applications on the Azure Container App Dapr is built-in to Container Apps, enabling you to use the Dapr API building blocks without any manual deployment of the Dapr runtime. You simply deploy your services with their Dapr components. -{{< button text="Learn more" link="https\://docs.microsoft.com/azure/container-apps/overview" newtab="true" >}} +{{< button text="Learn more" link="https://docs.microsoft.com/azure/container-apps/overview" newtab="true" >}} ## Tutorial @@ -17,4 +17,4 @@ Visit the [Azure docs](https://docs.microsoft.com/azure/container-apps/microserv Diagram of a Container Apps environment with two Dapr services -{{< button text="Try out Dapr on Container Apps" link="https\://docs.microsoft.com/azure/container-apps/microservices-dapr" newtab="true" >}} +{{< button text="Try out Dapr on Container Apps" link="https://docs.microsoft.com/azure/container-apps/microservices-dapr" newtab="true" >}} diff --git a/src/translated_content/zh_CN/docs/operations/observability/logging/newrelic.md b/src/translated_content/zh_CN/docs/operations/observability/logging/newrelic.md index 412777392..eb240c219 100644 --- a/src/translated_content/zh_CN/docs/operations/observability/logging/newrelic.md +++ b/src/translated_content/zh_CN/docs/operations/observability/logging/newrelic.md @@ -36,7 +36,7 @@ This document explains how to install it in your cluster, either using a Helm ch helm install newrelic/newrelic-logging --name newrelic-logging --set licenseKey=YOUR_LICENSE_KEY ``` -For EU users, add \`--set endpoint=https\://log-api.eu.newrelic.com/log/v1 to any of the helm install commands above. +For EU users, add \`--set endpoint=https://log-api.eu.newrelic.com/log/v1 to any of the helm install commands above. By default, tailing is set to /var/log/containers/\*.log. To change this setting, provide your preferred path by adding --set fluentBit.path=DESIRED_PATH to any of the helm install commands above. @@ -52,7 +52,7 @@ By default, tailing is set to /var/log/containers/\*.log. To change this setting 2. In the downloaded new-relic-fluent-plugin.yml file, replace the placeholder value LICENSE_KEY with your New Relic license key. - For EU users, replace the ENDPOINT environment variable to https\://log-api.eu.newrelic.com/log/v1. + For EU users, replace the ENDPOINT environment variable to https://log-api.eu.newrelic.com/log/v1. 3. Once the License key has been added, run the following command in your terminal or command-line interface: ```bash diff --git a/src/translated_content/zh_CN/docs/operations/observability/tracing/setup-tracing.md b/src/translated_content/zh_CN/docs/operations/observability/tracing/setup-tracing.md index 6ef4754f1..d57bf4388 100644 --- a/src/translated_content/zh_CN/docs/operations/observability/tracing/setup-tracing.md +++ b/src/translated_content/zh_CN/docs/operations/observability/tracing/setup-tracing.md @@ -27,13 +27,13 @@ spec: The following table lists the properties for tracing: -| Property | Type | Description | -| ------------------------ | ------ | ---------------------------------------------------------------------------------------------- | -| `samplingRate` | string | Set sampling rate for tracing to be enabled or disabled. | -| `stdout` | bool | True write more verbose information to the traces | -| `otel.endpointAddress` | string | Set the Open Telemetry (OTEL) server address. | -| `otel.isSecure` | bool | Is the connection to the endpoint address encrypted. | -| `otel.protocol` | string | Set to `http` or `grpc` protocol. | +| Property | Type | Description | +| ------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `samplingRate` | string | Set sampling rate for tracing to be enabled or disabled. | +| `stdout` | bool | True write more verbose information to the traces | +| `otel.endpointAddress` | string | Set the Open Telemetry (OTEL) server address. | +| `otel.isSecure` | bool | Is the connection to the endpoint address encrypted. | +| `otel.protocol` | string | Set to `http` or `grpc` protocol. | | `zipkin.endpointAddress` | string | Set the Zipkin server address. If this is used, you do not need to specify the `otel` section. | To enable tracing, use a configuration file (in self hosted mode) or a Kubernetes configuration object (in Kubernetes mode). For example, the following configuration object changes the sample rate to 1 (every span is sampled), and sends trace using OTEL protocol to the OTEL server at localhost:4317 diff --git a/src/translated_content/zh_CN/docs/operations/observability/tracing/zipkin.md b/src/translated_content/zh_CN/docs/operations/observability/tracing/zipkin.md index c239d35ff..c88aca358 100644 --- a/src/translated_content/zh_CN/docs/operations/observability/tracing/zipkin.md +++ b/src/translated_content/zh_CN/docs/operations/observability/tracing/zipkin.md @@ -43,7 +43,7 @@ dapr run --app-id mynode --app-port 3000 node app.js ### Viewing Traces -To view traces, in your browser go to http\://localhost:9411 and you will see the Zipkin UI. +To view traces, in your browser go to http://localhost:9411 and you will see the Zipkin UI. ## Configure Kubernetes diff --git a/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-actors-activation.md b/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-actors-activation.md index cd6813751..6b7ebd090 100644 --- a/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-actors-activation.md +++ b/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-actors-activation.md @@ -45,11 +45,11 @@ Test parameters: ### Results -- The actual throughput was \~500 qps. -- The tp90 latency was \~3ms. -- The tp99 latency was \~6.2ms. -- Dapr app consumed \~523m CPU and \~304.7Mb of Memory -- Dapr sidecar consumed 2m CPU and \~18.2Mb of Memory +- The actual throughput was ~500 qps. +- The tp90 latency was ~3ms. +- The tp99 latency was ~6.2ms. +- Dapr app consumed ~523m CPU and ~304.7Mb of Memory +- Dapr sidecar consumed 2m CPU and ~18.2Mb of Memory - No app restarts - No sidecar restarts diff --git a/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-service-invocation.md b/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-service-invocation.md index 2c9a5491e..e4493c191 100644 --- a/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-service-invocation.md +++ b/src/translated_content/zh_CN/docs/operations/performance-and-scalability/perf-service-invocation.md @@ -56,10 +56,10 @@ The baseline test included direct, non-encrypted traffic, without telemetry, dir ### Control plane performance The Dapr control plane uses a total of 0.009 vCPU and 61.6 Mb when running in non-HA mode, meaning a single replica per system component. -When running in a highly available production setup, the Dapr control plane consumes \~0.02 vCPU and 185 Mb. +When running in a highly available production setup, the Dapr control plane consumes ~0.02 vCPU and 185 Mb. -| Component | vCPU | Memory | -| ---------------- | ----- | ------- | +| Component | vCPU | Memory | +| ---------------- | --------------------- | ----------------------- | | Operator | 0.001 | 12.5 Mb | | Sentry | 0.005 | 13.6 Mb | | Sidecar Injector | 0.002 | 14.6 Mb | @@ -77,7 +77,7 @@ There are a number of variants that affect the CPU and memory consumption for ea ### Data plane performance The Dapr sidecar uses 0.48 vCPU and 23Mb per 1000 requests per second. -End-to-end, the Dapr sidecars (client and server) add \~1.40 ms to the 90th percentile latency, and \~2.10 ms to the 99th percentile latency. End-to-end here is a call from one app to another app receiving a response. This is shown by steps 1-7 in [this diagram]({{< ref service-invocation-overview.md >}}). +End-to-end, the Dapr sidecars (client and server) add ~1.40 ms to the 90th percentile latency, and ~2.10 ms to the 99th percentile latency. End-to-end here is a call from one app to another app receiving a response. This is shown by steps 1-7 in [this diagram]({{< ref service-invocation-overview.md >}}). This performance is on par or better than commonly used service meshes. diff --git a/src/translated_content/zh_CN/docs/operations/resiliency/health-checks/app-health.md b/src/translated_content/zh_CN/docs/operations/resiliency/health-checks/app-health.md index 22e36b75b..fb961200c 100644 --- a/src/translated_content/zh_CN/docs/operations/resiliency/health-checks/app-health.md +++ b/src/translated_content/zh_CN/docs/operations/resiliency/health-checks/app-health.md @@ -57,9 +57,9 @@ Adding this flag is both necessary and sufficient to enable app health checks wi The full list of options are listed in this table: -| CLI flags | Kubernetes deployment annotation | Description | Default value | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -| `--enable-app-health-check` | `dapr.io/enable-app-health-check` | Boolean that enables the health checks | Disabled | +| CLI flags | Kubernetes deployment annotation | Description | Default value | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | +| `--enable-app-health-check` | `dapr.io/enable-app-health-check` | Boolean that enables the health checks | Disabled | | [`--app-health-check-path`]({{< ref "app-health.md#health-check-paths" >}}) | `dapr.io/app-health-check-path` | Path that Dapr invokes for health probes when the app channel is HTTP (this value is ignored if the app channel is using gRPC) | `/healthz` | | [`--app-health-probe-interval`]({{< ref "app-health.md#intervals-timeouts-and-thresholds" >}}) | `dapr.io/app-health-probe-interval` | Number of _seconds_ between each health probe | `5` | | [`--app-health-probe-timeout`]({{< ref "app-health.md#intervals-timeouts-and-thresholds" >}}) | `dapr.io/app-health-probe-timeout` | Timeout in _milliseconds_ for health probe requests | `500` | @@ -69,8 +69,8 @@ The full list of options are listed in this table: Additionally, app health checks are impacted by the protocol used for the app channel, which is configured with the following flag or annotation: -| CLI flag | Kubernetes deployment annotation | Description | Default value | -| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------- | +| CLI flag | Kubernetes deployment annotation | Description | Default value | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | | [`--app-protocol`]({{< ref "app-health.md#health-check-paths" >}}) | `dapr.io/app-protocol` | Protocol used for the app channel. supported values are `http`, `grpc`, `https`, `grpcs`, and `h2c` (HTTP/2 Cleartext). | `http` | {{% alert title="Note" color="primary" %}} diff --git a/src/translated_content/zh_CN/docs/operations/resiliency/policies.md b/src/translated_content/zh_CN/docs/operations/resiliency/policies.md index 559f52203..fa1d029eb 100644 --- a/src/translated_content/zh_CN/docs/operations/resiliency/policies.md +++ b/src/translated_content/zh_CN/docs/operations/resiliency/policies.md @@ -37,10 +37,10 @@ If you don't specify a timeout value, the policy does not enforce a time and def With `retries`, you can define a retry strategy for failed operations, including requests failed due to triggering a defined timeout or circuit breaker policy. The following retry options are configurable: -| Retry option | Description | -| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Retry option | Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `policy` | Determines the back-off and retry interval strategy. Valid values are `constant` and `exponential`.
Defaults to `constant`. | -| `duration` | Determines the time interval between retries. Only applies to the `constant` policy.
Valid values are of the form `200ms`, `15s`, `2m`, etc.
Defaults to `5s`. | +| `duration` | Determines the time interval between retries. Only applies to the `constant` policy.
Valid values are of the form `200ms`, `15s`, `2m`, etc.
Defaults to `5s`. | | `maxInterval` | Determines the maximum interval between retries to which the `exponential` back-off policy can grow.
Additional retries always occur after a duration of `maxInterval`. Defaults to `60s`. Valid values are of the form `5s`, `1m`, `1m30s`, etc | | `maxRetries` | The maximum number of retries to attempt.
`-1` denotes an unlimited number of retries, while `0` means the request will not be retried (essentially behaving as if the retry policy were not set).
Defaults to `-1`. | @@ -75,11 +75,11 @@ spec: Circuit Breaker (CB) policies are used when other applications/services/components are experiencing elevated failure rates. CBs monitor the requests and shut off all traffic to the impacted service when a certain criteria is met ("open" state). By doing this, CBs give the service time to recover from their outage instead of flooding it with events. The CB can also allow partial traffic through to see if the system has healed ("half-open" state). Once requests resume being successful, the CB gets into "closed" state and allows traffic to completely resume. -| Retry option | Description | -| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `maxRequests` | The maximum number of requests allowed to pass through when the CB is half-open (recovering from failure). Defaults to `1`. | +| Retry option | Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `maxRequests` | The maximum number of requests allowed to pass through when the CB is half-open (recovering from failure). Defaults to `1`. | | `interval` | The cyclical period of time used by the CB to clear its internal counts. If set to 0 seconds, this never clears. Defaults to `0s`. | -| `timeout` | The period of the open state (directly after failure) until the CB switches to half-open. Defaults to `60s`. | +| `timeout` | The period of the open state (directly after failure) until the CB switches to half-open. Defaults to `60s`. | | `trip` | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) statement that is evaluated by the CB. When the statement evaluates to true, the CB trips and becomes open. Defaults to `consecutiveFailures > 5`. | Example: @@ -103,11 +103,11 @@ Dapr provides default retries for any unsuccessful request, such as failures and Below is a table that describes Dapr's default retries and the policy keywords to override them: -| Capability | Override Keyword | Default Retry Behavior | Description | -| ---------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 服务调用 | DaprBuiltInServiceRetries | Per call retries are performed with a backoff interval of 1 second, up to a threshold of 3 times. | Sidecar-to-sidecar requests (a service invocation method call) that fail and result in a gRPC code `Unavailable` or `Unauthenticated` | -| Actors | DaprBuiltInActorRetries | Per call retries are performed with a backoff interval of 1 second, up to a threshold of 3 times. | Sidecar-to-sidecar requests (an actor method call) that fail and result in a gRPC code `Unavailable` or `Unauthenticated` | -| Actor Reminders | DaprBuiltInActorReminderRetries | Per call retries are performed with an exponential backoff with an initial interval of 500ms, up to a maximum of 60s for a duration of 15mins | Requests that fail to persist an actor reminder to a state store | +| Capability | Override Keyword | Default Retry Behavior | Description | +| ---------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 服务调用 | DaprBuiltInServiceRetries | Per call retries are performed with a backoff interval of 1 second, up to a threshold of 3 times. | Sidecar-to-sidecar requests (a service invocation method call) that fail and result in a gRPC code `Unavailable` or `Unauthenticated` | +| Actors | DaprBuiltInActorRetries | Per call retries are performed with a backoff interval of 1 second, up to a threshold of 3 times. | Sidecar-to-sidecar requests (an actor method call) that fail and result in a gRPC code `Unavailable` or `Unauthenticated` | +| Actor Reminders | DaprBuiltInActorReminderRetries | Per call retries are performed with an exponential backoff with an initial interval of 500ms, up to a maximum of 60s for a duration of 15mins | Requests that fail to persist an actor reminder to a state store | | Initialization Retries | DaprBuiltInInitializationRetries | Per call retries are performed 3 times with an exponential backoff, an initial interval of 500ms and for a duration of 10s | Failures when making a request to an application to retrieve a given spec. For example, failure to retrieve a subscription, component or resiliency specification | The resiliency spec example below shows overriding the default retries for _all_ service invocation requests by using the reserved, named keyword 'DaprBuiltInServiceRetries'. @@ -146,8 +146,8 @@ If these policies are defined, they are used for every operation to a service, a Below is a table of all possible default policy keywords and how they translate into a policy name. -| Keyword | Target Operation | Example Policy Name | -| -------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------- | +| Keyword | Target Operation | Example Policy Name | +| -------------------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | `App` | Service invocation. | `DefaultAppRetryPolicy` | | `Actor` | Actor invocation. | `DefaultActorTimeoutPolicy` | | `Component` | All component operations. | `DefaultComponentCircuitBreakerPolicy` | diff --git a/src/translated_content/zh_CN/docs/operations/security/oauth.md b/src/translated_content/zh_CN/docs/operations/security/oauth.md index 89845aa72..788851484 100644 --- a/src/translated_content/zh_CN/docs/operations/security/oauth.md +++ b/src/translated_content/zh_CN/docs/operations/security/oauth.md @@ -40,12 +40,12 @@ Authorization/Token URLs of some of the popular authorization servers: -| Server | Authorization URL | Token URL | -| ------------------ | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | -| Microsoft Entra ID | https\://login.microsoftonline.com/{tenant}/oauth2/authorize | https\://login.microsoftonline.com/{tenant}/oauth2/token | -| GitHub | https\://github.com/login/oauth/authorize | https\://github.com/login/oauth/access_token | -| 谷歌 | https\://accounts.google.com/o/oauth2/v2/auth | https\://accounts.google.com/o/oauth2/token https\://www\.googleapis.com/oauth2/v4/token | -| Twitter | https\://api.twitter.com/oauth/authorize | https\://api.twitter.com/oauth2/token | +| Server | Authorization URL | Token URL | +| ------------------ | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Microsoft Entra ID | https://login.microsoftonline.com/{tenant}/oauth2/authorize | https://login.microsoftonline.com/{tenant}/oauth2/token | +| GitHub | https://github.com/login/oauth/authorize | https://github.com/login/oauth/access_token | +| 谷歌 | https://accounts.google.com/o/oauth2/v2/auth | https://accounts.google.com/o/oauth2/token https://www.googleapis.com/oauth2/v4/token | +| Twitter | https://api.twitter.com/oauth/authorize | https://api.twitter.com/oauth2/token | diff --git a/src/translated_content/zh_CN/docs/operations/support/alpha-beta-apis.md b/src/translated_content/zh_CN/docs/operations/support/alpha-beta-apis.md index 97d749766..7ceabbff6 100644 --- a/src/translated_content/zh_CN/docs/operations/support/alpha-beta-apis.md +++ b/src/translated_content/zh_CN/docs/operations/support/alpha-beta-apis.md @@ -8,19 +8,19 @@ description: List of current alpha and beta APIs ## Alpha APIs -| Building block/API | gRPC | HTTP | Description | Documentation | Version introduced | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -| Query State | [Query State proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L44) | `v1.0-alpha1/state/statestore/query` | The state query API enables you to retrieve, filter, and sort the key/value data stored in state store components. | [Query State API]({{< ref "howto-state-query-api.md" >}}) | v1.5 | -| 分布式锁 | [Lock proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L112) | `/v1.0-alpha1/lock` | The distributed lock API enables you to take a lock on a resource. | [Distributed Lock API]({{< ref "distributed-lock-api-overview.md" >}}) | v1.8 | -| 批量发布 | [Bulk publish proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L59) | `v1.0-alpha1/publish/bulk` | 批量发布API允许您在单个请求中发布多条消息到一个主题。 | [Bulk Publish and Subscribe API]({{< ref "pubsub-bulk.md" >}}) | v1.10 | -| 批量订阅 | [Bulk subscribe proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/appcallback.proto#L57) | N/A | The bulk subscribe application callback receives multiple messages from a topic in a single call. | [Bulk Publish and Subscribe API]({{< ref "pubsub-bulk.md" >}}) | v1.10 | -| Cryptography | [Crypto proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L118) | `v1.0-alpha1/crypto` | The cryptography API enables you to perform **high level** cryptography operations for encrypting and decrypting messages. | [Cryptography API]({{< ref "cryptography-overview.md" >}}) | v1.11 | +| Building block/API | gRPC | HTTP | Description | Documentation | Version introduced | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | +| Query State | [Query State proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L44) | `v1.0-alpha1/state/statestore/query` | The state query API enables you to retrieve, filter, and sort the key/value data stored in state store components. | [Query State API]({{< ref "howto-state-query-api.md" >}}) | v1.5 | +| 分布式锁 | [Lock proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L112) | `/v1.0-alpha1/lock` | The distributed lock API enables you to take a lock on a resource. | [Distributed Lock API]({{< ref "distributed-lock-api-overview.md" >}}) | v1.8 | +| 批量发布 | [Bulk publish proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L59) | `v1.0-alpha1/publish/bulk` | 批量发布API允许您在单个请求中发布多条消息到一个主题。 | [Bulk Publish and Subscribe API]({{< ref "pubsub-bulk.md" >}}) | v1.10 | +| 批量订阅 | [Bulk subscribe proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/appcallback.proto#L57) | N/A | The bulk subscribe application callback receives multiple messages from a topic in a single call. | [Bulk Publish and Subscribe API]({{< ref "pubsub-bulk.md" >}}) | v1.10 | +| Cryptography | [Crypto proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L118) | `v1.0-alpha1/crypto` | The cryptography API enables you to perform **high level** cryptography operations for encrypting and decrypting messages. | [Cryptography API]({{< ref "cryptography-overview.md" >}}) | v1.11 | ## Beta APIs -| Building block/API | gRPC | HTTP | Description | Documentation | Version introduced | -| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------ | -| Workflow | [Workflow proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L151) | `/v1.0-beta1/workflow` | The workflow API enables you to define long running, persistent processes or data flows. | [Workflow API]({{< ref "workflow-overview.md" >}}) | v1.10 | +| Building block/API | gRPC | HTTP | Description | Documentation | Version introduced | +| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | +| Workflow | [Workflow proto](https://github.com/dapr/dapr/blob/5aba3c9aa4ea9b3f388df125f9c66495b43c5c9e/dapr/proto/runtime/v1/dapr.proto#L151) | `/v1.0-beta1/workflow` | The workflow API enables you to define long running, persistent processes or data flows. | [Workflow API]({{< ref "workflow-overview.md" >}}) | v1.10 | ## Related links diff --git a/src/translated_content/zh_CN/docs/operations/support/breaking-changes-and-deprecations.md b/src/translated_content/zh_CN/docs/operations/support/breaking-changes-and-deprecations.md index 3a415570e..c425537e6 100644 --- a/src/translated_content/zh_CN/docs/operations/support/breaking-changes-and-deprecations.md +++ b/src/translated_content/zh_CN/docs/operations/support/breaking-changes-and-deprecations.md @@ -57,16 +57,16 @@ After announcing a future breaking change, the change will happen in 2 releases ## Announced deprecations -| Feature | Deprecation announcement | Removal | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -------------- | -| GET /v1.0/shutdown API (Users should use [POST API]({{< ref kubernetes-job.md >}}) instead) | 1.2.0 | 1.4.0 | -| Java domain builder classes deprecated (Users should use [setters](https://github.com/dapr/java-sdk/issues/587) instead) | Java SDK 1.3.0 | Java SDK 1.5.0 | -| Service invocation will no longer provide a default content type header of `application/json` when no content-type is specified. You must explicitly [set a content-type header]({{< ref "service_invocation_api.md#request-contents" >}}) for service invocation if your invoked apps rely on this header. | 1.7.0 | 1.9.0 | -| gRPC service invocation using `invoke` method is deprecated. Use proxy mode service invocation instead. See [How-To: Invoke services using gRPC ]({{< ref howto-invoke-services-grpc.md >}}) to use the proxy mode. | 1.9.0 | 1.10.0 | -| The CLI flag `--app-ssl` (in both the Dapr CLI and daprd) has been deprecated in favor of using `--app-protocol` with values `https` or `grpcs`. [daprd:6158](https://github.com/dapr/dapr/issues/6158) [cli:1267](https://github.com/dapr/cli/issues/1267) | 1.11.0 | 1.13.0 | -| Hazelcast PubSub Component | 1.9.0 | 1.11.0 | -| Twitter Binding Component | 1.10.0 | 1.11.0 | -| NATS Streaming PubSub Component | 1.11.0 | 1.13.0 | +| Feature | Deprecation announcement | Removal | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | +| GET /v1.0/shutdown API (Users should use [POST API]({{< ref kubernetes-job.md >}}) instead) | 1.2.0 | 1.4.0 | +| Java domain builder classes deprecated (Users should use [setters](https://github.com/dapr/java-sdk/issues/587) instead) | Java SDK 1.3.0 | Java SDK 1.5.0 | +| Service invocation will no longer provide a default content type header of `application/json` when no content-type is specified. You must explicitly [set a content-type header]({{< ref "service_invocation_api.md#request-contents" >}}) for service invocation if your invoked apps rely on this header. | 1.7.0 | 1.9.0 | +| gRPC service invocation using `invoke` method is deprecated. Use proxy mode service invocation instead. See [How-To: Invoke services using gRPC ]({{< ref howto-invoke-services-grpc.md >}}) to use the proxy mode. | 1.9.0 | 1.10.0 | +| The CLI flag `--app-ssl` (in both the Dapr CLI and daprd) has been deprecated in favor of using `--app-protocol` with values `https` or `grpcs`. [daprd:6158](https://github.com/dapr/dapr/issues/6158) [cli:1267](https://github.com/dapr/cli/issues/1267) | 1.11.0 | 1.13.0 | +| Hazelcast PubSub Component | 1.9.0 | 1.11.0 | +| Twitter Binding Component | 1.10.0 | 1.11.0 | +| NATS Streaming PubSub Component | 1.11.0 | 1.13.0 | ## Related links diff --git a/src/translated_content/zh_CN/docs/operations/support/support-preview-features.md b/src/translated_content/zh_CN/docs/operations/support/support-preview-features.md index 270ed7df5..e149a9cc9 100644 --- a/src/translated_content/zh_CN/docs/operations/support/support-preview-features.md +++ b/src/translated_content/zh_CN/docs/operations/support/support-preview-features.md @@ -14,13 +14,13 @@ For CLI there is no explicit opt-in, just the version that this was first made a ## Current preview features -| Feature | Description | Setting | Documentation | Version introduced | -| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -| **Pluggable components** | Allows creating self-hosted gRPC-based components written in any language that supports gRPC. The following component APIs are supported: State stores, Pub/sub, Bindings | N/A | [Pluggable components concept]({{\}}) | v1.9 | -| **Multi-App Run for Kubernetes** | Configure multiple Dapr applications from a single configuration file and run from a single command on Kubernetes | `dapr run -k -f` | [Multi-App Run]({{< ref multi-app-dapr-run.md >}}) | v1.12 | -| **Workflows** | Author workflows as code to automate and orchestrate tasks within your application, like messaging, state management, and failure handling | N/A | [Workflows concept]({{< ref "components-concept#workflows" >}}) | v1.10 | -| **Cryptography** | Encrypt or decrypt data without having to manage secrets keys | N/A | [Cryptography concept]({{< ref "components-concept#cryptography" >}}) | v1.11 | -| **Service invocation for non-Dapr endpoints** | Allow the invocation of non-Dapr endpoints by Dapr using the [Service invocation API]({{< ref service_invocation_api.md >}}). Read ["How-To: Invoke Non-Dapr Endpoints using HTTP"]({{< ref howto-invoke-non-dapr-endpoints.md >}}) for more information. | N/A | [服务调用API]({{< ref service_invocation_api.md >}}) | v1.11 | -| **Actor State TTL** | Allow actors to save records to state stores with Time To Live (TTL) set to automatically clean up old data. In its current implementation, actor state with TTL may not be reflected correctly by clients, read [Actor State Transactions]({{< ref actors_api.md >}}) for more information. | `ActorStateTTL` | [Actor State Transactions]({{< ref actors_api.md >}}) | v1.11 | -| **Transactional Outbox** | Allows state operations for inserts and updates to be published to a configured pub/sub topic using a single transaction across the state store and the pub/sub | N/A | [Transactional Outbox Feature]({{< ref howto-outbox.md >}}) | v1.12 | -| **Component Hot Reloading** | Allows for Dapr-loaded components to be "hot reloaded". A component spec is reloaded when it is created/updated/deleted in Kubernetes or on file when running in self-hosted mode. Ignores changes to actor state stores and workflow backends. | `HotReload` | [Hot Reloading]({{< ref components-concept.md >}}) | v1.13 | +| Feature | Description | Setting | Documentation | Version introduced | +| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | +| **Pluggable components** | Allows creating self-hosted gRPC-based components written in any language that supports gRPC. The following component APIs are supported: State stores, Pub/sub, Bindings | N/A | [Pluggable components concept]({{\}}) | v1.9 | +| **Multi-App Run for Kubernetes** | Configure multiple Dapr applications from a single configuration file and run from a single command on Kubernetes | `dapr run -k -f` | [Multi-App Run]({{< ref multi-app-dapr-run.md >}}) | v1.12 | +| **Workflows** | Author workflows as code to automate and orchestrate tasks within your application, like messaging, state management, and failure handling | N/A | [Workflows concept]({{< ref "components-concept#workflows" >}}) | v1.10 | +| **Cryptography** | Encrypt or decrypt data without having to manage secrets keys | N/A | [Cryptography concept]({{< ref "components-concept#cryptography" >}}) | v1.11 | +| **Service invocation for non-Dapr endpoints** | Allow the invocation of non-Dapr endpoints by Dapr using the [Service invocation API]({{< ref service_invocation_api.md >}}). Read ["How-To: Invoke Non-Dapr Endpoints using HTTP"]({{< ref howto-invoke-non-dapr-endpoints.md >}}) for more information. | N/A | [服务调用API]({{< ref service_invocation_api.md >}}) | v1.11 | +| **Actor State TTL** | Allow actors to save records to state stores with Time To Live (TTL) set to automatically clean up old data. In its current implementation, actor state with TTL may not be reflected correctly by clients, read [Actor State Transactions]({{< ref actors_api.md >}}) for more information. | `ActorStateTTL` | [Actor State Transactions]({{< ref actors_api.md >}}) | v1.11 | +| **Transactional Outbox** | Allows state operations for inserts and updates to be published to a configured pub/sub topic using a single transaction across the state store and the pub/sub | N/A | [Transactional Outbox Feature]({{< ref howto-outbox.md >}}) | v1.12 | +| **Component Hot Reloading** | Allows for Dapr-loaded components to be "hot reloaded". A component spec is reloaded when it is created/updated/deleted in Kubernetes or on file when running in self-hosted mode. Ignores changes to actor state stores and workflow backends. | `HotReload` | [Hot Reloading]({{< ref components-concept.md >}}) | v1.13 | diff --git a/src/translated_content/zh_CN/docs/operations/support/support-release-policy.md b/src/translated_content/zh_CN/docs/operations/support/support-release-policy.md index 02e282d4b..faafadd1c 100644 --- a/src/translated_content/zh_CN/docs/operations/support/support-release-policy.md +++ b/src/translated_content/zh_CN/docs/operations/support/support-release-policy.md @@ -12,11 +12,11 @@ This topic details the supported versions of Dapr releases, the upgrade policies Dapr releases use `MAJOR.MINOR.PATCH` versioning. For example, 1.0.0. -| Versioning | Description | -| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Versioning | Description | +| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `MAJOR` | Updated when there’s a non-backward compatible change to the runtime, such as an API change. A `MAJOR` release can also occur then there is a considered a significant addition/change of functionality that needs to differentiate from the previous version. | -| `MINOR` | Updated as part of the regular release cadence, including new features, bug, and security fixes. | -| `PATCH` | Incremented for a critical issue (P0) and security hot fixes. | +| `MINOR` | Updated as part of the regular release cadence, including new features, bug, and security fixes. | +| `PATCH` | Incremented for a critical issue (P0) and security hot fixes. | A supported release means: @@ -44,54 +44,54 @@ Learn more about [Dapr components' certification lifecycle]({{< ref "certificati The table below shows the versions of Dapr releases that have been tested together and form a "packaged" release. Any other combinations of releases are not supported. -| Release date | Runtime | CLI | SDKs | Dashboard | Status | Release notes | -| ------------------ | :----------: | :----- | ------------------------------------------------------------------------------------------- | --------- | -------------------------------------- | -------------------------------------------------------------------------- | -| March 6th 2024 | 1.13.0
| 1.13.0 | Java 1.11.0
Go 1.10.0
PHP 1.2.0
Python 1.13.0
.NET 1.13.0
JS 3.3.0 | 0.14.0 | Supported (current) | [v1.13.0 release notes](https://github.com/dapr/dapr/releases/tag/v1.13.0) | -| January 17th 2024 | 1.12.4
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported (current) | [v1.12.4 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.4) | -| January 2nd 2024 | 1.12.3
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported (current) | [v1.12.3 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.3) | -| November 18th 2023 | 1.12.2
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported (current) | [v1.12.2 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.2) | -| November 16th 2023 | 1.12.1
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported | [v1.12.1 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.1) | -| October 11th 2023 | 1.12.0
| 1.12.0 | Java 1.10.0
Go 1.9.0
PHP 1.1.0
Python 1.11.0
.NET 1.12.0
JS 3.1.2 | 0.14.0 | Supported | [v1.12.0 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.0) | -| November 18th 2023 | 1.11.6
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.6 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.6) | -| November 3rd 2023 | 1.11.5
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.5 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.5) | -| October 5th 2023 | 1.11.4
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.4 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.4) | -| August 31st 2023 | 1.11.3
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.3 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.3) | -| July 20th 2023 | 1.11.2
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.2 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.2) | -| June 22nd 2023 | 1.11.1
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.1 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.1) | -| June 12th 2023 | 1.11.0
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.0 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.0) | -| November 18th 2023 | 1.10.10
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | -| July 20th 2023 | 1.10.9
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | -| June 22nd 2023 | 1.10.8
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | -| May 15th 2023 | 1.10.7
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | -| May 12th 2023 | 1.10.6
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | -| April 13 2023 | 1.10.5
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | -| March 16 2023 | 1.10.4
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | -| March 14 2023 | 1.10.3
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | -| February 24 2023 | 1.10.2
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | -| February 20 2023 | 1.10.1
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | -| February 14 2023 | 1.10.0
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | -| December 2nd 2022 | 1.9.5
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | -| November 17th 2022 | 1.9.4
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | -| November 4th 2022 | 1.9.3
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | -| November 1st 2022 | 1.9.2
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.1
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | -| October 26th 2022 | 1.9.1
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.1
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | -| October 13th 2022 | 1.9.0
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | -| October 26th 2022 | 1.8.6
| 1.8.1 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | -| October 13th 2022 | 1.8.5
| 1.8.1 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | -| August 10th 2022 | 1.8.4
| 1.8.1 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | -| July 29th 2022 | 1.8.3
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | -| July 21st 2022 | 1.8.2
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | -| July 20th 2022 | 1.8.1
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | -| July 7th 2022 | 1.8.0
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | -| October 26th 2022 | 1.7.5
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.2.1 | 0.10.0 | Unsupported | | -| May 31st 2022 | 1.7.4
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.2.1 | 0.10.0 | Unsupported | | -| May 17th 2022 | 1.7.3
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.2.1 | 0.10.0 | Unsupported | | -| Apr 22th 2022 | 1.7.2
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.1.0 | 0.10.0 | Unsupported | | -| Apr 20th 2022 | 1.7.1
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.1.0 | 0.10.0 | Unsupported | | -| Apr 7th 2022 | 1.7.0
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.1.0 | 0.10.0 | Unsupported | | -| Apr 20th 2022 | 1.6.2
| 1.6.0 | Java 1.4.0
Go 1.3.1
PHP 1.1.0
Python 1.5.0
.NET 1.6.0
JS 2.0.0 | 0.9.0 | Unsupported | | -| Mar 25th 2022 | 1.6.1
| 1.6.0 | Java 1.4.0
Go 1.3.1
PHP 1.1.0
Python 1.5.0
.NET 1.6.0
JS 2.0.0 | 0.9.0 | Unsupported | | -| Jan 25th 2022 | 1.6.0
| 1.6.0 | Java 1.4.0
Go 1.3.1
PHP 1.1.0
Python 1.5.0
.NET 1.6.0
JS 2.0.0 | 0.9.0 | Unsupported | | +| Release date | Runtime | CLI | SDKs | Dashboard | Status | Release notes | +| ------------------ | :------------------------------------------: | :------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| March 6th 2024 | 1.13.0
| 1.13.0 | Java 1.11.0
Go 1.10.0
PHP 1.2.0
Python 1.13.0
.NET 1.13.0
JS 3.3.0 | 0.14.0 | Supported (current) | [v1.13.0 release notes](https://github.com/dapr/dapr/releases/tag/v1.13.0) | +| January 17th 2024 | 1.12.4
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported (current) | [v1.12.4 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.4) | +| January 2nd 2024 | 1.12.3
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported (current) | [v1.12.3 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.3) | +| November 18th 2023 | 1.12.2
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported (current) | [v1.12.2 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.2) | +| November 16th 2023 | 1.12.1
| 1.12.0 | Java 1.10.0
Go 1.9.1
PHP 1.2.0
Python 1.12.0
.NET 1.12.0
JS 3.2.0 | 0.14.0 | Supported | [v1.12.1 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.1) | +| October 11th 2023 | 1.12.0
| 1.12.0 | Java 1.10.0
Go 1.9.0
PHP 1.1.0
Python 1.11.0
.NET 1.12.0
JS 3.1.2 | 0.14.0 | Supported | [v1.12.0 release notes](https://github.com/dapr/dapr/releases/tag/v1.12.0) | +| November 18th 2023 | 1.11.6
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.6 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.6) | +| November 3rd 2023 | 1.11.5
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.5 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.5) | +| October 5th 2023 | 1.11.4
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.4 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.4) | +| August 31st 2023 | 1.11.3
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.3 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.3) | +| July 20th 2023 | 1.11.2
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.2 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.2) | +| June 22nd 2023 | 1.11.1
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.1 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.1) | +| June 12th 2023 | 1.11.0
| 1.11.0 | Java 1.9.0
Go 1.8.0
PHP 1.1.0
Python 1.10.0
.NET 1.11.0
JS 3.1.0 | 0.13.0 | Supported | [v1.11.0 release notes](https://github.com/dapr/dapr/releases/tag/v1.11.0) | +| November 18th 2023 | 1.10.10
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | +| July 20th 2023 | 1.10.9
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | +| June 22nd 2023 | 1.10.8
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | +| May 15th 2023 | 1.10.7
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | +| May 12th 2023 | 1.10.6
| 1.10.0 | Java 1.8.0
Go 1.7.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | +| April 13 2023 | 1.10.5
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 3.0.0 | 0.11.0 | Unsupported | | +| March 16 2023 | 1.10.4
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | +| March 14 2023 | 1.10.3
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | +| February 24 2023 | 1.10.2
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | +| February 20 2023 | 1.10.1
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | +| February 14 2023 | 1.10.0
| 1.10.0 | Java 1.8.0
Go 1.6.0
PHP 1.1.0
Python 1.9.0
.NET 1.10.0
JS 2.5.0 | 0.11.0 | Unsupported | | +| December 2nd 2022 | 1.9.5
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | +| November 17th 2022 | 1.9.4
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | +| November 4th 2022 | 1.9.3
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | +| November 1st 2022 | 1.9.2
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.1
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | +| October 26th 2022 | 1.9.1
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.1
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | +| October 13th 2022 | 1.9.0
| 1.9.1 | Java 1.7.0
Go 1.6.0
PHP 1.1.0
Python 1.8.3
.NET 1.9.0
JS 2.4.2 | 0.11.0 | Unsupported | | +| October 26th 2022 | 1.8.6
| 1.8.1 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | +| October 13th 2022 | 1.8.5
| 1.8.1 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | +| August 10th 2022 | 1.8.4
| 1.8.1 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | +| July 29th 2022 | 1.8.3
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | +| July 21st 2022 | 1.8.2
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | +| July 20th 2022 | 1.8.1
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | +| July 7th 2022 | 1.8.0
| 1.8.0 | Java 1.6.0
Go 1.5.0
PHP 1.1.0
Python 1.7.0
.NET 1.8.0
JS 2.3.0 | 0.11.0 | Unsupported | | +| October 26th 2022 | 1.7.5
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.2.1 | 0.10.0 | Unsupported | | +| May 31st 2022 | 1.7.4
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.2.1 | 0.10.0 | Unsupported | | +| May 17th 2022 | 1.7.3
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.2.1 | 0.10.0 | Unsupported | | +| Apr 22th 2022 | 1.7.2
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.1.0 | 0.10.0 | Unsupported | | +| Apr 20th 2022 | 1.7.1
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.1.0 | 0.10.0 | Unsupported | | +| Apr 7th 2022 | 1.7.0
| 1.7.0 | Java 1.5.0
Go 1.4.0
PHP 1.1.0
Python 1.6.0
.NET 1.7.0
JS 2.1.0 | 0.10.0 | Unsupported | | +| Apr 20th 2022 | 1.6.2
| 1.6.0 | Java 1.4.0
Go 1.3.1
PHP 1.1.0
Python 1.5.0
.NET 1.6.0
JS 2.0.0 | 0.9.0 | Unsupported | | +| Mar 25th 2022 | 1.6.1
| 1.6.0 | Java 1.4.0
Go 1.3.1
PHP 1.1.0
Python 1.5.0
.NET 1.6.0
JS 2.0.0 | 0.9.0 | Unsupported | | +| Jan 25th 2022 | 1.6.0
| 1.6.0 | Java 1.4.0
Go 1.3.1
PHP 1.1.0
Python 1.5.0
.NET 1.6.0
JS 2.0.0 | 0.9.0 | Unsupported | | ## SDK compatibility @@ -115,27 +115,27 @@ The table below shows the tested upgrade paths for the Dapr runtime. Any other c General guidance on upgrading can be found for [self hosted mode]({{< ref self-hosted-upgrade >}}) and [Kubernetes]({{< ref kubernetes-upgrade >}}) deployments. It is best to review the target version release notes for specific guidance. -| Current Runtime version | Must upgrade through | Target Runtime version | -| ----------------------- | -------------------- | ---------------------- | -| 1.5.0 to 1.5.2 | N/A | 1.6.0 | -| | 1.6.0 | 1.6.2 | -| | 1.6.2 | 1.7.5 | -| | 1.7.5 | 1.8.6 | -| | 1.8.6 | 1.9.6 | -| | 1.9.6 | 1.10.7 | -| 1.6.0 to 1.6.2 | N/A | 1.7.5 | -| | 1.7.5 | 1.8.6 | -| | 1.8.6 | 1.9.6 | -| | 1.9.6 | 1.10.7 | -| 1.7.0 to 1.7.5 | N/A | 1.8.6 | -| | 1.8.6 | 1.9.6 | -| | 1.9.6 | 1.10.7 | -| 1.8.0 to 1.8.6 | N/A | 1.9.6 | -| 1.9.0 | N/A | 1.9.6 | -| 1.10.0 | N/A | 1.10.8 | -| 1.11.0 | N/A | 1.11.4 | -| 1.12.0 | N/A | 1.12.4 | -| 1.13.0 | N/A | 1.13.0 | +| Current Runtime version | Must upgrade through | Target Runtime version | +| ------------------------------------------------------------------------------ | ------------------------------------- | -------------------------------------- | +| 1.5.0 to 1.5.2 | N/A | 1.6.0 | +| | 1.6.0 | 1.6.2 | +| | 1.6.2 | 1.7.5 | +| | 1.7.5 | 1.8.6 | +| | 1.8.6 | 1.9.6 | +| | 1.9.6 | 1.10.7 | +| 1.6.0 to 1.6.2 | N/A | 1.7.5 | +| | 1.7.5 | 1.8.6 | +| | 1.8.6 | 1.9.6 | +| | 1.9.6 | 1.10.7 | +| 1.7.0 to 1.7.5 | N/A | 1.8.6 | +| | 1.8.6 | 1.9.6 | +| | 1.9.6 | 1.10.7 | +| 1.8.0 to 1.8.6 | N/A | 1.9.6 | +| 1.9.0 | N/A | 1.9.6 | +| 1.10.0 | N/A | 1.10.8 | +| 1.11.0 | N/A | 1.11.4 | +| 1.12.0 | N/A | 1.12.4 | +| 1.13.0 | N/A | 1.13.0 | ## Upgrade on Hosting platforms @@ -148,8 +148,8 @@ Below is a list of software that the latest version of Dapr (v{{% dapr-latest-ve | Dependency | Supported Version | | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | | Kubernetes | Dapr support for Kubernetes is aligned with [Kubernetes Version Skew Policy](https://kubernetes.io/releases/version-skew-policy/) | -| [Open Telemetry collector (OTEL)](https://github.com/open-telemetry/opentelemetry-collector/releases) | v0.4.0 | -| [Prometheus](https://prometheus.io/download/) | v2.28 | +| [Open Telemetry collector (OTEL)](https://github.com/open-telemetry/opentelemetry-collector/releases) | v0.4.0 | +| [Prometheus](https://prometheus.io/download/) | v2.28 | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/api/actors_api.md b/src/translated_content/zh_CN/docs/reference/api/actors_api.md index cb579b10a..f0425ddb2 100644 --- a/src/translated_content/zh_CN/docs/reference/api/actors_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/actors_api.md @@ -31,8 +31,8 @@ POST/GET/PUT/DELETE http://localhost:/v1.0/actors///v1.0/actors///state #### URL Parameters -| Parameter | Description | -| ----------- | --------------- | +| Parameter | Description | +| ----------- | ------------------------------- | | `daprPort` | The Dapr port. | | `actorType` | The actor type. | | `actorId` | The actor ID. | @@ -161,8 +161,8 @@ GET http://localhost:/v1.0/actors///state/ #### URL Parameters -| Parameter | Description | -| ----------- | ---------------------------- | +| Parameter | Description | +| ----------- | -------------------------------------------- | | `daprPort` | The Dapr port. | | `actorType` | The actor type. | | `actorId` | The actor ID. | @@ -199,9 +199,9 @@ POST/PUT http://localhost:/v1.0/actors///reminders A JSON object with the following fields: -| Field | Description | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `dueTime` | Specifies the time after which the reminder is invoked. Its format should be [time.ParseDuration](https://pkg.go.dev/time#ParseDuration) | +| Field | Description | +| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `dueTime` | Specifies the time after which the reminder is invoked. Its format should be [time.ParseDuration](https://pkg.go.dev/time#ParseDuration) | | `period` | Specifies the period between different invocations. Its format should be [time.ParseDuration](https://pkg.go.dev/time#ParseDuration) or ISO 8601 duration format with optional recurrence. | `period` field supports `time.Duration` format and ISO 8601 format with some limitations. For `period`, only duration format of ISO 8601 duration `Rn/PnYnMnWnDTnHnMnS` is supported. `Rn/` specifies that the reminder will be invoked `n` number of times. @@ -248,8 +248,8 @@ To configure the reminder to fire only once, the period should be set to empty s #### URL Parameters -| Parameter | Description | -| ----------- | ----------------------------------- | +| Parameter | Description | +| ----------- | --------------------------------------------------- | | `daprPort` | The Dapr port. | | `actorType` | The actor type. | | `actorId` | The actor ID. | @@ -288,8 +288,8 @@ GET http://localhost:/v1.0/actors///reminders//v1.0/actors///reminders/< #### URL Parameters -| Parameter | Description | -| ----------- | ----------------------------------- | +| Parameter | Description | +| ----------- | --------------------------------------------------- | | `daprPort` | The Dapr port. | | `actorType` | The actor type. | | `actorId` | The actor ID. | @@ -391,8 +391,8 @@ A `dueTime` of 0 means to fire immediately. The following body means to fire im #### URL Parameters -| Parameter | Description | -| ----------- | -------------------------------- | +| Parameter | Description | +| ----------- | ------------------------------------------------ | | `daprPort` | The Dapr port. | | `actorType` | The actor type. | | `actorId` | The actor ID. | @@ -432,8 +432,8 @@ DELETE http://localhost:/v1.0/actors///timers//dapr/config #### URL Parameters -| Parameter | Description | -| --------- | --------------------- | +| Parameter | Description | +| --------- | ------------------------------------- | | `appPort` | The application port. | #### 示例 @@ -482,17 +482,17 @@ curl -X GET http://localhost:3000/dapr/config \ The above command returns the config (all fields are optional): -| Parameter | Description | -| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `entities` | The actor types this app supports. | -| `actorIdleTimeout` | Specifies how long to wait before deactivating an idle actor. An actor is idle if no actor method calls and no reminders have fired on it. | -| `actorScanInterval` | A duration which specifies how often to scan for actors to deactivate idle actors. Actors that have been idle longer than the actorIdleTimeout will be deactivated. | +| Parameter | Description | +| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `entities` | The actor types this app supports. | +| `actorIdleTimeout` | Specifies how long to wait before deactivating an idle actor. An actor is idle if no actor method calls and no reminders have fired on it. | +| `actorScanInterval` | A duration which specifies how often to scan for actors to deactivate idle actors. Actors that have been idle longer than the actorIdleTimeout will be deactivated. | | `drainOngoingCallTimeout` | A duration used when in the process of draining rebalanced actors. This specifies how long to wait for the current active actor method to finish. If there is no current actor method call, this is ignored. | | `drainRebalancedActors` | A bool. If true, Dapr will wait for `drainOngoingCallTimeout` to allow a current actor call to complete before trying to deactivate an actor. If false, do not wait. | -| `reentrancy` | A configuration object that holds the options for actor reentrancy. | -| `enabled` | A flag in the reentrancy configuration that is needed to enable reentrancy. | -| `maxStackDepth` | A value in the reentrancy configuration that controls how many reentrant calls be made to the same actor. | -| `entitiesConfig` | Array of entity configurations that allow per actor type settings. Any configuration defined here must have an entity that maps back into the root level entities. | +| `reentrancy` | A configuration object that holds the options for actor reentrancy. | +| `enabled` | A flag in the reentrancy configuration that is needed to enable reentrancy. | +| `maxStackDepth` | A value in the reentrancy configuration that controls how many reentrant calls be made to the same actor. | +| `entitiesConfig` | Array of entity configurations that allow per actor type settings. Any configuration defined here must have an entity that maps back into the root level entities. | {{% alert title="Note" color="primary" %}} Actor settings in configuration for timeouts and intervals use [time.ParseDuration](https://pkg.go.dev/time#ParseDuration) format. You can use string formats to represent durations. 例如： @@ -548,8 +548,8 @@ DELETE http://localhost:/actors// #### URL Parameters -| Parameter | Description | -| ----------- | --------------------- | +| Parameter | Description | +| ----------- | ------------------------------------- | | `appPort` | The application port. | | `actorType` | The actor type. | | `actorId` | The actor ID. | @@ -590,8 +590,8 @@ PUT http://localhost:/actors///method/ #### URL Parameters -| Parameter | Description | -| ------------ | --------------------------------- | +| Parameter | Description | +| ------------ | ------------------------------------------------- | | `appPort` | The application port. | | `actorType` | The actor type. | | `actorId` | The actor ID. | @@ -628,8 +628,8 @@ PUT http://localhost:/actors///method/remind//actors///method/timer//healthz #### URL Parameters -| Parameter | Description | -| --------- | --------------------- | +| Parameter | Description | +| --------- | ------------------------------------- | | `appPort` | The application port. | #### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/api/bindings_api.md b/src/translated_content/zh_CN/docs/reference/api/bindings_api.md index ea6d95ad6..565ef060f 100644 --- a/src/translated_content/zh_CN/docs/reference/api/bindings_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/bindings_api.md @@ -270,6 +270,6 @@ curl -X POST http://localhost:3500/v1.0/bindings/myKafka \ There are common metadata properties which are support across multiple binding components. The list below illustrates them: -| Property | Description | Binding definition | Available in | -| ------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | +| Property | Description | Binding definition | Available in | +| ------------ | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | ttlInSeconds | Defines the time to live in seconds for the message | If set in the binding definition will cause all messages to have a default time to live. The message ttl overrides any value in the binding definition. | RabbitMQ, Azure Service Bus, Azure Storage Queue | diff --git a/src/translated_content/zh_CN/docs/reference/api/configuration_api.md b/src/translated_content/zh_CN/docs/reference/api/configuration_api.md index 298867149..b4a753780 100644 --- a/src/translated_content/zh_CN/docs/reference/api/configuration_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/configuration_api.md @@ -18,9 +18,9 @@ GET http://localhost:/v1.0/configuration/ #### URL Parameters -| Parameter | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | The `metadata.name` field component file. Refer to the [component spec]({{< ref component-schema.md>}}) | #### Query Parameters @@ -84,9 +84,9 @@ GET http://localhost:/v1.0/configuration//subscribe #### URL Parameters -| Parameter | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | The `metadata.name` field component file. Refer to the [component spec]({{< ref component-schema.md>}}) | #### Query Parameters @@ -150,11 +150,11 @@ GET http://localhost:/v1.0/configuration// #### URL Parameters -| Parameter | Description | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | The `metadata.name` field component file. Refer to the [component spec]({{< ref component-schema.md>}}) | -| `subscription-id` | The value from the `id` field returned from the response of the subscribe endpoint | +| `subscription-id` | The value from the `id` field returned from the response of the subscribe endpoint | #### Query Parameters @@ -221,11 +221,11 @@ POST http://localhost:/configuration// #### URL Parameters -| Parameter | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `appPort` | The application port | +| Parameter | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `appPort` | The application port | | `storename` | The `metadata.name` field component file. Refer to the [component spec]({{< ref component-schema.md>}}) | -| `key` | The key subscribed to | +| `key` | The key subscribed to | #### Request Body diff --git a/src/translated_content/zh_CN/docs/reference/api/cryptography_api.md b/src/translated_content/zh_CN/docs/reference/api/cryptography_api.md index 2d7155328..d267860fa 100644 --- a/src/translated_content/zh_CN/docs/reference/api/cryptography_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/cryptography_api.md @@ -38,13 +38,13 @@ Additional encryption parameters are configured by setting headers with the appr values. The following table details the required and optional headers to set with every encryption request. -| Header Key | Description | Allowed Values | Required | -| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------- | -| dapr-key-name | The name of the key to use for the encryption operation | | Yes | -| dapr-key-wrap-algorithm | The key wrap algorithm to use | `A256KW`, `A128CBC`, `A192CBC`, `RSA-OAEP-256` | Yes | +| Header Key | Description | Allowed Values | Required | +| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| dapr-key-name | The name of the key to use for the encryption operation | | Yes | +| dapr-key-wrap-algorithm | The key wrap algorithm to use | `A256KW`, `A128CBC`, `A192CBC`, `RSA-OAEP-256` | Yes | | dapr-omit-decryption-key-name | If true, omits the decryption key name from header `dapr-decryption-key-name` from the output. If false, includes the specified decryption key name specified in header `dapr-decryption-key-name`. | The following values will be accepted as true: `y`, `yes`, `true`, `t`, `on`, `1` | No | -| dapr-decryption-key-name | If `dapr-omit-decryption-key-name` is true, this contains the name of the intended decryption key to include in the output. | | Required only if `dapr-omit-decryption-key-name` is true | -| dapr-data-encryption-cipher | The cipher to use for the encryption operation | `aes-gcm` or `chacha20-poly1305` | No | +| dapr-decryption-key-name | If `dapr-omit-decryption-key-name` is true, this contains the name of the intended decryption key to include in the output. | | Required only if `dapr-omit-decryption-key-name` is true | +| dapr-data-encryption-cipher | The cipher to use for the encryption operation | `aes-gcm` or `chacha20-poly1305` | No | ### HTTP Response @@ -103,8 +103,8 @@ PUT curl http://localhost:3500/v1.0/crypto//decrypt Additional decryption parameters are configured by setting headers with the appropriate values. The following table details the required and optional headers to set with every decryption request. -| Header Key | Description | Required | -| ------------- | -------------------------------------------------------- | -------- | +| Header Key | Description | Required | +| ------------- | ------------------------------------------------------------------------ | -------- | | dapr-key-name | The name of the key to use for the decryption operation. | Yes | ### HTTP Response diff --git a/src/translated_content/zh_CN/docs/reference/api/distributed_lock_api.md b/src/translated_content/zh_CN/docs/reference/api/distributed_lock_api.md index f345c9bb2..910be3a46 100644 --- a/src/translated_content/zh_CN/docs/reference/api/distributed_lock_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/distributed_lock_api.md @@ -18,9 +18,9 @@ POST http://localhost:/v1.0-alpha1/lock/ #### URL Parameters -| Parameter | Description | -| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | The `metadata.name` field component file. Refer to the [component schema]({{< ref component-schema.md >}}) | #### Query Parameters @@ -48,11 +48,11 @@ The lock endpoint receives the following JSON payload: } ``` -| Field | Description | -| --------------- | ----------------------------------------------------------------------- | +| Field | Description | +| --------------- | --------------------------------------------------------------------------------------- | | resourceId | The ID of the resource to lock. Can be any value | | lockOwner | The name of the lock owner. Should be set to a unique value per-request | -| expiryInSeconds | The time in seconds to hold the lock before it expires | +| expiryInSeconds | The time in seconds to hold the lock before it expires | ### HTTP Response Body @@ -92,9 +92,9 @@ POST http://localhost:/v1.0-alpha1/unlock/ #### URL Parameters -| Parameter | Description | -| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | The `metadata.name` field component file. Refer to the [component schema]({{< ref component-schema.md >}}) | #### Query Parameters diff --git a/src/translated_content/zh_CN/docs/reference/api/error_codes.md b/src/translated_content/zh_CN/docs/reference/api/error_codes.md index a41cd98f3..9a7f9aac0 100644 --- a/src/translated_content/zh_CN/docs/reference/api/error_codes.md +++ b/src/translated_content/zh_CN/docs/reference/api/error_codes.md @@ -17,34 +17,34 @@ For http calls made to Dapr runtime, when an error is encountered, an error json Following table lists the error codes returned by Dapr runtime: -| Error Code | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| Error Code | Description | +| --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | ERR_ACTOR_INSTANCE_MISSING | Error getting an actor instance. This means that actor is now hosted in some other service replica. | -| ERR_ACTOR_RUNTIME_NOT_FOUND | Error getting the actor instance. | -| ERR_ACTOR_REMINDER_CREATE | Error creating a reminder for an actor. | -| ERR_ACTOR_REMINDER_DELETE | Error deleting a reminder for an actor. | -| ERR_ACTOR_TIMER_CREATE | Error creating a timer for an actor. | -| ERR_ACTOR_TIMER_DELETE | Error deleting a timer for an actor. | -| ERR_ACTOR_REMINDER_GET | Error getting a reminder for an actor. | -| ERR_ACTOR_INVOKE_METHOD | Error invoking a method on an actor. | -| ERR_ACTOR_STATE_DELETE | Error deleting the state for an actor. | -| ERR_ACTOR_STATE_GET | Error getting the state for an actor. | -| ERR_ACTOR_STATE_TRANSACTION_SAVE | Error storing actor state transactionally. | -| ERR_PUBSUB_NOT_FOUND | Error referencing the Pub/Sub component in Dapr runtime. | -| ERR_PUBSUB_PUBLISH_MESSAGE | Error publishing a message. | -| ERR_PUBSUB_FORBIDDEN | Error message forbidden by access controls. | -| ERR_PUBSUB_CLOUD_EVENTS_SER | Error serializing Pub/Sub event envelope. | -| ERR_STATE_STORE_NOT_FOUND | Error referencing a state store not found. | -| ERR_STATE_STORES_NOT_CONFIGURED | Error no state stores configured. | -| ERR_NOT_SUPPORTED_STATE_OPERATION | Error transaction requested on a state store with no transaction support. | -| ERR_STATE_GET | Error getting a state for state store. | -| ERR_STATE_DELETE | Error deleting a state from state store. | -| ERR_STATE_SAVE | Error saving a state in state store. | -| ERR_INVOKE_OUTPUT_BINDING | Error invoking an output binding. | -| ERR_MALFORMED_REQUEST | Error with a malformed request. | -| ERR_DIRECT_INVOKE | Error in direct invocation. | -| ERR_DESERIALIZE_HTTP_BODY | Error deserializing an HTTP request body. | -| ERR_SECRET_STORES_NOT_CONFIGURED | Error that no secret store is configured. | -| ERR_SECRET_STORE_NOT_FOUND | Error that specified secret store is not found. | -| ERR_HEALTH_NOT_READY | Error that Dapr is not ready. | -| ERR_METADATA_GET | Error parsing the Metadata information. | +| ERR_ACTOR_RUNTIME_NOT_FOUND | Error getting the actor instance. | +| ERR_ACTOR_REMINDER_CREATE | Error creating a reminder for an actor. | +| ERR_ACTOR_REMINDER_DELETE | Error deleting a reminder for an actor. | +| ERR_ACTOR_TIMER_CREATE | Error creating a timer for an actor. | +| ERR_ACTOR_TIMER_DELETE | Error deleting a timer for an actor. | +| ERR_ACTOR_REMINDER_GET | Error getting a reminder for an actor. | +| ERR_ACTOR_INVOKE_METHOD | Error invoking a method on an actor. | +| ERR_ACTOR_STATE_DELETE | Error deleting the state for an actor. | +| ERR_ACTOR_STATE_GET | Error getting the state for an actor. | +| ERR_ACTOR_STATE_TRANSACTION_SAVE | Error storing actor state transactionally. | +| ERR_PUBSUB_NOT_FOUND | Error referencing the Pub/Sub component in Dapr runtime. | +| ERR_PUBSUB_PUBLISH_MESSAGE | Error publishing a message. | +| ERR_PUBSUB_FORBIDDEN | Error message forbidden by access controls. | +| ERR_PUBSUB_CLOUD_EVENTS_SER | Error serializing Pub/Sub event envelope. | +| ERR_STATE_STORE_NOT_FOUND | Error referencing a state store not found. | +| ERR_STATE_STORES_NOT_CONFIGURED | Error no state stores configured. | +| ERR_NOT_SUPPORTED_STATE_OPERATION | Error transaction requested on a state store with no transaction support. | +| ERR_STATE_GET | Error getting a state for state store. | +| ERR_STATE_DELETE | Error deleting a state from state store. | +| ERR_STATE_SAVE | Error saving a state in state store. | +| ERR_INVOKE_OUTPUT_BINDING | Error invoking an output binding. | +| ERR_MALFORMED_REQUEST | Error with a malformed request. | +| ERR_DIRECT_INVOKE | Error in direct invocation. | +| ERR_DESERIALIZE_HTTP_BODY | Error deserializing an HTTP request body. | +| ERR_SECRET_STORES_NOT_CONFIGURED | Error that no secret store is configured. | +| ERR_SECRET_STORE_NOT_FOUND | Error that specified secret store is not found. | +| ERR_HEALTH_NOT_READY | Error that Dapr is not ready. | +| ERR_METADATA_GET | Error parsing the Metadata information. | diff --git a/src/translated_content/zh_CN/docs/reference/api/metadata_api.md b/src/translated_content/zh_CN/docs/reference/api/metadata_api.md index b991495d7..2abe9c7d9 100644 --- a/src/translated_content/zh_CN/docs/reference/api/metadata_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/metadata_api.md @@ -63,8 +63,8 @@ GET http://localhost:/v1.0/metadata ### URL Parameters -| Parameter | Description | -| --------- | -------------- | +| Parameter | Description | +| --------- | ------------------------------ | | daprPort | The Dapr port. | ### HTTP Response Codes @@ -78,29 +78,29 @@ GET http://localhost:/v1.0/metadata **Metadata API Response Object** -| Name | Type | Description | -| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| id | string | Application ID | -| runtimeVersion | string | Version of the Dapr runtime | -| enabledFeatures | string[] | List of features enabled by Dapr Configuration, see https\://docs.dapr.io/operations/configuration/preview-features/ | -| actors | [Metadata API Response Registered Actor](#metadataapiresponseactor)[] | A json encoded array of registered actors metadata. | -| extended.attributeName | string | List of custom attributes as key-value pairs, where key is the attribute name. | -| components | [Metadata API Response Component](#metadataapiresponsecomponent)[] | A json encoded array of loaded components metadata. | -| httpEndpoints | [Metadata API Response HttpEndpoint](#metadataapiresponsehttpendpoint)[] | A json encoded array of loaded HttpEndpoints metadata. | -| subscriptions | [Metadata API Response Subscription](#metadataapiresponsesubscription)[] | A json encoded array of pub/sub subscriptions metadata. | -| appConnectionProperties | [Metadata API Response AppConnectionProperties](#metadataapiresponseappconnectionproperties) | A json encoded object of app connection properties. | +| Name | Type | Description | +| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | string | Application ID | +| runtimeVersion | string | Version of the Dapr runtime | +| enabledFeatures | string[] | List of features enabled by Dapr Configuration, see https://docs.dapr.io/operations/configuration/preview-features/ | +| actors | [Metadata API Response Registered Actor](#metadataapiresponseactor)[] | A json encoded array of registered actors metadata. | +| extended.attributeName | string | List of custom attributes as key-value pairs, where key is the attribute name. | +| components | [Metadata API Response Component](#metadataapiresponsecomponent)[] | A json encoded array of loaded components metadata. | +| httpEndpoints | [Metadata API Response HttpEndpoint](#metadataapiresponsehttpendpoint)[] | A json encoded array of loaded HttpEndpoints metadata. | +| subscriptions | [Metadata API Response Subscription](#metadataapiresponsesubscription)[] | A json encoded array of pub/sub subscriptions metadata. | +| appConnectionProperties | [Metadata API Response AppConnectionProperties](#metadataapiresponseappconnectionproperties) | A json encoded object of app connection properties. | **Metadata API Response Registered Actor** -| Name | Type | Description | -| ----- | ------- | -------------------------- | +| Name | Type | Description | +| ----- | ------- | ------------------------------------------ | | type | string | The registered actor type. | | count | integer | Number of actors running. | **Metadata API Response Component** -| Name | Type | Description | -| ------------ | ------ | ----------------------------------------------------------- | +| Name | Type | Description | +| ------------ | ------ | --------------------------------------------------------------------------- | | name | string | Name of the component. | | type | string | Component type. | | version | string | Component version. | @@ -108,14 +108,14 @@ GET http://localhost:/v1.0/metadata **Metadata API Response HttpEndpoint** -| Name | Type | Description | -| ---- | ------ | ------------------------- | +| Name | Type | Description | +| ---- | ------ | ----------------------------------------- | | name | string | Name of the HttpEndpoint. | **Metadata API Response Subscription** -| Name | Type | Description | -| --------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| Name | Type | Description | +| --------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | pubsubname | string | Name of the pub/sub. | | topic | string | Topic name. | | metadata | object | Metadata associated with the subscription. | @@ -124,15 +124,15 @@ GET http://localhost:/v1.0/metadata **Metadata API Response Subscription Rules** -| Name | Type | Description | -| ----- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| match | string | CEL expression to match the message, see https\://docs.dapr.io/developing-applications/building-blocks/pubsub/howto-route-messages/#common-expression-language-cel | -| path | string | Path to route the message if the match expression is true. | +| Name | Type | Description | +| ----- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| match | string | CEL expression to match the message, see https://docs.dapr.io/developing-applications/building-blocks/pubsub/howto-route-messages/#common-expression-language-cel | +| path | string | Path to route the message if the match expression is true. | **Metadata API Response AppConnectionProperties** -| Name | Type | Description | -| -------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| Name | Type | Description | +| -------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | port | integer | Port on which the app is listening. | | protocol | string | Protocol used by the app. | | channelAddress | string | Host address on which the app is listening. | @@ -141,8 +141,8 @@ GET http://localhost:/v1.0/metadata **Metadata API Response AppConnectionProperties Health** -| Name | Type | Description | -| ------------------- | ------- | -------------------------------------------------------------------------- | +| Name | Type | Description | +| ------------------- | ------- | ------------------------------------------------------------------------------------------ | | healthCheckPath | string | Health check path, applicable for HTTP protocol. | | healthProbeInterval | string | Time between each health probe, in go duration format. | | healthProbeTimeout | string | Timeout for each health probe, in go duration format. | @@ -239,9 +239,9 @@ PUT http://localhost:/v1.0/metadata/attributeName ### URL Parameters -| Parameter | Description | -| ------------- | ------------------------------------------------------------------- | -| daprPort | The Dapr port. | +| Parameter | Description | +| ------------- | --------------------------------------------------------------------------------------------------- | +| daprPort | The Dapr port. | | attributeName | Custom attribute name. This is they key name in the key-value pair. | ### HTTP Request Body diff --git a/src/translated_content/zh_CN/docs/reference/api/placement_api.md b/src/translated_content/zh_CN/docs/reference/api/placement_api.md index 7f3d97800..e62eb9a2c 100644 --- a/src/translated_content/zh_CN/docs/reference/api/placement_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/placement_api.md @@ -33,19 +33,19 @@ GET http://localhost:/placement/state **Placement tables API Response Object** -| Name | Type | Description | -| ------------ | --------------------------------------------------------------------------------------- | -------------------------------------------- | -| tableVersion | int | The placement table version | +| Name | Type | Description | +| ------------ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| tableVersion | int | The placement table version | | hostList | [Actor Host Info](#actorhostinfo)[] | A json array of registered actors host info. | **Actor Host Info** -| Name | Type | Description | -| ---------- | ----------------- | ------------------------------------------ | -| name | string | The host:port address of the actor. | -| appId | string | app id. | -| actorTypes | json string array | List of actor types it hosts. | -| updatedAt | timestamp | Timestamp of the actor registered/updated. | +| Name | Type | Description | +| ---------- | ----------------- | ------------------------------------------------------------------- | +| name | string | The host:port address of the actor. | +| appId | string | app id. | +| actorTypes | json string array | List of actor types it hosts. | +| updatedAt | timestamp | Timestamp of the actor registered/updated. | ## 示例 diff --git a/src/translated_content/zh_CN/docs/reference/api/pubsub_api.md b/src/translated_content/zh_CN/docs/reference/api/pubsub_api.md index 92d7b4f51..cae310735 100644 --- a/src/translated_content/zh_CN/docs/reference/api/pubsub_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/pubsub_api.md @@ -57,9 +57,9 @@ If you want to send your own custom CloudEvent, use the `application/cloudevents Metadata can be sent via query parameters in the request's URL. It must be prefixed with `metadata.`, as shown below. -| Parameter | Description | -| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata.ttlInSeconds` | The number of seconds for the message to expire, as [described here]({{< ref pubsub-message-ttl.md >}}) | +| Parameter | Description | +| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `metadata.ttlInSeconds` | The number of seconds for the message to expire, as [described here]({{< ref pubsub-message-ttl.md >}}) | | `metadata.rawPayload` | Boolean to determine if Dapr should publish the event without wrapping it as CloudEvent, as [described here]({{< ref pubsub-raw.md >}}) | > Additional metadata parameters are available based on each pubsub component. @@ -109,19 +109,19 @@ The `Content-Type` header should always be set to `application/json` since the r ### URL Parameters -| **Parameter** | **Description** | -| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | -| `pubsubname` | The name of pub/sub component | -| `topic` | The name of the topic | +| **Parameter** | **Description** | +| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | +| `pubsubname` | The name of pub/sub component | +| `topic` | The name of the topic | | `metadata` | Query parameters for [metadata]({{< ref "pubsub_api.md#metadata" >}}) | ### Metadata Metadata can be sent via query parameters in the request's URL. It must be prefixed with `metadata.`, as shown in the table below. -| **Parameter** | **Description** | -| -------------------------- | --------------------------------------------------------------------------------------------- | +| **Parameter** | **Description** | +| -------------------------- | ------------------------------------------------------------------------------------------------------------- | | `metadata.rawPayload` | Boolean to determine if Dapr should publish the messages without wrapping them as CloudEvent. | | `metadata.maxBulkPubBytes` | Maximum bytes to publish in a bulk publish request. | @@ -191,8 +191,8 @@ Example: Optionally, metadata can be sent via the request body. -| Parameter | Description | -| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Description | +| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `rawPayload` | boolean to subscribe to events that do not comply with CloudEvent specification, as [described here]({{< ref pubsub-raw.md >}}) | ### Provide route(s) for Dapr to deliver topic events @@ -239,11 +239,11 @@ Dapr assumes that a JSON-encoded payload response without `status` field or an e The HTTP response might be different from HTTP 2xx. The following are Dapr's behavior in different HTTP statuses: -| HTTP Status | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------ | +| HTTP Status | Description | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------- | | 2xx | message is processed as per status in payload (`SUCCESS` if empty; ignored if invalid payload). | -| 404 | error is logged and message is dropped | -| other | warning is logged and message to be retried | +| 404 | error is logged and message is dropped | +| other | warning is logged and message to be retried | ## Subscribe multiple messages from a given topic @@ -286,11 +286,11 @@ A JSON-encoded payload body with the processing status against each entry needs The HTTP response might be different from HTTP 2xx. The following are Dapr's behavior in different HTTP statuses: -| HTTP Status | Description | -| ----------- | ------------------------------------------------ | -| 2xx | message is processed as per status in payload. | -| 404 | error is logged and all messages are dropped | -| other | warning is logged and all messages to be retried | +| HTTP Status | Description | +| ----------- | -------------------------------------------------------------- | +| 2xx | message is processed as per status in payload. | +| 404 | error is logged and all messages are dropped | +| other | warning is logged and all messages to be retried | ## Message envelope diff --git a/src/translated_content/zh_CN/docs/reference/api/state_api.md b/src/translated_content/zh_CN/docs/reference/api/state_api.md index 6c8b16e8b..06dadc577 100644 --- a/src/translated_content/zh_CN/docs/reference/api/state_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/state_api.md @@ -26,8 +26,8 @@ spec: value: ``` -| Setting | Description | -| --------------- | -------------------------------------------------------------------------------------- | +| Setting | Description | +| --------------- | ------------------------------------------------------------------------------------------------------ | | `metadata.name` | The name of the state store. | | `spec/metadata` | An open key value pair metadata that allows a binding to define connection properties. | @@ -57,9 +57,9 @@ POST http://localhost:/v1.0/state/ #### URL Parameters -| Parameter | Description | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `daprPort` | The Dapr port | | `storename` | The `metadata.name` field in the user-configured `statestore.yaml` component file. Refer to the [Dapr state store configuration structure](#component-file) mentioned above. | The optional request metadata is passed via URL query parameters. For example, @@ -91,8 +91,8 @@ A JSON array of state objects. Each state object is comprised with the following Metadata can be sent via query parameters in the request's URL. It must be prefixed with `metadata.`, as shown below. -| Parameter | Description | -| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Description | +| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `metadata.ttlInSeconds` | The number of seconds for the message to expire, as [described here]({{< ref state-store-ttl.md >}}) | > **TTL:** Only certain state stores support the TTL option, according the [supported state stores]({{< ref supported-state-stores.md >}}). @@ -143,13 +143,13 @@ GET http://localhost:/v1.0/state// #### URL Parameters -| Parameter | Description | -| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | `metadata.name` field in the user-configured statestore.yaml component file. Refer to the [Dapr state store configuration structure](#component-file) mentioned above. | -| `key` | The key of the desired state | -| `consistency` | (optional) Read consistency mode; see [state operation options](#optional-behaviors) | -| `metadata` | (optional) Metadata as query parameters to the state store | +| `key` | The key of the desired state | +| `consistency` | (optional) Read consistency mode; see [state operation options](#optional-behaviors) | +| `metadata` | (optional) Metadata as query parameters to the state store | The optional request metadata is passed via URL query parameters. For example, @@ -212,11 +212,11 @@ POST/PUT http://localhost:/v1.0/state//bulk #### URL Parameters -| Parameter | Description | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | `metadata.name` field in the user-configured statestore.yaml component file. Refer to the [Dapr state store configuration structure](#component-file) mentioned above. | -| `metadata` | (optional) Metadata as query parameters to the state store | +| `metadata` | (optional) Metadata as query parameters to the state store | The optional request metadata is passed via URL query parameters. For example, @@ -286,13 +286,13 @@ DELETE http://localhost:/v1.0/state// #### URL Parameters -| Parameter | Description | -| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | `metadata.name` field in the user-configured statestore.yaml component file. Refer to the [Dapr state store configuration structure](#component-file) mentioned above. | -| `key` | The key of the desired state | -| `concurrency` | (optional) Either _first-write_ or _last-write_; see [state operation options](#optional-behaviors) | -| `consistency` | (optional) Either _strong_ or _eventual_; see [state operation options](#optional-behaviors) | +| `key` | The key of the desired state | +| `concurrency` | (optional) Either _first-write_ or _last-write_; see [state operation options](#optional-behaviors) | +| `consistency` | (optional) Either _strong_ or _eventual_; see [state operation options](#optional-behaviors) | The optional request metadata is passed via URL query parameters. For example, @@ -344,11 +344,11 @@ POST/PUT http://localhost:/v1.0-alpha1/state//query #### URL Parameters -| Parameter | Description | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | `metadata.name` field in the user-configured statestore.yaml component file. Refer to the [Dapr state store configuration structure](#component-file) mentioned above. | -| `metadata` | (optional) Metadata as query parameters to the state store | +| `metadata` | (optional) Metadata as query parameters to the state store | The optional request metadata is passed via URL query parameters. For example, @@ -484,9 +484,9 @@ POST/PUT http://localhost:/v1.0/state//transaction #### URL Parameters -| Parameter | Description | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `daprPort` | The Dapr port | +| Parameter | Description | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `daprPort` | The Dapr port | | `storename` | `metadata.name` field in the user-configured statestore.yaml component file. Refer to the [Dapr state store configuration structure](#component-file) mentioned above. | The optional request metadata is passed via URL query parameters. For example, diff --git a/src/translated_content/zh_CN/docs/reference/api/workflow_api.md b/src/translated_content/zh_CN/docs/reference/api/workflow_api.md index bb6036bd2..5e3a2922a 100644 --- a/src/translated_content/zh_CN/docs/reference/api/workflow_api.md +++ b/src/translated_content/zh_CN/docs/reference/api/workflow_api.md @@ -244,8 +244,8 @@ The API call will provide a JSON response similar to this: } ``` -| Parameter | Description | -| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Parameter | Description | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `runtimeStatus` | The status of the workflow instance. Values include: `"RUNNING"`, `"COMPLETED"`, `"CONTINUED_AS_NEW"`, `"FAILED"`, `"CANCELED"`, `"TERMINATED"`, `"PENDING"`, `"SUSPENDED"` | ## Component format @@ -267,7 +267,7 @@ spec: | Setting | Description | | --------------- | -------------------------------------------------------------- | -| `metadata.name` | The name of the workflow component. | +| `metadata.name` | The name of the workflow component. | | `spec/metadata` | Additional metadata parameters specified by workflow component | However, Dapr comes with a built-in `dapr` workflow component that is built on Dapr Actors. No component file is required to use the built-in Dapr workflow component. diff --git a/src/translated_content/zh_CN/docs/reference/arguments-annotations-overview.md b/src/translated_content/zh_CN/docs/reference/arguments-annotations-overview.md index 164d27420..426834b7d 100644 --- a/src/translated_content/zh_CN/docs/reference/arguments-annotations-overview.md +++ b/src/translated_content/zh_CN/docs/reference/arguments-annotations-overview.md @@ -10,63 +10,63 @@ aliases: This table is meant to help users understand the equivalent options for running Dapr sidecars in different contexts: via the [CLI]({{< ref cli-overview.md >}}) directly, via daprd, or on [Kubernetes]({{< ref kubernetes-overview.md >}}) via annotations. -| daprd | Dapr CLI | CLI shorthand | Kubernetes annotations | Description | -| ------------------------------------ | ----------------------------- | ------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--allowed-origins` | not supported | | not supported | Allowed HTTP origins (default "\*") | -| `--app-id` | `--app-id` | `-i` | `dapr.io/app-id` | The unique ID of the application. Used for service discovery, state encapsulation and the pub/sub consumer ID | -| `--app-port` | `--app-port` | `-p` | `dapr.io/app-port` | This parameter tells Dapr which port your application is listening on | -| `--components-path` | `--components-path` | `-d` | not supported | **Deprecated** in favor of `--resources-path` | -| `--resources-path` | `--resources-path` | `-d` | not supported | Path for components directory. If empty, components will not be loaded. | -| `--config` | `--config` | `-c` | `dapr.io/config` | Tells Dapr which Configuration resource to use | -| `--control-plane-address` | not supported | | not supported | Address for a Dapr control plane | -| `--dapr-grpc-port` | `--dapr-grpc-port` | | not supported | gRPC port for the Dapr API to listen on (default "50001") | -| `--dapr-http-port` | `--dapr-http-port` | | not supported | The HTTP port for the Dapr API | -| `--dapr-http-max-request-size` | --dapr-http-max-request-size | | `dapr.io/http-max-request-size` | Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is `4` MB | -| `--dapr-http-read-buffer-size` | --dapr-http-read-buffer-size | | `dapr.io/http-read-buffer-size` | Increasing max size of http header read buffer in KB to handle when sending multi-KB headers. The default 4 KB. When sending bigger than default 4KB http headers, you should set this to a larger value, for example 16 (for 16KB) | -| not supported | `--image` | | `dapr.io/sidecar-image` | Dapr sidecar image. Default is daprio/daprd:latest. The Dapr sidecar uses this image instead of the latest default image. Use this when building your own custom image of Dapr and or [using an alternative stable Dapr image]({{< ref "support-release-policy.md#build-variations" >}}) | -| `--internal-grpc-port` | not supported | | not supported | gRPC port for the Dapr Internal API to listen on | -| `--enable-metrics` | not supported | | configuration spec | Enable [prometheus metric]({{< ref prometheus >}}) (default true) | -| `--enable-mtls` | not supported | | configuration spec | Enables automatic mTLS for daprd to daprd communication channels | -| `--enable-profiling` | `--enable-profiling` | | `dapr.io/enable-profiling` | [Enable profiling]({{< ref profiling-debugging >}}) | -| `--unix-domain-socket` | `--unix-domain-socket` | `-u` | `dapr.io/unix-domain-socket-path` | The parent directory of socket file. On Linux, when communicating with the Dapr sidecar, use unix domain sockets for lower latency and greater throughput compared to TCP ports. Not available on Windows OS. | -| `--log-as-json` | not supported | | `dapr.io/log-as-json` | Setting this parameter to `true` outputs [logs in JSON format]({{< ref logs >}}). Default is `false` | -| `--log-level` | `--log-level` | | `dapr.io/log-level` | Sets the [log level]({{< ref logs-troubleshooting >}}) for the Dapr sidecar. Allowed values are `debug`, `info`, `warn`, `error`. Default is `info` | -| `--enable-api-logging` | `--enable-api-logging` | | `dapr.io/enable-api-logging` | [Enables API logging]({{< ref "api-logs-troubleshooting.md#configuring-api-logging-in-kubernetes" >}}) for the Dapr sidecar | -| `--app-max-concurrency` | `--app-max-concurrency` | | `dapr.io/app-max-concurrency` | Limit the [concurrency of your application]({{< ref "control-concurrency.md#setting-app-max-concurrency" >}}). A valid value is any number larger than `0` | -| `--metrics-port` | `--metrics-port` | | `dapr.io/metrics-port` | Sets the port for the sidecar metrics server. Default is `9090` | -| `--mode` | not supported | | not supported | Runtime hosting option mode for Dapr, either `"standalone"` or `"kubernetes"` (default `"standalone"`). [Learn more.]({{< ref hosting >}}) | -| `--placement-host-address` | `--placement-host-address` | | `dapr.io/placement-host-address` | Comma separated list of addresses for Dapr Actor Placement servers. When no annotation is set, the default value is set by the Sidecar Injector. When the annotation is set and the value is empty, the sidecar does not connect to Placement server. This can be used when there are no actors running in the sidecar. When the annotation is set and the value is not empty, the sidecar connects to the configured address. For example: `127.0.0.1:50057,127.0.0.1:50058` | -| `--actors-service` | not supported | | not supported | Configuration for the service that offers actor placement information. The format is `:
`. For example, setting this value to `placement:127.0.0.1:50057,127.0.0.1:50058` is an alternative to using the `--placement-host-address` flag. | -| `--reminders-service` | not supported | | not supported | Configuration for the service that enables actor reminders. The format is `[:
]`. Currently, the only supported value is `"default"` (which is also the default value), which uses the built-in reminders subsystem in the Dapr sidecar. | -| `--profiling-port` | `--profiling-port` | | not supported | The port for the profile server (default `7777`) | -| `--app-protocol` | `--app-protocol` | `-P` | `dapr.io/app-protocol` | Configures the protocol Dapr uses to communicate with your app. Valid options are `http`, `grpc`, `https` (HTTP with TLS), `grpcs` (gRPC with TLS), `h2c` (HTTP/2 Cleartext). Note that Dapr does not validate TLS certificates presented by the app. Default is `http` | -| `--enable-app-health-check` | `--enable-app-health-check` | | `dapr.io/enable-app-health-check` | Boolean that enables the [health checks]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `false`. | +| daprd | Dapr CLI | CLI shorthand | Kubernetes annotations | Description | +| ------------------------------------ | ----------------------------- | ------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--allowed-origins` | not supported | | not supported | Allowed HTTP origins (default "\*") | +| `--app-id` | `--app-id` | `-i` | `dapr.io/app-id` | The unique ID of the application. Used for service discovery, state encapsulation and the pub/sub consumer ID | +| `--app-port` | `--app-port` | `-p` | `dapr.io/app-port` | This parameter tells Dapr which port your application is listening on | +| `--components-path` | `--components-path` | `-d` | not supported | **Deprecated** in favor of `--resources-path` | +| `--resources-path` | `--resources-path` | `-d` | not supported | Path for components directory. If empty, components will not be loaded. | +| `--config` | `--config` | `-c` | `dapr.io/config` | Tells Dapr which Configuration resource to use | +| `--control-plane-address` | not supported | | not supported | Address for a Dapr control plane | +| `--dapr-grpc-port` | `--dapr-grpc-port` | | not supported | gRPC port for the Dapr API to listen on (default "50001") | +| `--dapr-http-port` | `--dapr-http-port` | | not supported | The HTTP port for the Dapr API | +| `--dapr-http-max-request-size` | --dapr-http-max-request-size | | `dapr.io/http-max-request-size` | Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is `4` MB | +| `--dapr-http-read-buffer-size` | --dapr-http-read-buffer-size | | `dapr.io/http-read-buffer-size` | Increasing max size of http header read buffer in KB to handle when sending multi-KB headers. The default 4 KB. When sending bigger than default 4KB http headers, you should set this to a larger value, for example 16 (for 16KB) | +| not supported | `--image` | | `dapr.io/sidecar-image` | Dapr sidecar image. Default is daprio/daprd:latest. The Dapr sidecar uses this image instead of the latest default image. Use this when building your own custom image of Dapr and or [using an alternative stable Dapr image]({{< ref "support-release-policy.md#build-variations" >}}) | +| `--internal-grpc-port` | not supported | | not supported | gRPC port for the Dapr Internal API to listen on | +| `--enable-metrics` | not supported | | configuration spec | Enable [prometheus metric]({{< ref prometheus >}}) (default true) | +| `--enable-mtls` | not supported | | configuration spec | Enables automatic mTLS for daprd to daprd communication channels | +| `--enable-profiling` | `--enable-profiling` | | `dapr.io/enable-profiling` | [Enable profiling]({{< ref profiling-debugging >}}) | +| `--unix-domain-socket` | `--unix-domain-socket` | `-u` | `dapr.io/unix-domain-socket-path` | The parent directory of socket file. On Linux, when communicating with the Dapr sidecar, use unix domain sockets for lower latency and greater throughput compared to TCP ports. Not available on Windows OS. | +| `--log-as-json` | not supported | | `dapr.io/log-as-json` | Setting this parameter to `true` outputs [logs in JSON format]({{< ref logs >}}). Default is `false` | +| `--log-level` | `--log-level` | | `dapr.io/log-level` | Sets the [log level]({{< ref logs-troubleshooting >}}) for the Dapr sidecar. Allowed values are `debug`, `info`, `warn`, `error`. Default is `info` | +| `--enable-api-logging` | `--enable-api-logging` | | `dapr.io/enable-api-logging` | [Enables API logging]({{< ref "api-logs-troubleshooting.md#configuring-api-logging-in-kubernetes" >}}) for the Dapr sidecar | +| `--app-max-concurrency` | `--app-max-concurrency` | | `dapr.io/app-max-concurrency` | Limit the [concurrency of your application]({{< ref "control-concurrency.md#setting-app-max-concurrency" >}}). A valid value is any number larger than `0` | +| `--metrics-port` | `--metrics-port` | | `dapr.io/metrics-port` | Sets the port for the sidecar metrics server. Default is `9090` | +| `--mode` | not supported | | not supported | Runtime hosting option mode for Dapr, either `"standalone"` or `"kubernetes"` (default `"standalone"`). [Learn more.]({{< ref hosting >}}) | +| `--placement-host-address` | `--placement-host-address` | | `dapr.io/placement-host-address` | Comma separated list of addresses for Dapr Actor Placement servers. When no annotation is set, the default value is set by the Sidecar Injector. When the annotation is set and the value is empty, the sidecar does not connect to Placement server. This can be used when there are no actors running in the sidecar. When the annotation is set and the value is not empty, the sidecar connects to the configured address. For example: `127.0.0.1:50057,127.0.0.1:50058` | +| `--actors-service` | not supported | | not supported | Configuration for the service that offers actor placement information. The format is `:
`. For example, setting this value to `placement:127.0.0.1:50057,127.0.0.1:50058` is an alternative to using the `--placement-host-address` flag. | +| `--reminders-service` | not supported | | not supported | Configuration for the service that enables actor reminders. The format is `[:
]`. Currently, the only supported value is `"default"` (which is also the default value), which uses the built-in reminders subsystem in the Dapr sidecar. | +| `--profiling-port` | `--profiling-port` | | not supported | The port for the profile server (default `7777`) | +| `--app-protocol` | `--app-protocol` | `-P` | `dapr.io/app-protocol` | Configures the protocol Dapr uses to communicate with your app. Valid options are `http`, `grpc`, `https` (HTTP with TLS), `grpcs` (gRPC with TLS), `h2c` (HTTP/2 Cleartext). Note that Dapr does not validate TLS certificates presented by the app. Default is `http` | +| `--enable-app-health-check` | `--enable-app-health-check` | | `dapr.io/enable-app-health-check` | Boolean that enables the [health checks]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `false`. | | `--app-health-check-path` | `--app-health-check-path` | | `dapr.io/app-health-check-path` | Path that Dapr invokes for health probes when the app channel is HTTP (this value is ignored if the app channel is using gRPC). Requires [app health checks to be enabled]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `/healthz`. | -| `--app-health-probe-interval` | `--app-health-probe-interval` | | `dapr.io/app-health-probe-interval` | Number of _seconds_ between each health probe. Requires [app health checks to be enabled]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `5` | -| `--app-health-probe-timeout` | `--app-health-probe-timeout` | | `dapr.io/app-health-probe-timeout` | Timeout in _milliseconds_ for health probe requests. Requires [app health checks to be enabled]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `500` | -| `--app-health-threshold` | `--app-health-threshold` | | `dapr.io/app-health-threshold"` | Max number of consecutive failures before the app is considered unhealthy. Requires [app health checks to be enabled]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `3` | -| `--sentry-address` | `--sentry-address` | | not supported | Address for the [Sentry CA service]({{< ref sentry >}}) | -| `--version` | `--version` | `-v` | not supported | Prints the runtime version | -| `--dapr-graceful-shutdown-seconds` | not supported | | `dapr.io/graceful-shutdown-seconds` | Graceful shutdown duration in seconds for Dapr, the maximum duration before forced shutdown when waiting for all in-progress requests to complete. Defaults to `5`. If you are running in Kubernetes mode, this value should not be larger than the Kubernetes termination grace period, who's default value is `30`. | +| `--app-health-probe-interval` | `--app-health-probe-interval` | | `dapr.io/app-health-probe-interval` | Number of _seconds_ between each health probe. Requires [app health checks to be enabled]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `5` | +| `--app-health-probe-timeout` | `--app-health-probe-timeout` | | `dapr.io/app-health-probe-timeout` | Timeout in _milliseconds_ for health probe requests. Requires [app health checks to be enabled]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `500` | +| `--app-health-threshold` | `--app-health-threshold` | | `dapr.io/app-health-threshold"` | Max number of consecutive failures before the app is considered unhealthy. Requires [app health checks to be enabled]({{< ref "app-health.md#configuring-app-health-checks" >}}). Default is `3` | +| `--sentry-address` | `--sentry-address` | | not supported | Address for the [Sentry CA service]({{< ref sentry >}}) | +| `--version` | `--version` | `-v` | not supported | Prints the runtime version | +| `--dapr-graceful-shutdown-seconds` | not supported | | `dapr.io/graceful-shutdown-seconds` | Graceful shutdown duration in seconds for Dapr, the maximum duration before forced shutdown when waiting for all in-progress requests to complete. Defaults to `5`. If you are running in Kubernetes mode, this value should not be larger than the Kubernetes termination grace period, who's default value is `30`. | | `--dapr-block-shutdown-duration` | not supported | | `dapr.io/block-shutdown-duration` | Block shutdown duration, if set, blocks the graceful shutdown procedure (as described above) from starting until the given duration has elapsed or the application becomes unhealthy as configured through application health options. This is useful for applications that need to execute Dapr APIs during their own termination procedure. Any new invocations of any Dapr APIs are not available to the application once the block has expired. Accepts [Go duration](https://pkg.go.dev/time#ParseDuration) string. | -| not supported | not supported | | `dapr.io/enabled` | Setting this paramater to true injects the Dapr sidecar into the pod | -| not supported | not supported | | `dapr.io/api-token-secret` | Tells Dapr which Kubernetes secret to use for [token-based API authentication]({{< ref api-token >}}). By default this is not set | -| not supported | not supported | | `dapr.io/app-token-secret` | Tells Dapr which Kubernetes secret to use for [token-based application authentication]({{< ref app-api-token >}}). By default, this is not set | -| `--dapr-listen-addresses` | not supported | | `dapr.io/sidecar-listen-addresses` | Comma separated list of IP addresses that sidecar will listen to. Defaults to all in standalone mode. Defaults to `[::1],127.0.0.1` in Kubernetes. To listen to all IPv4 addresses, use `0.0.0.0`. To listen to all IPv6 addresses, use `[::]`. | -| not supported | not supported | | `dapr.io/sidecar-cpu-limit` | Maximum amount of CPU that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | -| not supported | not supported | | `dapr.io/sidecar-memory-limit` | Maximum amount of Memory that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | -| not supported | not supported | | `dapr.io/sidecar-cpu-request` | Amount of CPU that the Dapr sidecar requests. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | -| not supported | not supported | | `dapr.io/sidecar-memory-request` | Amount of Memory that the Dapr sidecar requests .See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | -| not supported | not supported | | `dapr.io/sidecar-liveness-probe-delay-seconds` | Number of seconds after the sidecar container has started before liveness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | -| not supported | not supported | | `dapr.io/sidecar-liveness-probe-timeout-seconds` | Number of seconds after which the sidecar liveness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | -| not supported | not supported | | `dapr.io/sidecar-liveness-probe-period-seconds` | How often (in seconds) to perform the sidecar liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` | -| not supported | not supported | | `dapr.io/sidecar-liveness-probe-threshold` | When the sidecar liveness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unhealthy. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | -| not supported | not supported | | `dapr.io/sidecar-readiness-probe-delay-seconds` | Number of seconds after the sidecar container has started before readiness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | -| not supported | not supported | | `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | -| not supported | not supported | | `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` | -| not supported | not supported | | `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | -| not supported | not supported | | `dapr.io/env` | List of environment variable to be injected into the sidecar. Strings consisting of key=value pairs separated by a comma. | -| not supported | not supported | | `dapr.io/volume-mounts` | List of [pod volumes to be mounted to the sidecar container]({{< ref "kubernetes-volume-mounts" >}}) in read-only mode. Strings consisting of `volume:path` pairs separated by a comma. Example, `"volume-1:/tmp/mount1,volume-2:/home/root/mount2"`. | -| not supported | not supported | | `dapr.io/volume-mounts-rw` | List of [pod volumes to be mounted to the sidecar container]({{< ref "kubernetes-volume-mounts" >}}) in read-write mode. Strings consisting of `volume:path` pairs separated by a comma. Example, `"volume-1:/tmp/mount1,volume-2:/home/root/mount2"`. | +| not supported | not supported | | `dapr.io/enabled` | Setting this paramater to true injects the Dapr sidecar into the pod | +| not supported | not supported | | `dapr.io/api-token-secret` | Tells Dapr which Kubernetes secret to use for [token-based API authentication]({{< ref api-token >}}). By default this is not set | +| not supported | not supported | | `dapr.io/app-token-secret` | Tells Dapr which Kubernetes secret to use for [token-based application authentication]({{< ref app-api-token >}}). By default, this is not set | +| `--dapr-listen-addresses` | not supported | | `dapr.io/sidecar-listen-addresses` | Comma separated list of IP addresses that sidecar will listen to. Defaults to all in standalone mode. Defaults to `[::1],127.0.0.1` in Kubernetes. To listen to all IPv4 addresses, use `0.0.0.0`. To listen to all IPv6 addresses, use `[::]`. | +| not supported | not supported | | `dapr.io/sidecar-cpu-limit` | Maximum amount of CPU that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | +| not supported | not supported | | `dapr.io/sidecar-memory-limit` | Maximum amount of Memory that the Dapr sidecar can use. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | +| not supported | not supported | | `dapr.io/sidecar-cpu-request` | Amount of CPU that the Dapr sidecar requests. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | +| not supported | not supported | | `dapr.io/sidecar-memory-request` | Amount of Memory that the Dapr sidecar requests .See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). By default this is not set | +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-delay-seconds` | Number of seconds after the sidecar container has started before liveness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-timeout-seconds` | Number of seconds after which the sidecar liveness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-period-seconds` | How often (in seconds) to perform the sidecar liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` | +| not supported | not supported | | `dapr.io/sidecar-liveness-probe-threshold` | When the sidecar liveness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unhealthy. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-delay-seconds` | Number of seconds after the sidecar container has started before readiness probe is initiated. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-timeout-seconds` | Number of seconds after which the sidecar readiness probe times out. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-period-seconds` | How often (in seconds) to perform the sidecar readiness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `6` | +| not supported | not supported | | `dapr.io/sidecar-readiness-probe-threshold` | When the sidecar readiness probe fails, Kubernetes will try N times before giving up. In this case, the Pod will be marked Unready. Read more about `failureThreshold` [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). Default is `3` | +| not supported | not supported | | `dapr.io/env` | List of environment variable to be injected into the sidecar. Strings consisting of key=value pairs separated by a comma. | +| not supported | not supported | | `dapr.io/volume-mounts` | List of [pod volumes to be mounted to the sidecar container]({{< ref "kubernetes-volume-mounts" >}}) in read-only mode. Strings consisting of `volume:path` pairs separated by a comma. Example, `"volume-1:/tmp/mount1,volume-2:/home/root/mount2"`. | +| not supported | not supported | | `dapr.io/volume-mounts-rw` | List of [pod volumes to be mounted to the sidecar container]({{< ref "kubernetes-volume-mounts" >}}) in read-write mode. Strings consisting of `volume:path` pairs separated by a comma. Example, `"volume-1:/tmp/mount1,volume-2:/home/root/mount2"`. | | `--disable-builtin-k8s-secret-store` | not supported | | `dapr.io/disable-builtin-k8s-secret-store` | Disables BuiltIn Kubernetes secret store. Default value is false. See [Kubernetes secret store component]({{< ref "kubernetes-secret-store.md" >}}) for details. | -| not supported | not supported | | `dapr.io/sidecar-seccomp-profile-type` | Set the sidecar container's `securityContext.seccompProfile.type` to `Unconfined`, `RuntimeDefault`, or `Localhost`. By default, this annotation is not set on the Dapr sidecar, hence the field is omitted from sidecar container. | +| not supported | not supported | | `dapr.io/sidecar-seccomp-profile-type` | Set the sidecar container's `securityContext.seccompProfile.type` to `Unconfined`, `RuntimeDefault`, or `Localhost`. By default, this annotation is not set on the Dapr sidecar, hence the field is omitted from sidecar container. | diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-annotate.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-annotate.md index 977bb0da9..a411bbc0d 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-annotate.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-annotate.md @@ -21,48 +21,48 @@ dapr annotate [flags] CONFIG-FILE ### Flags -| Name | Environment Variable | Default | Description | -| ------------------------------------ | -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `--kubernetes, -k` | | | Apply annotations to Kubernetes resources. Required | -| `--api-token-secret` | | | The secret to use for the API token | -| `--app-id, -a` | | | The app id to annotate | -| `--app-max-concurrency` | | `-1` | The maximum number of concurrent requests to allow | -| `--app-port, -p` | | `-1` | The port to expose the app on | -| `--app-protocol` | | | The protocol to use for the app: `http` (default), `grpc`, `https`, `grpcs`, `h2c` | -| `--app-token-secret` | | | The secret to use for the app token | -| `--config, -c` | | | The config file to annotate | +| Name | Environment Variable | Default | Description | +| ------------------------------------ | -------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--kubernetes, -k` | | | Apply annotations to Kubernetes resources. Required | +| `--api-token-secret` | | | The secret to use for the API token | +| `--app-id, -a` | | | The app id to annotate | +| `--app-max-concurrency` | | `-1` | The maximum number of concurrent requests to allow | +| `--app-port, -p` | | `-1` | The port to expose the app on | +| `--app-protocol` | | | The protocol to use for the app: `http` (default), `grpc`, `https`, `grpcs`, `h2c` | +| `--app-token-secret` | | | The secret to use for the app token | +| `--config, -c` | | | The config file to annotate | | `--cpu-limit` | | | The CPU limit to set for the sidecar. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). | | `--cpu-request` | | | The CPU request to set for the sidecar. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/). | -| `--dapr-image` | | | The image to use for the dapr sidecar container | -| `--enable-debug` | | `false` | Enable debug | -| `--enable-metrics` | | `false` | Enable metrics | -| `--enable-profile` | | `false` | Enable profiling | -| `--env` | | | Environment variables to set (key value pairs, comma separated) | -| `--graceful-shutdown-seconds` | | `-1` | The number of seconds to wait for the app to shutdown | -| `--help, -h` | | | help for annotate | -| `--listen-addresses` | | | The addresses for sidecar to listen on. To listen to all IPv4 addresses, use `0.0.0.0`. To listen to all IPv6 addresses, use `[::]`. | +| `--dapr-image` | | | The image to use for the dapr sidecar container | +| `--enable-debug` | | `false` | Enable debug | +| `--enable-metrics` | | `false` | Enable metrics | +| `--enable-profile` | | `false` | Enable profiling | +| `--env` | | | Environment variables to set (key value pairs, comma separated) | +| `--graceful-shutdown-seconds` | | `-1` | The number of seconds to wait for the app to shutdown | +| `--help, -h` | | | help for annotate | +| `--listen-addresses` | | | The addresses for sidecar to listen on. To listen to all IPv4 addresses, use `0.0.0.0`. To listen to all IPv6 addresses, use `[::]`. | | `--liveness-probe-delay` | | `-1` | The delay for sidecar to use for the liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | | `--liveness-probe-period` | | `-1` | The period used by the sidecar for the liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | | `--liveness-probe-threshold` | | `-1` | The threshold used by the sidecar for the liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | | `--liveness-probe-timeout` | | `-1` | The timeout used by the sidecar for the liveness probe. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | -| `--log-level` | | | The log level to use | -| `--max-request-body-size` | | `-1` | The maximum request body size to use | -| `--http-read-buffer-size` | | `-1` | The maximum size of HTTP header read buffer in kilobytes | -| `--memory-limit` | | | The memory limit to set for the sidecar. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/) | -| `--memory-request` | | | The memory request to set for the sidecar | -| `--metrics-port` | | `-1` | The port to expose the metrics on | -| `--namespace, -n` | | | The namespace the resource target is in (can only be set if `--resource` is also set) | +| `--log-level` | | | The log level to use | +| `--max-request-body-size` | | `-1` | The maximum request body size to use | +| `--http-read-buffer-size` | | `-1` | The maximum size of HTTP header read buffer in kilobytes | +| `--memory-limit` | | | The memory limit to set for the sidecar. See valid values [here](https://kubernetes.io/docs/tasks/administer-cluster/manage-resources/quota-memory-cpu-namespace/) | +| `--memory-request` | | | The memory request to set for the sidecar | +| `--metrics-port` | | `-1` | The port to expose the metrics on | +| `--namespace, -n` | | | The namespace the resource target is in (can only be set if `--resource` is also set) | | `--readiness-probe-delay` | | `-1` | The delay to use for the readiness probe in the sidecar. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | | `--readiness-probe-period` | | `-1` | The period to use for the readiness probe in the sidecar. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | | `--readiness-probe-threshold` | | `-1` | The threshold to use for the readiness probe in the sidecar. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | | `--readiness-probe-timeout` | | `-1` | The timeout to use for the readiness probe in the sidecar. Read more [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#configure-probes). | -| `--resource, -r` | | | The Kubernetes resource target to annotate | -| `--enable-api-logging` | | | Enable API logging for the Dapr sidecar | -| `--unix-domain-socket-path` | | | Linux domain socket path to use for communicating with the Dapr sidecar | -| `--volume-mounts` | | | List of pod volumes to be mounted to the sidecar container in read-only mode | -| `--volume-mounts-rw` | | | List of pod volumes to be mounted to the sidecar container in read-write mode | -| `--disable-builtin-k8s-secret-store` | | | Disable the built-in Kubernetes secret store | -| `--placement-host-address` | | | Comma separated list of addresses for Dapr actor placement servers | +| `--resource, -r` | | | The Kubernetes resource target to annotate | +| `--enable-api-logging` | | | Enable API logging for the Dapr sidecar | +| `--unix-domain-socket-path` | | | Linux domain socket path to use for communicating with the Dapr sidecar | +| `--volume-mounts` | | | List of pod volumes to be mounted to the sidecar container in read-only mode | +| `--volume-mounts-rw` | | | List of pod volumes to be mounted to the sidecar container in read-write mode | +| `--disable-builtin-k8s-secret-store` | | | Disable the built-in Kubernetes secret store | +| `--placement-host-address` | | | Comma separated list of addresses for Dapr actor placement servers | {{% alert title="Warning" color="warning" %}} If an application ID is not provided using `--app-id, -a`, an ID is generated using the format `--`. diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-components.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-components.md index 774830a7d..0f23cb55e 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-components.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-components.md @@ -21,14 +21,14 @@ dapr components [flags] ### Flags -| Name | Environment Variable | Default | Description | -| ------------------------ | -------------------- | ------- | ------------------------------------------------------------------------------ | -| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster (required) | -| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr components in all namespaces | -| `--help`, `-h` | | | Print this help message | -| `--name`, `-n` | | | The components name to be printed (optional) | -| `--namespace` | | | List all components in the specified namespace | -| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) | +| Name | Environment Variable | Default | Description | +| ------------------------ | -------------------- | ------- | -------------------------------------------------------------------------------- | +| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster (required) | +| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr components in all namespaces | +| `--help`, `-h` | | | Print this help message | +| `--name`, `-n` | | | The components name to be printed (optional) | +| `--namespace` | | | List all components in the specified namespace | +| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-configurations.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-configurations.md index bcca19806..ed73e480a 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-configurations.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-configurations.md @@ -21,14 +21,14 @@ dapr configurations [flags] ### Flags -| Name | Environment Variable | Default | Description | -| ------------------------ | -------------------- | ------- | ------------------------------------------------------------------------------------- | -| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in Kubernetes cluster (required). | -| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr configurations in all namespaces (optional) | -| `--namespace` | | | List Dapr configurations in specific namespace. | -| `--name`, `-n` | | | Print specific Dapr configuration. (optional) | -| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) | -| `--help`, `-h` | | | Print this help message | +| Name | Environment Variable | Default | Description | +| ------------------------ | -------------------- | ------- | ------------------------------------------------------------------------------------------------- | +| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in Kubernetes cluster (required). | +| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr configurations in all namespaces (optional) | +| `--namespace` | | | List Dapr configurations in specific namespace. | +| `--name`, `-n` | | | Print specific Dapr configuration. (optional) | +| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) | +| `--help`, `-h` | | | Print this help message | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-dashboard.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-dashboard.md index c982fa8ea..368b0f237 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-dashboard.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-dashboard.md @@ -22,14 +22,14 @@ dapr dashboard [flags] ### Flags -| Name | Environment Variable | Default | Description | -| -------------------- | -------------------- | ------------- | --------------------------------------------------------------------------- | -| `--address`, `-a` | | `localhost` | Address to listen on. Only accepts IP address or localhost as a value | -| `--help`, `-h` | | | Prints this help message | -| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster | -| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running | -| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard | -| `--version`, `-v` | | `false` | Print the version for Dapr dashboard | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | ------------- | ------------------------------------------------------------------------------------- | +| `--address`, `-a` | | `localhost` | Address to listen on. Only accepts IP address or localhost as a value | +| `--help`, `-h` | | | Prints this help message | +| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster | +| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running | +| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard | +| `--version`, `-v` | | `false` | Print the version for Dapr dashboard | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-init.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-init.md index d5db61c04..684c59eb1 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-init.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-init.md @@ -22,29 +22,29 @@ dapr init [flags] ### Flags -| Name | Environment Variable | Default | Description | | -| --------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | -| `--dashboard-version` | | `latest` | The version of the Dapr dashboard to install, for example: `1.0.0` | | -| `--enable-ha` | | `false` | Enable high availability (HA) mode | | -| `--enable-mtls` | | `true` | Enable mTLS in your cluster | | -| `--from-dir` | | | Path to a local directory containing a downloaded "Dapr Installer Bundle" release which is used to `init` the airgap environment | | -| `--help`, `-h` | | | Print this help message | | -| `--image-registry` | | | Pulls container images required by Dapr from the given image registry | | -| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster | | -| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in | | -| `--network` | | | The Docker network on which to install and deploy the Dapr runtime | | -| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` | | -| `--image-variant` | | | The image variant to use for the Dapr runtime, for example: `mariner` | | +| Name | Environment Variable | Default | Description | | +| --------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | +| `--dashboard-version` | | `latest` | The version of the Dapr dashboard to install, for example: `1.0.0` | | +| `--enable-ha` | | `false` | Enable high availability (HA) mode | | +| `--enable-mtls` | | `true` | Enable mTLS in your cluster | | +| `--from-dir` | | | Path to a local directory containing a downloaded "Dapr Installer Bundle" release which is used to `init` the airgap environment | | +| `--help`, `-h` | | | Print this help message | | +| `--image-registry` | | | Pulls container images required by Dapr from the given image registry | | +| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster | | +| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in | | +| `--network` | | | The Docker network on which to install and deploy the Dapr runtime | | +| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` | | +| `--image-variant` | | | The image variant to use for the Dapr runtime, for example: `mariner` | | | `--set` | | | Configure options on the command line to be passed to the Dapr Helm chart and the Kubernetes cluster upon install. Can specify multiple values in a comma-separated list, for example: `key1=val1,key2=val2` | | -| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation | | -| `--timeout` | | `300` | The wait timeout for the Kubernetes installation | | -| `--wait` | | `false` | Wait for Kubernetes initialization to complete | | +| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation | | +| `--timeout` | | `300` | The wait timeout for the Kubernetes installation | | +| `--wait` | | `false` | Wait for Kubernetes initialization to complete | | | N/A | DAPR_DEFAULT_IMAGE_REGISTRY | | It is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr` it pulls the required images from Github container registry. To default to Docker hub, unset the environment variable or leave it blank | | -| N/A | DAPR_HELM_REPO_URL | | Specifies a private Dapr Helm chart url | | -| N/A | DAPR_HELM_REPO_USERNAME | A username for a private Helm chart | The username required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set | | -| N/A | DAPR_HELM_REPO_PASSWORD | A password for a private Helm chart | The password required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set | | +| N/A | DAPR_HELM_REPO_URL | | Specifies a private Dapr Helm chart url | | +| N/A | DAPR_HELM_REPO_USERNAME | A username for a private Helm chart | The username required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set | | +| N/A | DAPR_HELM_REPO_PASSWORD | A password for a private Helm chart | The password required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set | | | `--container-runtime` | | `docker` | Used to pass in a different container runtime other than Docker. Supported container runtimes are: `docker`, `podman` | | -| `--dev` | | | Creates Redis and Zipkin deployments when run in Kubernetes. | | +| `--dev` | | | Creates Redis and Zipkin deployments when run in Kubernetes. | | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-list.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-list.md index b7959c16d..ddda811d2 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-list.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-list.md @@ -22,13 +22,13 @@ dapr list [flags] ### Flags -| Name | Environment Variable | Default | Description | -| ------------------------ | -------------------- | --------- | ------------------------------------------------------------------------------------------------------------ | -| `--all-namespaces`, `-A` | | `false` | List all Dapr pods in all namespaces (optional) | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster (optional) | +| Name | Environment Variable | Default | Description | +| ------------------------ | -------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- | +| `--all-namespaces`, `-A` | | `false` | List all Dapr pods in all namespaces (optional) | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster (optional) | | `--namespace`, `-n` | | `default` | List the Dapr pods in the defined namespace in Kubernetes. Only with `-k` flag (optional) | -| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table` | +| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table` | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-mtls/dapr-mtls-renew-certificate.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-mtls/dapr-mtls-renew-certificate.md index 568be51f5..27fe6aa70 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-mtls/dapr-mtls-renew-certificate.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-mtls/dapr-mtls-renew-certificate.md @@ -32,7 +32,7 @@ dapr mtls renew-certificate [flags] | `--ca-root-certificate` | | | File path to user provided PEM root certificate | | | `--issuer-public-certificate` | | | File path to user provided PEM issuer certificate | | | `--issuer-private-key` | | | File path to user provided PEM issue private key | | -| `--private-key` | | | User provided root.key file which is used to generate root certificate | | +| `--private-key` | | | User provided root.key file which is used to generate root certificate | | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-run.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-run.md index ab123b55f..a2be47950 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-run.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-run.md @@ -21,37 +21,37 @@ dapr run [flags] [command] ### Flags -| Name | Environment Variable | Default | Description | -| --------------------------------- | -------------------- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--app-id`, `-a` | `APP_ID` | | The id for your application, used for service discovery. Cannot contain dots. | -| `--app-max-concurrency` | | `unlimited` | 应用程序的并发级别；默认为无限制 | -| `--app-port`, `-p` | `APP_PORT` | | 应用程序正在侦听的端口 | -| `--app-protocol`, `-P` | | `http` | Dapr 用于与应用程序通信的协议。 Valid values are: `http`, `grpc`, `https` (HTTP with TLS), `grpcs` (gRPC with TLS), `h2c` (HTTP/2 Cleartext) | +| Name | Environment Variable | Default | Description | +| --------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--app-id`, `-a` | `APP_ID` | | The id for your application, used for service discovery. Cannot contain dots. | +| `--app-max-concurrency` | | `unlimited` | 应用程序的并发级别；默认为无限制 | +| `--app-port`, `-p` | `APP_PORT` | | 应用程序正在侦听的端口 | +| `--app-protocol`, `-P` | | `http` | Dapr 用于与应用程序通信的协议。 Valid values are: `http`, `grpc`, `https` (HTTP with TLS), `grpcs` (gRPC with TLS), `h2c` (HTTP/2 Cleartext) | | `--resources-path`, `-d` | | Linux/Mac: `$HOME/.dapr/components`
Windows: `%USERPROFILE%\.dapr\components` | The path for resources directory. If you've organized your resources into multiple folders (for example, components in one folder, resiliency policies in another), you can define multiple resource paths. See [example]({{< ref "#examples" >}}) below. | -| `--app-channel-address` | | `127.0.0.1` | The network address the application listens on | -| `--runtime-path` | | | Dapr 运行时安装路径 | -| `--config`, `-c` | | Linux/Mac: `$HOME/.dapr/config.yaml`
Windows: `%USERPROFILE%\.dapr\config.yaml` | Dapr configuration file | -| `--dapr-grpc-port`, `-G` | `DAPR_GRPC_PORT` | `50001` | The gRPC port for Dapr to listen on | -| `--dapr-internal-grpc-port`, `-I` | | `50002` | The gRPC port for the Dapr internal API to listen on. Set during development for apps experiencing temporary errors with service invocation failures due to mDNS caching, or configuring Dapr sidecars behind firewall. Can be any value greater than 1024 and must be different for each app. | -| `--dapr-http-port`, `-H` | `DAPR_HTTP_PORT` | `3500` | The HTTP port for Dapr to listen on | -| `--enable-profiling` | | `false` | Enable "pprof" profiling via an HTTP endpoint | -| `--help`, `-h` | | | Print the help message | -| `--run-file`, `-f` | | Linux/MacOS: `$HOME/.dapr/dapr.yaml` | Run multiple applications at once using a Multi-App Run template file. Currently in [alpha]({{< ref "support-preview-features.md" >}}) and only available in Linux/MacOS | -| `--image` | | | Use a custom Docker image. Format is `repository/image` for Docker Hub, or `example.com/repository/image` for a custom registry. | -| `--log-level` | | `info` | 日志详细程度。 Valid values are: `debug`, `info`, `warn`, `error`, `fatal`, or `panic` | -| `--enable-api-logging` | | `false` | 启用从应用程序到 Dapr 的所有 API 调用的日志记录 | -| `--metrics-port` | `DAPR_METRICS_PORT` | `9090` | Dapr 将 metrics 信息发送到的端口 | -| `--profile-port` | | `7777` | 要监听的性能检测服务的端口 | -| `--enable-app-health-check` | | `false` | Enable health checks for the application using the protocol defined with app-protocol | -| `--app-health-check-path` | | | Path used for health checks; HTTP only | -| `--app-health-probe-interval` | | | 以秒为单位探测应用程序健康状态的间隔 | -| `--app-health-probe-timeout` | | | 应用健康探测的超时时间（以毫秒为单位） | -| `--app-health-threshold` | | | 应用被视为不健康之前的最大连续失败次数 | -| `--unix-domain-socket`, `-u` | | | Unix domain socket 目录挂载的路径。 如果指定了，与 Dapr sidecar 的通信将使用 unix domain sockets，与使用 TCP 端口相比，具有更低的延迟和更大的吞吐量。 在 Windows 操作系统上不可用。 | -| `--dapr-http-max-request-size` | | `4` | 请求正文的最大尺寸，单位为MB。 | -| `--dapr-http-read-buffer-size` | | `4` | Http 请求头读取缓冲区的最大大小，单位为KB。 这也限制了 HTTP 标头的最大大小。 默认是4KB。 | -| `--kubernetes`, `-k` | | | Running Dapr on Kubernetes, and used for [Multi-App Run template files on Kubernetes]({{< ref multi-app-dapr-run >}}). | -| `--components-path`, `-d` | | Linux/Mac: `$HOME/.dapr/components`
Windows: `%USERPROFILE%\.dapr\components` | **Deprecated** in favor of `--resources-path` | +| `--app-channel-address` | | `127.0.0.1` | The network address the application listens on | +| `--runtime-path` | | | Dapr 运行时安装路径 | +| `--config`, `-c` | | Linux/Mac: `$HOME/.dapr/config.yaml`
Windows: `%USERPROFILE%\.dapr\config.yaml` | Dapr configuration file | +| `--dapr-grpc-port`, `-G` | `DAPR_GRPC_PORT` | `50001` | The gRPC port for Dapr to listen on | +| `--dapr-internal-grpc-port`, `-I` | | `50002` | The gRPC port for the Dapr internal API to listen on. Set during development for apps experiencing temporary errors with service invocation failures due to mDNS caching, or configuring Dapr sidecars behind firewall. Can be any value greater than 1024 and must be different for each app. | +| `--dapr-http-port`, `-H` | `DAPR_HTTP_PORT` | `3500` | The HTTP port for Dapr to listen on | +| `--enable-profiling` | | `false` | Enable "pprof" profiling via an HTTP endpoint | +| `--help`, `-h` | | | Print the help message | +| `--run-file`, `-f` | | Linux/MacOS: `$HOME/.dapr/dapr.yaml` | Run multiple applications at once using a Multi-App Run template file. Currently in [alpha]({{< ref "support-preview-features.md" >}}) and only available in Linux/MacOS | +| `--image` | | | Use a custom Docker image. Format is `repository/image` for Docker Hub, or `example.com/repository/image` for a custom registry. | +| `--log-level` | | `info` | 日志详细程度。 Valid values are: `debug`, `info`, `warn`, `error`, `fatal`, or `panic` | +| `--enable-api-logging` | | `false` | 启用从应用程序到 Dapr 的所有 API 调用的日志记录 | +| `--metrics-port` | `DAPR_METRICS_PORT` | `9090` | Dapr 将 metrics 信息发送到的端口 | +| `--profile-port` | | `7777` | 要监听的性能检测服务的端口 | +| `--enable-app-health-check` | | `false` | Enable health checks for the application using the protocol defined with app-protocol | +| `--app-health-check-path` | | | Path used for health checks; HTTP only | +| `--app-health-probe-interval` | | | 以秒为单位探测应用程序健康状态的间隔 | +| `--app-health-probe-timeout` | | | 应用健康探测的超时时间（以毫秒为单位） | +| `--app-health-threshold` | | | 应用被视为不健康之前的最大连续失败次数 | +| `--unix-domain-socket`, `-u` | | | Unix domain socket 目录挂载的路径。 如果指定了，与 Dapr sidecar 的通信将使用 unix domain sockets，与使用 TCP 端口相比，具有更低的延迟和更大的吞吐量。 在 Windows 操作系统上不可用。 | +| `--dapr-http-max-request-size` | | `4` | 请求正文的最大尺寸，单位为MB。 | +| `--dapr-http-read-buffer-size` | | `4` | Http 请求头读取缓冲区的最大大小，单位为KB。 这也限制了 HTTP 标头的最大大小。 默认是4KB。 | +| `--kubernetes`, `-k` | | | Running Dapr on Kubernetes, and used for [Multi-App Run template files on Kubernetes]({{< ref multi-app-dapr-run >}}). | +| `--components-path`, `-d` | | Linux/Mac: `$HOME/.dapr/components`
Windows: `%USERPROFILE%\.dapr\components` | **Deprecated** in favor of `--resources-path` | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-stop.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-stop.md index 0271e6001..b0ea74810 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-stop.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-stop.md @@ -21,10 +21,10 @@ dapr stop [flags] ### Flags -| Name | Environment Variable | Default | Description | -| ------------------ | -------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--app-id`, `-a` | `APP_ID` | | The application id to be stopped | -| `--help`, `-h` | | | Print this help message | +| Name | Environment Variable | Default | Description | +| ------------------ | -------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `--app-id`, `-a` | `APP_ID` | | The application id to be stopped | +| `--help`, `-h` | | | Print this help message | | `--run-file`, `-f` | | | Stop running multiple applications at once using a Multi-App Run template file. Currently in [alpha]({{< ref "support-preview-features.md" >}}) and only available in Linux/MacOS | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-uninstall.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-uninstall.md index 3da2c1cd5..a53aef2ca 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-uninstall.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-uninstall.md @@ -22,13 +22,13 @@ dapr uninstall [flags] ### Flags -| Name | Environment Variable | Default | Description | -| --------------------- | -------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Environment Variable | Default | Description | +| --------------------- | -------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--all` | | `false` | Remove Redis, Zipkin containers in addition to actor placement container. Remove default dapr dir located at `$HOME/.dapr or %USERPROFILE%\.dapr\`. | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | Uninstall Dapr from a Kubernetes cluster | -| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to uninstall Dapr from | -| `--container-runtime` | | `docker` | Used to pass in a different container runtime other than Docker. Supported container runtimes are: `docker`, `podman` | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | Uninstall Dapr from a Kubernetes cluster | +| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to uninstall Dapr from | +| `--container-runtime` | | `docker` | Used to pass in a different container runtime other than Docker. Supported container runtimes are: `docker`, `podman` | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-upgrade.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-upgrade.md index de1793672..a8c9cec16 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-upgrade.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-upgrade.md @@ -27,13 +27,13 @@ dapr upgrade [flags] ### Flags -| Name | Environment Variable | Default | Description | -| -------------------- | -------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `--help`, `-h` | | | Print this help message | -| `--kubernetes`, `-k` | | `false` | Upgrade/Downgrade Dapr in a Kubernetes cluster | +| Name | Environment Variable | Default | Description | +| -------------------- | -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `--help`, `-h` | | | Print this help message | +| `--kubernetes`, `-k` | | `false` | Upgrade/Downgrade Dapr in a Kubernetes cluster | | `--runtime-version` | | `latest` | The version of the Dapr runtime to upgrade/downgrade to, for example: `1.0.0` | | `--set` | | | Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) | -| `--image-registry` | | | Pulls container images required by Dapr from the given image registry | +| `--image-registry` | | | Pulls container images required by Dapr from the given image registry | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/cli/dapr-version.md b/src/translated_content/zh_CN/docs/reference/cli/dapr-version.md index 292669a37..2d7f4c856 100644 --- a/src/translated_content/zh_CN/docs/reference/cli/dapr-version.md +++ b/src/translated_content/zh_CN/docs/reference/cli/dapr-version.md @@ -21,9 +21,9 @@ dapr version [flags] ### Flags -| Name | Environment Variable | Default | Description | -| ---------------- | -------------------- | ------- | ------------------------------------------------ | -| `--help`, `-h` | | | Print this help message | +| Name | Environment Variable | Default | Description | +| ---------------- | -------------------- | ------- | ---------------------------------------------------------------- | +| `--help`, `-h` | | | Print this help message | | `--output`, `-o` | | | Output format (options: json) | ### 示例 diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudoss.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudoss.md index b162cdb72..4f25f77dc 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudoss.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudoss.md @@ -36,12 +36,12 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------- | -------- | --------------- | --------------------------- | ------------------------------------- | -| `endpoint` | Y | Output | Alicloud OSS endpoint. | https\://oss-cn-hangzhou.aliyuncs.com | -| `accessKeyID` | Y | Output | Access key ID credential. | | -| `accessKey` | Y | Output | Access key credential. | | -| `bucket` | Y | Output | Name of the storage bucket. | | +| Field | Required | Binding support | Details | Example | +| ------------- | -------- | --------------- | ------------------------------------------- | ------------------------------------------------------------------------------------ | +| `endpoint` | Y | Output | Alicloud OSS endpoint. | https://oss-cn-hangzhou.aliyuncs.com | +| `accessKeyID` | Y | Output | Access key ID credential. | | +| `accessKey` | Y | Output | Access key credential. | | +| `bucket` | Y | Output | Name of the storage bucket. | | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudsls.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudsls.md index 0563e1e6a..d76638e34 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudsls.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudsls.md @@ -30,11 +30,11 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------------- | -------- | --------------- | ---------------------------- | ------- | -| `AccessKeyID` | Y | Output | Access key ID credential. | | -| `AccessKeySecret` | Y | Output | Access key credential secret | | -| `Endpoint` | Y | Output | Alicloud SLS endpoint. | | +| Field | Required | Binding support | Details | Example | +| ----------------- | -------- | --------------- | ----------------------------------------- | ------- | +| `AccessKeyID` | Y | Output | Access key ID credential. | | +| `AccessKeySecret` | Y | Output | Access key credential secret | | +| `Endpoint` | Y | Output | Alicloud SLS endpoint. | | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudtablestore.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudtablestore.md index a115835ec..a0ecb6284 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudtablestore.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/alicloudtablestore.md @@ -40,13 +40,13 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| -------------- | -------- | --------------- | ----------------------------- | -------------------------------------------- | -| `endpoint` | Y | Output | Alicloud Tablestore endpoint. | https\://tablestore-cn-hangzhou.aliyuncs.com | -| `accessKeyID` | Y | Output | Access key ID credential. | | -| `accessKey` | Y | Output | Access key credential. | | -| `instanceName` | Y | Output | Name of the instance. | | -| `tableName` | Y | Output | Name of the table. | | +| Field | Required | Binding support | Details | Example | +| -------------- | -------- | --------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `endpoint` | Y | Output | Alicloud Tablestore endpoint. | https://tablestore-cn-hangzhou.aliyuncs.com | +| `accessKeyID` | Y | Output | Access key ID credential. | | +| `accessKey` | Y | Output | Access key credential. | | +| `instanceName` | Y | Output | Name of the instance. | | +| `tableName` | Y | Output | Name of the table. | | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/apns.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/apns.md index 9192d8c26..5bc2117ff 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/apns.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/apns.md @@ -34,11 +34,11 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------- | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -| `development` | Y | Output | Tells the binding which APNs service to use. Set to `"true"` to use the development service or `"false"` to use the production service. Default: `"true"` | `"true"` | -| `key-id` | Y | Output | The identifier for the private key from the Apple Developer Portal | `"private-key-id`" | -| `team-id` | Y | Output | The identifier for the organization or author from the Apple Developer Portal | `"team-id"` | +| Field | Required | Binding support | Details | Example | +| ------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | +| `development` | Y | Output | Tells the binding which APNs service to use. Set to `"true"` to use the development service or `"false"` to use the production service. Default: `"true"` | `"true"` | +| `key-id` | Y | Output | The identifier for the private key from the Apple Developer Portal | `"private-key-id`" | +| `team-id` | Y | Output | The identifier for the organization or author from the Apple Developer Portal | `"team-id"` | | `private-key` | Y | Output | Is a PKCS #8-formatted private key. It is intended that the private key is stored in the secret store and not exposed directly in the configuration. See [here](#private-key) for more details | `"pem file"` | ### Private key diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/blobstorage.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/blobstorage.md index b9f7f4f5a..f57ccb47d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/blobstorage.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/blobstorage.md @@ -40,15 +40,15 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | -| `accountName` | Y | Input/Output | The name of the Azure Storage account | `"myexmapleaccount"` | -| `accountKey` | Y\* | Input/Output | The access key of the Azure Storage account. Only required when not using Microsoft Entra ID authentication. | `"access-key"` | -| `containerName` | Y | Output | The name of the Blob Storage container to write to | `myexamplecontainer` | +| Field | Required | Binding support | Details | Example | +| ------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | +| `accountName` | Y | Input/Output | The name of the Azure Storage account | `"myexmapleaccount"` | +| `accountKey` | Y\* | Input/Output | The access key of the Azure Storage account. Only required when not using Microsoft Entra ID authentication. | `"access-key"` | +| `containerName` | Y | Output | The name of the Blob Storage container to write to | `myexamplecontainer` | | `endpoint` | N | Input/Output | Optional custom endpoint URL. This is useful when using the [Azurite emulator](https://github.com/Azure/azurite) or when using custom domains for Azure Storage (although this is not officially supported). The endpoint must be the full base URL, including the protocol (`http://` or `https://`), the IP or FQDN, and optional port. | `"http://127.0.0.1:10000"` | -| `decodeBase64` | N | Output | Configuration to decode base64 file content before saving to Blob Storage. (In case of saving a file with binary content). Defaults to `false` | `true`, `false` | -| `getBlobRetryCount` | N | Output | Specifies the maximum number of HTTP GET requests that will be made while reading from a RetryReader Defaults to `10` | `1`, `2` | -| `publicAccessLevel` | N | Output | Specifies whether data in the container may be accessed publicly and the level of access (only used if the container is created by Dapr). Defaults to `none` | `blob`, `container`, `none` | +| `decodeBase64` | N | Output | Configuration to decode base64 file content before saving to Blob Storage. (In case of saving a file with binary content). Defaults to `false` | `true`, `false` | +| `getBlobRetryCount` | N | Output | Specifies the maximum number of HTTP GET requests that will be made while reading from a RetryReader Defaults to `10` | `1`, `2` | +| `publicAccessLevel` | N | Output | Specifies whether data in the container may be accessed publicly and the level of access (only used if the container is created by Dapr). Defaults to `none` | `blob`, `container`, `none` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cloudflare-queues.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cloudflare-queues.md index e3e159fc6..604efea5d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cloudflare-queues.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cloudflare-queues.md @@ -54,10 +54,10 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------- | :------: | --------------- | ----------------------------------------------------------------------------------- | -------------------------------------------- | -| `queueName` | Y | Output | Name of the existing Cloudflare Queue | `"mydaprqueue"` | -| `key` | Y | Output | Ed25519 private key, PEM-encoded | _See example above_ | +| Field | Required | Binding support | Details | Example | +| ------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| `queueName` | Y | Output | Name of the existing Cloudflare Queue | `"mydaprqueue"` | +| `key` | Y | Output | Ed25519 private key, PEM-encoded | _See example above_ | | `cfAccountID` | Y/N | Output | Cloudflare account ID. Required to have Dapr manage the worker. | `"456789abcdef8b5588f3d134f74ac"def` | | `cfAPIToken` | Y/N | Output | API token for Cloudflare. Required to have Dapr manage the Worker. | `"secret-key"` | | `workerUrl` | Y/N | Output | URL of the Worker. Required if the Worker has been pre-provisioned outside of Dapr. | `"https://mydaprqueue.mydomain.workers.dev"` | @@ -212,7 +212,7 @@ openssl genpkey -algorithm ed25519 -out private.pem openssl pkey -in private.pem -pubout -out public.pem ``` -> On macOS, using openssl\@3 from Homebrew: +> On macOS, using openssl@3 from Homebrew: > > ```sh > $(brew --prefix)/opt/openssl@3/bin/openssl genpkey -algorithm ed25519 -out private.pem diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cosmosdb.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cosmosdb.md index 14b69dd67..a64caaebf 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cosmosdb.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cosmosdb.md @@ -38,12 +38,12 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| -------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| `url` | Y | Output | The Cosmos DB url | `"https://******.documents.azure.com:443/"` | -| `masterKey` | Y | Output | The Cosmos DB account master key | `"master-key"` | -| `database` | Y | Output | The name of the Cosmos DB database | `"OrderDb"` | -| `collection` | Y | Output | The name of the container inside the database. | `"Orders"` | +| Field | Required | Binding support | Details | Example | +| -------------- | :------: | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| `url` | Y | Output | The Cosmos DB url | `"https://******.documents.azure.com:443/"` | +| `masterKey` | Y | Output | The Cosmos DB account master key | `"master-key"` | +| `database` | Y | Output | The name of the Cosmos DB database | `"OrderDb"` | +| `collection` | Y | Output | The name of the container inside the database. | `"Orders"` | | `partitionKey` | Y | Output | The name of the key to extract from the payload (document to be created) that is used as the partition key. This name must match the partition key specified upon creation of the Cosmos DB container. | `"OrderId"`, `"message"` | For more information see [Azure Cosmos DB resource model](https://docs.microsoft.com/azure/cosmos-db/account-databases-containers-items). diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cron.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cron.md index d29a596f9..94452bd74 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cron.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/cron.md @@ -28,10 +28,10 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------- | :------: | --------------- | ----------------------------------------------------------------------------- | -------------- | +| Field | Required | Binding support | Details | Example | +| ----------- | :------: | --------------- | --------------------------------------------------------------------------------------------- | -------------- | | `schedule` | Y | Input | The valid cron schedule to use. See [this](#schedule-format) for more details | `"@every 15m"` | -| `direction` | N | Input | The direction of the binding | `"input"` | +| `direction` | N | Input | The direction of the binding | `"input"` | ### Schedule Format diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventgrid.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventgrid.md index 3574b34d7..cacc9efc3 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventgrid.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventgrid.md @@ -57,19 +57,19 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------------------- | :------: | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| `accessKey` | Y | Output | The Access Key to be used for publishing an Event Grid Event to a custom topic | `"accessKey"` | -| `topicEndpoint` | Y | Output | The topic endpoint in which this output binding should publish events | `"topic-endpoint"` | -| `azureTenantId` | Y | Input | The Azure tenant ID of the Event Grid resource | `"tenentID"` | -| `azureSubscriptionId` | Y | Input | The Azure subscription ID of the Event Grid resource | `"subscriptionId"` | -| `azureClientId` | Y | Input | The client ID that should be used by the binding to create or update the Event Grid Event Subscription and to authenticate incoming messages | `"clientId"` | -| `azureClientSecret` | Y | Input | The client id that should be used by the binding to create or update the Event Grid Event Subscription and to authenticate incoming messages | `"clientSecret"` | +| Field | Required | Binding support | Details | Example | +| ----------------------- | :------: | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| `accessKey` | Y | Output | The Access Key to be used for publishing an Event Grid Event to a custom topic | `"accessKey"` | +| `topicEndpoint` | Y | Output | The topic endpoint in which this output binding should publish events | `"topic-endpoint"` | +| `azureTenantId` | Y | Input | The Azure tenant ID of the Event Grid resource | `"tenentID"` | +| `azureSubscriptionId` | Y | Input | The Azure subscription ID of the Event Grid resource | `"subscriptionId"` | +| `azureClientId` | Y | Input | The client ID that should be used by the binding to create or update the Event Grid Event Subscription and to authenticate incoming messages | `"clientId"` | +| `azureClientSecret` | Y | Input | The client id that should be used by the binding to create or update the Event Grid Event Subscription and to authenticate incoming messages | `"clientSecret"` | | `subscriberEndpoint` | Y | Input | The HTTPS endpoint of the webhook Event Grid sends events (formatted as Cloud Events) to. If you're not re-writing URLs on ingress, it should be in the form of: `"https://[YOUR HOSTNAME]/"`
If testing on your local machine, you can use something like [ngrok](https://ngrok.com) to create a public endpoint. | `"https://[YOUR HOSTNAME]/"` | -| `handshakePort` | Y | Input | The container port that the input binding listens on when receiving events on the webhook | `"9000"` | -| `scope` | Y | Input | The identifier of the resource to which the event subscription needs to be created or updated. See the [scope section](#scope) for more details | `"/subscriptions/{subscriptionId}/"` | -| `eventSubscriptionName` | N | Input | The name of the event subscription. Event subscription names must be between 3 and 64 characters long and should use alphanumeric letters only | `"name"` | -| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | +| `handshakePort` | Y | Input | The container port that the input binding listens on when receiving events on the webhook | `"9000"` | +| `scope` | Y | Input | The identifier of the resource to which the event subscription needs to be created or updated. See the [scope section](#scope) for more details | `"/subscriptions/{subscriptionId}/"` | +| `eventSubscriptionName` | N | Input | The name of the event subscription. Event subscription names must be between 3 and 64 characters long and should use alphanumeric letters only | `"name"` | +| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | ### Scope diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventhubs.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventhubs.md index 94abbbb7c..9dd2bb564 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventhubs.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/eventhubs.md @@ -66,22 +66,22 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `eventHub` | Y\* | Input/Output | The name of the Event Hubs hub ("topic"). Required if using Microsoft Entra ID authentication or if the connection string doesn't contain an `EntityPath` value | `mytopic` | +| Field | Required | Binding support | Details | Example | +| ------------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `eventHub` | Y\* | Input/Output | The name of the Event Hubs hub ("topic"). Required if using Microsoft Entra ID authentication or if the connection string doesn't contain an `EntityPath` value | `mytopic` | | `connectionString` | Y\* | Input/Output | Connection string for the Event Hub or the Event Hub namespace.
\* Mutally exclusive with `eventHubNamespace` field.
\* Required when not using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` or `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"` | | `eventHubNamespace` | Y\* | Input/Output | The Event Hub Namespace name.
\* Mutally exclusive with `connectionString` field.
\* Required when using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"namespace"` | -| `enableEntityManagement` | N | Input/Output | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true", "false"` | -| `resourceGroupName` | N | Input/Output | Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled | `"test-rg"` | -| `subscriptionID` | N | Input/Output | Azure subscription ID value. Required when entity management is enabled | `"azure subscription id"` | +| `enableEntityManagement` | N | Input/Output | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true", "false"` | +| `resourceGroupName` | N | Input/Output | Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled | `"test-rg"` | +| `subscriptionID` | N | Input/Output | Azure subscription ID value. Required when entity management is enabled | `"azure subscription id"` | | `partitionCount` | N | Input/Output | Number of partitions for the new Event Hub namespace. Used only when entity management is enabled. Default: `"1"` | `"2"` | | `messageRetentionInDays` | N | Input/Output | Number of days to retain messages for in the newly created Event Hub namespace. Used only when entity management is enabled. Default: `"1"` | `"90"` | -| `consumerGroup` | Y | Input | The name of the [Event Hubs Consumer Group](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#consumer-groups) to listen on | `"group1"` | -| `storageAccountName` | Y | Input | Storage account name to use for the checkpoint store. | `"myeventhubstorage"` | -| `storageAccountKey` | Y\* | Input | Storage account key for the checkpoint store account.
\* When using Microsoft Entra ID, it's possible to omit this if the service principal has access to the storage account too. | `"112233445566778899"` | -| `storageConnectionString` | Y\* | Input | Connection string for the checkpoint store, alternative to specifying `storageAccountKey` | `"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey="` | -| `storageContainerName` | Y | Input | Storage container name for the storage account name. | `"myeventhubstoragecontainer"` | -| `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` | +| `consumerGroup` | Y | Input | The name of the [Event Hubs Consumer Group](https://docs.microsoft.com/azure/event-hubs/event-hubs-features#consumer-groups) to listen on | `"group1"` | +| `storageAccountName` | Y | Input | Storage account name to use for the checkpoint store. | `"myeventhubstorage"` | +| `storageAccountKey` | Y\* | Input | Storage account key for the checkpoint store account.
\* When using Microsoft Entra ID, it's possible to omit this if the service principal has access to the storage account too. | `"112233445566778899"` | +| `storageConnectionString` | Y\* | Input | Connection string for the checkpoint store, alternative to specifying `storageAccountKey` | `"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey="` | +| `storageContainerName` | Y | Input | Storage container name for the storage account name. | `"myeventhubstoragecontainer"` | +| `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` | ### Microsoft Entra ID authentication @@ -99,14 +99,14 @@ Azure IoT Hub provides an [endpoint that is compatible with Event Hubs](https:// The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs binding for Dapr will return the following as part of the response metadata: -| System Property Name | Description & Routing Query Keyword | -| -------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| System Property Name | Description & Routing Query Keyword | +| -------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. | +| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. | | `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | | `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. | -| `message-id` | The user-settable AMQP **messageId**. | +| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. | +| `message-id` | The user-settable AMQP **messageId**. | For example, the headers of a HTTP `Read()` response would contain: diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcpbucket.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcpbucket.md index b3cf6c776..5134f1627 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcpbucket.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcpbucket.md @@ -54,19 +54,19 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| `bucket` | Y | Output | The bucket name | `"mybucket"` | -| `type` | Y | Output | Tge GCP credentials type | `"service_account"` | -| `project_id` | Y | Output | GCP project id | `projectId` | -| `private_key_id` | Y | Output | GCP private key id | `"privateKeyId"` | -| `private_key` | Y | Output | GCP credentials private key. Replace with x509 cert | `12345-12345` | -| `client_email` | Y | Output | GCP client email | `"client@email.com"` | -| `client_id` | Y | Output | GCP client id | `0123456789-0123456789` | -| `auth_uri` | Y | Output | Google account OAuth endpoint | `https://accounts.google.com/o/oauth2/auth` | -| `token_uri` | Y | Output | Google account token uri | `https://oauth2.googleapis.com/token` | -| `auth_provider_x509_cert_url` | Y | Output | GCP credentials cert url | `https://www.googleapis.com/oauth2/v1/certs` | -| `client_x509_cert_url` | Y | Output | GCP credentials project x509 cert url | `https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com` | +| Field | Required | Binding support | Details | Example | +| ----------------------------- | :------: | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| `bucket` | Y | Output | The bucket name | `"mybucket"` | +| `type` | Y | Output | Tge GCP credentials type | `"service_account"` | +| `project_id` | Y | Output | GCP project id | `projectId` | +| `private_key_id` | Y | Output | GCP private key id | `"privateKeyId"` | +| `private_key` | Y | Output | GCP credentials private key. Replace with x509 cert | `12345-12345` | +| `client_email` | Y | Output | GCP client email | `"client@email.com"` | +| `client_id` | Y | Output | GCP client id | `0123456789-0123456789` | +| `auth_uri` | Y | Output | Google account OAuth endpoint | `https://accounts.google.com/o/oauth2/auth` | +| `token_uri` | Y | Output | Google account token uri | `https://oauth2.googleapis.com/token` | +| `auth_provider_x509_cert_url` | Y | Output | GCP credentials cert url | `https://www.googleapis.com/oauth2/v1/certs` | +| `client_x509_cert_url` | Y | Output | GCP credentials project x509 cert url | `https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com` | | `decodeBase64` | N | Output | Configuration to decode base64 file content before saving to bucket storage. (In case of saving a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` | | `encodeBase64` | N | Output | Configuration to encode base64 file content before return the content. (In case of opening a file with binary content). `true` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `true`, `false` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcppubsub.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcppubsub.md index b5ca4f67f..6102c46e4 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcppubsub.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/gcppubsub.md @@ -54,20 +54,20 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------------------------- | :------: | ----------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| `topic` | Y | Output | GCP Pub/Sub topic name | `"topic1"` | -| `subscription` | N | GCP Pub/Sub subscription name | `"name1"` | | -| `type` | Y | Output | GCP credentials type | `service_account` | -| `project_id` | Y | Output | GCP project id | `projectId` | -| `private_key_id` | N | Output | GCP private key id | `"privateKeyId"` | +| Field | Required | Binding support | Details | Example | +| ----------------------------- | :------: | ----------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| `topic` | Y | Output | GCP Pub/Sub topic name | `"topic1"` | +| `subscription` | N | GCP Pub/Sub subscription name | `"name1"` | | +| `type` | Y | Output | GCP credentials type | `service_account` | +| `project_id` | Y | Output | GCP project id | `projectId` | +| `private_key_id` | N | Output | GCP private key id | `"privateKeyId"` | | `private_key` | Y | Output | GCP credentials private key. Replace with x509 cert | `12345-12345` | -| `client_email` | Y | Output | GCP client email | `"client@email.com"` | -| `client_id` | N | Output | GCP client id | `0123456789-0123456789` | -| `auth_uri` | N | Output | Google account OAuth endpoint | `https://accounts.google.com/o/oauth2/auth` | -| `token_uri` | N | Output | Google account token uri | `https://oauth2.googleapis.com/token` | -| `auth_provider_x509_cert_url` | N | Output | GCP credentials cert url | `https://www.googleapis.com/oauth2/v1/certs` | -| `client_x509_cert_url` | N | Output | GCP credentials project x509 cert url | `https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com` | +| `client_email` | Y | Output | GCP client email | `"client@email.com"` | +| `client_id` | N | Output | GCP client id | `0123456789-0123456789` | +| `auth_uri` | N | Output | Google account OAuth endpoint | `https://accounts.google.com/o/oauth2/auth` | +| `token_uri` | N | Output | Google account token uri | `https://oauth2.googleapis.com/token` | +| `auth_provider_x509_cert_url` | N | Output | GCP credentials cert url | `https://www.googleapis.com/oauth2/v1/certs` | +| `client_x509_cert_url` | N | Output | GCP credentials project x509 cert url | `https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com` | | `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/graghql.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/graghql.md index dc798244c..15e14d156 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/graghql.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/graghql.md @@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| `endpoint` | Y | Output | GraphQL endpoint string See [here](#url-format) for more details | `"http://localhost:4000/graphql/graphql"` | +| Field | Required | Binding support | Details | Example | +| ------------------------ | :------: | --------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| `endpoint` | Y | Output | GraphQL endpoint string See [here](#url-format) for more details | `"http://localhost:4000/graphql/graphql"` | | `header:[HEADERKEY]` | N | Output | GraphQL header. Specify the header key in the `name`, and the header value in the `value`. | `"no-cache"` (see above) | | `variable:[VARIABLEKEY]` | N | Output | GraphQL query variable. Specify the variable name in the `name`, and the variable value in the `value`. | `"123"` (see below) | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/http.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/http.md index 9026932db..80cfba2e0 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/http.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/http.md @@ -46,16 +46,16 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | | | -| --------------------- | :------: | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------- | -| `url` | Y | Output | The base URL of the HTTP endpoint to invoke | `http://host:port/path`, `http://myservice:8000/customers` | | | +| Field | Required | Binding support | Details | Example | | | +| --------------------- | :------: | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------- | +| `url` | Y | Output | The base URL of the HTTP endpoint to invoke | `http://host:port/path`, `http://myservice:8000/customers` | | | | `maxResponseBodySize` | N | Output | Maximum length of the response to read. A whole number is interpreted as bytes; units such as `Ki, Mi, Gi` (SI) or \`k | M | G`(decimal) can be added for convenience. The default value is`100Mi\` | "1Gi", "100Mi", "20Ki", "200" (bytes) | -| `MTLSRootCA` | N | Output | Path to root CA certificate or PEM-encoded string | | | | -| `MTLSClientCert` | N | Output | Path to client certificate or PEM-encoded string | | | | -| `MTLSClientKey` | N | Output | Path client private key or PEM-encoded string | | | | -| `MTLSRenegotiation` | N | Output | Type of mTLS renegotiation to be used | `RenegotiateOnceAsClient` | | | +| `MTLSRootCA` | N | Output | Path to root CA certificate or PEM-encoded string | | | | +| `MTLSClientCert` | N | Output | Path to client certificate or PEM-encoded string | | | | +| `MTLSClientKey` | N | Output | Path client private key or PEM-encoded string | | | | +| `MTLSRenegotiation` | N | Output | Type of mTLS renegotiation to be used | `RenegotiateOnceAsClient` | | | | `securityToken` | N | Output | The value of a token to be added to a HTTP request as a header. Used together with `securityTokenHeader` | | | | -| `securityTokenHeader` | N | Output | The name of the header for `securityToken` on a HTTP request | | | | +| `securityTokenHeader` | N | Output | The name of the header for `securityToken` on a HTTP request | | | | | `errorIfNot2XX` | N | Output | If a binding error should be thrown when the response is not in the 2xx range. Defaults to `true` | | | | The values for **MTLSRootCA**, **MTLSClientCert** and **MTLSClientKey** can be provided in three ways: @@ -110,10 +110,10 @@ This component supports **output binding** with the following [HTTP methods/verb All of the operations above support the following metadata fields -| Field | Required | Details | Example | -| ------------------------------------- | :------: | ----------------------------------------------------------------------- | ------------------------------------- | -| `path` | N | The path to append to the base URL. Used for accessing specific URIs. | `"/1234"`, `"/search?lastName=Jones"` | -| Field with a capitalized first letter | N | Any fields that have a capital first letter are sent as request headers | `"Content-Type"`, `"Accept"` | +| Field | Required | Details | Example | +| ------------------------------------- | :------: | ----------------------------------------------------------------------------------------------------- | ------------------------------------- | +| `path` | N | The path to append to the base URL. Used for accessing specific URIs. | `"/1234"`, `"/search?lastName=Jones"` | +| Field with a capitalized first letter | N | Any fields that have a capital first letter are sent as request headers | `"Content-Type"`, `"Accept"` | #### Retrieving data diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kafka.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kafka.md index 34bc67852..879c33810 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kafka.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kafka.md @@ -63,33 +63,33 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| `topics` | N | Input | A comma-separated string of topics. | `"mytopic1,topic2"` | -| `brokers` | Y | Input/Output | A comma-separated string of Kafka brokers. | `"localhost:9092,dapr-kafka.myapp.svc.cluster.local:9093"` | -| `clientID` | N | Input/Output | A user-provided string sent with every request to the Kafka brokers for logging, debugging, and auditing purposes. | `"my-dapr-app"` | -| `consumerGroup` | N | Input | A kafka consumer group to listen on. Each record published to a topic is delivered to one consumer within each consumer group subscribed to the topic. | `"group1"` | -| `consumeRetryEnabled` | N | Input/Output | Enable consume retry by setting to `"true"`. Default to `false` in Kafka binding component. | `"true"`, `"false"` | -| `publishTopic` | Y | Output | The topic to publish to. | `"mytopic"` | -| `authRequired` | N | _Deprecated_ | Enable [SASL](https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer) authentication with the Kafka brokers. | `"true"`, `"false"` | -| `authType` | Y | Input/Output | Configure or disable authentication. Supported values: `none`, `password`, `mtls`, or `oidc` | `"password"`, `"none"` | -| `saslUsername` | N | Input/Output | The SASL username used for authentication. Only required if `authRequired` is set to `"true"`. | `"adminuser"` | -| `saslPassword` | N | Input/Output | The SASL password used for authentication. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). Only required if `authRequired` is set to `"true"`. | `""`, `"KeFg23!"` | -| `saslMechanism` | N | Input/Output | The SASL authentication mechanism you'd like to use. Only required if `authtype` is set to `"password"`. If not provided, defaults to `PLAINTEXT`, which could cause a break for some services, like Amazon Managed Service for Kafka. | `"SHA-512", "SHA-256", "PLAINTEXT"` | -| `initialOffset` | N | Input | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"` | -| `maxMessageBytes` | N | Input/Output | The maximum size in bytes allowed for a single Kafka message. Defaults to 1024. | `"2048"` | -| `oidcTokenEndpoint` | N | Input/Output | Full URL to an OAuth2 identity provider access token endpoint. Required when `authType` is set to `oidc` | "https\://identity.example.com/v1/token" | -| `oidcClientID` | N | Input/Output | The OAuth2 client ID that has been provisioned in the identity provider. Required when `authType` is set to `oidc` | `"dapr-kafka"` | -| `oidcClientSecret` | N | Input/Output | The OAuth2 client secret that has been provisioned in the identity provider: Required when `authType` is set to `oidc` | `"KeFg23!"` | -| `oidcScopes` | N | Input/Output | Comma-delimited list of OAuth2/OIDC scopes to request with the access token. Recommended when `authType` is set to `oidc`. Defaults to `"openid"` | `"openid,kafka-prod"` | -| `version` | N | Input/Output | Kafka cluster version. Defaults to 2.0.0. Please note that this needs to be mandatorily set to `1.0.0` for EventHubs with Kafka. | `"1.0.0"` | -| `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` | -| `oidcExtensions` | N | Input/Output | String containing a JSON-encoded dictionary of OAuth2/OIDC extensions to request with the access token | `{"cluster":"kafka","poolid":"kafkapool"}` | -| `schemaRegistryURL` | N | Required when using Schema Registry Avro serialization/deserialization. The Schema Registry URL. | `http://localhost:8081` | | -| `schemaRegistryAPIKey` | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Key. | `XYAXXAZ` | | -| `schemaRegistryAPISecret` | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Secret. | `ABCDEFGMEADFF` | | -| `schemaCachingEnabled` | N | When using Schema Registry Avro serialization/deserialization. Enables caching for schemas. Default is `true` | `true` | | -| `schemaLatestVersionCacheTTL` | N | When using Schema Registry Avro serialization/deserialization. The TTL for schema caching when publishing a message with latest schema available. Default is 5 min | `5m` | | +| Field | Required | Binding support | Details | Example | +| ----------------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `topics` | N | Input | A comma-separated string of topics. | `"mytopic1,topic2"` | +| `brokers` | Y | Input/Output | A comma-separated string of Kafka brokers. | `"localhost:9092,dapr-kafka.myapp.svc.cluster.local:9093"` | +| `clientID` | N | Input/Output | A user-provided string sent with every request to the Kafka brokers for logging, debugging, and auditing purposes. | `"my-dapr-app"` | +| `consumerGroup` | N | Input | A kafka consumer group to listen on. Each record published to a topic is delivered to one consumer within each consumer group subscribed to the topic. | `"group1"` | +| `consumeRetryEnabled` | N | Input/Output | Enable consume retry by setting to `"true"`. Default to `false` in Kafka binding component. | `"true"`, `"false"` | +| `publishTopic` | Y | Output | The topic to publish to. | `"mytopic"` | +| `authRequired` | N | _Deprecated_ | Enable [SASL](https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer) authentication with the Kafka brokers. | `"true"`, `"false"` | +| `authType` | Y | Input/Output | Configure or disable authentication. Supported values: `none`, `password`, `mtls`, or `oidc` | `"password"`, `"none"` | +| `saslUsername` | N | Input/Output | The SASL username used for authentication. Only required if `authRequired` is set to `"true"`. | `"adminuser"` | +| `saslPassword` | N | Input/Output | The SASL password used for authentication. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). Only required if `authRequired` is set to `"true"`. | `""`, `"KeFg23!"` | +| `saslMechanism` | N | Input/Output | The SASL authentication mechanism you'd like to use. Only required if `authtype` is set to `"password"`. If not provided, defaults to `PLAINTEXT`, which could cause a break for some services, like Amazon Managed Service for Kafka. | `"SHA-512", "SHA-256", "PLAINTEXT"` | +| `initialOffset` | N | Input | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"` | +| `maxMessageBytes` | N | Input/Output | The maximum size in bytes allowed for a single Kafka message. Defaults to 1024. | `"2048"` | +| `oidcTokenEndpoint` | N | Input/Output | Full URL to an OAuth2 identity provider access token endpoint. Required when `authType` is set to `oidc` | "https://identity.example.com/v1/token" | +| `oidcClientID` | N | Input/Output | The OAuth2 client ID that has been provisioned in the identity provider. Required when `authType` is set to `oidc` | `"dapr-kafka"` | +| `oidcClientSecret` | N | Input/Output | The OAuth2 client secret that has been provisioned in the identity provider: Required when `authType` is set to `oidc` | `"KeFg23!"` | +| `oidcScopes` | N | Input/Output | Comma-delimited list of OAuth2/OIDC scopes to request with the access token. Recommended when `authType` is set to `oidc`. Defaults to `"openid"` | `"openid,kafka-prod"` | +| `version` | N | Input/Output | Kafka cluster version. Defaults to 2.0.0. Please note that this needs to be mandatorily set to `1.0.0` for EventHubs with Kafka. | `"1.0.0"` | +| `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` | +| `oidcExtensions` | N | Input/Output | String containing a JSON-encoded dictionary of OAuth2/OIDC extensions to request with the access token | `{"cluster":"kafka","poolid":"kafkapool"}` | +| `schemaRegistryURL` | N | Required when using Schema Registry Avro serialization/deserialization. The Schema Registry URL. | `http://localhost:8081` | | +| `schemaRegistryAPIKey` | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Key. | `XYAXXAZ` | | +| `schemaRegistryAPISecret` | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Secret. | `ABCDEFGMEADFF` | | +| `schemaCachingEnabled` | N | When using Schema Registry Avro serialization/deserialization. Enables caching for schemas. Default is `true` | `true` | | +| `schemaLatestVersionCacheTTL` | N | When using Schema Registry Avro serialization/deserialization. The TTL for schema caching when publishing a message with latest schema available. Default is 5 min | `5m` | | #### Note diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kinesis.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kinesis.md index 4abd77842..88d5de7c7 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kinesis.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kinesis.md @@ -47,16 +47,16 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| -------------- | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| Field | Required | Binding support | Details | Example | +| -------------- | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | `mode` | N | Input | The Kinesis stream mode. `shared`- Shared throughput, `extended` - Extended/Enhanced fanout methods. More details are [here](https://docs.aws.amazon.com/streams/latest/dev/building-consumers.html). Defaults to `"shared"` | `"shared"`, `"extended"` | -| `streamName` | Y | Input/Output | The AWS Kinesis Stream Name | `"stream"` | -| `consumerName` | Y | Input | The AWS Kinesis Consumer Name | `"myconsumer"` | -| `region` | Y | Output | The specific AWS region the AWS Kinesis instance is deployed in | `"us-east-1"` | -| `accessKey` | Y | Output | The AWS Access Key to access this resource | `"key"` | -| `secretKey` | Y | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | -| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` | -| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | +| `streamName` | Y | Input/Output | The AWS Kinesis Stream Name | `"stream"` | +| `consumerName` | Y | Input | The AWS Kinesis Consumer Name | `"myconsumer"` | +| `region` | Y | Output | The specific AWS region the AWS Kinesis instance is deployed in | `"us-east-1"` | +| `accessKey` | Y | Output | The AWS Access Key to access this resource | `"key"` | +| `secretKey` | Y | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | +| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` | +| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | {{% alert title="Important" color="warning" %}} When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you're using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you **must not** provide AWS access-key, secret-key, and tokens in the definition of the component spec you're using.\ diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubemq.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubemq.md index c9052624d..1a5c764fc 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubemq.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubemq.md @@ -30,15 +30,15 @@ spec: ## Spec metadata fields -| Field | Required | Details | Example | -| -------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| `address` | Y | Address of the KubeMQ server | `"localhost:50000"` | -| `channel` | Y | The Queue channel name | `"queue1"` | +| Field | Required | Details | Example | +| -------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| `address` | Y | Address of the KubeMQ server | `"localhost:50000"` | +| `channel` | Y | The Queue channel name | `"queue1"` | | `authToken` | N | Auth JWT token for connection. Check out [KubeMQ Authentication](https://docs.kubemq.io/learn/access-control/authentication) | `"ew..."` | -| `autoAcknowledged` | N | Sets if received queue message is automatically acknowledged | `"true"` or `"false"` (default is `"false"`) | -| `pollMaxItems` | N | Sets the number of messages to poll on every connection | `"1"` | -| `pollTimeoutSeconds` | N | Sets the time in seconds for each poll interval | `"3600"` | -| `direction` | N | The direction of the binding | `"input"`, `"output"`, `"input, output"` | +| `autoAcknowledged` | N | Sets if received queue message is automatically acknowledged | `"true"` or `"false"` (default is `"false"`) | +| `pollMaxItems` | N | Sets the number of messages to poll on every connection | `"1"` | +| `pollTimeoutSeconds` | N | Sets the time in seconds for each poll interval | `"3600"` | +| `direction` | N | The direction of the binding | `"input"`, `"output"`, `"input, output"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubernetes-binding.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubernetes-binding.md index aac420962..c73ba5f58 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubernetes-binding.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/kubernetes-binding.md @@ -30,11 +30,11 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------- | ----------------------- | -| `namespace` | Y | Input | The Kubernetes namespace to read events from | `"default"` | +| Field | Required | Binding support | Details | Example | +| ------------------- | :------: | --------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------- | +| `namespace` | Y | Input | The Kubernetes namespace to read events from | `"default"` | | `resyncPeriodInSec` | N | Input | The period of time to refresh event list from Kubernetes API server. Defaults to `"10"` | `"15"` | -| `direction` | N | Input | The direction of the binding | `"input"` | +| `direction` | N | Input | The direction of the binding | `"input"` | | `kubeconfigPath` | N | Input | The path to the kubeconfig file. If not specified, the binding uses the default in-cluster config value | `"/path/to/kubeconfig"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mqtt3.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mqtt3.md index 8e3509966..a77e1968e 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mqtt3.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mqtt3.md @@ -44,18 +44,18 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------- | :--------------------: | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | +| Field | Required | Binding support | Details | Example | +| ------------------- | :--------------------: | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | `url` | Y | Input/Output | Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference.
Use the **`tcp://`** URI scheme for non-TLS communication.
Use the **`ssl://`** URI scheme for TLS communication. | `"tcp://[username][:password]@host.domain[:port]"` | -| `topic` | Y | Input/Output | The topic to listen on or send events to. | `"mytopic"` | -| `consumerID` | Y | Input/Output | The client ID used to connect to the MQTT broker. | `"myMqttClientApp"` | -| `retain` | N | Input/Output | Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`. | `"true"`, `"false"` | -| `cleanSession` | N | Input/Output | Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"`. Defaults to `"false"`. | `"true"`, `"false"` | -| `caCert` | Required for using TLS | Input/Output | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | See example below | -| `clientCert` | Required for using TLS | Input/Output | TLS client certificate in PEM format. Must be used with `clientKey`. | See example below | -| `clientKey` | Required for using TLS | Input/Output | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | See example below | +| `topic` | Y | Input/Output | The topic to listen on or send events to. | `"mytopic"` | +| `consumerID` | Y | Input/Output | The client ID used to connect to the MQTT broker. | `"myMqttClientApp"` | +| `retain` | N | Input/Output | Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`. | `"true"`, `"false"` | +| `cleanSession` | N | Input/Output | Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"`. Defaults to `"false"`. | `"true"`, `"false"` | +| `caCert` | Required for using TLS | Input/Output | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | See example below | +| `clientCert` | Required for using TLS | Input/Output | TLS client certificate in PEM format. Must be used with `clientKey`. | See example below | +| `clientKey` | Required for using TLS | Input/Output | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | See example below | | `backOffMaxRetries` | N | Input | The maximum number of retries to process the message before returning an error. Defaults to `"0"`, which means that no retries will be attempted. `"-1"` can be specified to indicate that messages should be retried indefinitely until they are successfully processed or the application is shutdown. The component will wait 5 seconds between retries. | `"3"` | -| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | +| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | ### Communication using TLS diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mysql.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mysql.md index a250e3433..3d8a38fce 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mysql.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/mysql.md @@ -45,8 +45,8 @@ Note that you can not use secret just for username/password. If you use secret, ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------------- | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| Field | Required | Binding support | Details | Example | +| ----------------- | :------: | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | | `url` | Y | Output | Represent DB connection in Data Source Name (DNS) format. See [here](#ssl-connection-details) SSL details | `"user:password@tcp(localhost:3306)/dbname"` | | `pemPath` | Y | Output | Path to the PEM file. Used with SSL connection | `"path/to/pem/file"` | | `maxIdleConns` | N | Output | The max idle connections. Integer greater than 0 | `"10"` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/openai.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/openai.md index 0f6246605..efadbe851 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/openai.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/openai.md @@ -33,9 +33,9 @@ The above example uses `apiKey` as a plain string. It is recommended to use a s ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | -| `endpoint` | Y | Output | Azure OpenAI service endpoint URL. | `"https://myopenai.openai.azure.com"` | +| Field | Required | Binding support | Details | Example | +| ------------------- | :------: | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| `endpoint` | Y | Output | Azure OpenAI service endpoint URL. | `"https://myopenai.openai.azure.com"` | | `apiKey` | Y\* | Output | The access key of the Azure OpenAI service. Only required when not using Microsoft Entra ID authentication. | `"1234567890abcdef"` | | `azureTenantId` | Y\* | Input | The tenant ID of the Azure OpenAI resource. Only required when `apiKey` is not provided. | `"tenentID"` | | `azureClientId` | Y\* | Input | The client ID that should be used by the binding to create or update the Azure OpenAI Subscription and to authenticate incoming messages. Only required when `apiKey` is not provided. | `"clientId"` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/postgresql.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/postgresql.md index 1dd59af12..93ad99584 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/postgresql.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/postgresql.md @@ -36,28 +36,28 @@ The above example uses secrets as plain strings. It is recommended to use a secr The following metadata options are **required** to authenticate using a PostgreSQL connection string. -| Field | Required | Details | Example | -| ------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| ------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `connectionString` | Y | The connection string for the PostgreSQL database. See the PostgreSQL [documentation on database connections](https://www.postgresql.org/docs/current/libpq-connect.html) for information on how to define a connection string. | `"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=my_db"` | ### Authenticate using Microsoft Entra ID Authenticating with Microsoft Entra ID is supported with Azure Database for PostgreSQL. All authentication methods supported by Dapr can be used, including client credentials ("service principal") and Managed Identity. -| Field | Required | Details | Example | -| ------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | +| Field | Required | Details | Example | +| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain the user, which corresponds to the name of the user created inside PostgreSQL that maps to the Microsoft Entra ID identity; this is often the name of the corresponding principal (e.g. the name of the Microsoft Entra ID application). This connection string should not contain any password. | `"host=mydb.postgres.database.azure.com user=myapplication port=5432 database=my_db sslmode=require"` | -| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | -| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | -| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | +| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | +| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | +| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | ### Other metadata options -| Field | Required | Binding support | Details | Example | -| ----------------------- | :------: | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -| `maxConns` | N | Output | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | -| `connectionMaxIdleTime` | N | Output | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | +| Field | Required | Binding support | Details | Example | +| ----------------------- | :------: | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | +| `maxConns` | N | Output | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | +| `connectionMaxIdleTime` | N | Output | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | | `queryExecMode` | N | Output | Controls the default mode for executing queries. By default Dapr uses the extended protocol and automatically prepares and caches prepared statements. However, this may be incompatible with proxies such as PGBouncer. In this case it may be preferrable to use `exec` or `simple_protocol`. | `"simple_protocol"` | ### URL format diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/rabbitmq.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/rabbitmq.md index 29a5e17fd..1fb327a69 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/rabbitmq.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/rabbitmq.md @@ -60,23 +60,23 @@ The above example uses secrets as plain strings. It is recommended to use a secr > When a new RabbitMQ message gets published, all values from the associated metadata are added to the message's header values. -| Field | Required | Binding support | Details | Example | -| ------------------------ | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `queueName` | Y | Input/Output | The RabbitMQ queue name | `"myqueue"` | -| `host` | Y | Input/Output | The RabbitMQ host address | `"amqp://[username][:password]@host.domain[:port]"` or with TLS: `"amqps://[username][:password]@host.domain[:port]"` | -| `durable` | N | Output | Tells RabbitMQ to persist message in storage. Defaults to `"false"` | `"true"`, `"false"` | -| `deleteWhenUnused` | N | Input/Output | Enables or disables auto-delete. Defaults to `"false"` | `"true"`, `"false"` | -| `ttlInSeconds` | N | Output | Set the [default message time to live at RabbitMQ queue level](https://www.rabbitmq.com/ttl.html). If this parameter is omitted, messages won't expire, continuing to exist on the queue until processed. See [also](#specifying-a-ttl-per-message) | `60` | -| `prefetchCount` | N | Input | Set the [Channel Prefetch Setting (QoS)](https://www.rabbitmq.com/confirms.html#channel-qos-prefetch). If this parameter is omiited, QoS would set value to 0 as no limit | `0` | -| `exclusive` | N | Input/Output | Determines whether the topic will be an exclusive topic or not. Defaults to `"false"` | `"true"`, `"false"` | -| `maxPriority` | N | Input/Output | Parameter to set the [priority queue](https://www.rabbitmq.com/priority.html). If this parameter is omitted, queue will be created as a general queue instead of a priority queue. Value between 1 and 255. See [also](#specifying-a-priority-per-message) | `"1"`, `"10"` | -| `contentType` | N | Input/Output | The content type of the message. Defaults to "text/plain". | `"text/plain"`, `"application/cloudevent+json"` and so on | -| `reconnectWaitInSeconds` | N | Input/Output | Represents the duration in seconds that the client should wait before attempting to reconnect to the server after a disconnection occurs. Defaults to `"5"`. | `"5"`, `"10"` | -| `externalSasl` | N | Input/Output | With TLS, should the username be taken from an additional field (e.g. CN.) See [RabbitMQ Authentication Mechanisms](https://www.rabbitmq.com/access-control.html#mechanisms). Defaults to `"false"`. | `"true"`, `"false"` | -| `caCert` | N | Input/Output | The CA certificate to use for TLS connection. Defaults to `null`. | `"-----BEGIN CERTIFICATE-----\nMI..."` | -| `clientCert` | N | Input/Output | The client certificate to use for TLS connection. Defaults to `null`. | `"-----BEGIN CERTIFICATE-----\nMI..."` | -| `clientKey` | N | Input/Output | The client key to use for TLS connection. Defaults to `null`. | `"-----BEGIN PRIVATE KEY-----\nMI..."` | -| `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` | +| Field | Required | Binding support | Details | Example | +| ------------------------ | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| `queueName` | Y | Input/Output | The RabbitMQ queue name | `"myqueue"` | +| `host` | Y | Input/Output | The RabbitMQ host address | `"amqp://[username][:password]@host.domain[:port]"` or with TLS: `"amqps://[username][:password]@host.domain[:port]"` | +| `durable` | N | Output | Tells RabbitMQ to persist message in storage. Defaults to `"false"` | `"true"`, `"false"` | +| `deleteWhenUnused` | N | Input/Output | Enables or disables auto-delete. Defaults to `"false"` | `"true"`, `"false"` | +| `ttlInSeconds` | N | Output | Set the [default message time to live at RabbitMQ queue level](https://www.rabbitmq.com/ttl.html). If this parameter is omitted, messages won't expire, continuing to exist on the queue until processed. See [also](#specifying-a-ttl-per-message) | `60` | +| `prefetchCount` | N | Input | Set the [Channel Prefetch Setting (QoS)](https://www.rabbitmq.com/confirms.html#channel-qos-prefetch). If this parameter is omiited, QoS would set value to 0 as no limit | `0` | +| `exclusive` | N | Input/Output | Determines whether the topic will be an exclusive topic or not. Defaults to `"false"` | `"true"`, `"false"` | +| `maxPriority` | N | Input/Output | Parameter to set the [priority queue](https://www.rabbitmq.com/priority.html). If this parameter is omitted, queue will be created as a general queue instead of a priority queue. Value between 1 and 255. See [also](#specifying-a-priority-per-message) | `"1"`, `"10"` | +| `contentType` | N | Input/Output | The content type of the message. Defaults to "text/plain". | `"text/plain"`, `"application/cloudevent+json"` and so on | +| `reconnectWaitInSeconds` | N | Input/Output | Represents the duration in seconds that the client should wait before attempting to reconnect to the server after a disconnection occurs. Defaults to `"5"`. | `"5"`, `"10"` | +| `externalSasl` | N | Input/Output | With TLS, should the username be taken from an additional field (e.g. CN.) See [RabbitMQ Authentication Mechanisms](https://www.rabbitmq.com/access-control.html#mechanisms). Defaults to `"false"`. | `"true"`, `"false"` | +| `caCert` | N | Input/Output | The CA certificate to use for TLS connection. Defaults to `null`. | `"-----BEGIN CERTIFICATE-----\nMI..."` | +| `clientCert` | N | Input/Output | The client certificate to use for TLS connection. Defaults to `null`. | `"-----BEGIN CERTIFICATE-----\nMI..."` | +| `clientKey` | N | Input/Output | The client key to use for TLS connection. Defaults to `null`. | `"-----BEGIN PRIVATE KEY-----\nMI..."` | +| `direction` | N | Input/Output | The direction of the binding. | `"input"`, `"output"`, `"input, output"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/redis.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/redis.md index 3460452eb..9ff3f8cae 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/redis.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/redis.md @@ -34,29 +34,29 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ----------------------- | :------: | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| `redisHost` | Y | Output | The Redis host address | `"localhost:6379"` | -| `redisPassword` | Y | Output | The Redis password | `"password"` | -| `redisUsername` | N | Output | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `"username"` | -| `enableTLS` | N | Output | If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"` | `"true"`, `"false"` | -| `failover` | N | Output | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` | -| `sentinelMasterName` | N | Output | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` | -| `redeliverInterval` | N | Output | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | -| `processingTimeout` | N | Output | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | -| `redisType` | N | Output | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | -| `redisDB` | N | Output | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | -| `redisMaxRetries` | N | Output | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` | -| `redisMinRetryInterval` | N | Output | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | -| `redisMaxRetryInterval` | N | Output | Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` | -| `dialTimeout` | N | Output | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | -| `readTimeout` | N | Output | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | -| `writeTimeout` | N | Output | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | -| `poolSize` | N | Output | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | -| `poolTimeout` | N | Output | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | -| `maxConnAge` | N | Output | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | -| `minIdleConns` | N | Output | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | -| `idleCheckFrequency` | N | Output | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | +| Field | Required | Binding support | Details | Example | +| ----------------------- | :------: | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | +| `redisHost` | Y | Output | The Redis host address | `"localhost:6379"` | +| `redisPassword` | Y | Output | The Redis password | `"password"` | +| `redisUsername` | N | Output | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `"username"` | +| `enableTLS` | N | Output | If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"` | `"true"`, `"false"` | +| `failover` | N | Output | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` | +| `sentinelMasterName` | N | Output | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` | +| `redeliverInterval` | N | Output | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | +| `processingTimeout` | N | Output | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | +| `redisType` | N | Output | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | +| `redisDB` | N | Output | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | +| `redisMaxRetries` | N | Output | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` | +| `redisMinRetryInterval` | N | Output | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | +| `redisMaxRetryInterval` | N | Output | Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` | +| `dialTimeout` | N | Output | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | +| `readTimeout` | N | Output | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | +| `writeTimeout` | N | Output | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | +| `poolSize` | N | Output | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | +| `poolTimeout` | N | Output | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | +| `maxConnAge` | N | Output | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | +| `minIdleConns` | N | Output | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | +| `idleCheckFrequency` | N | Output | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | | `idleTimeout` | N | Output | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/s3.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/s3.md index f813f2be1..c8f4703ed 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/s3.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/s3.md @@ -52,19 +52,19 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ---------------- | :------: | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| `bucket` | Y | Output | The name of the S3 bucket to write to | `"bucket"` | -| `region` | Y | Output | The specific AWS region | `"us-east-1"` | -| `endpoint` | N | Output | The specific AWS endpoint | `"s3.us-east-1.amazonaws.com"` | -| `accessKey` | Y | Output | The AWS Access Key to access this resource | `"key"` | -| `secretKey` | Y | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | -| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` | -| `forcePathStyle` | N | Output | Currently Amazon S3 SDK supports virtual hosted-style and path-style access. `"true"` is path-style format like `"https:////"`. `"false"` is hosted-style format like `"https://./"`. Defaults to `"false"` | `"true"`, `"false"` | +| Field | Required | Binding support | Details | Example | +| ---------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | +| `bucket` | Y | Output | The name of the S3 bucket to write to | `"bucket"` | +| `region` | Y | Output | The specific AWS region | `"us-east-1"` | +| `endpoint` | N | Output | The specific AWS endpoint | `"s3.us-east-1.amazonaws.com"` | +| `accessKey` | Y | Output | The AWS Access Key to access this resource | `"key"` | +| `secretKey` | Y | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | +| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` | +| `forcePathStyle` | N | Output | Currently Amazon S3 SDK supports virtual hosted-style and path-style access. `"true"` is path-style format like `"https:////"`. `"false"` is hosted-style format like `"https://./"`. Defaults to `"false"` | `"true"`, `"false"` | | `decodeBase64` | N | Output | Configuration to decode base64 file content before saving to bucket storage. (In case of saving a file with binary content). `"true"` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `false` | `"true"`, `"false"` | | `encodeBase64` | N | Output | Configuration to encode base64 file content before return the content. (In case of opening a file with binary content). `"true"` is the only allowed positive value. Other positive variations like `"True", "1"` are not acceptable. Defaults to `"false"` | `"true"`, `"false"` | -| `disableSSL` | N | Output | Allows to connect to non `https://` endpoints. Defaults to `"false"` | `"true"`, `"false"` | -| `insecureSSL` | N | Output | When connecting to `https://` endpoints, accepts invalid or self-signed certificates. Defaults to `"false"` | `"true"`, `"false"` | +| `disableSSL` | N | Output | Allows to connect to non `https://` endpoints. Defaults to `"false"` | `"true"`, `"false"` | +| `insecureSSL` | N | Output | When connecting to `https://` endpoints, accepts invalid or self-signed certificates. Defaults to `"false"` | `"true"`, `"false"` | {{% alert title="Important" color="warning" %}} When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you're using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you **must not** provide AWS access-key, secret-key, and tokens in the definition of the component spec you're using.\ diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/sendgrid.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/sendgrid.md index 33d844d93..9b6c571b9 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/sendgrid.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/sendgrid.md @@ -48,16 +48,16 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| --------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ | -| `apiKey` | Y | Output | SendGrid API key, this should be considered a secret value | `"apikey"` | +| Field | Required | Binding support | Details | Example | +| --------------- | :------: | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | +| `apiKey` | Y | Output | SendGrid API key, this should be considered a secret value | `"apikey"` | | `emailFrom` | N | Output | If set this specifies the 'from' email address of the email message. Only a single email address is allowed. Optional field, see [below](#example-request-payload) | `"me@example.com"` | -| `emailFromName` | N | Output | If set this specifies the 'from' name of the email message. Optional field, see [below](#example-request-payload) | `"me"` | +| `emailFromName` | N | Output | If set this specifies the 'from' name of the email message. Optional field, see [below](#example-request-payload) | `"me"` | | `emailTo` | N | Output | If set this specifies the 'to' email address of the email message. Only a single email address is allowed. Optional field, see [below](#example-request-payload) | `"me@example.com"` | -| `emailToName` | N | Output | If set this specifies the 'to' name of the email message. Optional field, see [below](#example-request-payload) | `"me"` | +| `emailToName` | N | Output | If set this specifies the 'to' name of the email message. Optional field, see [below](#example-request-payload) | `"me"` | | `emailCc` | N | Output | If set this specifies the 'cc' email address of the email message. Only a single email address is allowed. Optional field, see [below](#example-request-payload) | `"me@example.com"` | | `emailBcc` | N | Output | If set this specifies the 'bcc' email address of the email message. Only a single email address is allowed. Optional field, see [below](#example-request-payload) | `"me@example.com"` | -| `subject` | N | Output | If set this specifies the subject of the email message. Optional field, see [below](#example-request-payload) | `"subject of the email"` | +| `subject` | N | Output | If set this specifies the subject of the email message. Optional field, see [below](#example-request-payload) | `"subject of the email"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/servicebusqueues.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/servicebusqueues.md index 16827810b..fb783d5fa 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/servicebusqueues.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/servicebusqueues.md @@ -66,30 +66,30 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| --------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| `connectionString` | Y | Input/Output | The Service Bus connection string. Required unless using Microsoft Entra ID authentication. | `"Endpoint=sb://************"` | -| `queueName` | Y | Input/Output | The Service Bus queue name. Queue names are case-insensitive and will always be forced to lowercase. | `"queuename"` | -| `timeoutInSec` | N | Input/Output | Timeout for all invocations to the Azure Service Bus endpoint, in seconds. _Note that this option impacts network calls and it's unrelated to the TTL applies to messages_. Default: `"60"` | `"60"` | -| `namespaceName` | N | Input/Output | Parameter to set the address of the Service Bus namespace, as a fully-qualified domain name. Required if using Microsoft Entra ID authentication. | `"namespace.servicebus.windows.net"` | -| `disableEntityManagement` | N | Input/Output | When set to true, queues and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | -| `lockDurationInSec` | N | Input/Output | Defines the length in seconds that a message will be locked for before expiring. Used during subscription creation only. Default set by server. | `"30"` | -| `autoDeleteOnIdleInSec` | N | Input/Output | Time in seconds to wait before auto deleting idle subscriptions. Used during subscription creation only. Default: `"0"` (disabled) | `"3600"` | -| `defaultMessageTimeToLiveInSec` | N | Input/Output | Default message time to live, in seconds. Used during subscription creation only. | `"10"` | -| `maxDeliveryCount` | N | Input/Output | Defines the number of attempts the server will make to deliver a message. Used during subscription creation only. Default set by server. | `"10"` | -| `minConnectionRecoveryInSec` | N | Input/Output | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `"2"` | `"5"` | -| `maxConnectionRecoveryInSec` | N | Input/Output | Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the component waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `"300"` (5 minutes) | `"600"` | -| `maxActiveMessages` | N | Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `"1"` | `"1"` | | -| `handlerTimeoutInSec` | N | Input | Timeout for invoking the app's handler. Default: `"0"` (no timeout) | `"30"` | -| `minConnectionRecoveryInSec` | N | Input | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `"2"` | `"5"` | -| `maxConnectionRecoveryInSec` | N | Input | Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the binding waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `"300"` (5 minutes) | `"600"` | -| `lockRenewalInSec` | N | Input | Defines the frequency at which buffered message locks will be renewed. Default: `"20"`. | `"20"` | -| `maxActiveMessages` | N | Input | Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `"1"` | `"2000"` | -| `maxConcurrentHandlers` | N | Input | Defines the maximum number of concurrent message handlers; set to `0` for unlimited. Default: `"1"` | `"10"` | -| `maxRetriableErrorsPerSec` | N | Input | Maximum number of retriable errors that are processed per second. If a message fails to be processed with a retriable error, the component adds a delay before it starts processing another message, to avoid immediately re-processing messages that have failed. Default: `"10"` | `"10"` | -| `publishMaxRetries` | N | Output | The max number of retries for when Azure Service Bus responds with "too busy" in order to throttle messages. Defaults: `"5"` | `"5"` | -| `publishInitialRetryIntervalInMs` | N | Output | Time in milliseconds for the initial exponential backoff when Azure Service Bus throttle messages. Defaults: `"500"` | `"500"` | -| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | +| Field | Required | Binding support | Details | Example | +| --------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| `connectionString` | Y | Input/Output | The Service Bus connection string. Required unless using Microsoft Entra ID authentication. | `"Endpoint=sb://************"` | +| `queueName` | Y | Input/Output | The Service Bus queue name. Queue names are case-insensitive and will always be forced to lowercase. | `"queuename"` | +| `timeoutInSec` | N | Input/Output | Timeout for all invocations to the Azure Service Bus endpoint, in seconds. _Note that this option impacts network calls and it's unrelated to the TTL applies to messages_. Default: `"60"` | `"60"` | +| `namespaceName` | N | Input/Output | Parameter to set the address of the Service Bus namespace, as a fully-qualified domain name. Required if using Microsoft Entra ID authentication. | `"namespace.servicebus.windows.net"` | +| `disableEntityManagement` | N | Input/Output | When set to true, queues and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | +| `lockDurationInSec` | N | Input/Output | Defines the length in seconds that a message will be locked for before expiring. Used during subscription creation only. Default set by server. | `"30"` | +| `autoDeleteOnIdleInSec` | N | Input/Output | Time in seconds to wait before auto deleting idle subscriptions. Used during subscription creation only. Default: `"0"` (disabled) | `"3600"` | +| `defaultMessageTimeToLiveInSec` | N | Input/Output | Default message time to live, in seconds. Used during subscription creation only. | `"10"` | +| `maxDeliveryCount` | N | Input/Output | Defines the number of attempts the server will make to deliver a message. Used during subscription creation only. Default set by server. | `"10"` | +| `minConnectionRecoveryInSec` | N | Input/Output | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `"2"` | `"5"` | +| `maxConnectionRecoveryInSec` | N | Input/Output | Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the component waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `"300"` (5 minutes) | `"600"` | +| `maxActiveMessages` | N | Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `"1"` | `"1"` | | +| `handlerTimeoutInSec` | N | Input | Timeout for invoking the app's handler. Default: `"0"` (no timeout) | `"30"` | +| `minConnectionRecoveryInSec` | N | Input | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `"2"` | `"5"` | +| `maxConnectionRecoveryInSec` | N | Input | Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the binding waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `"300"` (5 minutes) | `"600"` | +| `lockRenewalInSec` | N | Input | Defines the frequency at which buffered message locks will be renewed. Default: `"20"`. | `"20"` | +| `maxActiveMessages` | N | Input | Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `"1"` | `"2000"` | +| `maxConcurrentHandlers` | N | Input | Defines the maximum number of concurrent message handlers; set to `0` for unlimited. Default: `"1"` | `"10"` | +| `maxRetriableErrorsPerSec` | N | Input | Maximum number of retriable errors that are processed per second. If a message fails to be processed with a retriable error, the component adds a delay before it starts processing another message, to avoid immediately re-processing messages that have failed. Default: `"10"` | `"10"` | +| `publishMaxRetries` | N | Output | The max number of retries for when Azure Service Bus responds with "too busy" in order to throttle messages. Defaults: `"5"` | `"5"` | +| `publishInitialRetryIntervalInMs` | N | Output | Time in milliseconds for the initial exponential backoff when Azure Service Bus throttle messages. Defaults: `"500"` | `"500"` | +| `direction` | N | Input/Output | The direction of the binding | `"input"`, `"output"`, `"input, output"` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/ses.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/ses.md index 7e69d1e75..d4d28b7ec 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/ses.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/ses.md @@ -48,12 +48,12 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| -------------- | :------: | --------------- | -------------------------------------------------------------------------------------- | ------------------- | -| `region` | N | Output | The specific AWS region | `"eu-west-1"` | -| `accessKey` | N | Output | The AWS Access Key to access this resource | `"key"` | -| `secretKey` | N | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | -| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` | +| Field | Required | Binding support | Details | Example | +| -------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------ | ------------------- | +| `region` | N | Output | The specific AWS region | `"eu-west-1"` | +| `accessKey` | N | Output | The AWS Access Key to access this resource | `"key"` | +| `secretKey` | N | Output | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | +| `sessionToken` | N | Output | The AWS session token to use | `"sessionToken"` | | `emailFrom` | N | Output | If set, this specifies the email address of the sender. See [also](#example-request) | `"me@example.com"` | | `emailTo` | N | Output | If set, this specifies the email address of the receiver. See [also](#example-request) | `"me@example.com"` | | `emailCc` | N | Output | If set, this specifies the email address to CC in. See [also](#example-request) | `"me@example.com"` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/signalr.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/signalr.md index f1c88ee9f..ed75ac058 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/signalr.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/signalr.md @@ -32,12 +32,12 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------ | :------: | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| `connectionString` | Y | Output | The Azure SignalR connection string | `"Endpoint=https://.service.signalr.net;AccessKey=;Version=1.0;"` | +| Field | Required | Binding support | Details | Example | +| ------------------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| `connectionString` | Y | Output | The Azure SignalR connection string | `"Endpoint=https://.service.signalr.net;AccessKey=;Version=1.0;"` | | `hub` | N | Output | Defines the hub in which the message will be send. The hub can be dynamically defined as a metadata value when publishing to an output binding (key is "hub") | `"myhub"` | -| `endpoint` | N | Output | Endpoint of Azure SignalR; required if not included in the `connectionString` or if using Microsoft Entra ID | `"https://.service.signalr.net"` | -| `accessKey` | N | Output | Access key | `"your-access-key"` | +| `endpoint` | N | Output | Endpoint of Azure SignalR; required if not included in the `connectionString` or if using Microsoft Entra ID | `"https://.service.signalr.net"` | +| `accessKey` | N | Output | Access key | `"your-access-key"` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/smtp.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/smtp.md index bcbab783d..2a9a63095 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/smtp.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/smtp.md @@ -50,18 +50,18 @@ The example configuration shown above, contain a username and password as plain- ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| --------------- | :------: | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -| `host` | Y | Output | The host where your SMTP server runs | `"smtphost"` | -| `port` | Y | Output | The port your SMTP server listens on | `"9999"` | -| `user` | Y | Output | The user to authenticate against the SMTP server | `"user"` | -| `password` | Y | Output | The password of the user | `"password"` | -| `skipTLSVerify` | N | Output | If set to true, the SMPT server's TLS certificate will not be verified. Defaults to `"false"` | `"true"`, `"false"` | -| `emailFrom` | N | Output | If set, this specifies the email address of the sender. See [also](#example-request) | `"me@example.com"` | -| `emailTo` | N | Output | If set, this specifies the email address of the receiver. See [also](#example-request) | `"me@example.com"` | -| `emailCc` | N | Output | If set, this specifies the email address to CC in. See [also](#example-request) | `"me@example.com"` | -| `emailBcc` | N | Output | If set, this specifies email address to BCC in. See [also](#example-request) | `"me@example.com"` | -| `subject` | N | Output | If set, this specifies the subject of the email message. See [also](#example-request) | `"subject of mail"` | +| Field | Required | Binding support | Details | Example | +| --------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- | +| `host` | Y | Output | The host where your SMTP server runs | `"smtphost"` | +| `port` | Y | Output | The port your SMTP server listens on | `"9999"` | +| `user` | Y | Output | The user to authenticate against the SMTP server | `"user"` | +| `password` | Y | Output | The password of the user | `"password"` | +| `skipTLSVerify` | N | Output | If set to true, the SMPT server's TLS certificate will not be verified. Defaults to `"false"` | `"true"`, `"false"` | +| `emailFrom` | N | Output | If set, this specifies the email address of the sender. See [also](#example-request) | `"me@example.com"` | +| `emailTo` | N | Output | If set, this specifies the email address of the receiver. See [also](#example-request) | `"me@example.com"` | +| `emailCc` | N | Output | If set, this specifies the email address to CC in. See [also](#example-request) | `"me@example.com"` | +| `emailBcc` | N | Output | If set, this specifies email address to BCC in. See [also](#example-request) | `"me@example.com"` | +| `subject` | N | Output | If set, this specifies the subject of the email message. See [also](#example-request) | `"subject of mail"` | | `priority` | N | Output | If set, this specifies the priority (X-Priority) of the email message, from 1 (lowest) to 5 (highest) (default value: 3). See [also](#example-request) | `"1"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/storagequeues.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/storagequeues.md index 00ff574a7..1f185d2b6 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/storagequeues.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/storagequeues.md @@ -48,18 +48,18 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `accountName` | Y | Input/Output | The name of the Azure Storage account | `"account1"` | -| `accountKey` | Y\* | Input/Output | The access key of the Azure Storage account. Only required when not using Microsoft Entra ID authentication. | `"access-key"` | -| `queueName` | Y | Input/Output | The name of the Azure Storage queue | `"myqueue"` | -| `pollingInterval` | N | Output | Set the interval to poll Azure Storage Queues for new messages, as a Go duration value. Default: `"10s"` | `"30s"` | -| `ttlInSeconds` | N | Output | Parameter to set the default message time to live. If this parameter is omitted, messages will expire after 10 minutes. See [also](#specifying-a-ttl-per-message) | `"60"` | -| `decodeBase64` | N | Input | Configuration to decode base64 content received from the Storage Queue into a string. Defaults to `false` | `true`, `false` | -| `encodeBase64` | N | Output | If enabled base64 encodes the data payload before uploading to Azure storage queues. Default `false`. | `true`, `false` | +| Field | Required | Binding support | Details | Example | +| ------------------- | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| `accountName` | Y | Input/Output | The name of the Azure Storage account | `"account1"` | +| `accountKey` | Y\* | Input/Output | The access key of the Azure Storage account. Only required when not using Microsoft Entra ID authentication. | `"access-key"` | +| `queueName` | Y | Input/Output | The name of the Azure Storage queue | `"myqueue"` | +| `pollingInterval` | N | Output | Set the interval to poll Azure Storage Queues for new messages, as a Go duration value. Default: `"10s"` | `"30s"` | +| `ttlInSeconds` | N | Output | Parameter to set the default message time to live. If this parameter is omitted, messages will expire after 10 minutes. See [also](#specifying-a-ttl-per-message) | `"60"` | +| `decodeBase64` | N | Input | Configuration to decode base64 content received from the Storage Queue into a string. Defaults to `false` | `true`, `false` | +| `encodeBase64` | N | Output | If enabled base64 encodes the data payload before uploading to Azure storage queues. Default `false`. | `true`, `false` | | `endpoint` | N | Input/Output | Optional custom endpoint URL. This is useful when using the [Azurite emulator](https://github.com/Azure/azurite) or when using custom domains for Azure Storage (although this is not officially supported). The endpoint must be the full base URL, including the protocol (`http://` or `https://`), the IP or FQDN, and optional port. | `"http://127.0.0.1:10001"` or `"https://accountName.queue.example.com"` | -| `visibilityTimeout` | N | Input | Allows setting a custom queue visibility timeout to avoid immediate retrying of recently failed messages. Defaults to 30 seconds. | `"100s"` | -| `direction` | N | Input/Output | Direction of the binding. | `"input"`, `"output"`, `"input, output"` | +| `visibilityTimeout` | N | Input | Allows setting a custom queue visibility timeout to avoid immediate retrying of recently failed messages. Defaults to 30 seconds. | `"100s"` | +| `direction` | N | Input/Output | Direction of the binding. | `"input"`, `"output"`, `"input, output"` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/wasm.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/wasm.md index c850225ea..688af7e5d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/wasm.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/wasm.md @@ -79,8 +79,8 @@ spec: ## Spec metadata fields -| Field | Details | Required | Example | -| ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------- | +| Field | Details | Required | Example | +| ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------- | | `url` | The URL of the resource including the Wasm binary to instantiate. The supported schemes include `file://`, `http://`, and `https://`. The path of a `file://` URL is relative to the Dapr process unless it begins with `/`. | true | `file://hello.wasm`, `https://example.com/hello.wasm` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-command.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-command.md index 4c72584ed..bf1e2c88d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-command.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-command.md @@ -32,12 +32,12 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------------ | :------: | --------------- | ---------------------------------------------------------------------------------------- | -------------------- | -| `gatewayAddr` | Y | Output | Zeebe gateway address | `"localhost:26500"` | +| Field | Required | Binding support | Details | Example | +| ------------------------ | :------: | --------------- | -------------------------------------------------------------------------------------------------------- | -------------------- | +| `gatewayAddr` | Y | Output | Zeebe gateway address | `"localhost:26500"` | | `gatewayKeepAlive` | N | Output | Sets how often keep alive messages should be sent to the gateway. Defaults to 45 seconds | `"45s"` | -| `usePlainTextConnection` | N | Output | Whether to use a plain text connection or not | `"true"`, `"false"` | -| `caCertificatePath` | N | Output | The path to the CA cert | `"/path/to/ca-cert"` | +| `usePlainTextConnection` | N | Output | Whether to use a plain text connection or not | `"true"`, `"false"` | +| `caCertificatePath` | N | Output | The path to the CA cert | `"/path/to/ca-cert"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-jobworker.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-jobworker.md index ba4033d2d..6c13aabbe 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-jobworker.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-bindings/zeebe-jobworker.md @@ -56,24 +56,24 @@ spec: ## Spec metadata fields -| Field | Required | Binding support | Details | Example | -| ------------------------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| `gatewayAddr` | Y | Input | Zeebe gateway address | `"localhost:26500"` | -| `gatewayKeepAlive` | N | Input | Sets how often keep alive messages should be sent to the gateway. Defaults to 45 seconds | `"45s"` | -| `usePlainTextConnection` | N | Input | Whether to use a plain text connection or not | `"true"`, `"false"` | -| `caCertificatePath` | N | Input | The path to the CA cert | `"/path/to/ca-cert"` | -| `workerName` | N | Input | The name of the worker activating the jobs, mostly used for logging purposes | `"products-worker"` | -| `workerTimeout` | N | Input | A job returned after this call will not be activated by another call until the timeout has been reached; defaults to 5 minutes | `"5m"` | +| Field | Required | Binding support | Details | Example | +| ------------------------ | :------: | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | +| `gatewayAddr` | Y | Input | Zeebe gateway address | `"localhost:26500"` | +| `gatewayKeepAlive` | N | Input | Sets how often keep alive messages should be sent to the gateway. Defaults to 45 seconds | `"45s"` | +| `usePlainTextConnection` | N | Input | Whether to use a plain text connection or not | `"true"`, `"false"` | +| `caCertificatePath` | N | Input | The path to the CA cert | `"/path/to/ca-cert"` | +| `workerName` | N | Input | The name of the worker activating the jobs, mostly used for logging purposes | `"products-worker"` | +| `workerTimeout` | N | Input | A job returned after this call will not be activated by another call until the timeout has been reached; defaults to 5 minutes | `"5m"` | | `requestTimeout` | N | Input | The request will be completed when at least one job is activated or after the requestTimeout. If the requestTimeout = 0, a default timeout is used. If the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated. Defaults to 10 seconds | `"30s"` | -| `jobType` | Y | Input | the job type, as defined in the BPMN process (e.g. ``) | `"fetch-products"` | -| `maxJobsActive` | N | Input | Set the maximum number of jobs which will be activated for this worker at the same time. Defaults to 32 | `"32"` | -| `concurrency` | N | Input | The maximum number of concurrent spawned goroutines to complete jobs. Defaults to 4 | `"4"` | -| `pollInterval` | N | Input | Set the maximal interval between polling for new jobs. Defaults to 100 milliseconds | `"100ms"` | -| `pollThreshold` | N | Input | Set the threshold of buffered activated jobs before polling for new jobs, i.e. threshold \* maxJobsActive. Defaults to 0.3 | `"0.3"` | -| `fetchVariables` | N | Input | A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned | `"productId"`, `"productName"`, `"productKey"` | -| `autocomplete` | N | Input | Indicates if a job should be autocompleted or not. If not set, all jobs will be auto-completed by default. Disable it if the worker should manually complete or fail the job with either a business error or an incident | `"true"`, `"false"` | -| `retryBackOff` | N | Input | The back-off timeout for the next retry if a job fails | `15s` | -| `direction` | N | Input | The direction of the binding | `"input"` | +| `jobType` | Y | Input | the job type, as defined in the BPMN process (e.g. ``) | `"fetch-products"` | +| `maxJobsActive` | N | Input | Set the maximum number of jobs which will be activated for this worker at the same time. Defaults to 32 | `"32"` | +| `concurrency` | N | Input | The maximum number of concurrent spawned goroutines to complete jobs. Defaults to 4 | `"4"` | +| `pollInterval` | N | Input | Set the maximal interval between polling for new jobs. Defaults to 100 milliseconds | `"100ms"` | +| `pollThreshold` | N | Input | Set the threshold of buffered activated jobs before polling for new jobs, i.e. threshold \* maxJobsActive. Defaults to 0.3 | `"0.3"` | +| `fetchVariables` | N | Input | A list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned | `"productId"`, `"productName"`, `"productKey"` | +| `autocomplete` | N | Input | Indicates if a job should be autocompleted or not. If not set, all jobs will be auto-completed by default. Disable it if the worker should manually complete or fail the job with either a business error or an incident | `"true"`, `"false"` | +| `retryBackOff` | N | Input | The back-off timeout for the next retry if a job fails | `15s` | +| `direction` | N | Input | The direction of the binding | `"input"` | ## Binding support diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/azure-appconfig-configuration-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/azure-appconfig-configuration-store.md index 93205c7c6..c69ead87b 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/azure-appconfig-configuration-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/azure-appconfig-configuration-store.md @@ -50,14 +50,14 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| --------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | connectionString | Y\* | Connection String for the Azure App Configuration instance. No Default. Can be `secretKeyRef` to use a secret reference. \*Mutally exclusive with host field. \*Not to be used when [Azure Authentication](https://docs.dapr.io/developing-applications/integrations/azure/azure-authentication/authenticating-azure/) is used | `Endpoint=https://foo.azconfig.io;Id=osOX-l9-s0:sig;Secret=00000000000000000000000000000000000000000000` | -| host | N\* | Endpoint for the Azure App Configuration instance. No Default. \*Mutally exclusive with connectionString field. \*To be used when [Azure Authentication](https://docs.dapr.io/developing-applications/integrations/azure/azure-authentication/authenticating-azure/) is used | `https://dapr.azconfig.io` | -| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | -| retryDelay | N | RetryDelay specifies the initial amount of delay to use before retrying an operation. The delay increases exponentially with each retry up to the maximum specified by MaxRetryDelay. Defaults to `4` seconds; `"-1"` disables delay between retries. | `4s` | -| maxRetryDelay | N | MaxRetryDelay specifies the maximum delay allowed before retrying an operation. Typically the value is greater than or equal to the value specified in RetryDelay. Defaults to `120` seconds; `"-1"` disables the limit | `120s` | -| subscribePollInterval | N | subscribePollInterval specifies the poll interval in nanoseconds for polling the subscribed keys for any changes. This will be updated in the future to Go Time format. Default polling interval is set to `24` hours. | `30s` | +| host | N\* | Endpoint for the Azure App Configuration instance. No Default. \*Mutally exclusive with connectionString field. \*To be used when [Azure Authentication](https://docs.dapr.io/developing-applications/integrations/azure/azure-authentication/authenticating-azure/) is used | `https://dapr.azconfig.io` | +| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | +| retryDelay | N | RetryDelay specifies the initial amount of delay to use before retrying an operation. The delay increases exponentially with each retry up to the maximum specified by MaxRetryDelay. Defaults to `4` seconds; `"-1"` disables delay between retries. | `4s` | +| maxRetryDelay | N | MaxRetryDelay specifies the maximum delay allowed before retrying an operation. Typically the value is greater than or equal to the value specified in RetryDelay. Defaults to `120` seconds; `"-1"` disables the limit | `120s` | +| subscribePollInterval | N | subscribePollInterval specifies the poll interval in nanoseconds for polling the subscribed keys for any changes. This will be updated in the future to Go Time format. Default polling interval is set to `24` hours. | `30s` | **Note**: either `host` or `connectionString` must be specified. diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md index 8ce8b7ceb..9610d8d1d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/postgresql-configuration-store.md @@ -63,29 +63,29 @@ The above example uses secrets as plain strings. It is recommended to use a secr The following metadata options are **required** to authenticate using a PostgreSQL connection string. -| Field | Required | Details | Example | -| ------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| ------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `connectionString` | Y | The connection string for the PostgreSQL database. See the PostgreSQL [documentation on database connections](https://www.postgresql.org/docs/current/libpq-connect.html) for information on how to define a connection string. | `"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=my_db"` | ### Authenticate using Microsoft Entra ID Authenticating with Microsoft Entra ID is supported with Azure Database for PostgreSQL. All authentication methods supported by Dapr can be used, including client credentials ("service principal") and Managed Identity. -| Field | Required | Details | Example | -| ------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | +| Field | Required | Details | Example | +| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain the user, which corresponds to the name of the user created inside PostgreSQL that maps to the Microsoft Entra ID identity; this is often the name of the corresponding principal (e.g. the name of the Microsoft Entra ID application). This connection string should not contain any password. | `"host=mydb.postgres.database.azure.com user=myapplication port=5432 database=my_db sslmode=require"` | -| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | -| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | -| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | +| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | +| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | +| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | ### Other metadata options -| Field | Required | Details | Example | -| ----------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -| `table` | Y | Table name for configuration information, must be lowercased. | `configtable` | -| `maxConns` | N | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | -| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | +| Field | Required | Details | Example | +| ----------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | +| `table` | Y | Table name for configuration information, must be lowercased. | `configtable` | +| `maxConns` | N | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | +| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | | `queryExecMode` | N | Controls the default mode for executing queries. By default Dapr uses the extended protocol and automatically prepares and caches prepared statements. However, this may be incompatible with proxies such as PGBouncer. In this case it may be preferrable to use `exec` or `simple_protocol`. | `"simple_protocol"` | ## Set up PostgreSQL as Configuration Store diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/redis-configuration-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/redis-configuration-store.md index efd098d2e..29b81460d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/redis-configuration-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-configuration-stores/redis-configuration-store.md @@ -35,27 +35,27 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | | -| --------------------- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| redisHost | Y | Output | The Redis host address | `"localhost:6379"` | -| redisPassword | Y | Output | The Redis password | `"password"` | -| redisUsername | N | Output | Username for Redis host. Defaults to empty. Make sure your Redis server version is 6 or above, and have created acl rule correctly. | `"username"` | -| enableTLS | N | Output | If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"` | `"true"`, `"false"` | -| failover | N | Output | Property to enabled failover configuration. Needs sentinelMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` | -| sentinelMasterName | N | Output | The Sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` | -| redisType | N | Output | The type of Redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for Redis cluster mode. Defaults to `"node"`. | `"cluster"` | -| redisDB | N | Output | Database selected after connecting to Redis. If `"redisType"` is `"cluster"`, this option is ignored. Defaults to `"0"`. | `"0"` | -| redisMaxRetries | N | Output | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` | -| redisMinRetryInterval | N | Output | Minimum backoff for Redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | -| redisMaxRetryInterval | N | Output | Maximum backoff for Redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` | -| dialTimeout | N | Output | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | -| readTimeout | N | Output | Timeout for socket reads. If reached, Redis commands fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | -| writeTimeout | N | Output | Timeout for socket writes. If reached, Redis commands fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | -| poolSize | N | Output | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | -| poolTimeout | N | Output | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | -| maxConnAge | N | Output | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | -| minIdleConns | N | Output | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | -| idleCheckFrequency | N | Output | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | +| Field | Required | Details | Example | | +| --------------------- | :------: | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | +| redisHost | Y | Output | The Redis host address | `"localhost:6379"` | +| redisPassword | Y | Output | The Redis password | `"password"` | +| redisUsername | N | Output | Username for Redis host. Defaults to empty. Make sure your Redis server version is 6 or above, and have created acl rule correctly. | `"username"` | +| enableTLS | N | Output | If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"` | `"true"`, `"false"` | +| failover | N | Output | Property to enabled failover configuration. Needs sentinelMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` | +| sentinelMasterName | N | Output | The Sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/reference/sentinel-clients/) | `""`, `"127.0.0.1:6379"` | +| redisType | N | Output | The type of Redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for Redis cluster mode. Defaults to `"node"`. | `"cluster"` | +| redisDB | N | Output | Database selected after connecting to Redis. If `"redisType"` is `"cluster"`, this option is ignored. Defaults to `"0"`. | `"0"` | +| redisMaxRetries | N | Output | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` | +| redisMinRetryInterval | N | Output | Minimum backoff for Redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | +| redisMaxRetryInterval | N | Output | Maximum backoff for Redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` | +| dialTimeout | N | Output | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | +| readTimeout | N | Output | Timeout for socket reads. If reached, Redis commands fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | +| writeTimeout | N | Output | Timeout for socket writes. If reached, Redis commands fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | +| poolSize | N | Output | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | +| poolTimeout | N | Output | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | +| maxConnAge | N | Output | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | +| minIdleConns | N | Output | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | +| idleCheckFrequency | N | Output | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | | idleTimeout | N | Output | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` | ## Setup Redis diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/azure-key-vault.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/azure-key-vault.md index 14e7d1850..27ee0fb4d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/azure-key-vault.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/azure-key-vault.md @@ -42,9 +42,9 @@ The Azure Key Vault cryptography component supports authentication with Microsof ## Spec metadata fields -| Field | Required | Details | Example | -| ------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -| `vaultName` | Y | Azure Key Vault name | `"mykeyvault"` | +| Field | Required | Details | Example | +| ------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | +| `vaultName` | Y | Azure Key Vault name | `"mykeyvault"` | | Auth metadata | Y | See [Authenticating to Azure]({{< ref "authenticating-azure.md" >}}) for more information | | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/json-web-key-sets.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/json-web-key-sets.md index 3a6da1505..93cf2fe2c 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/json-web-key-sets.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/json-web-key-sets.md @@ -69,11 +69,11 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| -------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `jwks` | Y | Path to the JWKS document | Local file: `"fixtures/crypto/jwks/jwks.json"`
HTTP(S) URL: `"https://example.com/.well-known/jwks.json"`
Embedded JWKS: `{"keys": […]}` (can be base64-encoded) | -| `requestTimeout` | N | Timeout for network requests when fetching the JWKS document from a HTTP(S) URL, as a Go duration. Default: "30s" | `"5s"` | -| `minRefreshInterval` | N | Minimum interval to wait before subsequent refreshes of the JWKS document from a HTTP(S) source, as a Go duration. Default: "10m" | `"1h"` | +| Field | Required | Details | Example | +| -------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `jwks` | Y | Path to the JWKS document | Local file: `"fixtures/crypto/jwks/jwks.json"`
HTTP(S) URL: `"https://example.com/.well-known/jwks.json"`
Embedded JWKS: `{"keys": […]}` (can be base64-encoded) | +| `requestTimeout` | N | Timeout for network requests when fetching the JWKS document from a HTTP(S) URL, as a Go duration. Default: "30s" | `"5s"` | +| `minRefreshInterval` | N | Minimum interval to wait before subsequent refreshes of the JWKS document from a HTTP(S) source, as a Go duration. Default: "10m" | `"1h"` | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/local-storage.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/local-storage.md index 0a4786b09..6e578a42e 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/local-storage.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-cryptography/local-storage.md @@ -43,8 +43,8 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ------ | :------: | --------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| Field | Required | Details | Example | +| ------ | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | `path` | Y | Folder containing the keys to be loaded. When loading a key, the name of the key will be used as name of the file in this folder. | `/path/to/folder` | **Example** diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-locks/redis-lock.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-locks/redis-lock.md index 57c1cddf1..b0439293c 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-locks/redis-lock.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-locks/redis-lock.md @@ -76,31 +76,31 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | -| redisHost | Y | Connection-string for the redis host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | -| redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` | -| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | -| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | -| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | -| maxRetryBackoff | N | Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff. | `3000000000` | +| Field | Required | Details | Example | +| --------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| redisHost | Y | Connection-string for the redis host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | +| redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` | +| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | +| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | +| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | +| maxRetryBackoff | N | Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff. | `3000000000` | | failover | N | Property to enabled failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/). Defaults to `"false"` | `"true"`, `"false"` | -| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `"mymaster"` | -| redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | -| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | -| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | -| redisDB | N | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | -| redisMaxRetries | N | Alias for `maxRetries`. If both values are set `maxRetries` is ignored. | `"5"` | -| redisMinRetryInterval | N | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | -| redisMaxRetryInterval | N | Alias for `maxRetryBackoff`. If both values are set `maxRetryBackoff` is ignored. | `"5s"` | -| dialTimeout | N | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | -| readTimeout | N | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | -| writeTimeout | N | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | -| poolSize | N | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | -| poolTimeout | N | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | -| maxConnAge | N | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | -| minIdleConns | N | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | -| idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | +| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `"mymaster"` | +| redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | +| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | +| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | +| redisDB | N | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | +| redisMaxRetries | N | Alias for `maxRetries`. If both values are set `maxRetries` is ignored. | `"5"` | +| redisMinRetryInterval | N | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | +| redisMaxRetryInterval | N | Alias for `maxRetryBackoff`. If both values are set `maxRetryBackoff` is ignored. | `"5s"` | +| dialTimeout | N | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | +| readTimeout | N | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | +| writeTimeout | N | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | +| poolSize | N | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | +| poolTimeout | N | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | +| maxConnAge | N | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | +| minIdleConns | N | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | +| idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | | idleTimeout | N | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` | ## Setup Redis diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-bearer.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-bearer.md index c3510d39b..27008ab1c 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-bearer.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-bearer.md @@ -32,10 +32,10 @@ spec: ## Spec metadata fields -| Field | Required | Details | Example | -| ---------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| Field | Required | Details | Example | +| ---------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | `audience` | Y | The audience expected in the tokens. Usually, this corresponds to the client ID of your application that is created as part of a credential hosted by a OpenID Connect platform. | | -| `issuer` | Y | The issuer authority, which is the value expected in the issuer claim in the tokens. | `"https://accounts.google.com"` | +| `issuer` | Y | The issuer authority, which is the value expected in the issuer claim in the tokens. | `"https://accounts.google.com"` | | `jwksURL` | N | Address of the JWKS (JWK Set containing the public keys for verifying tokens). If empty, will try to fetch the URL set in the OpenID Configuration document `/.well-known/openid-configuration`. | `"https://accounts.google.com/.well-known/openid-configuration"` | Common values for `issuer` include: diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-oauth2clientcredentials.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-oauth2clientcredentials.md index 72bb6e41b..2caa38c88 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-oauth2clientcredentials.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-oauth2clientcredentials.md @@ -46,15 +46,15 @@ The above example uses secrets as plain strings. It is recommended to use a secr | tokenURL | The endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token | `"https://accounts.google.com/o/oauth2/token"` | | headerName | The authorization header name to forward to your application | `"authorization"` | | endpointParamsQuery | Specifies additional parameters for requests to the token endpoint | `true` | -| authStyle | Optionally specifies how the endpoint wants the client ID & client secret sent. See the table of possible values below | `0` | +| authStyle | Optionally specifies how the endpoint wants the client ID & client secret sent. See the table of possible values below | `0` | ### Possible values for `authStyle` -| Value | Meaning | -| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `1` | Sends the "client_id" and "client_secret" in the POST body as application/x-www-form-urlencoded parameters. | +| Value | Meaning | +| ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `1` | Sends the "client_id" and "client_secret" in the POST body as application/x-www-form-urlencoded parameters. | | `2` | Sends the "client_id" and "client_secret" using HTTP Basic Authorization. This is an optional style described in the [OAuth2 RFC 6749 section 2.3.1](https://tools.ietf.org/html/rfc6749#section-2.3.1). | -| `0` | Means to auto-detect which authentication style the provider wants by trying both ways and caching the successful way for the future. | +| `0` | Means to auto-detect which authentication style the provider wants by trying both ways and caching the successful way for the future. | ## Dapr configuration diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-opa.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-opa.md index 80d8e8bf0..173b7a213 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-opa.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-opa.md @@ -75,10 +75,10 @@ You can prototype and experiment with policies using the [official OPA playgroun ## Spec metadata fields -| Field | Details | Example | -| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `rego` | The Rego policy language | See above | -| `defaultStatus` | The status code to return for denied responses | `"https://accounts.google.com"`, `"https://login.salesforce.com"` | +| Field | Details | Example | +| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| `rego` | The Rego policy language | See above | +| `defaultStatus` | The status code to return for denied responses | `"https://accounts.google.com"`, `"https://login.salesforce.com"` | | `readBody` | If set to `true` (the default value), the body of each request is read fully in-memory and can be used to make policy decisions. If your policy doesn't depend on inspecting the request body, consider disabling this (setting to `false`) for significant performance improvements. | `"false"` | | `includedHeaders` | A comma-separated set of case-insensitive headers to include in the request input. Request headers are not passed to the policy by default. Include to receive incoming request headers in the input | `"x-my-custom-header, x-jwt-header"` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-rate-limit.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-rate-limit.md index 375ee1635..6c5aed532 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-rate-limit.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-rate-limit.md @@ -28,8 +28,8 @@ spec: ## Spec metadata fields -| Field | Details | Example | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| Field | Details | Example | +| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | | `maxRequestsPerSecond` | The maximum requests per second by remote IP.
The component looks at the `X-Forwarded-For` and `X-Real-IP` headers to determine the caller's IP. | `10` | Once the limit is reached, the requests will fail with HTTP Status code _429: Too Many Requests_. diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-routeralias.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-routeralias.md index d94629056..524b855ff 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-routeralias.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-routeralias.md @@ -35,8 +35,8 @@ In the example above, an incoming HTTP request for `/mall/activity/info?id=123` # Spec metadata fields -| Field | Details | Example | -| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | +| Field | Details | Example | +| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | | `routes` | String containing a JSON-encoded or YAML-encoded dictionary. Each key in the dictionary is the incoming path, and the value is the path it's converted to. | See example above | ## Dapr configuration diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-wasm.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-wasm.md index 1a26b0ecf..9d85e4b83 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-wasm.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-middleware/middleware-wasm.md @@ -49,10 +49,10 @@ spec: Minimally, a user must specify a Wasm binary implements the [http-handler](https://http-wasm.io/http-handler/). How to compile this is described later. -| Field | Details | Required | Example | -| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------- | +| Field | Details | Required | Example | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------- | | url | The URL of the resource including the Wasm binary to instantiate. The supported schemes include `file://`, `http://`, and `https://`. The path of a `file://` URL is relative to the Dapr process unless it begins with `/`. | true | `file://hello.wasm`, `https://example.com/hello.wasm` | -| guestConfig | An optional configuration passed to Wasm guests. Users can pass an arbitrary string to be parsed by the guest code. | false | `environment=production`,`{"environment":"production"}` | +| guestConfig | An optional configuration passed to Wasm guests. Users can pass an arbitrary string to be parsed by the guest code. | false | `environment=production`,`{"environment":"production"}` | ## Dapr configuration diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-kubernetes.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-kubernetes.md index 8d5f80450..c2371e350 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-kubernetes.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-kubernetes.md @@ -32,10 +32,10 @@ The component resolves target apps by using the Kubernetes cluster's DNS provide The configuration spec is fixed to v1.3.0 of the Consul API -| Field | Required | Type | Details | 示例 | -| ------------- | :------: | -------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| clusterDomain | N | `string` | The cluster domain to be used for resolved addresses. This field is mutually exclusive with the `template` file. | `cluster.local` | -| template | N | `string` | A template string to be parsed when addresses are resolved using [text/template](https://pkg.go.dev/text/template#Template) . The template will be populated by the fields in the [ResolveRequest](https\://github.com/dapr/components-contrib/blob/release-{{% dapr-latest-version short="true" %}}/nameresolution/requests.go#L20) struct. This field is mutually exclusive with `clusterDomain` field. | `{{.ID}}-{{.Data.region}}.{{.Namespace}}.internal:{{.Port}}` | +| Field | Required | Type | Details | 示例 | +| ------------- | :------: | -------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ | +| clusterDomain | N | `string` | The cluster domain to be used for resolved addresses. This field is mutually exclusive with the `template` file. | `cluster.local` | +| template | N | `string` | A template string to be parsed when addresses are resolved using [text/template](https://pkg.go.dev/text/template#Template) . The template will be populated by the fields in the [ResolveRequest](https://github.com/dapr/components-contrib/blob/release-{{% dapr-latest-version short="true" %}}/nameresolution/requests.go#L20) struct. This field is mutually exclusive with `clusterDomain` field. | `{{.ID}}-{{.Data.region}}.{{.Namespace}}.internal:{{.Port}}` | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-sqlite.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-sqlite.md index 966f3b931..25570f2db 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-sqlite.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/nr-sqlite.md @@ -38,16 +38,16 @@ spec: When using the SQLite name resolver component, the `spec.nameResolution.configuration` dictionary contains these options: -| Field | Required | Type | Details | 示例 | -| ------------------- | :------: | ---------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `connectionString` | Y | `string` | The connection string for the SQLite database. Normally, this is the path to a file on disk, relative to the current working directory, or absolute. | `"nr.db"` (relative to the working directory), `"/home/user/.dapr/nr.db"` | -| `updateInterval` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`) | Interval for active Dapr sidecars to update their status in the database, which is used as healthcheck.
Smaller intervals reduce the likelihood of stale data being returned if an application goes offline, but increase the load on the database.
Must be at least 1s greater than `timeout`. Values with fractions of seconds are truncated (for example, `1500ms` becomes `1s`). Default: `5s` | `"2s"` | -| `timeout` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`).
Must be at least 1s. | Timeout for operations on the database. Integers are interpreted as number of seconds. Defaults to `1s` | `"2s"`, `2` | -| `tableName` | N | `string` | Name of the table where the data is stored. If the table does not exist, the table is created by Dapr. Defaults to `hosts`. | `"hosts"` | -| `metadataTableName` | N | `string` | Name of the table used by Dapr to store metadata for the component. If the table does not exist, the table is created by Dapr. Defaults to `metadata`. | `"metadata"` | -| `cleanupInterval` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`) | Interval to remove stale records from the database. Default: `1h` (1 hour) | `"10m"` | -| `busyTimeout` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`) | Interval to wait in case the SQLite database is currently busy serving another request, before returning a "database busy" error. This is an advanced setting.
`busyTimeout` controls how locking works in SQLite. With SQLite, writes are exclusive, so every time any app is writing the database is locked. If another app tries to write, it waits up to `busyTimeout` before returning the "database busy" error. However the `timeout` setting controls the timeout for the entire operation. For example if the query "hangs", after the database has acquired the lock (so after busy timeout is cleared), then `timeout` comes into effect. Default: `800ms` (800 milliseconds) | `"100ms"` | -| `disableWAL` | N | `bool` | If set to true, disables Write-Ahead Logging for journaling of the SQLite database. This is for advanced scenarios only | `true`, `false` | +| Field | Required | Type | Details | 示例 | +| ------------------- | :------: | -----------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `connectionString` | Y | `string` | The connection string for the SQLite database. Normally, this is the path to a file on disk, relative to the current working directory, or absolute. | `"nr.db"` (relative to the working directory), `"/home/user/.dapr/nr.db"` | +| `updateInterval` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`) | Interval for active Dapr sidecars to update their status in the database, which is used as healthcheck.
Smaller intervals reduce the likelihood of stale data being returned if an application goes offline, but increase the load on the database.
Must be at least 1s greater than `timeout`. Values with fractions of seconds are truncated (for example, `1500ms` becomes `1s`). Default: `5s` | `"2s"` | +| `timeout` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`).
Must be at least 1s. | Timeout for operations on the database. Integers are interpreted as number of seconds. Defaults to `1s` | `"2s"`, `2` | +| `tableName` | N | `string` | Name of the table where the data is stored. If the table does not exist, the table is created by Dapr. Defaults to `hosts`. | `"hosts"` | +| `metadataTableName` | N | `string` | Name of the table used by Dapr to store metadata for the component. If the table does not exist, the table is created by Dapr. Defaults to `metadata`. | `"metadata"` | +| `cleanupInterval` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`) | Interval to remove stale records from the database. Default: `1h` (1 hour) | `"10m"` | +| `busyTimeout` | N | [Go duration](https://pkg.go.dev/time#ParseDuration) (as a `string`) | Interval to wait in case the SQLite database is currently busy serving another request, before returning a "database busy" error. This is an advanced setting.
`busyTimeout` controls how locking works in SQLite. With SQLite, writes are exclusive, so every time any app is writing the database is locked. If another app tries to write, it waits up to `busyTimeout` before returning the "database busy" error. However the `timeout` setting controls the timeout for the entire operation. For example if the query "hangs", after the database has acquired the lock (so after busy timeout is cleared), then `timeout` comes into effect. Default: `800ms` (800 milliseconds) | `"100ms"` | +| `disableWAL` | N | `bool` | If set to true, disables Write-Ahead Logging for journaling of the SQLite database. This is for advanced scenarios only | `true`, `false` | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/setup-nr-consul.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/setup-nr-consul.md index c9fb97e68..ec30d3774 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/setup-nr-consul.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-name-resolution/setup-nr-consul.md @@ -37,15 +37,15 @@ The component resolves target apps by filtering healthy services and looks for a The configuration spec is fixed to v1.3.0 of the Consul API -| Field | Required | Type | Details | 示例 | -| -------------------- | :------: | -----------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| Client | N | [\*api.Config](https://pkg.go.dev/github.com/hashicorp/consul/api@v1.3.0#Config) | Configures client connection to the Consul agent. If blank it will use the sdk defaults, which in this case is just an address of `127.0.0.1:8500` | `10.0.4.4:8500` | -| QueryOptions | N | [\*api.QueryOptions](https://pkg.go.dev/github.com/hashicorp/consul/api@v1.3.0#QueryOptions) | Configures query used for resolving healthy services, if blank it will default to `UseCache:true` | `UseCache: false`, `Datacenter: "myDC"` | -| Checks | N | [[]\*api.AgentServiceCheck](https://pkg.go.dev/github.com/hashicorp/consul/api@v1.3.0#AgentServiceCheck) | Configures health checks if/when registering. If blank it will default to a single health check on the Dapr sidecar health endpoint | See [sample configs](#sample-configurations) | -| Tags | N | `[]string` | Configures any tags to include if/when registering services | `- "dapr"` | -| Meta | N | `map[string]string` | Configures any additional metadata to include if/when registering services | `DAPR_METRICS_PORT: "${DAPR_METRICS_PORT}"` | -| DaprPortMetaKey | N | `string` | The key used for getting the Dapr sidecar port from Consul service metadata during service resolution, it will also be used to set the Dapr sidecar port in metadata during registration. If blank it will default to `DAPR_PORT` | `"DAPR_TO_DAPR_PORT"` | -| SelfRegister | N | `bool` | Controls if Dapr will register the service to Consul. The name resolution interface does not cater for an "on shutdown" pattern so please consider this if using Dapr to register services to Consul as it will not deregister services. If blank it will default to `false` | `true` | +| Field | Required | Type | Details | 示例 | +| -------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| Client | N | [\*api.Config](https://pkg.go.dev/github.com/hashicorp/consul/api@v1.3.0#Config) | Configures client connection to the Consul agent. If blank it will use the sdk defaults, which in this case is just an address of `127.0.0.1:8500` | `10.0.4.4:8500` | +| QueryOptions | N | [\*api.QueryOptions](https://pkg.go.dev/github.com/hashicorp/consul/api@v1.3.0#QueryOptions) | Configures query used for resolving healthy services, if blank it will default to `UseCache:true` | `UseCache: false`, `Datacenter: "myDC"` | +| Checks | N | [[]\*api.AgentServiceCheck](https://pkg.go.dev/github.com/hashicorp/consul/api@v1.3.0#AgentServiceCheck) | Configures health checks if/when registering. If blank it will default to a single health check on the Dapr sidecar health endpoint | See [sample configs](#sample-configurations) | +| Tags | N | `[]string` | Configures any tags to include if/when registering services | `- "dapr"` | +| Meta | N | `map[string]string` | Configures any additional metadata to include if/when registering services | `DAPR_METRICS_PORT: "${DAPR_METRICS_PORT}"` | +| DaprPortMetaKey | N | `string` | The key used for getting the Dapr sidecar port from Consul service metadata during service resolution, it will also be used to set the Dapr sidecar port in metadata during registration. If blank it will default to `DAPR_PORT` | `"DAPR_TO_DAPR_PORT"` | +| SelfRegister | N | `bool` | Controls if Dapr will register the service to Consul. The name resolution interface does not cater for an "on shutdown" pattern so please consider this if using Dapr to register services to Consul as it will not deregister services. If blank it will default to `false` | `true` | | AdvancedRegistration | N | [\*api.AgentServiceRegistration](https://pkg.go.dev/github.com/hashicorp/consul/api@v1.3.0#AgentServiceRegistration) | Gives full control of service registration through configuration. If configured the component will ignore any configuration of Checks, Tags, Meta and SelfRegister. | See [sample configs](#sample-configurations) | ## Sample configurations diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-apache-kafka.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-apache-kafka.md index 94521e4d7..2bfba6af0 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-apache-kafka.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-apache-kafka.md @@ -66,43 +66,43 @@ spec: ## Spec metadata fields -| Field | Required | Details | Example | | -| --------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------ | -| brokers | Y | A comma-separated list of Kafka brokers. | `"localhost:9092,dapr-kafka.myapp.svc.cluster.local:9093"` | | -| consumerGroup | N | A kafka consumer group to listen on. Each record published to a topic is delivered to one consumer within each consumer group subscribed to the topic. If a value for `consumerGroup` is provided, any value for `consumerID` is ignored - a combination of the consumer group and a random unique identifier will be set for the `consumerID` instead. | `"group1"` | | +| Field | Required | Details | Example | | +| --------------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------ | +| brokers | Y | A comma-separated list of Kafka brokers. | `"localhost:9092,dapr-kafka.myapp.svc.cluster.local:9093"` | | +| consumerGroup | N | A kafka consumer group to listen on. Each record published to a topic is delivered to one consumer within each consumer group subscribed to the topic. If a value for `consumerGroup` is provided, any value for `consumerID` is ignored - a combination of the consumer group and a random unique identifier will be set for the `consumerID` instead. | `"group1"` | | | consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. If a value for `consumerGroup` is provided, any value for `consumerID` is ignored - a combination of the consumer group and a random unique identifier will be set for the `consumerID` instead. | `"channel1"` | | -| clientID | N | A user-provided string sent with every request to the Kafka brokers for logging, debugging, and auditing purposes. Defaults to `"namespace.appID"` for Kubernetes mode or `"appID"` for Self-Hosted mode. | `"my-namespace.my-dapr-app"`, `"my-dapr-app"` | | -| authRequired | N | _Deprecated_ Enable [SASL](https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer) authentication with the Kafka brokers. | `"true"`, `"false"` | | -| authType | Y | Configure or disable authentication. Supported values: `none`, `password`, `mtls`, `oidc` or `awsiam` | `"password"`, `"none"` | | -| saslUsername | N | The SASL username used for authentication. Only required if `authType` is set to `"password"`. | `"adminuser"` | | +| clientID | N | A user-provided string sent with every request to the Kafka brokers for logging, debugging, and auditing purposes. Defaults to `"namespace.appID"` for Kubernetes mode or `"appID"` for Self-Hosted mode. | `"my-namespace.my-dapr-app"`, `"my-dapr-app"` | | +| authRequired | N | _Deprecated_ Enable [SASL](https://en.wikipedia.org/wiki/Simple_Authentication_and_Security_Layer) authentication with the Kafka brokers. | `"true"`, `"false"` | | +| authType | Y | Configure or disable authentication. Supported values: `none`, `password`, `mtls`, `oidc` or `awsiam` | `"password"`, `"none"` | | +| saslUsername | N | The SASL username used for authentication. Only required if `authType` is set to `"password"`. | `"adminuser"` | | | saslPassword | N | The SASL password used for authentication. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). Only required if `authType is set to `"password"\`. | `""`, `"KeFg23!"` | | -| saslMechanism | N | The SASL Authentication Mechanism you wish to use. Only required if `authType` is set to `"password"`. Defaults to `PLAINTEXT` | `"SHA-512", "SHA-256", "PLAINTEXT"` | | -| initialOffset | N | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"` | | -| maxMessageBytes | N | The maximum size in bytes allowed for a single Kafka message. Defaults to 1024. | `2048` | | -| consumeRetryInterval | N | The interval between retries when attempting to consume topics. Treats numbers without suffix as milliseconds. Defaults to 100ms. | `200ms` | | -| consumeRetryEnabled | N | Disable consume retry by setting `"false"` | `"true"`, `"false"` | | -| version | N | Kafka cluster version. Defaults to 2.0.0. Note that this must be set to `1.0.0` if you are using Azure EventHubs with Kafka. | `0.10.2.0` | | -| caCert | N | Certificate authority certificate, required for using TLS. Can be `secretKeyRef` to use a secret reference | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | | -| clientCert | N | Client certificate, required for `authType` `mtls`. Can be `secretKeyRef` to use a secret reference | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | | -| clientKey | N | Client key, required for `authType` `mtls` Can be `secretKeyRef` to use a secret reference | `"-----BEGIN RSA PRIVATE KEY-----\n\n-----END RSA PRIVATE KEY-----"` | | -| skipVerify | N | Skip TLS verification, this is not recommended for use in production. Defaults to `"false"` | `"true"`, `"false"` | | +| saslMechanism | N | The SASL Authentication Mechanism you wish to use. Only required if `authType` is set to `"password"`. Defaults to `PLAINTEXT` | `"SHA-512", "SHA-256", "PLAINTEXT"` | | +| initialOffset | N | The initial offset to use if no offset was previously committed. Should be "newest" or "oldest". Defaults to "newest". | `"oldest"` | | +| maxMessageBytes | N | The maximum size in bytes allowed for a single Kafka message. Defaults to 1024. | `2048` | | +| consumeRetryInterval | N | The interval between retries when attempting to consume topics. Treats numbers without suffix as milliseconds. Defaults to 100ms. | `200ms` | | +| consumeRetryEnabled | N | Disable consume retry by setting `"false"` | `"true"`, `"false"` | | +| version | N | Kafka cluster version. Defaults to 2.0.0. Note that this must be set to `1.0.0` if you are using Azure EventHubs with Kafka. | `0.10.2.0` | | +| caCert | N | Certificate authority certificate, required for using TLS. Can be `secretKeyRef` to use a secret reference | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | | +| clientCert | N | Client certificate, required for `authType` `mtls`. Can be `secretKeyRef` to use a secret reference | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | | +| clientKey | N | Client key, required for `authType` `mtls` Can be `secretKeyRef` to use a secret reference | `"-----BEGIN RSA PRIVATE KEY-----\n\n-----END RSA PRIVATE KEY-----"` | | +| skipVerify | N | Skip TLS verification, this is not recommended for use in production. Defaults to `"false"` | `"true"`, `"false"` | | | disableTls | N | Disable TLS for transport security. To disable, you're not required to set value to `"true"`. This is not recommended for use in production. Defaults to `"false"`. | `"true"`, `"false"` | | -| oidcTokenEndpoint | N | Full URL to an OAuth2 identity provider access token endpoint. Required when `authType` is set to `oidc` | "https\://identity.example.com/v1/token" | | -| oidcClientID | N | The OAuth2 client ID that has been provisioned in the identity provider. Required when `authType` is set to `oidc` | `dapr-kafka` | | -| oidcClientSecret | N | The OAuth2 client secret that has been provisioned in the identity provider: Required when `authType` is set to `oidc` | `"KeFg23!"` | | -| oidcScopes | N | Comma-delimited list of OAuth2/OIDC scopes to request with the access token. Recommended when `authType` is set to `oidc`. Defaults to `"openid"` | `"openid,kafka-prod"` | | -| oidcExtensions | N | Input/Output | String containing a JSON-encoded dictionary of OAuth2/OIDC extensions to request with the access token | `{"cluster":"kafka","poolid":"kafkapool"}` | -| awsRegion | N | The AWS region where the Kafka cluster is deployed to. Required when `authType` is set to `awsiam` | `us-west-1` | | -| awsAccessKey | N | AWS access key associated with an IAM account. | `"accessKey"` | | -| awsSecretKey | N | The secret key associated with the access key. | `"secretKey"` | | -| awsSessionToken | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"sessionToken"` | | -| awsIamRoleArn | N | IAM role that has access to AWS Managed Streaming for Apache Kafka (MSK). This is another option to authenticate with MSK aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/mskRole"` | | -| awsStsSessionName | N | Represents the session name for assuming a role. | `"MSKSASLDefaultSession"` | | -| schemaRegistryURL | N | Required when using Schema Registry Avro serialization/deserialization. The Schema Registry URL. | `http://localhost:8081` | | -| schemaRegistryAPIKey | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Key. | `XYAXXAZ` | | -| schemaRegistryAPISecret | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Secret. | `ABCDEFGMEADFF` | | -| schemaCachingEnabled | N | When using Schema Registry Avro serialization/deserialization. Enables caching for schemas. Default is `true` | `true` | | -| schemaLatestVersionCacheTTL | N | When using Schema Registry Avro serialization/deserialization. The TTL for schema caching when publishing a message with latest schema available. Default is 5 min | `5m` | | +| oidcTokenEndpoint | N | Full URL to an OAuth2 identity provider access token endpoint. Required when `authType` is set to `oidc` | "https://identity.example.com/v1/token" | | +| oidcClientID | N | The OAuth2 client ID that has been provisioned in the identity provider. Required when `authType` is set to `oidc` | `dapr-kafka` | | +| oidcClientSecret | N | The OAuth2 client secret that has been provisioned in the identity provider: Required when `authType` is set to `oidc` | `"KeFg23!"` | | +| oidcScopes | N | Comma-delimited list of OAuth2/OIDC scopes to request with the access token. Recommended when `authType` is set to `oidc`. Defaults to `"openid"` | `"openid,kafka-prod"` | | +| oidcExtensions | N | Input/Output | String containing a JSON-encoded dictionary of OAuth2/OIDC extensions to request with the access token | `{"cluster":"kafka","poolid":"kafkapool"}` | +| awsRegion | N | The AWS region where the Kafka cluster is deployed to. Required when `authType` is set to `awsiam` | `us-west-1` | | +| awsAccessKey | N | AWS access key associated with an IAM account. | `"accessKey"` | | +| awsSecretKey | N | The secret key associated with the access key. | `"secretKey"` | | +| awsSessionToken | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"sessionToken"` | | +| awsIamRoleArn | N | IAM role that has access to AWS Managed Streaming for Apache Kafka (MSK). This is another option to authenticate with MSK aside from the AWS Credentials. | `"arn:aws:iam::123456789:role/mskRole"` | | +| awsStsSessionName | N | Represents the session name for assuming a role. | `"MSKSASLDefaultSession"` | | +| schemaRegistryURL | N | Required when using Schema Registry Avro serialization/deserialization. The Schema Registry URL. | `http://localhost:8081` | | +| schemaRegistryAPIKey | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Key. | `XYAXXAZ` | | +| schemaRegistryAPISecret | N | When using Schema Registry Avro serialization/deserialization. The Schema Registry credentials API Secret. | `ABCDEFGMEADFF` | | +| schemaCachingEnabled | N | When using Schema Registry Avro serialization/deserialization. Enables caching for schemas. Default is `true` | `true` | | +| schemaLatestVersionCacheTTL | N | When using Schema Registry Avro serialization/deserialization. The TTL for schema caching when publishing a message with latest schema available. Default is 5 min | `5m` | | The `secretKeyRef` above is referencing a [kubernetes secrets store]({{< ref kubernetes-secret-store.md >}}) to access the tls information. Visit [here]({{< ref setup-secret-store.md >}}) to learn more about how to configure a secret store component. diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-aws-snssqs.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-aws-snssqs.md index b17b69dff..b8ba31186 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-aws-snssqs.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-aws-snssqs.md @@ -78,26 +78,26 @@ The above example uses secrets as plain strings. It is recommended to use [a sec ## Spec metadata fields -| Field | Required | Details | Example | -| ------------------------------ | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| accessKey | Y | ID of the AWS account/role with appropriate permissions to SNS and SQS (see below) | `"AKIAIOSFODNN7EXAMPLE"` | -| secretKey | Y | Secret for the AWS user/role. If using an `AssumeRole` access, you will also need to provide a `sessionToken` | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | -| region | Y | The AWS region where the SNS/SQS assets are located or be created in. See [this page](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ugi\&l=na) for valid regions. Ensure that SNS and SQS are available in that region | `"us-east-1"` | +| Field | Required | Details | Example | +| ------------------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| accessKey | Y | ID of the AWS account/role with appropriate permissions to SNS and SQS (see below) | `"AKIAIOSFODNN7EXAMPLE"` | +| secretKey | Y | Secret for the AWS user/role. If using an `AssumeRole` access, you will also need to provide a `sessionToken` | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | +| region | Y | The AWS region where the SNS/SQS assets are located or be created in. See [this page](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/?p=ugi\&l=na) for valid regions. Ensure that SNS and SQS are available in that region | `"us-east-1"` | | consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. See the [pub/sub broker component file]({{< ref setup-pubsub.md >}}) to learn how ConsumerID is automatically generated. | `"channel1"` | -| endpoint | N | AWS endpoint for the component to use. Only used for local development with, for example, [localstack](https://github.com/localstack/localstack). The `endpoint` is unnecessary when running against production AWS | `"http://localhost:4566"` | -| sessionToken | N | AWS session token to use. A session token is only required if you are using temporary security credentials | `"TOKEN"` | -| messageReceiveLimit | N | Number of times a message is received, after processing of that message fails, that once reached, results in removing of that message from the queue. If `sqsDeadLettersQueueName` is specified, `messageReceiveLimit` is the number of times a message is received, after processing of that message fails, that once reached, results in moving of the message to the SQS dead-letters queue. Default: `10` | `10` | -| sqsDeadLettersQueueName | N | Name of the dead letters queue for this application | `"myapp-dlq"` | -| messageVisibilityTimeout | N | Amount of time in seconds that a message is hidden from receive requests after it is sent to a subscriber. Default: `10` | `10` | -| messageRetryLimit | N | Number of times to resend a message after processing of that message fails before removing that message from the queue. Default: `10` | `10` | -| messageWaitTimeSeconds | N | The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than `messageWaitTimeSeconds`. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages. Default: `1` | `1` | -| messageMaxNumber | N | Maximum number of messages to receive from the queue at a time. Default: `10`, Maximum: `10` | `10` | -| fifo | N | Use SQS FIFO queue to provide message ordering and deduplication. Default: `"false"`. See further details about [SQS FIFO](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) | `"true"`, `"false"` | -| fifoMessageGroupID | N | If `fifo` is enabled, instructs Dapr to use a custom [Message Group ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) for the pubsub deployment. This is not mandatory as Dapr creates a custom Message Group ID for each producer, thus ensuring ordering of messages per a Dapr producer. Default: `""` | `"app1-mgi"` | -| disableEntityManagement | N | When set to true, SNS topics, SQS queues and the SQS subscriptions to SNS do not get created automatically. Default: `"false"` | `"true"`, `"false"` | -| disableDeleteOnRetryLimit | N | When set to true, after retrying and failing of `messageRetryLimit` times processing a message, reset the message visibility timeout so that other consumers can try processing, instead of deleting the message from SQS (the default behvior). Default: `"false"` | `"true"`, `"false"` | -| assetsManagementTimeoutSeconds | N | Amount of time in seconds, for an AWS asset management operation, before it times out and cancelled. Asset management operations are any operations performed on STS, SNS and SQS, except message publish and consume operations that implement the default Dapr component retry behavior. The value can be set to any non-negative float/integer. Default: `5` | `0.5`, `10` | -| concurrencyMode | N | When messages are received in bulk from SQS, call the subscriber sequentially (“single” message at a time), or concurrently (in “parallel”). Default: `"parallel"` | `"single"`, `"parallel"` | +| endpoint | N | AWS endpoint for the component to use. Only used for local development with, for example, [localstack](https://github.com/localstack/localstack). The `endpoint` is unnecessary when running against production AWS | `"http://localhost:4566"` | +| sessionToken | N | AWS session token to use. A session token is only required if you are using temporary security credentials | `"TOKEN"` | +| messageReceiveLimit | N | Number of times a message is received, after processing of that message fails, that once reached, results in removing of that message from the queue. If `sqsDeadLettersQueueName` is specified, `messageReceiveLimit` is the number of times a message is received, after processing of that message fails, that once reached, results in moving of the message to the SQS dead-letters queue. Default: `10` | `10` | +| sqsDeadLettersQueueName | N | Name of the dead letters queue for this application | `"myapp-dlq"` | +| messageVisibilityTimeout | N | Amount of time in seconds that a message is hidden from receive requests after it is sent to a subscriber. Default: `10` | `10` | +| messageRetryLimit | N | Number of times to resend a message after processing of that message fails before removing that message from the queue. Default: `10` | `10` | +| messageWaitTimeSeconds | N | The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than `messageWaitTimeSeconds`. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages. Default: `1` | `1` | +| messageMaxNumber | N | Maximum number of messages to receive from the queue at a time. Default: `10`, Maximum: `10` | `10` | +| fifo | N | Use SQS FIFO queue to provide message ordering and deduplication. Default: `"false"`. See further details about [SQS FIFO](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) | `"true"`, `"false"` | +| fifoMessageGroupID | N | If `fifo` is enabled, instructs Dapr to use a custom [Message Group ID](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html) for the pubsub deployment. This is not mandatory as Dapr creates a custom Message Group ID for each producer, thus ensuring ordering of messages per a Dapr producer. Default: `""` | `"app1-mgi"` | +| disableEntityManagement | N | When set to true, SNS topics, SQS queues and the SQS subscriptions to SNS do not get created automatically. Default: `"false"` | `"true"`, `"false"` | +| disableDeleteOnRetryLimit | N | When set to true, after retrying and failing of `messageRetryLimit` times processing a message, reset the message visibility timeout so that other consumers can try processing, instead of deleting the message from SQS (the default behvior). Default: `"false"` | `"true"`, `"false"` | +| assetsManagementTimeoutSeconds | N | Amount of time in seconds, for an AWS asset management operation, before it times out and cancelled. Asset management operations are any operations performed on STS, SNS and SQS, except message publish and consume operations that implement the default Dapr component retry behavior. The value can be set to any non-negative float/integer. Default: `5` | `0.5`, `10` | +| concurrencyMode | N | When messages are received in bulk from SQS, call the subscriber sequentially (“single” message at a time), or concurrently (in “parallel”). Default: `"parallel"` | `"single"`, `"parallel"` | ### Additional info diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md index 4ac002592..10233932b 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md @@ -60,18 +60,18 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Field | Required | Details | Example | +| ------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `connectionString` | Y\* | Connection string for the Event Hub or the Event Hub namespace.
\* Mutally exclusive with `eventHubNamespace` field.
\* Required when not using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key};EntityPath={EventHub}"` or `"Endpoint=sb://{EventHubNamespace}.servicebus.windows.net/;SharedAccessKeyName={PolicyName};SharedAccessKey={Key}"` | | `eventHubNamespace` | Y\* | The Event Hub Namespace name.
\* Mutally exclusive with `connectionString` field.
\* Required when using [Microsoft Entra ID Authentication]({{< ref "authenticating-azure.md" >}}) | `"namespace"` | | `consumerID` | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | `"channel1"` | -| `storageAccountName` | Y | Storage account name to use for the checkpoint store. | `"myeventhubstorage"` | -| `storageAccountKey` | Y\* | Storage account key for the checkpoint store account.
\* When using Microsoft Entra ID, it's possible to omit this if the service principal has access to the storage account too. | `"112233445566778899"` | -| `storageConnectionString` | Y\* | Connection string for the checkpoint store, alternative to specifying `storageAccountKey` | `"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey="` | -| `storageContainerName` | Y | Storage container name for the storage account name. | `"myeventhubstoragecontainer"` | -| `enableEntityManagement` | N | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true", "false"` | -| `resourceGroupName` | N | Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled | `"test-rg"` | -| `subscriptionID` | N | Azure subscription ID value. Required when entity management is enabled | `"azure subscription id"` | +| `storageAccountName` | Y | Storage account name to use for the checkpoint store. | `"myeventhubstorage"` | +| `storageAccountKey` | Y\* | Storage account key for the checkpoint store account.
\* When using Microsoft Entra ID, it's possible to omit this if the service principal has access to the storage account too. | `"112233445566778899"` | +| `storageConnectionString` | Y\* | Connection string for the checkpoint store, alternative to specifying `storageAccountKey` | `"DefaultEndpointsProtocol=https;AccountName=myeventhubstorage;AccountKey="` | +| `storageContainerName` | Y | Storage container name for the storage account name. | `"myeventhubstoragecontainer"` | +| `enableEntityManagement` | N | Boolean value to allow management of the EventHub namespace and storage account. Default: `false` | `"true", "false"` | +| `resourceGroupName` | N | Name of the resource group the Event Hub namespace is part of. Required when entity management is enabled | `"test-rg"` | +| `subscriptionID` | N | Azure subscription ID value. Required when entity management is enabled | `"azure subscription id"` | | `partitionCount` | N | Number of partitions for the new Event Hub namespace. Used only when entity management is enabled. Default: `"1"` | `"2"` | | `messageRetentionInDays` | N | Number of days to retain messages for in the newly created Event Hub namespace. Used only when entity management is enabled. Default: `"1"` | `"90"` | @@ -201,14 +201,14 @@ Azure IoT Hub provides an [endpoint that is compatible with Event Hubs](https:// The device-to-cloud events created by Azure IoT Hub devices will contain additional [IoT Hub System Properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-construct#system-properties-of-d2c-iot-hub-messages), and the Azure Event Hubs pubsub component for Dapr will return the following as part of the response metadata: -| System Property Name | Description & Routing Query Keyword | -| -------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| System Property Name | Description & Routing Query Keyword | +| -------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `iothub-connection-auth-generation-id` | The **connectionDeviceGenerationId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. | +| `iothub-connection-auth-method` | The **connectionAuthMethod** used to authenticate the device that sent the message. | | `iothub-connection-device-id` | The **deviceId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | | `iothub-connection-module-id` | The **moduleId** of the device that sent the message. See [IoT Hub device identity properties](https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#device-identity-properties). | -| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. | -| `message-id` | The user-settable AMQP **messageId**. | +| `iothub-enqueuedtime` | The **enqueuedTime** in RFC3339 format that the device-to-cloud message was received by IoT Hub. | +| `message-id` | The user-settable AMQP **messageId**. | For example, the headers of a delivered HTTP subscription message would contain: diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-queues.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-queues.md index 3879a837d..c68f3a9d2 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-queues.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-queues.md @@ -68,26 +68,26 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| `connectionString` | Y | Shared access policy connection string for the Service Bus. Required unless using Microsoft Entra ID authentication. | See example above | +| Field | Required | Details | Example | +| --------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | +| `connectionString` | Y | Shared access policy connection string for the Service Bus. Required unless using Microsoft Entra ID authentication. | See example above | | `consumerID` | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | `"channel1"` | -| `namespaceName` | N | Parameter to set the address of the Service Bus namespace, as a fully-qualified domain name. Required if using Microsoft Entra ID authentication. | `"namespace.servicebus.windows.net"` | -| `timeoutInSec` | N | Timeout for sending messages and for management operations. Default: `60` | `30` | -| `handlerTimeoutInSec` | N | Timeout for invoking the app's handler. Default: `60` | `30` | +| `namespaceName` | N | Parameter to set the address of the Service Bus namespace, as a fully-qualified domain name. Required if using Microsoft Entra ID authentication. | `"namespace.servicebus.windows.net"` | +| `timeoutInSec` | N | Timeout for sending messages and for management operations. Default: `60` | `30` | +| `handlerTimeoutInSec` | N | Timeout for invoking the app's handler. Default: `60` | `30` | | `lockRenewalInSec` | N | Defines the frequency at which buffered message locks will be renewed. Default: `20`. | `20` | | `maxActiveMessages` | N | Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `1000` | `2000` | -| `maxConcurrentHandlers` | N | Defines the maximum number of concurrent message handlers. Default: `0` (unlimited) | `10` | -| `disableEntityManagement` | N | When set to true, queues and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | -| `defaultMessageTimeToLiveInSec` | N | Default message time to live, in seconds. Used during subscription creation only. | `10` | +| `maxConcurrentHandlers` | N | Defines the maximum number of concurrent message handlers. Default: `0` (unlimited) | `10` | +| `disableEntityManagement` | N | When set to true, queues and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | +| `defaultMessageTimeToLiveInSec` | N | Default message time to live, in seconds. Used during subscription creation only. | `10` | | `autoDeleteOnIdleInSec` | N | Time in seconds to wait before auto deleting idle subscriptions. Used during subscription creation only. Default: `0` (disabled) | `3600` | | `maxDeliveryCount` | N | Defines the number of attempts the server will make to deliver a message. Used during subscription creation only. Default set by server. | `10` | | `lockDurationInSec` | N | Defines the length in seconds that a message will be locked for before expiring. Used during subscription creation only. Default set by server. | `30` | -| `minConnectionRecoveryInSec` | N | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `2` | `5` | +| `minConnectionRecoveryInSec` | N | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `2` | `5` | | `maxConnectionRecoveryInSec` | N | Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the component waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `300` (5 minutes) | `600` | | `maxRetriableErrorsPerSec` | N | Maximum number of retriable errors that are processed per second. If a message fails to be processed with a retriable error, the component adds a delay before it starts processing another message, to avoid immediately re-processing messages that have failed. Default: `10` | `10` | -| `publishMaxRetries` | N | The max number of retries for when Azure Service Bus responds with "too busy" in order to throttle messages. Defaults: `5` | `5` | -| `publishInitialRetryIntervalInMs` | N | Time in milliseconds for the initial exponential backoff when Azure Service Bus throttle messages. Defaults: `500` | `500` | +| `publishMaxRetries` | N | The max number of retries for when Azure Service Bus responds with "too busy" in order to throttle messages. Defaults: `5` | `5` | +| `publishInitialRetryIntervalInMs` | N | Time in milliseconds for the initial exponential backoff when Azure Service Bus throttle messages. Defaults: `500` | `500` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-topics.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-topics.md index d5ad0a28d..680d362d0 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-topics.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-azure-servicebus-topics.md @@ -71,26 +71,26 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| `connectionString` | Y | Shared access policy connection string for the Service Bus. Required unless using Microsoft Entra ID authentication. | See example above | -| `namespaceName` | N | Parameter to set the address of the Service Bus namespace, as a fully-qualified domain name. Required if using Microsoft Entra ID authentication. | `"namespace.servicebus.windows.net"` | +| Field | Required | Details | Example | +| --------------------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | +| `connectionString` | Y | Shared access policy connection string for the Service Bus. Required unless using Microsoft Entra ID authentication. | See example above | +| `namespaceName` | N | Parameter to set the address of the Service Bus namespace, as a fully-qualified domain name. Required if using Microsoft Entra ID authentication. | `"namespace.servicebus.windows.net"` | | `consumerID` | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. (`appID`) value. | | -| `timeoutInSec` | N | Timeout for sending messages and for management operations. Default: `60` | `30` | -| `handlerTimeoutInSec` | N | Timeout for invoking the app's handler. Default: `60` | `30` | -| `lockRenewalInSec` | N | Defines the frequency at which buffered message locks will be renewed. Default: `20`. | `20` | -| `maxActiveMessages` | N | Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `1000` | `2000` | -| `maxConcurrentHandlers` | N | Defines the maximum number of concurrent message handlers. Default: `0` (unlimited) | `10` | -| `disableEntityManagement` | N | When set to true, queues and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | -| `defaultMessageTimeToLiveInSec` | N | Default message time to live, in seconds. Used during subscription creation only. | `10` | -| `autoDeleteOnIdleInSec` | N | Time in seconds to wait before auto deleting idle subscriptions. Used during subscription creation only. Default: `0` (disabled) | `3600` | -| `maxDeliveryCount` | N | Defines the number of attempts the server will make to deliver a message. Used during subscription creation only. Default set by server. | `10` | -| `lockDurationInSec` | N | Defines the length in seconds that a message will be locked for before expiring. Used during subscription creation only. Default set by server. | `30` | -| `minConnectionRecoveryInSec` | N | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `2` | `5` | -| `maxConnectionRecoveryInSec` | N | Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the component waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `300` (5 minutes) | `600` | -| `maxRetriableErrorsPerSec` | N | Maximum number of retriable errors that are processed per second. If a message fails to be processed with a retriable error, the component adds a delay before it starts processing another message, to avoid immediately re-processing messages that have failed. Default: `10` | `10` | -| `publishMaxRetries` | N | The max number of retries for when Azure Service Bus responds with "too busy" in order to throttle messages. Defaults: `5` | `5` | -| `publishInitialRetryIntervalInMs` | N | Time in milliseconds for the initial exponential backoff when Azure Service Bus throttle messages. Defaults: `500` | `500` | +| `timeoutInSec` | N | Timeout for sending messages and for management operations. Default: `60` | `30` | +| `handlerTimeoutInSec` | N | Timeout for invoking the app's handler. Default: `60` | `30` | +| `lockRenewalInSec` | N | Defines the frequency at which buffered message locks will be renewed. Default: `20`. | `20` | +| `maxActiveMessages` | N | Defines the maximum number of messages to be processing or in the buffer at once. This should be at least as big as the maximum concurrent handlers. Default: `1000` | `2000` | +| `maxConcurrentHandlers` | N | Defines the maximum number of concurrent message handlers. Default: `0` (unlimited) | `10` | +| `disableEntityManagement` | N | When set to true, queues and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | +| `defaultMessageTimeToLiveInSec` | N | Default message time to live, in seconds. Used during subscription creation only. | `10` | +| `autoDeleteOnIdleInSec` | N | Time in seconds to wait before auto deleting idle subscriptions. Used during subscription creation only. Default: `0` (disabled) | `3600` | +| `maxDeliveryCount` | N | Defines the number of attempts the server will make to deliver a message. Used during subscription creation only. Default set by server. | `10` | +| `lockDurationInSec` | N | Defines the length in seconds that a message will be locked for before expiring. Used during subscription creation only. Default set by server. | `30` | +| `minConnectionRecoveryInSec` | N | Minimum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. Default: `2` | `5` | +| `maxConnectionRecoveryInSec` | N | Maximum interval (in seconds) to wait before attempting to reconnect to Azure Service Bus in case of a connection failure. After each attempt, the component waits a random number of seconds, increasing every time, between the minimum and the maximum. Default: `300` (5 minutes) | `600` | +| `maxRetriableErrorsPerSec` | N | Maximum number of retriable errors that are processed per second. If a message fails to be processed with a retriable error, the component adds a delay before it starts processing another message, to avoid immediately re-processing messages that have failed. Default: `10` | `10` | +| `publishMaxRetries` | N | The max number of retries for when Azure Service Bus responds with "too busy" in order to throttle messages. Defaults: `5` | `5` | +| `publishInitialRetryIntervalInMs` | N | Time in milliseconds for the initial exponential backoff when Azure Service Bus throttle messages. Defaults: `500` | `500` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-gcp-pubsub.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-gcp-pubsub.md index 532f9a5f6..63e600ddf 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-gcp-pubsub.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-gcp-pubsub.md @@ -69,28 +69,28 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ----------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| projectId | Y | GCP project id | `myproject-123` | +| Field | Required | Details | Example | +| ----------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| projectId | Y | GCP project id | `myproject-123` | | endpoint | N | GCP endpoint for the component to use. Only used for local development (for example) with [GCP Pub/Sub Emulator](https://cloud.google.com/pubsub/docs/emulator). The `endpoint` is unnecessary when running against the GCP production API. | `"http://localhost:8085"` | | `consumerID` | N | The Consumer ID organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. The `consumerID`, along with the `topic` provided as part of the request, are used to build the Pub/Sub subscription ID | | -| identityProjectId | N | If the GCP pubsub project is different from the identity project, specify the identity project using this attribute | `"myproject-123"` | -| privateKeyId | N | If using explicit credentials, this field should contain the `private_key_id` field from the service account json document | `"my-private-key"` | -| privateKey | N | If using explicit credentials, this field should contain the `private_key` field from the service account json | `-----BEGIN PRIVATE KEY-----MIIBVgIBADANBgkqhkiG9w0B` | -| clientEmail | N | If using explicit credentials, this field should contain the `client_email` field from the service account json | `"myservice@myproject-123.iam.gserviceaccount.com"` | -| clientId | N | If using explicit credentials, this field should contain the `client_id` field from the service account json | `106234234234` | -| authUri | N | If using explicit credentials, this field should contain the `auth_uri` field from the service account json | `https://accounts.google.com/o/oauth2/auth` | -| tokenUri | N | If using explicit credentials, this field should contain the `token_uri` field from the service account json | `https://oauth2.googleapis.com/token` | -| authProviderX509CertUrl | N | If using explicit credentials, this field should contain the `auth_provider_x509_cert_url` field from the service account json | `https://www.googleapis.com/oauth2/v1/certs` | -| clientX509CertUrl | N | If using explicit credentials, this field should contain the `client_x509_cert_url` field from the service account json | `https://www.googleapis.com/robot/v1/metadata/x509/myserviceaccount%40myproject.iam.gserviceaccount.com` | -| disableEntityManagement | N | When set to `"true"`, topics and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | -| enableMessageOrdering | N | When set to `"true"`, subscribed messages will be received in order, depending on publishing and permissions configuration. | `"true"`, `"false"` | -| orderingKey | N | The key provided in the request. It's used when `enableMessageOrdering` is set to `true` to order messages based on such key. | "my-orderingkey" | -| maxReconnectionAttempts | N | Defines the maximum number of reconnect attempts. Default: `30` | `30` | -| connectionRecoveryInSec | N | Time in seconds to wait between connection recovery attempts. Default: `2` | `2` | -| deadLetterTopic | N | Name of the GCP Pub/Sub Topic. This topic **must** exist before using this component. | `"myapp-dlq"` | -| maxDeliveryAttempts | N | Maximum number of attempts to deliver the message. If `deadLetterTopic` is specified, `maxDeliveryAttempts` is the maximum number of attempts for failed processing of messages. Once that number is reached, the message will be moved to the dead-letter topic. Default: `5` | `5` | -| type | N | **DEPRECATED** GCP credentials type. Only `service_account` is supported. Defaults to `service_account` | `service_account` | +| identityProjectId | N | If the GCP pubsub project is different from the identity project, specify the identity project using this attribute | `"myproject-123"` | +| privateKeyId | N | If using explicit credentials, this field should contain the `private_key_id` field from the service account json document | `"my-private-key"` | +| privateKey | N | If using explicit credentials, this field should contain the `private_key` field from the service account json | `-----BEGIN PRIVATE KEY-----MIIBVgIBADANBgkqhkiG9w0B` | +| clientEmail | N | If using explicit credentials, this field should contain the `client_email` field from the service account json | `"myservice@myproject-123.iam.gserviceaccount.com"` | +| clientId | N | If using explicit credentials, this field should contain the `client_id` field from the service account json | `106234234234` | +| authUri | N | If using explicit credentials, this field should contain the `auth_uri` field from the service account json | `https://accounts.google.com/o/oauth2/auth` | +| tokenUri | N | If using explicit credentials, this field should contain the `token_uri` field from the service account json | `https://oauth2.googleapis.com/token` | +| authProviderX509CertUrl | N | If using explicit credentials, this field should contain the `auth_provider_x509_cert_url` field from the service account json | `https://www.googleapis.com/oauth2/v1/certs` | +| clientX509CertUrl | N | If using explicit credentials, this field should contain the `client_x509_cert_url` field from the service account json | `https://www.googleapis.com/robot/v1/metadata/x509/myserviceaccount%40myproject.iam.gserviceaccount.com` | +| disableEntityManagement | N | When set to `"true"`, topics and subscriptions do not get created automatically. Default: `"false"` | `"true"`, `"false"` | +| enableMessageOrdering | N | When set to `"true"`, subscribed messages will be received in order, depending on publishing and permissions configuration. | `"true"`, `"false"` | +| orderingKey | N | The key provided in the request. It's used when `enableMessageOrdering` is set to `true` to order messages based on such key. | "my-orderingkey" | +| maxReconnectionAttempts | N | Defines the maximum number of reconnect attempts. Default: `30` | `30` | +| connectionRecoveryInSec | N | Time in seconds to wait between connection recovery attempts. Default: `2` | `2` | +| deadLetterTopic | N | Name of the GCP Pub/Sub Topic. This topic **must** exist before using this component. | `"myapp-dlq"` | +| maxDeliveryAttempts | N | Maximum number of attempts to deliver the message. If `deadLetterTopic` is specified, `maxDeliveryAttempts` is the maximum number of attempts for failed processing of messages. Once that number is reached, the message will be moved to the dead-letter topic. Default: `5` | `5` | +| type | N | **DEPRECATED** GCP credentials type. Only `service_account` is supported. Defaults to `service_account` | `service_account` | {{% alert title="Warning" color="warning" %}} If `enableMessageOrdering` is set to "true", the roles/viewer or roles/pubsub.viewer role will be required on the service account in order to guarantee ordering in cases where order tokens are not embedded in the messages. If this role is not given, or the call to Subscription.Config() fails for any other reason, ordering by embedded order tokens will still function correctly. diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-jetstream.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-jetstream.md index 59b5e337e..c693d76cb 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-jetstream.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-jetstream.md @@ -98,7 +98,7 @@ spec: | rateLimit | N | [Rate Limit] | `1024` | | heartbeat | N | [Heartbeat] | `10s` | | ackPolicy | N | [Ack Policy] | `explicit` | -| deliverPolicy | N | One of: all, last, new, sequence, time | `all` | +| deliverPolicy | N | One of: all, last, new, sequence, time | `all` | | domain | N | [JetStream Leafondes] | `HUB` | | apiPrefix | N | [JetStream Leafnodes] | `PREFIX` | @@ -178,35 +178,19 @@ spec: - [NATS CLI](https://github.com/nats-io/natscli) [Durable Name]: https://docs.nats.io/jetstream/concepts/consumers#durable-name - [Start Sequence]: https://docs.nats.io/jetstream/concepts/consumers#deliverbystartsequence - [Start Time]: https://docs.nats.io/jetstream/concepts/consumers#deliverbystarttime - [Replay Policy]: https://docs.nats.io/jetstream/concepts/consumers#replaypolicy - [Flow Control]: https://docs.nats.io/jetstream/concepts/consumers#flowcontrol - [Ack Wait]: https://docs.nats.io/jetstream/concepts/consumers#ackwait - [Max Deliver]: https://docs.nats.io/jetstream/concepts/consumers#maxdeliver - [BackOff]: https://docs.nats.io/jetstream/concepts/consumers#backoff - [Max Ack Pending]: https://docs.nats.io/jetstream/concepts/consumers#maxackpending - [Replicas]: https://docs.nats.io/jetstream/concepts/consumers#replicas - [Memory Storage]: https://docs.nats.io/jetstream/concepts/consumers#memorystorage - [Rate Limit]: https://docs.nats.io/jetstream/concepts/consumers#ratelimit - [Heartbeat]: https://docs.nats.io/jetstream/concepts/consumers#heartbeat - [Ack Policy]: https://docs.nats.io/nats-concepts/jetstream/consumers#ackpolicy - [JetStream Leafonodes]: https://docs.nats.io/running-a-nats-service/configuration/leafnodes/jetstream_leafnodes - [Decentralized JWT Authentication/Authorization]: https://docs.nats.io/running-a-nats-service/configuration/securing_nats/auth_intro/jwt - [NATS token based authentication]: https://docs.nats.io/running-a-nats-service/configuration/securing_nats/auth_intro/tokens diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-kubemq.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-kubemq.md index c6ea908d3..801a547b1 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-kubemq.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-kubemq.md @@ -30,15 +30,15 @@ spec: ## Spec metadata fields -| Field | Required | Details | Example | -| ----------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| address | Y | Address of the KubeMQ server | `"localhost:50000"` | -| store | N | type of pubsub, true: pubsub persisted (EventsStore), false: pubsub in-memory (Events) | `true` or `false` (default is `false`) | +| Field | Required | Details | Example | +| ----------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| address | Y | Address of the KubeMQ server | `"localhost:50000"` | +| store | N | type of pubsub, true: pubsub persisted (EventsStore), false: pubsub in-memory (Events) | `true` or `false` (default is `false`) | | consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | `"channel1"` | -| clientID | N | Name for client id connection | `sub-client-12345` | -| authToken | N | Auth JWT token for connection Check out [KubeMQ Authentication](https://docs.kubemq.io/learn/access-control/authentication) | `ew...` | -| group | N | Subscriber group for load balancing | `g1` | -| disableReDelivery | N | Set if message should be re-delivered in case of error coming from application | `true` or `false` (default is `false`) | +| clientID | N | Name for client id connection | `sub-client-12345` | +| authToken | N | Auth JWT token for connection Check out [KubeMQ Authentication](https://docs.kubemq.io/learn/access-control/authentication) | `ew...` | +| group | N | Subscriber group for load balancing | `g1` | +| disableReDelivery | N | Set if message should be re-delivered in case of error coming from application | `true` or `false` (default is `false`) | ## Create a KubeMQ broker diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt.md index 86a9fa871..85f61d6ad 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt.md @@ -38,17 +38,17 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ------------ | :--------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| url | Y | Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference.
Use the **`tcp://`** URI scheme for non-TLS communication.
Use the **`ssl://`** URI scheme for TLS communication. | `"tcp://[username][:password]@host.domain[:port]"` | -| consumerID | N | The client ID used to connect to the MQTT broker for the consumer connection. Defaults to the Dapr app ID.
Note: if `producerID` is not set, `-consumer` is appended to this value for the consumer connection | `"myMqttClientApp"` | -| producerID | N | The client ID used to connect to the MQTT broker for the producer connection. Defaults to `{consumerID}-producer`. | `"myMqttProducerApp"` | -| qos | N | Indicates the Quality of Service Level (QoS) of the message ([more info](https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels/)). Defaults to `1`. | `0`, `1`, `2` | -| retain | N | Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`. | `"true"`, `"false"` | -| cleanSession | N | Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"` ([more info](http://www.steves-internet-guide.com/mqtt-clean-sessions-example/)). Defaults to `"false"`. | `"true"`, `"false"` | -| caCert | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | -| clientCert | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | -| clientKey | Required for using TLS | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | `"-----BEGIN RSA PRIVATE KEY-----\n\n-----END RSA PRIVATE KEY-----"` | +| Field | Required | Details | Example | +| ------------ | :--------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | +| url | Y | Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference.
Use the **`tcp://`** URI scheme for non-TLS communication.
Use the **`ssl://`** URI scheme for TLS communication. | `"tcp://[username][:password]@host.domain[:port]"` | +| consumerID | N | The client ID used to connect to the MQTT broker for the consumer connection. Defaults to the Dapr app ID.
Note: if `producerID` is not set, `-consumer` is appended to this value for the consumer connection | `"myMqttClientApp"` | +| producerID | N | The client ID used to connect to the MQTT broker for the producer connection. Defaults to `{consumerID}-producer`. | `"myMqttProducerApp"` | +| qos | N | Indicates the Quality of Service Level (QoS) of the message ([more info](https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels/)). Defaults to `1`. | `0`, `1`, `2` | +| retain | N | Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`. | `"true"`, `"false"` | +| cleanSession | N | Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"` ([more info](http://www.steves-internet-guide.com/mqtt-clean-sessions-example/)). Defaults to `"false"`. | `"true"`, `"false"` | +| caCert | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | +| clientCert | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | +| clientKey | Required for using TLS | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | `"-----BEGIN RSA PRIVATE KEY-----\n\n-----END RSA PRIVATE KEY-----"` | ### Enabling message delivery retries diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt3.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt3.md index e344195ee..335dcab8d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt3.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-mqtt3.md @@ -40,16 +40,16 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| -------------- | :--------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| `url` | Y | Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference.
Use the **`tcp://`** URI scheme for non-TLS communication.
Use the **`ssl://`** URI scheme for TLS communication. | `"tcp://[username][:password]@host.domain[:port]"` | -| `consumerID` | N | The client ID used to connect to the MQTT broker. Defaults to the Dapr app ID. | `"myMqttClientApp"` | -| `retain` | N | Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`. | `"true"`, `"false"` | -| `cleanSession` | N | Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"` ([more info](http://www.steves-internet-guide.com/mqtt-clean-sessions-example/)). Defaults to `"false"`. | `"true"`, `"false"` | -| `caCert` | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | See example below | -| `clientCert` | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | See example below | -| `clientKey` | Required for using TLS | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | See example below | -| `qos` | N | Indicates the Quality of Service Level (QoS) of the message ([more info](https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels/)). Defaults to `1`. | `0`, `1`, `2` | +| Field | Required | Details | Example | +| -------------- | :--------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | +| `url` | Y | Address of the MQTT broker. Can be `secretKeyRef` to use a secret reference.
Use the **`tcp://`** URI scheme for non-TLS communication.
Use the **`ssl://`** URI scheme for TLS communication. | `"tcp://[username][:password]@host.domain[:port]"` | +| `consumerID` | N | The client ID used to connect to the MQTT broker. Defaults to the Dapr app ID. | `"myMqttClientApp"` | +| `retain` | N | Defines whether the message is saved by the broker as the last known good value for a specified topic. Defaults to `"false"`. | `"true"`, `"false"` | +| `cleanSession` | N | Sets the `clean_session` flag in the connection message to the MQTT broker if `"true"` ([more info](http://www.steves-internet-guide.com/mqtt-clean-sessions-example/)). Defaults to `"false"`. | `"true"`, `"false"` | +| `caCert` | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | See example below | +| `clientCert` | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | See example below | +| `clientKey` | Required for using TLS | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | See example below | +| `qos` | N | Indicates the Quality of Service Level (QoS) of the message ([more info](https://www.hivemq.com/blog/mqtt-essentials-part-6-mqtt-quality-of-service-levels/)). Defaults to `1`. | `0`, `1`, `2` | ### Communication using TLS diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-pulsar.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-pulsar.md index 8c48db9db..340b84670 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-pulsar.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-pulsar.md @@ -68,34 +68,34 @@ The above example uses secrets as plain strings. It is recommended to use a [sec ## Spec metadata fields -| Field | Required | Details | Example | -| ----------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | -| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"` OR `"http://pulsar-pj54qwwdpz4b-pulsar.ap-sg.public.pulsar.com:8080"` | -| enableTLS | N | Enable TLS. Default: `"false"` | `"true"`, `"false"` | -| tenant | N | The topic tenant within the instance. Tenants are essential to multi-tenancy in Pulsar, and spread across clusters. Default: `"public"` | `"public"` | -| consumerID | N | Used to set the subscription name or consumer ID. | `"channel1"` | -| namespace | N | The administrative unit of the topic, which acts as a grouping mechanism for related topics. Default: `"default"` | `"default"` | -| persistent | N | Pulsar supports two kinds of topics: [persistent](https://pulsar.apache.org/docs/en/concepts-architecture-overview#persistent-storage) and [non-persistent](https://pulsar.apache.org/docs/en/concepts-messaging/#non-persistent-topics). With persistent topics, all messages are durably persisted on disks (if the broker is not standalone, messages are durably persisted on multiple disks), whereas data for non-persistent topics is not persisted to storage disks. | | -| disableBatching | N | disable batching.When batching enabled default batch delay is set to 10 ms and default batch size is 1000 messages,Setting `disableBatching: true` will make the producer to send messages individually. Default: `"false"` | `"true"`, `"false"` | -| batchingMaxPublishDelay | N | batchingMaxPublishDelay set the time period within which the messages sent will be batched,if batch messages are enabled. If set to a non zero value, messages will be queued until this time interval or batchingMaxMessages (see below) or batchingMaxSize (see below). There are two valid formats, one is the fraction with a unit suffix format, and the other is the pure digital format that is processed as milliseconds. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Default: `"10ms"` | `"10ms"`, `"10"` | -| batchingMaxMessages | N | batchingMaxMessages set the maximum number of messages permitted in a batch.If set to a value greater than 1, messages will be queued until this threshold is reached or batchingMaxSize (see below) has been reached or the batch interval has elapsed. Default: `"1000"` | `"1000"` | -| batchingMaxSize | N | batchingMaxSize sets the maximum number of bytes permitted in a batch. If set to a value greater than 1, messages will be queued until this threshold is reached or batchingMaxMessages (see above) has been reached or the batch interval has elapsed. Default: `"128KB"` | `"131072"` | -| .jsonschema | N | Enforces JSON schema validation for the configured topic. | | -| .avroschema | N | Enforces Avro schema validation for the configured topic. | | -| publicKey | N | A public key to be used for publisher and consumer encryption. Value can be one of two options: file path for a local PEM cert, or the cert data string value | | -| privateKey | N | A private key to be used for consumer encryption. Value can be one of two options: file path for a local PEM cert, or the cert data string value | | -| keys | N | A comma delimited string containing names of [Pulsar session keys](https://pulsar.apache.org/docs/3.0.x/security-encryption/#how-it-works-in-pulsar). Used in conjunction with `publicKey` for publisher encryption | | -| processMode | N | Enable processing multiple messages at once. Default: `"async"` | `"async"`, `"sync"` | -| subscribeType | N | Pulsar supports four kinds of [subscription types](https://pulsar.apache.org/docs/3.0.x/concepts-messaging/#subscription-types). Default: `"shared"` | `"shared"`, `"exclusive"`, `"failover"`, `"key_shared"` | -| partitionKey | N | Sets the key of the message for routing policy. Default: `""` | | -| `maxConcurrentHandlers` | N | Defines the maximum number of concurrent message handlers. Default: `100` | `10` | +| Field | Required | Details | Example | +| --------------------------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"` OR `"http://pulsar-pj54qwwdpz4b-pulsar.ap-sg.public.pulsar.com:8080"` | +| enableTLS | N | Enable TLS. Default: `"false"` | `"true"`, `"false"` | +| tenant | N | The topic tenant within the instance. Tenants are essential to multi-tenancy in Pulsar, and spread across clusters. Default: `"public"` | `"public"` | +| consumerID | N | Used to set the subscription name or consumer ID. | `"channel1"` | +| namespace | N | The administrative unit of the topic, which acts as a grouping mechanism for related topics. Default: `"default"` | `"default"` | +| persistent | N | Pulsar supports two kinds of topics: [persistent](https://pulsar.apache.org/docs/en/concepts-architecture-overview#persistent-storage) and [non-persistent](https://pulsar.apache.org/docs/en/concepts-messaging/#non-persistent-topics). With persistent topics, all messages are durably persisted on disks (if the broker is not standalone, messages are durably persisted on multiple disks), whereas data for non-persistent topics is not persisted to storage disks. | | +| disableBatching | N | disable batching.When batching enabled default batch delay is set to 10 ms and default batch size is 1000 messages,Setting `disableBatching: true` will make the producer to send messages individually. Default: `"false"` | `"true"`, `"false"` | +| batchingMaxPublishDelay | N | batchingMaxPublishDelay set the time period within which the messages sent will be batched,if batch messages are enabled. If set to a non zero value, messages will be queued until this time interval or batchingMaxMessages (see below) or batchingMaxSize (see below). There are two valid formats, one is the fraction with a unit suffix format, and the other is the pure digital format that is processed as milliseconds. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". Default: `"10ms"` | `"10ms"`, `"10"` | +| batchingMaxMessages | N | batchingMaxMessages set the maximum number of messages permitted in a batch.If set to a value greater than 1, messages will be queued until this threshold is reached or batchingMaxSize (see below) has been reached or the batch interval has elapsed. Default: `"1000"` | `"1000"` | +| batchingMaxSize | N | batchingMaxSize sets the maximum number of bytes permitted in a batch. If set to a value greater than 1, messages will be queued until this threshold is reached or batchingMaxMessages (see above) has been reached or the batch interval has elapsed. Default: `"128KB"` | `"131072"` | +| .jsonschema | N | Enforces JSON schema validation for the configured topic. | | +| .avroschema | N | Enforces Avro schema validation for the configured topic. | | +| publicKey | N | A public key to be used for publisher and consumer encryption. Value can be one of two options: file path for a local PEM cert, or the cert data string value | | +| privateKey | N | A private key to be used for consumer encryption. Value can be one of two options: file path for a local PEM cert, or the cert data string value | | +| keys | N | A comma delimited string containing names of [Pulsar session keys](https://pulsar.apache.org/docs/3.0.x/security-encryption/#how-it-works-in-pulsar). Used in conjunction with `publicKey` for publisher encryption | | +| processMode | N | Enable processing multiple messages at once. Default: `"async"` | `"async"`, `"sync"` | +| subscribeType | N | Pulsar supports four kinds of [subscription types](https://pulsar.apache.org/docs/3.0.x/concepts-messaging/#subscription-types). Default: `"shared"` | `"shared"`, `"exclusive"`, `"failover"`, `"key_shared"` | +| partitionKey | N | Sets the key of the message for routing policy. Default: `""` | | +| `maxConcurrentHandlers` | N | Defines the maximum number of concurrent message handlers. Default: `100` | `10` | ### Authenticate using Token To authenticate to pulsar using a static [JWT token](https://pulsar.apache.org/docs/en/security-jwt), you can use the following metadata field: -| Field | Required | Details | Example | -| ----- | :------: | ------------------------------ | --------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| ----- | :------: | ---------------------------------------------- | --------------------------------------------------------------------------------------------- | | token | N | Token used for authentication. | [How to create Pulsar token](https://pulsar.apache.org/docs/en/security-jwt/#generate-tokens) | ```yaml @@ -124,14 +124,14 @@ It is recommended that you use a secret reference for the client secret. The pulsar OAuth2 authenticator is not specifically complaint with OIDC so it is your responsibility to ensure fields are compliant. For example, the issuer URL must use the `https` protocol, the requested scopes include `openid`, etc. If the `oauth2TokenCAPEM` field is omitted then the system's certificate pool is used for connecting to the OAuth2 issuer if using `https`. -| Field | Required | Details | Example | -| ------------------ | :------: | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| oauth2TokenURL | N | URL to request the OIDC client_credentials token from. Must not be empty. | "https\://oauth.example.com/o/oauth2/token"\` | -| oauth2TokenCAPEM | N | CA PEM certificate bundle to connect to the OAuth2 issuer. If not defined, the system's certificate pool will be used. | `"---BEGIN CERTIFICATE---\n...\n---END CERTIFICATE---"` | -| oauth2ClientID | N | OIDC client ID. Must not be empty. | `"my-client-id"` | -| oauth2ClientSecret | N | OIDC client secret. Must not be empty. | `"my-client-secret"` | -| oauth2Audiences | N | Comma separated list of audiences to request for. Must not be empty. | `"my-audience-1,my-audience-2"` | -| oauth2Scopes | N | Comma separated list of scopes to request. Must not be empty. | `"openid,profile,email"` | +| Field | Required | Details | Example | +| ------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | +| oauth2TokenURL | N | URL to request the OIDC client_credentials token from. Must not be empty. | "https://oauth.example.com/o/oauth2/token"\` | +| oauth2TokenCAPEM | N | CA PEM certificate bundle to connect to the OAuth2 issuer. If not defined, the system's certificate pool will be used. | `"---BEGIN CERTIFICATE---\n...\n---END CERTIFICATE---"` | +| oauth2ClientID | N | OIDC client ID. Must not be empty. | `"my-client-id"` | +| oauth2ClientSecret | N | OIDC client secret. Must not be empty. | `"my-client-secret"` | +| oauth2Audiences | N | Comma separated list of audiences to request for. Must not be empty. | `"my-audience-1,my-audience-2"` | +| oauth2Scopes | N | Comma separated list of scopes to request. Must not be empty. | `"openid,profile,email"` | ```yaml apiVersion: dapr.io/v1alpha1 diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rabbitmq.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rabbitmq.md index e3313f083..590cd3dd7 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rabbitmq.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rabbitmq.md @@ -74,34 +74,34 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ----------------- | :--------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| connectionString | Y\* | The RabbitMQ connection string. \*Mutally exclusive with protocol, hostname, username, password field | `amqp://user:pass@localhost:5672` | -| protocol | N\* | The RabbitMQ protocol. \*Mutally exclusive with connectionString field | `amqp` | -| hostname | N\* | The RabbitMQ hostname. \*Mutally exclusive with connectionString field | `localhost` | -| username | N\* | The RabbitMQ username. \*Mutally exclusive with connectionString field | `username` | -| password | N\* | The RabbitMQ password. \*Mutally exclusive with connectionString field | `password` | -| consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | | -| durable | N | Whether or not to use [durable](https://www.rabbitmq.com/queues.html#durability) queues. Defaults to `"false"` | `"true"`, `"false"` | -| deletedWhenUnused | N | Whether or not the queue should be configured to [auto-delete](https://www.rabbitmq.com/queues.html) Defaults to `"true"` | `"true"`, `"false"` | -| autoAck | N | Whether or not the queue consumer should [auto-ack](https://www.rabbitmq.com/confirms.html) messages. Defaults to `"false"` | `"true"`, `"false"` | -| deliveryMode | N | Persistence mode when publishing messages. Defaults to `"0"`. RabbitMQ treats `"2"` as persistent, all other numbers as non-persistent | `"0"`, `"2"` | -| requeueInFailure | N | Whether or not to requeue when sending a [negative acknowledgement](https://www.rabbitmq.com/nack.html) in case of a failure. Defaults to `"false"` | `"true"`, `"false"` | -| prefetchCount | N | Number of messages to [prefetch](https://www.rabbitmq.com/consumer-prefetch.html). Consider changing this to a non-zero value for production environments. Defaults to `"0"`, which means that all available messages will be pre-fetched. | `"2"` | -| publisherConfirm | N | If enabled, client waits for [publisher confirms](https://www.rabbitmq.com/confirms.html#publisher-confirms) after publishing a message. Defaults to `"false"` | `"true"`, `"false"` | -| reconnectWait | N | How long to wait (in seconds) before reconnecting if a connection failure occurs | `"0"` | -| concurrencyMode | N | `parallel` is the default, and allows processing multiple messages in parallel (limited by the `app-max-concurrency` annotation, if configured). Set to `single` to disable parallel processing. In most situations there's no reason to change this. | `parallel`, `single` | -| enableDeadLetter | N | Enable forwarding Messages that cannot be handled to a dead-letter topic. Defaults to `"false"` | `"true"`, `"false"` | -| maxLen | N | The maximum number of messages of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit. | `"1000"` | -| maxLenBytes | N | Maximum length in bytes of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit. | `"1048576"` | -| exchangeKind | N | Exchange kind of the rabbitmq exchange. Defaults to `"fanout"`. | `"fanout"`,`"topic"` | -| saslExternal | N | With TLS, should the username be taken from an additional field (for example, CN). See [RabbitMQ Authentication Mechanisms](https://www.rabbitmq.com/access-control.html#mechanisms). Defaults to `"false"`. | `"true"`, `"false"` | -| ttlInSeconds | N | Set message TTL at the component level, which can be overwritten by message level TTL per request. | `"60"` | -| caCert | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | -| clientCert | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | +| Field | Required | Details | Example | +| ----------------- | :--------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| connectionString | Y\* | The RabbitMQ connection string. \*Mutally exclusive with protocol, hostname, username, password field | `amqp://user:pass@localhost:5672` | +| protocol | N\* | The RabbitMQ protocol. \*Mutally exclusive with connectionString field | `amqp` | +| hostname | N\* | The RabbitMQ hostname. \*Mutally exclusive with connectionString field | `localhost` | +| username | N\* | The RabbitMQ username. \*Mutally exclusive with connectionString field | `username` | +| password | N\* | The RabbitMQ password. \*Mutally exclusive with connectionString field | `password` | +| consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | | +| durable | N | Whether or not to use [durable](https://www.rabbitmq.com/queues.html#durability) queues. Defaults to `"false"` | `"true"`, `"false"` | +| deletedWhenUnused | N | Whether or not the queue should be configured to [auto-delete](https://www.rabbitmq.com/queues.html) Defaults to `"true"` | `"true"`, `"false"` | +| autoAck | N | Whether or not the queue consumer should [auto-ack](https://www.rabbitmq.com/confirms.html) messages. Defaults to `"false"` | `"true"`, `"false"` | +| deliveryMode | N | Persistence mode when publishing messages. Defaults to `"0"`. RabbitMQ treats `"2"` as persistent, all other numbers as non-persistent | `"0"`, `"2"` | +| requeueInFailure | N | Whether or not to requeue when sending a [negative acknowledgement](https://www.rabbitmq.com/nack.html) in case of a failure. Defaults to `"false"` | `"true"`, `"false"` | +| prefetchCount | N | Number of messages to [prefetch](https://www.rabbitmq.com/consumer-prefetch.html). Consider changing this to a non-zero value for production environments. Defaults to `"0"`, which means that all available messages will be pre-fetched. | `"2"` | +| publisherConfirm | N | If enabled, client waits for [publisher confirms](https://www.rabbitmq.com/confirms.html#publisher-confirms) after publishing a message. Defaults to `"false"` | `"true"`, `"false"` | +| reconnectWait | N | How long to wait (in seconds) before reconnecting if a connection failure occurs | `"0"` | +| concurrencyMode | N | `parallel` is the default, and allows processing multiple messages in parallel (limited by the `app-max-concurrency` annotation, if configured). Set to `single` to disable parallel processing. In most situations there's no reason to change this. | `parallel`, `single` | +| enableDeadLetter | N | Enable forwarding Messages that cannot be handled to a dead-letter topic. Defaults to `"false"` | `"true"`, `"false"` | +| maxLen | N | The maximum number of messages of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit. | `"1000"` | +| maxLenBytes | N | Maximum length in bytes of a queue and its dead letter queue (if dead letter enabled). If both `maxLen` and `maxLenBytes` are set then both will apply; whichever limit is hit first will be enforced. Defaults to no limit. | `"1048576"` | +| exchangeKind | N | Exchange kind of the rabbitmq exchange. Defaults to `"fanout"`. | `"fanout"`,`"topic"` | +| saslExternal | N | With TLS, should the username be taken from an additional field (for example, CN). See [RabbitMQ Authentication Mechanisms](https://www.rabbitmq.com/access-control.html#mechanisms). Defaults to `"false"`. | `"true"`, `"false"` | +| ttlInSeconds | N | Set message TTL at the component level, which can be overwritten by message level TTL per request. | `"60"` | +| caCert | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | +| clientCert | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | | clientKey | Required for using TLS | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | `"-----BEGIN RSA PRIVATE KEY-----\n\n-----END RSA PRIVATE KEY-----"` | -| clientName | N | This RabbitMQ [client-provided connection name](https://www.rabbitmq.com/connections.html#client-provided-names) is a custom identifier. If set, the identifier is mentioned in RabbitMQ server log entries and management UI. Can be set to {uuid}, {podName}, or {appID}, which is replaced by Dapr runtime to the real value. | `"app1"`, `{uuid}`, `{podName}`, `{appID}` | -| heartBeat | N | Defines the heartbeat interval with the server, detecting the aliveness of the peer TCP connection with the RabbitMQ server. Defaults to `10s` . | `"10s"` | +| clientName | N | This RabbitMQ [client-provided connection name](https://www.rabbitmq.com/connections.html#client-provided-names) is a custom identifier. If set, the identifier is mentioned in RabbitMQ server log entries and management UI. Can be set to {uuid}, {podName}, or {appID}, which is replaced by Dapr runtime to the real value. | `"app1"`, `{uuid}`, `{podName}`, `{appID}` | +| heartBeat | N | Defines the heartbeat interval with the server, detecting the aliveness of the peer TCP connection with the RabbitMQ server. Defaults to `10s` . | `"10s"` | ## Communication using TLS diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-redis-pubsub.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-redis-pubsub.md index 5f884d6b9..8ac604f49 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-redis-pubsub.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-redis-pubsub.md @@ -36,34 +36,34 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| redisHost | Y | Connection-string for the redis host. If `"redisType"` is `"cluster"` it can be multiple hosts separated by commas or just a single host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | -| redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` | -| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | -| consumerID | N | The consumer group ID | `"myGroup"` | -| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | +| Field | Required | Details | Example | +| --------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| redisHost | Y | Connection-string for the redis host. If `"redisType"` is `"cluster"` it can be multiple hosts separated by commas or just a single host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | +| redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` | +| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | +| consumerID | N | The consumer group ID | `"myGroup"` | +| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | | redeliverInterval | N | The interval between checking for pending messages to redeliver. Can use either be Go duration string (for example "ms", "s", "m") or milliseconds number. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"`, `"5000"` | | processingTimeout | N | The amount time that a message must be pending before attempting to redeliver it. Can use either be Go duration string ( for example "ms", "s", "m") or milliseconds number. Defaults to `"15s"`. `"0"` disables redelivery. | `"60s"`, `"600000"` | -| queueDepth | N | The size of the message queue for processing. Defaults to `"100"`. | `"1000"` | -| concurrency | N | The number of concurrent workers that are processing messages. Defaults to `"10"`. | `"15"` | -| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | -| redisDB | N | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | -| redisMaxRetries | N | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` | -| redisMinRetryInterval | N | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | -| redisMaxRetryInterval | N | Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` | -| dialTimeout | N | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | -| readTimeout | N | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | -| writeTimeout | N | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | -| poolSize | N | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | -| poolTimeout | N | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | -| maxConnAge | N | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | -| minIdleConns | N | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | -| idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | +| queueDepth | N | The size of the message queue for processing. Defaults to `"100"`. | `"1000"` | +| concurrency | N | The number of concurrent workers that are processing messages. Defaults to `"10"`. | `"15"` | +| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | +| redisDB | N | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | +| redisMaxRetries | N | Maximum number of times to retry commands before giving up. Default is to not retry failed commands. | `"5"` | +| redisMinRetryInterval | N | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | +| redisMaxRetryInterval | N | Maximum backoff for redis commands between each retry. Default is `"512ms"`;`"-1"` disables backoff. | `"5s"` | +| dialTimeout | N | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | +| readTimeout | N | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | +| writeTimeout | N | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | +| poolSize | N | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | +| poolTimeout | N | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | +| maxConnAge | N | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | +| minIdleConns | N | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | +| idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | | idleTimeout | N | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` | -| failover | N | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` | -| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `""`, `"127.0.0.1:6379"` | -| maxLenApprox | N | Maximum number of items inside a stream.The old entries are automatically evicted when the specified length is reached, so that the stream is left at a constant size. Defaults to unlimited. | `"10000"` | +| failover | N | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"` | +| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `""`, `"127.0.0.1:6379"` | +| maxLenApprox | N | Maximum number of items inside a stream.The old entries are automatically evicted when the specified length is reached, so that the stream is left at a constant size. Defaults to unlimited. | `"10000"` | ## Create a Redis instance diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rocketmq.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rocketmq.md index 888aa1a50..7ff311d87 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rocketmq.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-rocketmq.md @@ -46,42 +46,42 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | default | Example | -| -------------------------------------------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| instanceName | N | Instance name | `time.Now().String()` | `dapr-rocketmq-test` | -| consumerGroup | N | Consumer group name. Recommend. If `producerGroup` is `null`，`groupName` is used. | | `dapr-rocketmq-test-g-c ` | +| Field | Required | Details | default | Example | +| -------------------------------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| instanceName | N | Instance name | `time.Now().String()` | `dapr-rocketmq-test` | +| consumerGroup | N | Consumer group name. Recommend. If `producerGroup` is `null`，`groupName` is used. | | `dapr-rocketmq-test-g-c ` | | producerGroup (consumerID) | N | Producer group name. Recommended. If `producerGroup` is `null`，`consumerID` is used. If `consumerID` also is null, `groupName` is used. | | `dapr-rocketmq-test-g-p` | -| consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | `"channel1"` | | -| groupName | N | Consumer/Producer group name. **Depreciated**. | | `dapr-rocketmq-test-g` | -| nameSpace | N | RocketMQ namespace | | `dapr-rocketmq` | -| nameServerDomain | N | RocketMQ name server domain | | `https://my-app.net:8080/nsaddr` | -| nameServer | N | RocketMQ name server, separated by "," or ";" | | `127.0.0.1:9876;127.0.0.2:9877,127.0.0.3:9877` | -| accessKey | N | Access Key (Username) | | `"admin"` | -| secretKey | N | Secret Key (Password) | | `"password"` | -| securityToken | N | Security Token | | | -| retries | N | Number of retries to send a message to broker | `3` | `3` | -| producerQueueSelector (queueSelector) | N | Producer Queue selector. There are five implementations of queue selector: `hash`, `random`, `manual`, `roundRobin`, `dapr`. | `dapr` | `hash` | -| consumerModel | N | Message model that defines how messages are delivered to each consumer client. RocketMQ supports two message models: `clustering` and `broadcasting`. | `clustering` | `broadcasting` , `clustering` | -| fromWhere (consumeFromWhere) | N | Consuming point on consumer booting. There are three consuming points: `CONSUME_FROM_LAST_OFFSET`, `CONSUME_FROM_FIRST_OFFSET`, `CONSUME_FROM_TIMESTAMP` | `CONSUME_FROM_LAST_OFFSET` | `CONSUME_FROM_LAST_OFFSET` | +| consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | `"channel1"` | | +| groupName | N | Consumer/Producer group name. **Depreciated**. | | `dapr-rocketmq-test-g` | +| nameSpace | N | RocketMQ namespace | | `dapr-rocketmq` | +| nameServerDomain | N | RocketMQ name server domain | | `https://my-app.net:8080/nsaddr` | +| nameServer | N | RocketMQ name server, separated by "," or ";" | | `127.0.0.1:9876;127.0.0.2:9877,127.0.0.3:9877` | +| accessKey | N | Access Key (Username) | | `"admin"` | +| secretKey | N | Secret Key (Password) | | `"password"` | +| securityToken | N | Security Token | | | +| retries | N | Number of retries to send a message to broker | `3` | `3` | +| producerQueueSelector (queueSelector) | N | Producer Queue selector. There are five implementations of queue selector: `hash`, `random`, `manual`, `roundRobin`, `dapr`. | `dapr` | `hash` | +| consumerModel | N | Message model that defines how messages are delivered to each consumer client. RocketMQ supports two message models: `clustering` and `broadcasting`. | `clustering` | `broadcasting` , `clustering` | +| fromWhere (consumeFromWhere) | N | Consuming point on consumer booting. There are three consuming points: `CONSUME_FROM_LAST_OFFSET`, `CONSUME_FROM_FIRST_OFFSET`, `CONSUME_FROM_TIMESTAMP` | `CONSUME_FROM_LAST_OFFSET` | `CONSUME_FROM_LAST_OFFSET` | | consumeTimestamp | N | Backtracks consumption time with second precision. Time format is `yyyymmddhhmmss`. For example, `20131223171201` implies the time of 17:12:01 and date of December 23, 2013 | ` time.Now().Add(time.Minute * (-30)).Format("20060102150405")` | `20131223171201` | -| consumeOrderly | N | Determines if it's an ordered message using FIFO order. | `false` | `false` | -| consumeMessageBatchMaxSize | N | Batch consumption size out of range `[1, 1024]` | `512` | `10` | -| consumeConcurrentlyMaxSpan | N | Concurrently max span offset. This has no effect on sequential consumption. Range: `[1, 65535]` | `1000` | `1000` | -| maxReconsumeTimes | N | Max re-consume times. `-1` means 16 times. If messages are re-consumed more than {@link maxReconsumeTimes} before success, they'll be directed to a deletion queue. | Orderly message is `MaxInt32`; Concurrently message is `16` | `16` | -| autoCommit | N | Enable auto commit | `true` | `false` | -| consumeTimeout | N | Maximum amount of time a message may block the consuming thread. Time unit: Minute | `15` | `15` | -| consumerPullTimeout | N | The socket timeout in milliseconds | | | -| pullInterval | N | Message pull interval | `100` | `100` | -| pullBatchSize | N | The number of messages pulled from the broker at a time. If `pullBatchSize` is `null`, use `ConsumerBatchSize`. `pullBatchSize` out of range `[1, 1024]` | `32` | `10` | +| consumeOrderly | N | Determines if it's an ordered message using FIFO order. | `false` | `false` | +| consumeMessageBatchMaxSize | N | Batch consumption size out of range `[1, 1024]` | `512` | `10` | +| consumeConcurrentlyMaxSpan | N | Concurrently max span offset. This has no effect on sequential consumption. Range: `[1, 65535]` | `1000` | `1000` | +| maxReconsumeTimes | N | Max re-consume times. `-1` means 16 times. If messages are re-consumed more than {@link maxReconsumeTimes} before success, they'll be directed to a deletion queue. | Orderly message is `MaxInt32`; Concurrently message is `16` | `16` | +| autoCommit | N | Enable auto commit | `true` | `false` | +| consumeTimeout | N | Maximum amount of time a message may block the consuming thread. Time unit: Minute | `15` | `15` | +| consumerPullTimeout | N | The socket timeout in milliseconds | | | +| pullInterval | N | Message pull interval | `100` | `100` | +| pullBatchSize | N | The number of messages pulled from the broker at a time. If `pullBatchSize` is `null`, use `ConsumerBatchSize`. `pullBatchSize` out of range `[1, 1024]` | `32` | `10` | | pullThresholdForQueue | N | Flow control threshold on queue level. Each message queue will cache a maximum of 1000 messages by default. Consider the `PullBatchSize` - the instantaneous value may exceed the limit. Range: `[1, 65535]` | `1024` | `1000` | | pullThresholdForTopic | N | Flow control threshold on topic level. The value of `pullThresholdForQueue` will be overwritten and calculated based on `pullThresholdForTopic` if it isn't unlimited. For example, if the value of `pullThresholdForTopic` is 1000 and 10 message queues are assigned to this consumer, then `pullThresholdForQueue` will be set to 100. Range: `[1, 6553500]` | `-1(Unlimited)` | `10` | | pullThresholdSizeForQueue | N | Limit the cached message size on queue level. Consider the `pullBatchSize` - the instantaneous value may exceed the limit. The size of a message is only measured by message body, so it's not accurate. Range: `[1, 1024]` | `100` | `100` | | pullThresholdSizeForTopic | N | Limit the cached message size on topic level. The value of `pullThresholdSizeForQueue` will be overwritten and calculated based on `pullThresholdSizeForTopic` if it isn't unlimited. For example, if the value of `pullThresholdSizeForTopic` is 1000 MiB and 10 message queues are assigned to this consumer, then `pullThresholdSizeForQueue` will be set to 100 MiB. Range: `[1, 102400]` | `-1` | `100` | -| content-type | N | Message content type. | `"text/plain"` | `"application/cloudevents+json; charset=utf-8"`, `"application/octet-stream"` | -| logLevel | N | Log level | `warn` | `info` | -| sendTimeOut | N | Send message timeout to connect RocketMQ's broker, measured in nanoseconds. **Deprecated**. | 3 seconds | `10000000000` | -| sendTimeOutSec | N | Timeout duration for publishing a message in seconds. If `sendTimeOutSec` is `null`, `sendTimeOut` is used. | 3 seconds | `3` | -| mspProperties | N | The RocketMQ message properties in this collection are passed to the APP in Data Separate multiple properties with "," | | `key,mkey` | +| content-type | N | Message content type. | `"text/plain"` | `"application/cloudevents+json; charset=utf-8"`, `"application/octet-stream"` | +| logLevel | N | Log level | `warn` | `info` | +| sendTimeOut | N | Send message timeout to connect RocketMQ's broker, measured in nanoseconds. **Deprecated**. | 3 seconds | `10000000000` | +| sendTimeOutSec | N | Timeout duration for publishing a message in seconds. If `sendTimeOutSec` is `null`, `sendTimeOut` is used. | 3 seconds | `3` | +| mspProperties | N | The RocketMQ message properties in this collection are passed to the APP in Data Separate multiple properties with "," | | `key,mkey` | For backwards-compatibility reasons, the following values in the metadata are supported, although their use is discouraged. @@ -93,7 +93,7 @@ For backwards-compatibility reasons, the following values in the metadata are su ## Setup RocketMQ -See https\://rocketmq.apache.org/docs/quick-start/ to setup a local RocketMQ instance. +See https://rocketmq.apache.org/docs/quick-start/ to setup a local RocketMQ instance. ## Per-call metadata fields diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-solace-amqp.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-solace-amqp.md index c2a6d7714..b88fa47c9 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-solace-amqp.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-pubsub/setup-solace-amqp.md @@ -36,15 +36,15 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ---------- | :--------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| url | Y | Address of the AMQP broker. Can be `secretKeyRef` to use a secret reference.
Use the **`amqp://`** URI scheme for non-TLS communication.
Use the **`amqps://`** URI scheme for TLS communication. | `"amqp://host.domain[:port]"` | -| username | Y | The username to connect to the broker. Only required if anonymous is not specified or set to `false` . | `default` | -| password | Y | The password to connect to the broker. Only required if anonymous is not specified or set to `false`. | `default` | -| consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | `"channel1"` | -| anonymous | N | To connect to the broker without credential validation. Only works if enabled on the broker. A username and password would not be required if this is set to `true`. | `true` | -| caCert | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | -| clientCert | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | +| Field | Required | Details | Example | +| ---------- | :--------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| url | Y | Address of the AMQP broker. Can be `secretKeyRef` to use a secret reference.
Use the **`amqp://`** URI scheme for non-TLS communication.
Use the **`amqps://`** URI scheme for TLS communication. | `"amqp://host.domain[:port]"` | +| username | Y | The username to connect to the broker. Only required if anonymous is not specified or set to `false` . | `default` | +| password | Y | The password to connect to the broker. Only required if anonymous is not specified or set to `false`. | `default` | +| consumerID | N | Consumer ID (consumer tag) organizes one or more consumers into a group. Consumers with the same consumer ID work as one virtual consumer; for example, a message is processed only once by one of the consumers in the group. If the `consumerID` is not provided, the Dapr runtime set it to the Dapr application ID (`appID`) value. | `"channel1"` | +| anonymous | N | To connect to the broker without credential validation. Only works if enabled on the broker. A username and password would not be required if this is set to `true`. | `true` | +| caCert | Required for using TLS | Certificate Authority (CA) certificate in PEM format for verifying server TLS certificates. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | +| clientCert | Required for using TLS | TLS client certificate in PEM format. Must be used with `clientKey`. | `"-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----"` | | clientKey | Required for using TLS | TLS client key in PEM format. Must be used with `clientCert`. Can be `secretKeyRef` to use a secret reference. | `"-----BEGIN RSA PRIVATE KEY-----\n\n-----END RSA PRIVATE KEY-----"` | ### Communication using TLS diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md index 50f81fb67..d76e35bea 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md @@ -47,14 +47,14 @@ The above example uses secrets as plain strings. It is recommended to use a loca The following [optional query parameters]({{< ref "secrets_api.md#query-parameters" >}}) can be provided when retrieving secrets from this secret store: -| Query Parameter | Description | -| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `metadata.version_id` | Version for the given secret key | +| Query Parameter | Description | +| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `metadata.version_id` | Version for the given secret key | | `metadata.path` | (For bulk requests only) The path from the metadata. If not set, defaults to root path (all secrets). | ## Create an AlibabaCloud OOS Parameter Store instance -Setup AlibabaCloud OOS Parameter Store using the AlibabaCloud documentation: https\://www\.alibabacloud.com/help/en/doc-detail/186828.html. +Setup AlibabaCloud OOS Parameter Store using the AlibabaCloud documentation: https://www.alibabacloud.com/help/en/doc-detail/186828.html. ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-parameter-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-parameter-store.md index 92adb6ca4..3aea2023c 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-parameter-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-parameter-store.md @@ -40,12 +40,12 @@ The above example uses secrets as plain strings. It is recommended to use a loca ## Spec metadata fields -| Field | Required | Details | Example | -| ------------ | :------: | ------------------------------------------------------------------------------- | ------------------- | -| region | Y | The specific AWS region the AWS SSM Parameter Store instance is deployed in | `"us-east-1"` | -| accessKey | Y | The AWS Access Key to access this resource | `"key"` | -| secretKey | Y | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | -| sessionToken | N | The AWS session token to use | `"sessionToken"` | +| Field | Required | Details | Example | +| ------------ | :------: | ----------------------------------------------------------------------------------------------- | ------------------- | +| region | Y | The specific AWS region the AWS SSM Parameter Store instance is deployed in | `"us-east-1"` | +| accessKey | Y | The AWS Access Key to access this resource | `"key"` | +| secretKey | Y | The AWS Secret Access Key to access this resource | `"secretAccessKey"` | +| sessionToken | N | The AWS session token to use | `"sessionToken"` | | prefix | N | Allows you to specify more than one SSM parameter store secret store component. | `"prefix"` | {{% alert title="Important" color="warning" %}} @@ -54,7 +54,7 @@ When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernet ## Create an AWS SSM Parameter Store instance -Setup AWS SSM Parameter Store using the AWS documentation: https\://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html. +Setup AWS SSM Parameter Store using the AWS documentation: https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html. ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-secret-manager.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-secret-manager.md index 7fead956b..63e452686 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-secret-manager.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/aws-secret-manager.md @@ -53,14 +53,14 @@ When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernet The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store: -| Query Parameter | Description | -| ------------------------ | --------------------------------------- | +| Query Parameter | Description | +| ------------------------ | ------------------------------------------------------- | | `metadata.version_id` | Version for the given secret key. | | `metadata.version_stage` | Version stage for the given secret key. | ## Create an AWS Secrets Manager instance -Setup AWS Secrets Manager using the AWS documentation: https\://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html. +Setup AWS Secrets Manager using the AWS documentation: https://docs.aws.amazon.com/secretsmanager/latest/userguide/tutorials_basic.html. ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/azure-keyvault.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/azure-keyvault.md index 6eee68bc8..082e9059a 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/azure-keyvault.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/azure-keyvault.md @@ -47,10 +47,10 @@ The Azure Key Vault secret store component supports authentication with Microsof ## Spec metadata fields -| Field | Required | Details | Example | -| ------------------ | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `vaultName` | Y | The name of the Azure Key Vault | `"mykeyvault"` | -| `azureEnvironment` | N | Optional name for the Azure environment if using a different Azure cloud | `"AZUREPUBLICCLOUD"` (default value), `"AZURECHINACLOUD"`, `"AZUREUSGOVERNMENTCLOUD"`, `"AZUREGERMANCLOUD"` | +| Field | Required | Details | Example | +| ------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | +| `vaultName` | Y | The name of the Azure Key Vault | `"mykeyvault"` | +| `azureEnvironment` | N | Optional name for the Azure environment if using a different Azure cloud | `"AZUREPUBLICCLOUD"` (default value), `"AZURECHINACLOUD"`, `"AZUREUSGOVERNMENTCLOUD"`, `"AZUREGERMANCLOUD"` | | Auth metadata | | See [Authenticating to Azure]({{< ref authenticating-azure.md >}}) for more information | | Additionally, you must provide the authentication fields as explained in the [Authenticating to Azure]({{< ref authenticating-azure.md >}}) document. @@ -59,8 +59,8 @@ Additionally, you must provide the authentication fields as explained in the [Au The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store: -| Query Parameter | Description | -| --------------------- | ------------------------------------------------------------------------------------------------------------------- | +| Query Parameter | Description | +| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | `metadata.version_id` | Version for the given secret key. | | `metadata.maxresults` | (For bulk requests only) Number of secrets to return, after which the request will be truncated. | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/envvar-secret-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/envvar-secret-store.md index c7384b90e..99ebfa3dd 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/envvar-secret-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/envvar-secret-store.md @@ -32,8 +32,8 @@ spec: ## Spec metadata fields -| Field | Required | Details | Example | -| -------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| Field | Required | Details | Example | +| -------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | `prefix` | N | If set, limits operations to environment variables with the given prefix. The prefix is removed from the returned secrets' names.
The matching is case-insensitive on Windows and case-sensitive on all other operating systems. | `"MYAPP_"` | ## Notes diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/file-secret-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/file-secret-store.md index 70e115607..14124bba0 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/file-secret-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/file-secret-store.md @@ -36,10 +36,10 @@ spec: ## Spec metadata fields -| Field | Required | Details | Example | -| --------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | -| secretsFile | Y | The path to the file where secrets are stored | `"path/to/file.json"` | -| nestedSeparator | N | Used by the store when flattening the JSON hierarchy to a map. Defaults to `":"` | `":"` | +| Field | Required | Details | Example | +| --------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | +| secretsFile | Y | The path to the file where secrets are stored | `"path/to/file.json"` | +| nestedSeparator | N | Used by the store when flattening the JSON hierarchy to a map. Defaults to `":"` | `":"` | | multiValued | N | `"true"` sets the `multipleKeyValuesPerSecret` behavior. Allows one level of multi-valued key/value pairs before flattening JSON hierarchy. Defaults to `"false"` | `"true"` | ## Setup JSON file to hold the secrets @@ -62,9 +62,9 @@ The flag `multiValued` determines whether the secret store presents a [name/valu If `multiValued` is `false`, the store loads [the JSON file]({{< ref "#setup-json-file-to-hold-the-secrets" >}}) and create a map with the following key-value pairs: -| flattened key | value | -| ------------------------- | -------------------------------- | -| "redisPassword" | `"your redis password"` | +| flattened key | value | +| ----------------------------------------- | -------------------------------- | +| "redisPassword" | `"your redis password"` | | "connectionStrings:sql" | `"your sql connection string"` | | "connectionStrings:mysql" | `"your mysql connection string"` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/gcp-secret-manager.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/gcp-secret-manager.md index 1f749f03e..335fb040a 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/gcp-secret-manager.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/gcp-secret-manager.md @@ -48,30 +48,30 @@ The above example uses secrets as plain strings. It is recommended to use a loca ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------------------------------------------------------------------------------------------------- | :------: | ---------------------------------------------- | -------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| --------------------------------------------------------------------------------------------------------------- | :------: | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | type | Y | The type of the account. | `"service_account"` | | project_id | Y | The project ID associated with this component. | `"project_id"` | -| private_key_id | N | The private key ID | `"privatekey"` | -| client_email | Y | The client email address | `"client@example.com"` | -| client_id | N | The ID of the client | `"11111111"` | -| auth_uri | N | The authentication URI | `"https://accounts.google.com/o/oauth2/auth"` | -| token_uri | N | The authentication token URI | `"https://oauth2.googleapis.com/token"` | -| auth_provider_x509_cert_url | N | The certificate URL for the auth provider | `"https://www.googleapis.com/oauth2/v1/certs"` | -| client_x509_cert_url | N | The certificate URL for the client | `"https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com"` | -| private_key | Y | The private key for authentication | `"privateKey"` | +| private_key_id | N | The private key ID | `"privatekey"` | +| client_email | Y | The client email address | `"client@example.com"` | +| client_id | N | The ID of the client | `"11111111"` | +| auth_uri | N | The authentication URI | `"https://accounts.google.com/o/oauth2/auth"` | +| token_uri | N | The authentication token URI | `"https://oauth2.googleapis.com/token"` | +| auth_provider_x509_cert_url | N | The certificate URL for the auth provider | `"https://www.googleapis.com/oauth2/v1/certs"` | +| client_x509_cert_url | N | The certificate URL for the client | `"https://www.googleapis.com/robot/v1/metadata/x509/.iam.gserviceaccount.com"` | +| private_key | Y | The private key for authentication | `"privateKey"` | ## Optional per-request metadata properties The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided to the GCP Secret Manager component: -| Query Parameter | Description | -| --------------------- | --------------------------------- | +| Query Parameter | Description | +| --------------------- | ------------------------------------------------- | | `metadata.version_id` | Version for the given secret key. | ## Setup GCP Secret Manager instance -Setup GCP Secret Manager using the GCP documentation: https\://cloud.google.com/secret-manager/docs/quickstart. +Setup GCP Secret Manager using the GCP documentation: https://cloud.google.com/secret-manager/docs/quickstart. ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/hashicorp-vault.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/hashicorp-vault.md index 58877bfa8..d63910214 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/hashicorp-vault.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/hashicorp-vault.md @@ -52,27 +52,27 @@ The above example uses secrets as plain strings. It is recommended to use a loca ## Spec metadata fields -| Field | Required | Details | Example | -| ------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| vaultAddr | N | The address of the Vault server. Defaults to `"https://127.0.0.1:8200"` | `"https://127.0.0.1:8200"` | -| caPem | N | The inlined contents of the CA certificate to use, in PEM format. If defined, takes precedence over `caPath` and `caCert`. | See below | -| caPath | N | The path to a folder holding the CA certificate file to use, in PEM format. If the folder contains multiple files, only the first file found will be used. If defined, takes precedence over `caCert`. | `"path/to/cacert/holding/folder"` | -| caCert | N | The path to the CA certificate to use, in PEM format. | `""path/to/cacert.pem"` | -| skipVerify | N | Skip TLS verification. Defaults to `"false"` | `"true"`, `"false"` | -| tlsServerName | N | The name of the server requested during TLS handshake in order to support virtual hosting. This value is also used to verify the TLS certificate presented by Vault server. | `"tls-server"` | -| vaultTokenMountPath | Y | Path to file containing token | `"path/to/file"` | -| vaultToken | Y | [Token](https://learn.hashicorp.com/tutorials/vault/tokens) for authentication within Vault. | `"tokenValue"` | -| vaultKVPrefix | N | The prefix in vault. Defaults to `"dapr"` | `"dapr"`, `"myprefix"` | -| vaultKVUsePrefix | N | If false, vaultKVPrefix is forced to be empty. If the value is not given or set to true, vaultKVPrefix is used when accessing the vault. Setting it to false is needed to be able to use the BulkGetSecret method of the store. | `"true"`, `"false"` | -| enginePath | N | The [engine](https://www.vaultproject.io/api-docs/secret/kv/kv-v2) path in vault. Defaults to `"secret"` | `"kv"`, `"any"` | +| Field | Required | Details | Example | +| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | +| vaultAddr | N | The address of the Vault server. Defaults to `"https://127.0.0.1:8200"` | `"https://127.0.0.1:8200"` | +| caPem | N | The inlined contents of the CA certificate to use, in PEM format. If defined, takes precedence over `caPath` and `caCert`. | See below | +| caPath | N | The path to a folder holding the CA certificate file to use, in PEM format. If the folder contains multiple files, only the first file found will be used. If defined, takes precedence over `caCert`. | `"path/to/cacert/holding/folder"` | +| caCert | N | The path to the CA certificate to use, in PEM format. | `""path/to/cacert.pem"` | +| skipVerify | N | Skip TLS verification. Defaults to `"false"` | `"true"`, `"false"` | +| tlsServerName | N | The name of the server requested during TLS handshake in order to support virtual hosting. This value is also used to verify the TLS certificate presented by Vault server. | `"tls-server"` | +| vaultTokenMountPath | Y | Path to file containing token | `"path/to/file"` | +| vaultToken | Y | [Token](https://learn.hashicorp.com/tutorials/vault/tokens) for authentication within Vault. | `"tokenValue"` | +| vaultKVPrefix | N | The prefix in vault. Defaults to `"dapr"` | `"dapr"`, `"myprefix"` | +| vaultKVUsePrefix | N | If false, vaultKVPrefix is forced to be empty. If the value is not given or set to true, vaultKVPrefix is used when accessing the vault. Setting it to false is needed to be able to use the BulkGetSecret method of the store. | `"true"`, `"false"` | +| enginePath | N | The [engine](https://www.vaultproject.io/api-docs/secret/kv/kv-v2) path in vault. Defaults to `"secret"` | `"kv"`, `"any"` | | vaultValueType | N | Vault value type. `map` means to parse the value into `map[string]string`, `text` means to use the value as a string. 'map' sets the `multipleKeyValuesPerSecret` behavior. `text` makes Vault behave as a secret store with name/value semantics. Defaults to `"map"` | `"map"`, `"text"` | ## Optional per-request metadata properties The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided to Hashicorp Vault secret store component: -| Query Parameter | Description | -| --------------------- | --------------------------------- | +| Query Parameter | Description | +| --------------------- | ------------------------------------------------- | | `metadata.version_id` | Version for the given secret key. | ## Setup Hashicorp Vault instance @@ -80,11 +80,11 @@ The following [optional query parameters]({{< ref "secrets_api#query-parameters" {{< tabs "Self-Hosted" "Kubernetes" >}} {{% codetab %}} -Setup Hashicorp Vault using the Vault documentation: https\://www\.vaultproject.io/docs/install/index.html. +Setup Hashicorp Vault using the Vault documentation: https://www.vaultproject.io/docs/install/index.html. {{% /codetab %}} {{% codetab %}} -For Kubernetes, you can use the Helm Chart: https\://github.com/hashicorp/vault-helm. +For Kubernetes, you can use the Helm Chart: https://github.com/hashicorp/vault-helm. {{% /codetab %}} {{< /tabs >}} diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/huaweicloud-csms.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/huaweicloud-csms.md index 941a6b9f6..67f4551d7 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/huaweicloud-csms.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/huaweicloud-csms.md @@ -44,13 +44,13 @@ The above example uses secrets as plain strings. It is recommended to use a loca The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided when retrieving secrets from this secret store: -| Query Parameter | Description | -| --------------------- | --------------------------------- | +| Query Parameter | Description | +| --------------------- | ------------------------------------------------- | | `metadata.version_id` | Version for the given secret key. | ## Setup HuaweiCloud Cloud Secret Management Service (CSMS) instance -Setup HuaweiCloud Cloud Secret Management Service (CSMS) using the HuaweiCloud documentation: https\://support.huaweicloud.com/intl/en-us/usermanual-dew/dew_01_9993.html. +Setup HuaweiCloud Cloud Secret Management Service (CSMS) using the HuaweiCloud documentation: https://support.huaweicloud.com/intl/en-us/usermanual-dew/dew_01_9993.html. ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/kubernetes-secret-store.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/kubernetes-secret-store.md index 9b3fc26b1..4f9d08d7d 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/kubernetes-secret-store.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-secret-stores/kubernetes-secret-store.md @@ -43,8 +43,8 @@ spec: The following [optional query parameters]({{< ref "secrets_api#query-parameters" >}}) can be provided to Kubernetes secret store component: -| Query Parameter | Description | -| -------------------- | -------------------------------------------------------------------------------- | +| Query Parameter | Description | +| -------------------- | ---------------------------------------------------------------------------------------------------------------- | | `metadata.namespace` | The namespace of the secret. If not specified, the namespace of the pod is used. | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-blobstorage.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-blobstorage.md index 739639a85..681536bb9 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-blobstorage.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-blobstorage.md @@ -47,19 +47,19 @@ If you are using `v1` of this component, you should continue to use `v1` until y ## Spec metadata fields -| Field | Required | Details | Example | -| -------------------- | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `accountName` | Y | The storage account name | `"mystorageaccount"`. | -| `accountKey` | Y (unless using Microsoft Entra ID) | Primary or secondary storage key | `"key"` | -| `containerName` | Y | The name of the container to be used for Dapr state. The container will be created for you if it doesn't exist | `"container"` | -| `azureEnvironment` | N | Optional name for the Azure environment if using a different Azure cloud | `"AZUREPUBLICCLOUD"` (default value), `"AZURECHINACLOUD"`, `"AZUREUSGOVERNMENTCLOUD"` | +| Field | Required | Details | Example | +| -------------------- | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `accountName` | Y | The storage account name | `"mystorageaccount"`. | +| `accountKey` | Y (unless using Microsoft Entra ID) | Primary or secondary storage key | `"key"` | +| `containerName` | Y | The name of the container to be used for Dapr state. The container will be created for you if it doesn't exist | `"container"` | +| `azureEnvironment` | N | Optional name for the Azure environment if using a different Azure cloud | `"AZUREPUBLICCLOUD"` (default value), `"AZURECHINACLOUD"`, `"AZUREUSGOVERNMENTCLOUD"` | | `endpoint` | N | Optional custom endpoint URL. This is useful when using the [Azurite emulator](https://github.com/Azure/azurite) or when using custom domains for Azure Storage (although this is not officially supported). The endpoint must be the full base URL, including the protocol (`http://` or `https://`), the IP or FQDN, and optional port. | `"http://127.0.0.1:10000"` | -| `ContentType` | N | The blob's content type | `"text/plain"` | -| `ContentMD5` | N | The blob's MD5 hash | `"vZGKbMRDAnMs4BIwlXaRvQ=="` | -| `ContentEncoding` | N | The blob's content encoding | `"UTF-8"` | -| `ContentLanguage` | N | The blob's content language | `"en-us"` | -| `ContentDisposition` | N | The blob's content disposition. Conveys additional information about how to process the response payload | `"attachment"` | -| `CacheControl` | N | The blob's cache control | `"no-cache"` | +| `ContentType` | N | The blob's content type | `"text/plain"` | +| `ContentMD5` | N | The blob's MD5 hash | `"vZGKbMRDAnMs4BIwlXaRvQ=="` | +| `ContentEncoding` | N | The blob's content encoding | `"UTF-8"` | +| `ContentLanguage` | N | The blob's content language | `"en-us"` | +| `ContentDisposition` | N | The blob's content disposition. Conveys additional information about how to process the response payload | `"attachment"` | +| `CacheControl` | N | The blob's cache control | `"no-cache"` | ## Setup Azure Blob Storage diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-cosmosdb.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-cosmosdb.md index 92f2c7f79..b454c60ab 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-cosmosdb.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-cosmosdb.md @@ -43,13 +43,13 @@ If you wish to use Cosmos DB as an actor store, append the following to the yam ## Spec metadata fields -| Field | Required | Details | Example | -| --------------- | :------: | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| url | Y | The Cosmos DB url | `"https://******.documents.azure.com:443/"`. | -| masterKey | Y\* | The key to authenticate to the Cosmos DB account. Only required when not using Microsoft Entra ID authentication. | `"key"` | -| database | Y | The name of the database | `"db"` | -| collection | Y | The name of the collection (container) | `"collection"` | -| actorStateStore | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | +| Field | Required | Details | Example | +| --------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| url | Y | The Cosmos DB url | `"https://******.documents.azure.com:443/"`. | +| masterKey | Y\* | The key to authenticate to the Cosmos DB account. Only required when not using Microsoft Entra ID authentication. | `"key"` | +| database | Y | The name of the database | `"db"` | +| collection | Y | The name of the collection (container) | `"collection"` | +| actorStateStore | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md index b5ffa608d..d5d46b4bf 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-azure-tablestorage.md @@ -36,13 +36,13 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ----------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| `accountName` | Y | The storage account name | `"mystorageaccount"`. | -| `accountKey` | Y | Primary or secondary storage key | `"key"` | -| `tableName` | Y | The name of the table to be used for Dapr state. The table will be created for you if it doesn't exist | `"table"` | -| `cosmosDbMode` | N | If enabled, connects to Cosmos DB Table API instead of Azure Tables (Storage Accounts). Defaults to `false`. | `"false"` | -| `serviceURL` | N | The full storage service endpoint URL. Useful for Azure environments other than public cloud. | `"https://mystorageaccount.table.core.windows.net/"` | +| Field | Required | Details | Example | +| ----------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| `accountName` | Y | The storage account name | `"mystorageaccount"`. | +| `accountKey` | Y | Primary or secondary storage key | `"key"` | +| `tableName` | Y | The name of the table to be used for Dapr state. The table will be created for you if it doesn't exist | `"table"` | +| `cosmosDbMode` | N | If enabled, connects to Cosmos DB Table API instead of Azure Tables (Storage Accounts). Defaults to `false`. | `"false"` | +| `serviceURL` | N | The full storage service endpoint URL. Useful for Azure environments other than public cloud. | `"https://mystorageaccount.table.core.windows.net/"` | | `skipCreateTable` | N | Skips the check for and, if necessary, creation of the specified storage table. This is useful when using active directory authentication with minimal privileges. Defaults to `false`. | `"true"` | ### Microsoft Entra ID authentication diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cassandra.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cassandra.md index f5e51e9c0..38d0ad6ca 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cassandra.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cassandra.md @@ -44,17 +44,17 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ----------------- | :------: | ------------------------------------------------------- | ------------------------------------------ | -| hosts | Y | Comma separated value of the hosts | `"cassandra.cassandra.svc.cluster.local"`. | -| port | N | Port for communication. Default `"9042"` | `"9042"` | -| username | Y | The username of database user. No default | `"user"` | -| password | Y | The password for the user | `"password"` | -| consistency | N | The consistency values | `"All"`, `"Quorum"` | -| table | N | Table name. Defaults to `"items"` | `"items"`, `"tab"` | -| keyspace | N | The cassandra keyspace to use. Defaults to `"dapr"` | `"dapr"` | -| protoVersion | N | The proto version for the client. Defaults to `"4"` | `"3"`, `"4"` | -| replicationFactor | N | The replication factor for the calls. Defaults to `"1"` | `"3"` | +| Field | Required | Details | Example | +| ----------------- | :------: | ----------------------------------------------------------------------- | ---------------------------------------------------------- | +| hosts | Y | Comma separated value of the hosts | `"cassandra.cassandra.svc.cluster.local"`. | +| port | N | Port for communication. Default `"9042"` | `"9042"` | +| username | Y | The username of database user. No default | `"user"` | +| password | Y | The password for the user | `"password"` | +| consistency | N | The consistency values | `"All"`, `"Quorum"` | +| table | N | Table name. Defaults to `"items"` | `"items"`, `"tab"` | +| keyspace | N | The cassandra keyspace to use. Defaults to `"dapr"` | `"dapr"` | +| protoVersion | N | The proto version for the client. Defaults to `"4"` | `"3"`, `"4"` | +| replicationFactor | N | The replication factor for the calls. Defaults to `"1"` | `"3"` | ## Setup Cassandra diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cloudflare-workerskv.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cloudflare-workerskv.md index a3f4122fe..1da7bc0cf 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cloudflare-workerskv.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cloudflare-workerskv.md @@ -51,11 +51,11 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| --------------- | :------: | ----------------------------------------------------------------------------------- | ----------------------------------------- | -| `kvNamespaceID` | Y | ID of the pre-created Workers KV namespace | `"123456789abcdef8b5588f3d134f74ac"` | -| `workerName` | Y | Name of the Worker to connect to | `"mydaprkv"` | -| `key` | Y | Ed25519 private key, PEM-encoded | _See example above_ | +| Field | Required | Details | Example | +| --------------- | :------: | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| `kvNamespaceID` | Y | ID of the pre-created Workers KV namespace | `"123456789abcdef8b5588f3d134f74ac"` | +| `workerName` | Y | Name of the Worker to connect to | `"mydaprkv"` | +| `key` | Y | Ed25519 private key, PEM-encoded | _See example above_ | | `cfAccountID` | Y/N | Cloudflare account ID. Required to have Dapr manage the worker. | `"456789abcdef8b5588f3d134f74ac"def` | | `cfAPIToken` | Y/N | API token for Cloudflare. Required to have Dapr manage the Worker. | `"secret-key"` | | `workerUrl` | Y/N | URL of the Worker. Required if the Worker has been pre-provisioned outside of Dapr. | `"https://mydaprkv.mydomain.workers.dev"` | @@ -208,7 +208,7 @@ openssl genpkey -algorithm ed25519 -out private.pem openssl pkey -in private.pem -pubout -out public.pem ``` -> On macOS, using openssl\@3 from Homebrew: +> On macOS, using openssl@3 from Homebrew: > > ```sh > $(brew --prefix)/opt/openssl@3/bin/openssl genpkey -algorithm ed25519 -out private.pem diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cockroachdb.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cockroachdb.md index fc26af87d..6e547f56c 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cockroachdb.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-cockroachdb.md @@ -51,15 +51,15 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| -------------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `connectionString` | Y | The connection string for CockroachDB | `"host=localhost user=root port=26257 connect_timeout=10 database=dapr_test"` | -| `timeoutInSeconds` | N | Timeout, in seconds, for all database operations. Defaults to `20` | `30` | -| `tableName` | N | Name of the table where the data is stored. Defaults to `state`. Can optionally have the schema name as prefix, such as `public.state` | `"state"`, `"public.state"` | -| `metadataTableName` | N | Name of the table Dapr uses to store a few metadata properties. Defaults to `dapr_metadata`. Can optionally have the schema name as prefix, such as `public.dapr_metadata` | `"dapr_metadata"`, `"public.dapr_metadata"` | -| `cleanupIntervalInSeconds` | N | Interval, in seconds, to clean up rows with an expired TTL. Default: `3600` (i.e. 1 hour). Setting this to values <=0 disables the periodic cleanup. | `1800`, `-1` | -| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | -| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | +| Field | Required | Details | Example | +| -------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `connectionString` | Y | The connection string for CockroachDB | `"host=localhost user=root port=26257 connect_timeout=10 database=dapr_test"` | +| `timeoutInSeconds` | N | Timeout, in seconds, for all database operations. Defaults to `20` | `30` | +| `tableName` | N | Name of the table where the data is stored. Defaults to `state`. Can optionally have the schema name as prefix, such as `public.state` | `"state"`, `"public.state"` | +| `metadataTableName` | N | Name of the table Dapr uses to store a few metadata properties. Defaults to `dapr_metadata`. Can optionally have the schema name as prefix, such as `public.dapr_metadata` | `"dapr_metadata"`, `"public.dapr_metadata"` | +| `cleanupIntervalInSeconds` | N | Interval, in seconds, to clean up rows with an expired TTL. Default: `3600` (i.e. 1 hour). Setting this to values <=0 disables the periodic cleanup. | `1800`, `-1` | +| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | +| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | ## Setup CockroachDB diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-consul.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-consul.md index af9506d3e..a83691629 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-consul.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-consul.md @@ -38,10 +38,10 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ------------- | :------: | ------------------------------------------------------------------- | ----------------------------------------- | -| datacenter | Y | Datacenter to use | `"dc1"` | -| httpAddr | Y | Address of the Consul server | `"consul.default.svc.cluster.local:8500"` | +| Field | Required | Details | Example | +| ------------- | :------: | ----------------------------------------------------------------------------------- | ----------------------------------------- | +| datacenter | Y | Datacenter to use | `"dc1"` | +| httpAddr | Y | Address of the Consul server | `"consul.default.svc.cluster.local:8500"` | | aclToken | N | Per Request ACL Token. Default is `""` | `"token"` | | scheme | N | Scheme is the URI scheme for the Consul server. Default is `"http"` | `"http"` | | keyPrefixPath | N | Key prefix path in Consul. Default is `""` | `"dapr"` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-dynamodb.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-dynamodb.md index cf7ab11aa..c37be8efc 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-dynamodb.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-dynamodb.md @@ -48,16 +48,16 @@ In order to use DynamoDB as a Dapr state store, the table must have a primary ke ## Spec metadata fields -| Field | Required | Details | Example | -| ---------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| table | Y | name of the DynamoDB table to use | `"Contracts"` | -| accessKey | N | ID of the AWS account with appropriate permissions to SNS and SQS. Can be `secretKeyRef` to use a secret reference | `"AKIAIOSFODNN7EXAMPLE"` | -| secretKey | N | Secret for the AWS user. Can be `secretKeyRef` to use a secret reference | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | -| region | N | The AWS region to the instance. See this page for valid regions: https\://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html. Ensure that DynamoDB are available in that region. | `"us-east-1"` | -| endpoint | N | AWS endpoint for the component to use. Only used for local development. The `endpoint` is unncessary when running against production AWS | `"http://localhost:4566"` | -| sessionToken | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | -| ttlAttributeName | N | The table attribute name which should be used for TTL. | `"expiresAt"` | -| partitionKey | N | The table primary key or partition key attribute name. This field is used to replace the default primary key attribute name `"key"`. See the section [Partition Keys]({{< ref "setup-dynamodb.md#partition-keys" >}}). | `"ContractID"` | +| Field | Required | Details | Example | +| ---------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| table | Y | name of the DynamoDB table to use | `"Contracts"` | +| accessKey | N | ID of the AWS account with appropriate permissions to SNS and SQS. Can be `secretKeyRef` to use a secret reference | `"AKIAIOSFODNN7EXAMPLE"` | +| secretKey | N | Secret for the AWS user. Can be `secretKeyRef` to use a secret reference | `"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` | +| region | N | The AWS region to the instance. See this page for valid regions: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html. Ensure that DynamoDB are available in that region. | `"us-east-1"` | +| endpoint | N | AWS endpoint for the component to use. Only used for local development. The `endpoint` is unncessary when running against production AWS | `"http://localhost:4566"` | +| sessionToken | N | AWS session token to use. A session token is only required if you are using temporary security credentials. | `"TOKEN"` | +| ttlAttributeName | N | The table attribute name which should be used for TTL. | `"expiresAt"` | +| partitionKey | N | The table primary key or partition key attribute name. This field is used to replace the default primary key attribute name `"key"`. See the section [Partition Keys]({{< ref "setup-dynamodb.md#partition-keys" >}}). | `"ContractID"` | {{% alert title="Important" color="warning" %}} When running the Dapr sidecar (daprd) with your application on EKS (AWS Kubernetes), if you're using a node/pod that has already been attached to an IAM policy defining access to AWS resources, you **must not** provide AWS access-key, secret-key, and tokens in the definition of the component spec you're using.\ diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-etcd.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-etcd.md index 4e0ebe9af..a36e77c96 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-etcd.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-etcd.md @@ -50,14 +50,14 @@ If you are using `v1`, you should continue to use `v1` until you create a new Et ## Spec metadata fields -| Field | Required | Details | Example | -| --------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| `endpoints` | Y | Connection string to the Etcd cluster | `"192.168.0.1:2379,192.168.0.2:2379,192.168.0.3:2379"` | -| `keyPrefixPath` | N | Key prefix path in Etcd. Default is no prefix. | `"dapr"` | -| `tlsEnable` | N | Whether to enable TLS for connecting to Etcd. | `"false"` | -| `ca` | N | CA certificate for connecting to Etcd, PEM-encoded. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). | `"-----BEGIN CERTIFICATE-----\nMIIC9TCCA..."` | -| `cert` | N | TLS certificate for connecting to Etcd, PEM-encoded. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). | `"-----BEGIN CERTIFICATE-----\nMIIDUTCC..."` | -| `key` | N | TLS key for connecting to Etcd, PEM-encoded. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). | `"-----BEGIN PRIVATE KEY-----\nMIIEpAIB..."` | +| Field | Required | Details | Example | +| --------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| `endpoints` | Y | Connection string to the Etcd cluster | `"192.168.0.1:2379,192.168.0.2:2379,192.168.0.3:2379"` | +| `keyPrefixPath` | N | Key prefix path in Etcd. Default is no prefix. | `"dapr"` | +| `tlsEnable` | N | Whether to enable TLS for connecting to Etcd. | `"false"` | +| `ca` | N | CA certificate for connecting to Etcd, PEM-encoded. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). | `"-----BEGIN CERTIFICATE-----\nMIIC9TCCA..."` | +| `cert` | N | TLS certificate for connecting to Etcd, PEM-encoded. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). | `"-----BEGIN CERTIFICATE-----\nMIIDUTCC..."` | +| `key` | N | TLS key for connecting to Etcd, PEM-encoded. Can be `secretKeyRef` to use a [secret reference]({{< ref component-secrets.md >}}). | `"-----BEGIN PRIVATE KEY-----\nMIIEpAIB..."` | ## Setup Etcd diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-firestore.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-firestore.md index 634b82935..555ed9416 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-firestore.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-firestore.md @@ -54,21 +54,21 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------------------------------------------------------------------------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| project_id | Y | The ID of the GCP project to use | `"project-id"` | +| Field | Required | Details | Example | +| --------------------------------------------------------------------------------------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| project_id | Y | The ID of the GCP project to use | `"project-id"` | | endpoint | N | GCP endpoint for the component to use. Only used for local development with (for example) [GCP Datastore Emulator](https://cloud.google.com/datastore/docs/tools/datastore-emulator). The `endpoint` is unnecessary when running against the GCP production API. | `"localhost:8432"` | -| private_key_id | N | The ID of the prvate key to use | `"private-key-id"` | -| privateKey | N | If using explicit credentials, this field should contain the `private_key` field from the service account json | `-----BEGIN PRIVATE KEY-----MIIBVgIBADANBgkqhkiG9w0B` | -| client_email | N | The email address for the client | `"eample@example.com"` | -| client_id | N | The client id value to use for authentication | `"client-id"` | -| auth_uri | N | The authentication URI to use | `"https://accounts.google.com/o/oauth2/auth"` | -| token_uri | N | The token URI to query for Auth token | `"https://oauth2.googleapis.com/token"` | -| auth_provider_x509_cert_url | N | The auth provider certificate URL | `"https://www.googleapis.com/oauth2/v1/certs"` | -| client_x509_cert_url | N | The client certificate URL | `"https://www.googleapis.com/robot/v1/metadata/x509/x"` | -| entity_kind | N | The entity name in Filestore. Defaults to `"DaprState"` | `"DaprState"` | -| noindex | N | Whether to disable indexing of state entities. Use this setting if you encounter Firestore index size limitations. Defaults to `"false"` | `"true"` | -| type | N | **DEPRECATED** The credentials type | `"serviceaccount"` | +| private_key_id | N | The ID of the prvate key to use | `"private-key-id"` | +| privateKey | N | If using explicit credentials, this field should contain the `private_key` field from the service account json | `-----BEGIN PRIVATE KEY-----MIIBVgIBADANBgkqhkiG9w0B` | +| client_email | N | The email address for the client | `"eample@example.com"` | +| client_id | N | The client id value to use for authentication | `"client-id"` | +| auth_uri | N | The authentication URI to use | `"https://accounts.google.com/o/oauth2/auth"` | +| token_uri | N | The token URI to query for Auth token | `"https://oauth2.googleapis.com/token"` | +| auth_provider_x509_cert_url | N | The auth provider certificate URL | `"https://www.googleapis.com/oauth2/v1/certs"` | +| client_x509_cert_url | N | The client certificate URL | `"https://www.googleapis.com/robot/v1/metadata/x509/x"` | +| entity_kind | N | The entity name in Filestore. Defaults to `"DaprState"` | `"DaprState"` | +| noindex | N | Whether to disable indexing of state entities. Use this setting if you encounter Firestore index size limitations. Defaults to `"false"` | `"true"` | +| type | N | **DEPRECATED** The credentials type | `"serviceaccount"` | ## GCP Credentials diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-memcached.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-memcached.md index 60fb0c441..b30a40e46 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-memcached.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-memcached.md @@ -34,9 +34,9 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ------------------ | :------: | --------------------------------------------------------------- | --------------------------------------------- | -| hosts | Y | Comma delimited endpoints | `"memcached.default.svc.cluster.local:11211"` | +| Field | Required | Details | Example | +| ------------------ | :------: | ------------------------------------------------------------------------------- | --------------------------------------------- | +| hosts | Y | Comma delimited endpoints | `"memcached.default.svc.cluster.local:11211"` | | maxIdleConnections | N | The max number of idle connections. Defaults to `"2"` | `"3"` | | timeout | N | The timeout for the calls in milliseconds. Defaults to `"1000"` | `"1000"` | diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mongodb.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mongodb.md index 4462680a1..e92813dba 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mongodb.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mongodb.md @@ -65,11 +65,11 @@ If you wish to use MongoDB as an actor store, add this metadata option to your C | host | Y1 | The host to connect to | `"mongo-mongodb.default.svc.cluster.local:27017"` | | username | N | The username of the user to connect with (applicable in conjunction with `host`) | `"admin"` | | password | N | The password of the user (applicable in conjunction with `host`) | `"password"` | -| databaseName | N | The name of the database to use. Defaults to `"daprStore"` | `"daprStore"` | -| collectionName | N | The name of the collection to use. Defaults to `"daprCollection"` | `"daprCollection"` | +| databaseName | N | The name of the database to use. Defaults to `"daprStore"` | `"daprStore"` | +| collectionName | N | The name of the collection to use. Defaults to `"daprCollection"` | `"daprCollection"` | | writeConcern | N | The write concern to use | `"majority"` | | readConcern | N | The read concern to use | `"majority"`, `"local"`,`"available"`, `"linearizable"`, `"snapshot"` | -| operationTimeout | N | The timeout for the operation. Defaults to `"5s"` | `"5s"` | +| operationTimeout | N | The timeout for the operation. Defaults to `"5s"` | `"5s"` | | params | N2 | Additional parameters to use | `"?authSource=daprStore&ssl=true"` | > [1] The `server` and `host` fields are mutually exclusive. If neither or both are set, Dapr returns an error. diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mysql.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mysql.md index 8d52c6455..969adc7e2 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mysql.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-mysql.md @@ -49,15 +49,15 @@ If you wish to use MySQL as an actor store, append the following to the yaml. ## Spec metadata fields -| Field | Required | Details | Example | -| -------------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `connectionString` | Y | The connection string to connect to MySQL. Do not add the schema to the connection string | [Non SSL connection](#non-ssl-connection): `":@tcp(:3306)/?allowNativePasswords=true"`, [Enforced SSL Connection](#enforced-ssl-connection): `":@tcp(:3306)/?allowNativePasswords=true&tls=custom"` | -| `schemaName` | N | The schema name to use. Will be created if schema does not exist. Defaults to `"dapr_state_store"` | `"custom_schema"`, `"dapr_schema"` | -| `tableName` | N | The table name to use. Will be created if table does not exist. Defaults to `"state"` | `"table_name"`, `"dapr_state"` | -| `timeoutInSeconds` | N | Timeout for all database operations. Defaults to `20` | `30` | -| `pemPath` | N | Full path to the PEM file to use for [enforced SSL Connection](#enforced-ssl-connection) required if pemContents is not provided. Cannot be used in K8s environment | `"/path/to/file.pem"`, `"C:\path\to\file.pem"` | -| `pemContents` | N | Contents of PEM file to use for [enforced SSL Connection](#enforced-ssl-connection) required if pemPath is not provided. Can be used in K8s environment | `"pem value"` | -| `cleanupIntervalInSeconds` | N | Interval, in seconds, to clean up rows with an expired TTL. Default: `3600` (that is 1 hour). Setting this to values <=0 disables the periodic cleanup. | `1800`, `-1` | +| Field | Required | Details | Example | +| -------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `connectionString` | Y | The connection string to connect to MySQL. Do not add the schema to the connection string | [Non SSL connection](#non-ssl-connection): `":@tcp(:3306)/?allowNativePasswords=true"`, [Enforced SSL Connection](#enforced-ssl-connection): `":@tcp(:3306)/?allowNativePasswords=true&tls=custom"` | +| `schemaName` | N | The schema name to use. Will be created if schema does not exist. Defaults to `"dapr_state_store"` | `"custom_schema"`, `"dapr_schema"` | +| `tableName` | N | The table name to use. Will be created if table does not exist. Defaults to `"state"` | `"table_name"`, `"dapr_state"` | +| `timeoutInSeconds` | N | Timeout for all database operations. Defaults to `20` | `30` | +| `pemPath` | N | Full path to the PEM file to use for [enforced SSL Connection](#enforced-ssl-connection) required if pemContents is not provided. Cannot be used in K8s environment | `"/path/to/file.pem"`, `"C:\path\to\file.pem"` | +| `pemContents` | N | Contents of PEM file to use for [enforced SSL Connection](#enforced-ssl-connection) required if pemPath is not provided. Can be used in K8s environment | `"pem value"` | +| `cleanupIntervalInSeconds` | N | Interval, in seconds, to clean up rows with an expired TTL. Default: `3600` (that is 1 hour). Setting this to values <=0 disables the periodic cleanup. | `1800`, `-1` | ## Setup MySQL diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oci-objectstorage.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oci-objectstorage.md index a12121452..db610bec1 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oci-objectstorage.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oci-objectstorage.md @@ -54,19 +54,19 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| instancePrincipalAuthentication | N | Boolean to indicate whether instance principal based authentication is used. Default: `"false"` | `"true"` or `"false"` . | -| configFileAuthentication | N | Boolean to indicate whether identity credential details are provided through a configuration file. Default: `"false"` Not required nor used when instancePrincipalAuthentication is true. | `"true"` or `"false"` . | -| configFilePath | N | Full path name to the OCI configuration file. No default value exists. Not used when instancePrincipalAuthentication is true. Note: the \~/ prefix is not supported. | `"/home/apps/configuration-files/myOCIConfig.txt"`. | -| configFileProfile | N | Name of profile in configuration file to use. Default: `"DEFAULT"` Not used when instancePrincipalAuthentication is true. | `"DEFAULT"` or `"PRODUCTION"` . | -| tenancyOCID | Y | The OCI tenancy identifier. Not required nor used when instancePrincipalAuthentication is true. | `"ocid1.tenancy.oc1..aaaaaaaag7c7sljhsdjhsdyuwe723"`. | -| userOCID | Y | The OCID for an OCI account (this account requires permissions to access OCI Object Storage). Not required nor used when instancePrincipalAuthentication is true. | `"ocid1.user.oc1..aaaaaaaaby4oyyyuqwy7623yuwe76"` | -| fingerPrint | Y | Fingerprint of the public key. Not required nor used when instancePrincipalAuthentication is true. | `"02:91:6c:49:e2:94:21:15:a7:6b:0e:a7:34:e1:3d:1b"` | -| privateKey | Y | Private key of the RSA key pair. Not required nor used when instancePrincipalAuthentication is true. | `"MIIEoyuweHAFGFG2727as+7BTwQRAIW4V"` | -| region | Y | OCI Region. Not required nor used when instancePrincipalAuthentication is true. | `"us-ashburn-1"` | -| bucketName | Y | Name of the bucket written to and read from (and if necessary created) | `"application-state-store-bucket"` | -| compartmentOCID | Y | The OCID for the compartment that contains the bucket | `"ocid1.compartment.oc1..aaaaaaaacsssekayyuq7asjh78"` | +| Field | Required | Details | Example | +| ------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| instancePrincipalAuthentication | N | Boolean to indicate whether instance principal based authentication is used. Default: `"false"` | `"true"` or `"false"` . | +| configFileAuthentication | N | Boolean to indicate whether identity credential details are provided through a configuration file. Default: `"false"` Not required nor used when instancePrincipalAuthentication is true. | `"true"` or `"false"` . | +| configFilePath | N | Full path name to the OCI configuration file. No default value exists. Not used when instancePrincipalAuthentication is true. Note: the ~/ prefix is not supported. | `"/home/apps/configuration-files/myOCIConfig.txt"`. | +| configFileProfile | N | Name of profile in configuration file to use. Default: `"DEFAULT"` Not used when instancePrincipalAuthentication is true. | `"DEFAULT"` or `"PRODUCTION"` . | +| tenancyOCID | Y | The OCI tenancy identifier. Not required nor used when instancePrincipalAuthentication is true. | `"ocid1.tenancy.oc1..aaaaaaaag7c7sljhsdjhsdyuwe723"`. | +| userOCID | Y | The OCID for an OCI account (this account requires permissions to access OCI Object Storage). Not required nor used when instancePrincipalAuthentication is true. | `"ocid1.user.oc1..aaaaaaaaby4oyyyuqwy7623yuwe76"` | +| fingerPrint | Y | Fingerprint of the public key. Not required nor used when instancePrincipalAuthentication is true. | `"02:91:6c:49:e2:94:21:15:a7:6b:0e:a7:34:e1:3d:1b"` | +| privateKey | Y | Private key of the RSA key pair. Not required nor used when instancePrincipalAuthentication is true. | `"MIIEoyuweHAFGFG2727as+7BTwQRAIW4V"` | +| region | Y | OCI Region. Not required nor used when instancePrincipalAuthentication is true. | `"us-ashburn-1"` | +| bucketName | Y | Name of the bucket written to and read from (and if necessary created) | `"application-state-store-bucket"` | +| compartmentOCID | Y | The OCID for the compartment that contains the bucket | `"ocid1.compartment.oc1..aaaaaaaacsssekayyuq7asjh78"` | ## Setup OCI Object Storage @@ -76,7 +76,7 @@ Dapr-applications running on Oracle Cloud Infrastructure - in a compute instance Identity based authentication interacts with OCI through an OCI account that has permissions to create, read and delete objects through OCI Object Storage in the indicated bucket and that is allowed to create a bucket in the specified compartment if the bucket is not created beforehand. The OCI documentation [describes how to create an OCI Account](https://docs.oracle.com/en-us/iaas/Content/GSG/Tasks/addingusers.htm#Adding_Users). The interaction by the state store is performed using the public key's fingerprint and a private key from an RSA Key Pair generated for the OCI account. The [instructions for generating the key pair and getting hold of the required information](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm) are available in the OCI documentation. -Details for the identity and identity's credentials to be used for interaction with OCI can be provided directly in the Dapr component properties file - using the properties tenancyOCID, userOCID, fingerPrint, privateKey and region - or can be provided from a configuration file as is common for many OCI related tools (such as CLI and Terraform) and SDKs. In the latter case the exact file name and full path has to be provided through property configFilePath. Note: the \~/ prefix is not supported in the path. A configuration file can contain multiple profiles; the desired profile can be specified through property configFileProfile. If no value is provided, DEFAULT is used as the name for the profile to be used. Note: if the indicated profile is not found, then the DEFAULT profile (if it exists) is used instead. The OCI SDK documentation gives [details about the definition of the configuration file](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm). +Details for the identity and identity's credentials to be used for interaction with OCI can be provided directly in the Dapr component properties file - using the properties tenancyOCID, userOCID, fingerPrint, privateKey and region - or can be provided from a configuration file as is common for many OCI related tools (such as CLI and Terraform) and SDKs. In the latter case the exact file name and full path has to be provided through property configFilePath. Note: the ~/ prefix is not supported in the path. A configuration file can contain multiple profiles; the desired profile can be specified through property configFileProfile. If no value is provided, DEFAULT is used as the name for the profile to be used. Note: if the indicated profile is not found, then the DEFAULT profile (if it exists) is used instead. The OCI SDK documentation gives [details about the definition of the configuration file](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm). If you wish to create the bucket for Dapr to use, you can do so beforehand. However, Object Storage state provider will create one - in the specified compartment - for you automatically if it doesn't exist. @@ -113,8 +113,8 @@ curl -X POST http://localhost:3500/v1.0/state \ creates the following object: -| Bucket | Directory | Object Name | Object Content | Meta Tags | -| --------------------------------------------------- | --------------------------- | ----------- | -------------- | -------------------------- | +| Bucket | Directory | Object Name | Object Content | Meta Tags | +| ------------------------------------------------------------------- | --------------------------- | ----------- | -------------- | ------------------------------------------ | | as specified with **bucketName** in components.yaml | - (root) | nihilus | darth | category: dapr-state-store | Dapr uses a fixed key scheme with _composite keys_ to partition state across applications. For general states, the key format is: @@ -136,8 +136,8 @@ curl -X POST http://localhost:3500/v1.0/state \ will create the following object: -| Bucket | Directory | Object Name | Object Content | Meta Tags | -| --------------------------------------------------- | ------------- | ----------- | -------------- | -------------------------- | +| Bucket | Directory | Object Name | Object Content | Meta Tags | +| ------------------------------------------------------------------- | ------------- | ----------- | -------------- | ------------------------------------------ | | as specified with **bucketName** in components.yaml | myApplication | nihilus | darth | category: dapr-state-store | You will be able to inspect all state stored through the OCI Object Storage state store by inspecting the contents of the bucket through the console, the APIs, CLI or SDKs. By going directly to the bucket, you can prepare state that will be available as state to your application at runtime. @@ -164,8 +164,8 @@ curl -X POST http://localhost:3500/v1.0/state \ creates the following object: -| Bucket | Directory | Object Name | Object Content | Meta Tags | -| --------------------------------------------------- | --------- | ----------- | -------------- | ---------------------------------------------------------------------- | +| Bucket | Directory | Object Name | Object Content | Meta Tags | +| ------------------------------------------------------------------- | --------- | ----------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | as specified with **bucketName** in components.yaml | - | nihilus | darth | category: dapr-state-store , expiry-time-from-ttl: 2022-01-06T08:34:32 | The exact value of the expiry-time-from-ttl depends of course on the time at which the state was created and will be 120 seconds later than that moment. diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oracledatabase.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oracledatabase.md index 6f2977698..b31731aa6 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oracledatabase.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-oracledatabase.md @@ -63,9 +63,9 @@ curl -X POST http://localhost:3500/v1.0/state \ creates the following records in table STATE: -| KEY | VALUE | CREATION_TIME | BINARY_YN | ETAG | -| ------- | ----- | ---------------------------------- | ------------------------------ | ------------------------------------ | -| nihilus | darth | 2022-02-14T22:11:00 | N | 79dfb504-5b27-43f6-950f-d55d5ae0894f | +| KEY | VALUE | CREATION_TIME | BINARY_YN | ETAG | +| ------- | ----- | --------------------------------------------------- | ------------------------------ | ------------------------------------ | +| nihilus | darth | 2022-02-14T22:11:00 | N | 79dfb504-5b27-43f6-950f-d55d5ae0894f | Dapr uses a fixed key scheme with _composite keys_ to partition state across applications. For general states, the key format is: `App-ID||state key`. The Oracle Database state store maps this key in its entirety to the KEY column. @@ -94,9 +94,9 @@ curl -X POST http://localhost:3500/v1.0/state \ creates the following object: -| KEY | VALUE | CREATION_TIME | EXPIRATION_TIME | BINARY_YN | ETAG | -| --------- | --------- | ---------------------------------- | ------------------------------------ | ------------------------------ | ------------------------------------ | -| temporary | ephemeral | 2022-03-31T22:11:00 | 2022-03-31T22:13:00 | N | 79dfb504-5b27-43f6-950f-d55d5ae0894f | +| KEY | VALUE | CREATION_TIME | EXPIRATION_TIME | BINARY_YN | ETAG | +| --------- | --------- | --------------------------------------------------- | --------------------------------------------------- | ------------------------------ | ------------------------------------ | +| temporary | ephemeral | 2022-03-31T22:11:00 | 2022-03-31T22:13:00 | N | 79dfb504-5b27-43f6-950f-d55d5ae0894f | with the EXPIRATION_TIME set to a timestamp 2 minutes (120 seconds) (later than the CREATION_TIME) diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v1.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v1.md index 0142593d7..e50943df4 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v1.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v1.md @@ -67,34 +67,34 @@ The above example uses secrets as plain strings. It is recommended to use a secr The following metadata options are **required** to authenticate using a PostgreSQL connection string. -| Field | Required | Details | Example | -| ------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| ------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `connectionString` | Y | The connection string for the PostgreSQL database. See the PostgreSQL [documentation on database connections](https://www.postgresql.org/docs/current/libpq-connect.html) for information on how to define a connection string. | `"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=my_db"` | ### Authenticate using Microsoft Entra ID Authenticating with Microsoft Entra ID is supported with Azure Database for PostgreSQL. All authentication methods supported by Dapr can be used, including client credentials ("service principal") and Managed Identity. -| Field | Required | Details | Example | -| ------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | +| Field | Required | Details | Example | +| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain the user, which corresponds to the name of the user created inside PostgreSQL that maps to the Microsoft Entra ID identity; this is often the name of the corresponding principal (e.g. the name of the Microsoft Entra ID application). This connection string should not contain any password. | `"host=mydb.postgres.database.azure.com user=myapplication port=5432 database=my_db sslmode=require"` | -| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | -| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | -| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | +| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | +| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | +| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | ### Other metadata options -| Field | Required | Details | Example | -| ----------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| `tableName` | N | Name of the table where the data is stored. Defaults to `state`. Can optionally have the schema name as prefix, such as `public.state` | `"state"`, `"public.state"` | -| `metadataTableName` | N | Name of the table Dapr uses to store a few metadata properties. Defaults to `dapr_metadata`. Can optionally have the schema name as prefix, such as `public.dapr_metadata` | `"dapr_metadata"`, `"public.dapr_metadata"` | -| `timeout` | N | Timeout for operations on the database, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Integers are interpreted as number of seconds. Defaults to `20s` | `"30s"`, `30` | +| Field | Required | Details | Example | +| ----------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| `tableName` | N | Name of the table where the data is stored. Defaults to `state`. Can optionally have the schema name as prefix, such as `public.state` | `"state"`, `"public.state"` | +| `metadataTableName` | N | Name of the table Dapr uses to store a few metadata properties. Defaults to `dapr_metadata`. Can optionally have the schema name as prefix, such as `public.dapr_metadata` | `"dapr_metadata"`, `"public.dapr_metadata"` | +| `timeout` | N | Timeout for operations on the database, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Integers are interpreted as number of seconds. Defaults to `20s` | `"30s"`, `30` | | `cleanupInterval` | N | Interval, as a Go duration or number of seconds, to clean up rows with an expired TTL. Default: `1h` (1 hour). Setting this to values <=0 disables the periodic cleanup. | `"30m"`, `1800`, `-1` | -| `maxConns` | N | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | -| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | +| `maxConns` | N | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | +| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | | `queryExecMode` | N | Controls the default mode for executing queries. By default Dapr uses the extended protocol and automatically prepares and caches prepared statements. However, this may be incompatible with proxies such as PGBouncer. In this case it may be preferrable to use `exec` or `simple_protocol`. | `"simple_protocol"` | -| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | +| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | ## Setup PostgreSQL diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v2.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v2.md index 94c661b14..401809470 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v2.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-postgresql-v2.md @@ -67,34 +67,34 @@ The above example uses secrets as plain strings. It is recommended to use a secr The following metadata options are **required** to authenticate using a PostgreSQL connection string. -| Field | Required | Details | Example | -| ------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| ------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `connectionString` | Y | The connection string for the PostgreSQL database. See the PostgreSQL [documentation on database connections](https://www.postgresql.org/docs/current/libpq-connect.html) for information on how to define a connection string. | `"host=localhost user=postgres password=example port=5432 connect_timeout=10 database=my_db"` | ### Authenticate using Microsoft Entra ID Authenticating with Microsoft Entra ID is supported with Azure Database for PostgreSQL. All authentication methods supported by Dapr can be used, including client credentials ("service principal") and Managed Identity. -| Field | Required | Details | Example | -| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | +| Field | Required | Details | Example | +| ------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | | `connectionString` | Y | The connection string for the PostgreSQL database.
This must contain the user, which corresponds to the name of the user created inside PostgreSQL that maps to the Microsoft Entra ID identity. This is often the name of the corresponding principal (for example, the name of the Microsoft Entra ID application). This connection string should not contain any password. | `"host=mydb.postgres.database.azure.com user=myapplication port=5432 database=my_db sslmode=require"` | -| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | -| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | -| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | +| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-…"` | +| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-…"` | +| `azureClientSecret` | N | Client secret (application password) | `"Ecy3X…"` | ### Other metadata options -| Field | Required | Details | Example | -| ----------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | -| `tablePrefix` | N | Prefix for the table where the data is stored. Can optionally have the schema name as prefix, such as `public.prefix_` | `"prefix_"`, `"public.prefix_"` | -| `metadataTableName` | N | Name of the table Dapr uses to store a few metadata properties. Defaults to `dapr_metadata`. Can optionally have the schema name as prefix, such as `public.dapr_metadata` | `"dapr_metadata"`, `"public.dapr_metadata"` | -| `timeout` | N | Timeout for operations on the database, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Integers are interpreted as number of seconds. Defaults to `20s` | `"30s"`, `30` | +| Field | Required | Details | Example | +| ----------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| `tablePrefix` | N | Prefix for the table where the data is stored. Can optionally have the schema name as prefix, such as `public.prefix_` | `"prefix_"`, `"public.prefix_"` | +| `metadataTableName` | N | Name of the table Dapr uses to store a few metadata properties. Defaults to `dapr_metadata`. Can optionally have the schema name as prefix, such as `public.dapr_metadata` | `"dapr_metadata"`, `"public.dapr_metadata"` | +| `timeout` | N | Timeout for operations on the database, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Integers are interpreted as number of seconds. Defaults to `20s` | `"30s"`, `30` | | `cleanupInterval` | N | Interval, as a Go duration or number of seconds, to clean up rows with an expired TTL. Default: `1h` (1 hour). Setting this to values <=0 disables the periodic cleanup. | `"30m"`, `1800`, `-1` | -| `maxConns` | N | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | -| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | +| `maxConns` | N | Maximum number of connections pooled by this component. Set to 0 or lower to use the default value, which is the greater of 4 or the number of CPUs. | `"4"` | +| `connectionMaxIdleTime` | N | Max idle time before unused connections are automatically closed in the connection pool. By default, there's no value and this is left to the database driver to choose. | `"5m"` | | `queryExecMode` | N | Controls the default mode for executing queries. By default Dapr uses the extended protocol and automatically prepares and caches prepared statements. However, this may be incompatible with proxies such as PGBouncer. In this case, it may be preferrable to use `exec` or `simple_protocol`. | `"simple_protocol"` | -| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | +| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | ## Setup PostgreSQL diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-redis.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-redis.md index 889665eae..2f491f0a8 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-redis.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-redis.md @@ -89,35 +89,35 @@ If you wish to use Redis as an actor store, append the following to the yaml. ## Spec metadata fields -| Field | Required | Details | Example | -| --------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| redisHost | Y | Connection-string for the redis host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | +| Field | Required | Details | Example | +| --------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | +| redisHost | Y | Connection-string for the redis host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379` | | redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"` | -| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | -| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | -| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | +| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"` | +| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"` | +| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10` | | maxRetryBackoff | N | Maximum backoff between each retry. Defaults to `2` seconds; `"-1"` disables backoff. | `3000000000` | -| failover | N | Property to enabled failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/). Defaults to `"false"` | `"true"`, `"false"` | -| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `""`, `"127.0.0.1:6379"` | -| redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | -| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | -| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | -| redisDB | N | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | +| failover | N | Property to enabled failover configuration. Needs sentinelMasterName to be set. The redisHost should be the sentinel host address. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/). Defaults to `"false"` | `"true"`, `"false"` | +| sentinelMasterName | N | The sentinel master name. See [Redis Sentinel Documentation](https://redis.io/docs/manual/sentinel/) | `""`, `"127.0.0.1:6379"` | +| redeliverInterval | N | The interval between checking for pending messages to redelivery. Defaults to `"60s"`. `"0"` disables redelivery. | `"30s"` | +| processingTimeout | N | The amount time a message must be pending before attempting to redeliver it. Defaults to `"15s"`. `"0"` disables redelivery. | `"30s"` | +| redisType | N | The type of redis. There are two valid values, one is `"node"` for single node mode, the other is `"cluster"` for redis cluster mode. Defaults to `"node"`. | `"cluster"` | +| redisDB | N | Database selected after connecting to redis. If `"redisType"` is `"cluster"` this option is ignored. Defaults to `"0"`. | `"0"` | | redisMaxRetries | N | Alias for `maxRetries`. If both values are set `maxRetries` is ignored. | `"5"` | | redisMinRetryInterval | N | Minimum backoff for redis commands between each retry. Default is `"8ms"`; `"-1"` disables backoff. | `"8ms"` | | redisMaxRetryInterval | N | Alias for `maxRetryBackoff`. If both values are set `maxRetryBackoff` is ignored. | `"5s"` | | dialTimeout | N | Dial timeout for establishing new connections. Defaults to `"5s"`. | `"5s"` | -| readTimeout | N | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | -| writeTimeout | N | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | -| poolSize | N | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | +| readTimeout | N | Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to `"3s"`, `"-1"` for no timeout. | `"3s"` | +| writeTimeout | N | Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout. | `"3s"` | +| poolSize | N | Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU. | `"20"` | | poolTimeout | N | Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second. | `"5s"` | | maxConnAge | N | Connection age at which the client retires (closes) the connection. Default is to not close aged connections. | `"30m"` | | minIdleConns | N | Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to `"0"`. | `"2"` | -| idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | -| idleTimeout | N | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` | -| actorStateStore | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | +| idleCheckFrequency | N | Frequency of idle checks made by idle connections reaper. Default is `"1m"`. `"-1"` disables idle connections reaper. | `"-1"` | +| idleTimeout | N | Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is `"5m"`. `"-1"` disables idle timeout check. | `"10m"` | +| actorStateStore | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | | ttlInSeconds | N | Allows specifying a default Time-to-live (TTL) in seconds that will be applied to every state store request unless TTL is explicitly defined via the [request metadata]({{< ref "state-store-ttl.md" >}}). | `600` | -| queryIndexes | N | Indexing schemas for querying JSON objects | see [Querying JSON objects](#querying-json-objects) | +| queryIndexes | N | Indexing schemas for querying JSON objects | see [Querying JSON objects](#querying-json-objects) | ## Setup Redis diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-rethinkdb.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-rethinkdb.md index 017cf2a18..41be74eba 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-rethinkdb.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-rethinkdb.md @@ -42,14 +42,14 @@ If the optional `archive` metadata is set to `true`, on each state change, the R ## Spec metadata fields -| Field | Required | Details | Example | -| -------- | :------: | ---------------------------------------- | ------------------------------------------------------------------ | -| address | Y | The address for RethinkDB server | `"127.0.0.1:28015"`, `"rethinkdb.default.svc.cluster.local:28015"` | +| Field | Required | Details | Example | +| -------- | :------: | -------------------------------------------------------- | ------------------------------------------------------------------ | +| address | Y | The address for RethinkDB server | `"127.0.0.1:28015"`, `"rethinkdb.default.svc.cluster.local:28015"` | | database | Y | The database to use. Alpha-numerics only | `"dapr"` | -| table | N | The table name to use | `"table"` | -| username | N | The username to connect with | `"user"` | -| password | N | The password to connect with | `"password"` | -| archive | N | Whether or not to archive the table | `"true"`, `"false"` | +| table | N | The table name to use | `"table"` | +| username | N | The username to connect with | `"user"` | +| password | N | The password to connect with | `"password"` | +| archive | N | Whether or not to archive the table | `"true"`, `"false"` | ## Setup RethinkDB diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlite.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlite.md index 167c1fb2d..2565c229e 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlite.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlite.md @@ -48,16 +48,16 @@ spec: ## Spec metadata fields -| Field | Required | Details | Example | -| ------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | -| `connectionString` | Y | The connection string for the SQLite database. See below for more details. | `"path/to/data.db"`, `"file::memory:?cache=shared"` | -| `timeout` | N | Timeout for operations on the database, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Integers are interpreted as number of seconds. Defaults to `20s` | `"30s"`, `30` | -| `tableName` | N | Name of the table where the data is stored. Defaults to `state`. | `"state"` | -| `metadataTableName` | N | Name of the table used by Dapr to store metadata for the component. Defaults to `metadata`. | `"metadata"` | -| `cleanupInterval` | N | Interval, as a [Go duration](https://pkg.go.dev/time#ParseDuration), to clean up rows with an expired TTL. Setting this to values <=0 disables the periodic cleanup. Default: `0` (i.e. disabled) | `"2h"`, `"30m"`, `-1` | -| `busyTimeout` | N | Interval, as a [Go duration](https://pkg.go.dev/time#ParseDuration), to wait in case the SQLite database is currently busy serving another request, before returning a "database busy" error. Default: `2s` | `"100ms"`, `"5s"` | +| Field | Required | Details | Example | +| ------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | +| `connectionString` | Y | The connection string for the SQLite database. See below for more details. | `"path/to/data.db"`, `"file::memory:?cache=shared"` | +| `timeout` | N | Timeout for operations on the database, as a [Go duration](https://pkg.go.dev/time#ParseDuration). Integers are interpreted as number of seconds. Defaults to `20s` | `"30s"`, `30` | +| `tableName` | N | Name of the table where the data is stored. Defaults to `state`. | `"state"` | +| `metadataTableName` | N | Name of the table used by Dapr to store metadata for the component. Defaults to `metadata`. | `"metadata"` | +| `cleanupInterval` | N | Interval, as a [Go duration](https://pkg.go.dev/time#ParseDuration), to clean up rows with an expired TTL. Setting this to values <=0 disables the periodic cleanup. Default: `0` (i.e. disabled) | `"2h"`, `"30m"`, `-1` | +| `busyTimeout` | N | Interval, as a [Go duration](https://pkg.go.dev/time#ParseDuration), to wait in case the SQLite database is currently busy serving another request, before returning a "database busy" error. Default: `2s` | `"100ms"`, `"5s"` | | `disableWAL` | N | If set to true, disables Write-Ahead Logging for journaling of the SQLite database. You should set this to `false` if the database is stored on a network file system (for example, a folder mounted as a SMB or NFS share). This option is ignored for read-only or in-memory databases. | `"true"`, `"false"` | -| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | +| `actorStateStore` | N | Consider this state store for actors. Defaults to `"false"` | `"true"`, `"false"` | The **`connectionString`** parameter configures how to open the SQLite database. diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlserver.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlserver.md index 468804e46..660fc03e9 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlserver.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-sqlserver.md @@ -70,34 +70,34 @@ If you wish to use SQL server as an [actor state store]({{< ref "state_api.md#co The following metadata options are **required** to authenticate using SQL Server credentials. This is supported on both SQL Server and Azure SQL. -| Field | Required | Details | Example | -| ------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| ------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | `connectionString` | Y | The connection string used to connect.
If the connection string contains the database, it must already exist. Otherwise, if the database is omitted, a default database named "Dapr" is created. | `"Server=myServerName\myInstanceName;Database=myDataBase;User Id=myUsername;Password=myPassword;"` | ### Authenticate using Microsoft Entra ID Authenticating with Microsoft Entra ID is supported with Azure SQL only. All authentication methods supported by Dapr can be used, including client credentials ("service principal") and Managed Identity. -| Field | Required | Details | Example | -| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | +| Field | Required | Details | Example | +| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| `useAzureAD` | Y | Must be set to `true` to enable the component to retrieve access tokens from Microsoft Entra ID. | `"true"` | | `connectionString` | Y | The connection string or URL of the Azure SQL database, **without credentials**.
If the connection string contains the database, it must already exist. Otherwise, if the database is omitted, a default database named "Dapr" is created. | `"sqlserver://myServerName.database.windows.net:1433?database=myDataBase"` | -| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-47e1-b4d5-65447fdd542b"` | -| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-4ba2-a905-acd4d3f8f08b"` | -| `azureClientSecret` | N | Client secret (application password) | `"Ecy3XG7zVZK3/vl/a2NSB+a1zXLa8RnMum/IgD0E"` | +| `azureTenantId` | N | ID of the Microsoft Entra ID tenant | `"cd4b2887-304c-47e1-b4d5-65447fdd542b"` | +| `azureClientId` | N | Client ID (application ID) | `"c7dd251f-811f-4ba2-a905-acd4d3f8f08b"` | +| `azureClientSecret` | N | Client secret (application password) | `"Ecy3XG7zVZK3/vl/a2NSB+a1zXLa8RnMum/IgD0E"` | ### Other metadata options -| Field | Required | Details | Example | -| -------------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| -------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `tableName` | N | The name of the table to use. Alpha-numeric with underscores. Defaults to `"state"` | `"table_name"` | | `metadataTableName` | N | Name of the table Dapr uses to store a few metadata properties. Defaults to `dapr_metadata`. | `"dapr_metadata"` | -| `keyType` | N | The type of key used. Supported values: `"string"` (default), `"uuid"`, `"integer"`. | `"string"` | +| `keyType` | N | The type of key used. Supported values: `"string"` (default), `"uuid"`, `"integer"`. | `"string"` | | `keyLength` | N | The max length of key. Ignored if "keyType" is not `string`. Defaults to `"200"` | `"200"` | -| `schema` | N | The schema to use. Defaults to `"dbo"` | `"dapr"`,`"dbo"` | -| `indexedProperties` | N | List of indexed properties, as a string containing a JSON document. | `'[{"column": "transactionid", "property": "id", "type": "int"}, {"column": "customerid", "property": "customer", "type": "nvarchar(100)"}]'` | +| `schema` | N | The schema to use. Defaults to `"dbo"` | `"dapr"`,`"dbo"` | +| `indexedProperties` | N | List of indexed properties, as a string containing a JSON document. | `'[{"column": "transactionid", "property": "id", "type": "int"}, {"column": "customerid", "property": "customer", "type": "nvarchar(100)"}]'` | | `actorStateStore` | N | Indicates that Dapr should configure this component for the actor state store ([more information]({{< ref "state_api.md#configuring-state-store-for-actors" >}})). | `"true"` | -| `cleanupIntervalInSeconds` | N | Interval, in seconds, to clean up rows with an expired TTL. Default: `"3600"` (i.e. 1 hour). Setting this to values <=0 disables the periodic cleanup. | `"1800"`, `"-1"` | +| `cleanupIntervalInSeconds` | N | Interval, in seconds, to clean up rows with an expired TTL. Default: `"3600"` (i.e. 1 hour). Setting this to values <=0 disables the periodic cleanup. | `"1800"`, `"-1"` | ## Create a Microsoft SQL Server/Azure SQL instance diff --git a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-zookeeper.md b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-zookeeper.md index c2c39cdd8..f63032ff2 100644 --- a/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-zookeeper.md +++ b/src/translated_content/zh_CN/docs/reference/components-reference/supported-state-stores/setup-zookeeper.md @@ -38,10 +38,10 @@ The above example uses secrets as plain strings. It is recommended to use a secr ## Spec metadata fields -| Field | Required | Details | Example | -| ----------------- | :------: | -------------------------------------------------------------- | -------------------------------------------- | -| servers | Y | Comma delimited list of servers | `"zookeeper.default.svc.cluster.local:2181"` | -| sessionTimeout | Y | The session timeout value | `"5s"` | +| Field | Required | Details | Example | +| ----------------- | :------: | ------------------------------------------------------------------------------ | -------------------------------------------- | +| servers | Y | Comma delimited list of servers | `"zookeeper.default.svc.cluster.local:2181"` | +| sessionTimeout | Y | The session timeout value | `"5s"` | | maxBufferSize | N | The maximum size of buffer. Defaults to `"1048576"` | `"1048576"` | | maxConnBufferSize | N | The maximum size of connection buffer. Defaults to `"1048576`" | `"1048576"` | | keyPrefixPath | N | The key prefix path in Zookeeper. No default | `"dapr"` | diff --git a/src/translated_content/zh_CN/docs/reference/environment/_index.md b/src/translated_content/zh_CN/docs/reference/environment/_index.md index 75d305feb..86f0eab88 100644 --- a/src/translated_content/zh_CN/docs/reference/environment/_index.md +++ b/src/translated_content/zh_CN/docs/reference/environment/_index.md @@ -8,25 +8,25 @@ weight: 300 The following table lists the environment variables used by the Dapr runtime, CLI, or from within your application: -| Environment Variable | Used By | Description | -| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| APP_ID | Your application | The id for your application, used for service discovery | -| APP_PORT | Dapr sidecar | 应用程序正在侦听的端口 | -| APP_API_TOKEN | Your application | The token used by the application to authenticate requests from Dapr API. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. | -| DAPR_HTTP_PORT | Your application | The HTTP port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | -| DAPR_GRPC_PORT | Your application | The gRPC port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | -| DAPR_API_TOKEN | Dapr sidecar | The token used for Dapr API authentication for requests from the application. [Enable API token authentication in Dapr]({{< ref api-token >}}). | -| NAMESPACE | Dapr sidecar | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}). | -| DAPR_DEFAULT_IMAGE_REGISTRY | Dapr CLI | In self-hosted mode, it is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr`, it pulls the required images from Github container registry. To default to Docker hub, unset this environment variable. | -| SSL_CERT_DIR | Dapr sidecar | Specifies the location where the public certificates for all the trusted certificate authorities (CA) are located. Not applicable when the sidecar is running as a process in self-hosted mode. | -| DAPR_HELM_REPO_URL | Your private Dapr Helm chart url | Specifies a private Dapr Helm chart url, which defaults to the official Helm chart URL: `https://dapr.github.io/helm-charts` | -| DAPR_HELM_REPO_USERNAME | A username for a private Helm chart | The username required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set | -| DAPR_HELM_REPO_PASSWORD | A password for a private Helm chart | The password required to access the private Dapr helm chart. If it can be accessed publicly, this env variable does not need to be set | -| OTEL_EXPORTER_OTLP_ENDPOINT | OpenTelemetry Tracing | Sets the Open Telemetry (OTEL) server address, turns on tracing. (Example: `http://localhost:4318`) | -| OTEL_EXPORTER_OTLP_INSECURE | OpenTelemetry Tracing | Sets the connection to the endpoint as unencrypted. (`true`, `false`) | -| OTEL_EXPORTER_OTLP_PROTOCOL | OpenTelemetry Tracing | The OTLP protocol to use Transport protocol. (`grpc`, `http/protobuf`, `http/json`) | -| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` | -| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. | -| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) | -| DAPR_HOST_IP | Dapr sidecar | The host's chosen IP address. If not specified, will loop over the network interfaces and select the first non-loopback address it finds. | -| DAPR_HEALTH_TIMEOUT | SDKs | Sets the time on the "wait for sidecar" availability. Overrides the default timeout setting of 60 seconds. | +| Environment Variable | Used By | Description | +| ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| APP_ID | Your application | The id for your application, used for service discovery | +| APP_PORT | Dapr sidecar | 应用程序正在侦听的端口 | +| APP_API_TOKEN | Your application | The token used by the application to authenticate requests from Dapr API. Read [authenticate requests from Dapr using token authentication]({{< ref app-api-token >}}) for more information. | +| DAPR_HTTP_PORT | Your application | The HTTP port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | +| DAPR_GRPC_PORT | Your application | The gRPC port that the Dapr sidecar is listening on. Your application should use this variable to connect to Dapr sidecar instead of hardcoding the port value. Set by the Dapr CLI run command for self-hosted or injected by the `dapr-sidecar-injector` into all the containers in the pod. | +| DAPR_API_TOKEN | Dapr sidecar | The token used for Dapr API authentication for requests from the application. [Enable API token authentication in Dapr]({{< ref api-token >}}). | +| NAMESPACE | Dapr sidecar | Used to specify a component's [namespace in self-hosted mode]({{< ref component-scopes >}}). | +| DAPR_DEFAULT_IMAGE_REGISTRY | Dapr CLI | In self-hosted mode, it is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr`, it pulls the required images from Github container registry. To default to Docker hub, unset this environment variable. | +| SSL_CERT_DIR | Dapr sidecar | Specifies the location where the public certificates for all the trusted certificate authorities (CA) are located. Not applicable when the sidecar is running as a process in self-hosted mode. | +| DAPR_HELM_REPO_URL | Your private Dapr Helm chart url | Specifies a private Dapr Helm chart url, which defaults to the official Helm chart URL: `https://dapr.github.io/helm-charts` | +| DAPR_HELM_REPO_USERNAME | A username for a private Helm chart | The username required to access the private Dapr Helm chart. If it can be accessed publicly, this env variable does not need to be set | +| DAPR_HELM_REPO_PASSWORD | A password for a private Helm chart | The password required to access the private Dapr helm chart. If it can be accessed publicly, this env variable does not need to be set | +| OTEL_EXPORTER_OTLP_ENDPOINT | OpenTelemetry Tracing | Sets the Open Telemetry (OTEL) server address, turns on tracing. (Example: `http://localhost:4318`) | +| OTEL_EXPORTER_OTLP_INSECURE | OpenTelemetry Tracing | Sets the connection to the endpoint as unencrypted. (`true`, `false`) | +| OTEL_EXPORTER_OTLP_PROTOCOL | OpenTelemetry Tracing | The OTLP protocol to use Transport protocol. (`grpc`, `http/protobuf`, `http/json`) | +| DAPR_COMPONENTS_SOCKETS_FOLDER | Dapr runtime and the .NET, Go, and Java pluggable component SDKs | The location or path where Dapr looks for Pluggable Components Unix Domain Socket files. If unset this location defaults to `/tmp/dapr-components-sockets` | +| DAPR_COMPONENTS_SOCKETS_EXTENSION | .NET and Java pluggable component SDKs | A per-SDK configuration that indicates the default file extension applied to socket files created by the SDKs. Not a Dapr-enforced behavior. | +| DAPR_PLACEMENT_METADATA_ENABLED | Dapr placement | Enable an endpoint for the Placement service that exposes placement table information on actor usage. Set to `true` to enable in self-hosted mode. [Learn more about the Placement API]({{< ref placement_api.md >}}) | +| DAPR_HOST_IP | Dapr sidecar | The host's chosen IP address. If not specified, will loop over the network interfaces and select the first non-loopback address it finds. | +| DAPR_HEALTH_TIMEOUT | SDKs | Sets the time on the "wait for sidecar" availability. Overrides the default timeout setting of 60 seconds. | diff --git a/src/translated_content/zh_CN/docs/reference/resource-specs/component-schema.md b/src/translated_content/zh_CN/docs/reference/resource-specs/component-schema.md index 464b2f2a3..c9aac8902 100644 --- a/src/translated_content/zh_CN/docs/reference/resource-specs/component-schema.md +++ b/src/translated_content/zh_CN/docs/reference/resource-specs/component-schema.md @@ -33,33 +33,33 @@ scopes: ## Spec fields -| Field | Required | Details | Example | -| ------------------ | :------: | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| apiVersion | Y | The version of the Dapr (and Kubernetes if applicable) API you are calling | `dapr.io/v1alpha1` | -| kind | Y | The type of resource. For components is must always be `Component` | `Component` | -| auth | N | The name of a secret store where `secretKeyRef` in the metadata lookup the name of secrets used in the component | See [How-to: Reference secrets in components]({{< ref component-secrets >}}) | -| scopes | N | The applications the component is limited to, specified by their app IDs | `order-processor`, `checkout` | -| **metadata** | - | **Information about the component registration** | | -| metadata.name | Y | The name of the component | `prod-statestore` | -| metadata.namespace | N | The namespace for the component for hosting environments with namespaces | `myapp-namespace` | -| **spec** | * | **Detailed information on the component resource** | | -| spec.type | Y | The type of the component | `state.redis` | -| spec.version | Y | The version of the component | `v1` | -| spec.initTimeout | N | The timeout duration for the initialization of the component. Default is 5s | `5m`, `1h`, `20s` | -| spec.ignoreErrors | N | Tells the Dapr sidecar to continue initialization if the component fails to load. Default is false | `false` | -| **spec.metadata** | - | **A key/value pair of component specific configuration. See your component definition for fields** | | -| spec.metadata.name | Y | The name of the component-specific property and its value | `- name: secretsFile`
`value: secrets.json` | +| Field | Required | Details | Example | +| -------------------------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| apiVersion | Y | The version of the Dapr (and Kubernetes if applicable) API you are calling | `dapr.io/v1alpha1` | +| kind | Y | The type of resource. For components is must always be `Component` | `Component` | +| auth | N | The name of a secret store where `secretKeyRef` in the metadata lookup the name of secrets used in the component | See [How-to: Reference secrets in components]({{< ref component-secrets >}}) | +| scopes | N | The applications the component is limited to, specified by their app IDs | `order-processor`, `checkout` | +| **metadata** | - | **Information about the component registration** | | +| metadata.name | Y | The name of the component | `prod-statestore` | +| metadata.namespace | N | The namespace for the component for hosting environments with namespaces | `myapp-namespace` | +| **spec** | * | **Detailed information on the component resource** | | +| spec.type | Y | The type of the component | `state.redis` | +| spec.version | Y | The version of the component | `v1` | +| spec.initTimeout | N | The timeout duration for the initialization of the component. Default is 5s | `5m`, `1h`, `20s` | +| spec.ignoreErrors | N | Tells the Dapr sidecar to continue initialization if the component fails to load. Default is false | `false` | +| **spec.metadata** | - | **A key/value pair of component specific configuration. See your component definition for fields** | | +| spec.metadata.name | Y | The name of the component-specific property and its value | `- name: secretsFile`
`value: secrets.json` | ### Templated metadata values Metadata values can contain template tags that are resolved on Dapr sidecar startup. The table below shows the current templating tags that can be used in components. -| Tag | Details | Example use case | -| ----------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Tag | Details | Example use case | +| ----------- | ------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | {uuid} | Randomly generated UUIDv4 | When you need a unique identifier in self-hosted mode; for example, multiple application instances consuming a [shared MQTT subscription]({{< ref "setup-mqtt3.md" >}}) | -| {podName} | Name of the pod containing the Dapr sidecar | Use to have a persisted behavior, where the ConsumerID does not change on restart when using StatefulSets in Kubernetes | -| {namespace} | Namespace where the Dapr sidecar resides combined with its appId | Using a shared `clientId` when multiple application instances consume a Kafka topic in Kubernetes | -| {appID} | The configured `appID` of the resource containing the Dapr sidecar | Having a shared `clientId` when multiple application instances consumer a Kafka topic in self-hosted mode | +| {podName} | Name of the pod containing the Dapr sidecar | Use to have a persisted behavior, where the ConsumerID does not change on restart when using StatefulSets in Kubernetes | +| {namespace} | Namespace where the Dapr sidecar resides combined with its appId | Using a shared `clientId` when multiple application instances consume a Kafka topic in Kubernetes | +| {appID} | The configured `appID` of the resource containing the Dapr sidecar | Having a shared `clientId` when multiple application instances consumer a Kafka topic in self-hosted mode | Below is an example of using the `{uuid}` tag in an MQTT pubsub component. Note that multiple template tags can be used in a single metadata value. diff --git a/src/translated_content/zh_CN/docs/reference/resource-specs/configuration-schema.md b/src/translated_content/zh_CN/docs/reference/resource-specs/configuration-schema.md index 73e32c32d..2b497f68e 100644 --- a/src/translated_content/zh_CN/docs/reference/resource-specs/configuration-schema.md +++ b/src/translated_content/zh_CN/docs/reference/resource-specs/configuration-schema.md @@ -75,19 +75,19 @@ spec: ### Spec fields -| Field | Required | Details | Example | -| --------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| accessControl | N | Applied to Dapr sidecar for the called application. Enables the configuration of policies that restrict what operations calling applications can perform (via service invocation) on the called appliaction. | [Learn more about the `accessControl` configuration.]({{< ref invoke-allowlist.md >}}) | -| api | N | Used to enable only the Dapr sidecar APIs used by the application. | [Learn more about the `api` configuration.]({{< ref api-allowlist.md >}}) | -| httpPipeline | N | Configure API middleware pipelines | [Middleware pipeline configuration overview]({{< ref "configuration-overview.md#middleware" >}})
[Learn more about the `httpPipeline` configuration.]({{< ref "middleware.md#configure-api-middleware-pipelines" >}}) | -| appHttpPipeline | N | Configure application middleware pipelines | [Middleware pipeline configuration overview]({{< ref "configuration-overview.md#middleware" >}})
[Learn more about the `appHttpPipeline` configuration.]({{< ref "middleware.md#configure-app-middleware-pipelines" >}}) | -| components | N | Used to specify a denylist of component types that can't be initialized. | [Learn more about the `components` configuration.]({{< ref "configuration-overview.md#disallow-usage-of-certain-component-types" >}}) | -| features | N | Defines the preview features that are enabled/disabled. | [Learn more about the `features` configuration.]({{< ref preview-features.md >}}) | -| logging | N | Configure how logging works in the Dapr runtime. | [Learn more about the `logging` configuration.]({{< ref "configuration-overview.md#logging" >}}) | -| 度量 | N | Enable or disable metrics for an application. | [Learn more about the `metrics` configuration.]({{< ref "configuration-overview.md#metrics" >}}) | -| nameResolution | N | Name resolution configuration spec for the service invocation building block. | [Learn more about the `nameResolution` configuration per components.]({{< ref supported-name-resolution.md >}}) | -| secrets | N | Limit the secrets to which your Dapr application has access. | [Learn more about the `secrets` configuration.]({{< ref secret-scope.md >}}) | -| tracing | N | Turns on tracing for an application. | [Learn more about the `tracing` configuration.]({{< ref "configuration-overview.md#tracing" >}}) | +| Field | Required | Details | Example | +| --------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| accessControl | N | Applied to Dapr sidecar for the called application. Enables the configuration of policies that restrict what operations calling applications can perform (via service invocation) on the called appliaction. | [Learn more about the `accessControl` configuration.]({{< ref invoke-allowlist.md >}}) | +| api | N | Used to enable only the Dapr sidecar APIs used by the application. | [Learn more about the `api` configuration.]({{< ref api-allowlist.md >}}) | +| httpPipeline | N | Configure API middleware pipelines | [Middleware pipeline configuration overview]({{< ref "configuration-overview.md#middleware" >}})
[Learn more about the `httpPipeline` configuration.]({{< ref "middleware.md#configure-api-middleware-pipelines" >}}) | +| appHttpPipeline | N | Configure application middleware pipelines | [Middleware pipeline configuration overview]({{< ref "configuration-overview.md#middleware" >}})
[Learn more about the `appHttpPipeline` configuration.]({{< ref "middleware.md#configure-app-middleware-pipelines" >}}) | +| components | N | Used to specify a denylist of component types that can't be initialized. | [Learn more about the `components` configuration.]({{< ref "configuration-overview.md#disallow-usage-of-certain-component-types" >}}) | +| features | N | Defines the preview features that are enabled/disabled. | [Learn more about the `features` configuration.]({{< ref preview-features.md >}}) | +| logging | N | Configure how logging works in the Dapr runtime. | [Learn more about the `logging` configuration.]({{< ref "configuration-overview.md#logging" >}}) | +| 度量 | N | Enable or disable metrics for an application. | [Learn more about the `metrics` configuration.]({{< ref "configuration-overview.md#metrics" >}}) | +| nameResolution | N | Name resolution configuration spec for the service invocation building block. | [Learn more about the `nameResolution` configuration per components.]({{< ref supported-name-resolution.md >}}) | +| secrets | N | Limit the secrets to which your Dapr application has access. | [Learn more about the `secrets` configuration.]({{< ref secret-scope.md >}}) | +| tracing | N | Turns on tracing for an application. | [Learn more about the `tracing` configuration.]({{< ref "configuration-overview.md#tracing" >}}) | ## Control plane format @@ -108,8 +108,8 @@ spec: ### Spec fields -| Field | Required | Details | Example | -| ----- | :------: | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| ----- | :------: | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | mtls | N | Defines the mTLS configuration | `allowedClockSkew: 15m`
`workloadCertTTL:24h`
[Learn more about the `mtls` configuration.]({{< ref "configuration-overview.md#mtls-mutual-tls" >}}) | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/resource-specs/resiliency-schema.md b/src/translated_content/zh_CN/docs/reference/resource-specs/resiliency-schema.md index bc88f9caa..e2f25871c 100644 --- a/src/translated_content/zh_CN/docs/reference/resource-specs/resiliency-schema.md +++ b/src/translated_content/zh_CN/docs/reference/resource-specs/resiliency-schema.md @@ -55,10 +55,10 @@ targets: # Required ## Spec fields -| Field | Required | Details | Example | -| -------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| Field | Required | Details | Example | +| -------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | policies | Y | The configuration of resiliency policies, including:
  • `timeouts`
  • `retries`
  • `circuitBreakers`

[See more examples with all of the built-in policies]({{< ref policies.md >}}) | timeout: `general`
retry: `retryForever`
circuit breaker: `simpleCB` | -| targets | Y | The configuration for the applications, actors, or components that use the resiliency policies.
[See more examples in the resiliency targets guide]({{< ref targets.md >}}) | `apps`
`components`
`actors` | +| targets | Y | The configuration for the applications, actors, or components that use the resiliency policies.
[See more examples in the resiliency targets guide]({{< ref targets.md >}}) | `apps`
`components`
`actors` | ## Related links diff --git a/src/translated_content/zh_CN/docs/reference/resource-specs/subscription-schema.md b/src/translated_content/zh_CN/docs/reference/resource-specs/subscription-schema.md index 7eb0c6e2c..a1c367c31 100644 --- a/src/translated_content/zh_CN/docs/reference/resource-specs/subscription-schema.md +++ b/src/translated_content/zh_CN/docs/reference/resource-specs/subscription-schema.md @@ -38,13 +38,13 @@ scopes: ### Spec fields -| Field | Required | Details | Example | -| --------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | -| topic | Y | The name of the topic to which your component subscribes. | `orders` | +| Field | Required | Details | Example | +| --------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| topic | Y | The name of the topic to which your component subscribes. | `orders` | | routes | Y | The routes configuration for this topic, including specifying the condition for sending a message to a specific path. Includes the following fields:
  • match: The CEL expression used to match the event. If not specified, the route is considered the default.
  • path: The path for events that match this rule.
The endpoint to which all topic messages are sent. | `match: event.type == "widget"`
`path: /widgets` | -| pubsubname | N | The name of your pub/sub component. | `pubsub` | -| deadLetterTopic | N | The name of the dead letter topic that forwards undeliverable messages. | `poisonMessages` | -| bulkSubscribe | N | Enable bulk subscribe properties. | `true`, `false` | +| pubsubname | N | The name of your pub/sub component. | `pubsub` | +| deadLetterTopic | N | The name of the dead letter topic that forwards undeliverable messages. | `poisonMessages` | +| bulkSubscribe | N | Enable bulk subscribe properties. | `true`, `false` | ## `v1alpha1` format @@ -70,8 +70,8 @@ scopes: ### Spec fields -| Field | Required | Details | Example | -| --------------- | :------: | ----------------------------------------------------------------------- | ---------------- | +| Field | Required | Details | Example | +| --------------- | :------: | --------------------------------------------------------------------------------------- | ---------------- | | topic | Y | The name of the topic to which your component subscribes. | `orders` | | route | Y | The endpoint to which all topic messages are sent. | `/checkout` | | pubsubname | N | The name of your pub/sub component. | `pubsub` | diff --git a/src/translated_content/zh_CN/sdks_dotnet/_index.md b/src/translated_content/zh_CN/sdks_dotnet/_index.md index 99675ec69..5ea3b90be 100644 --- a/src/translated_content/zh_CN/sdks_dotnet/_index.md +++ b/src/translated_content/zh_CN/sdks_dotnet/_index.md @@ -32,10 +32,10 @@ dotnet add package Dapr.Client 对 Dapr .NET SDK 进行测试。 演练 .NET 快速入门和教程，了解 Dapr 的实际应用： -| SDK 示例 | 说明 | -| ------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | +| SDK 示例 | 说明 | +| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | | [快速入门]({{< ref quickstarts >}}) | 使用 .NET SDK 在短短几分钟内体验 Dapr 的 API 构建块。 | -| [SDK示例](https://github.com/dapr/dotnet-sdk/tree/master/examples) | 克隆 SDK 存储库以尝试一些示例并开始使用。 | +| [SDK示例](https://github.com/dapr/dotnet-sdk/tree/master/examples) | 克隆 SDK 存储库以尝试一些示例并开始使用。 | | [发布/订阅教程](https://github.com/dapr/quickstarts/tree/master/tutorials/pub-sub) | 了解 Dapr .NET SDK 如何与其他 Dapr SDK 协同工作，以启用发布/订阅应用程序。 | ## 可用软件包 @@ -47,7 +47,7 @@ dotnet add package Dapr.Client

创建与 Dapr sidecar 和其他 Dapr 应用程序交互的 .NET 客户端。

- + @@ -65,7 +65,7 @@ dotnet add package Dapr.Client

在 .NET 中创建具有状态、提醒/计时器和方法的 virtual actor。

- + @@ -74,7 +74,7 @@ dotnet add package Dapr.Client

创建和管理与 .NET 中的其他 Dapr API 配合使用的工作流。

- + 了解 .NET Dapr 应用程序的本地开发选项

- + diff --git a/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-client.md b/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-client.md index 9b1751557..b41930ee6 100644 --- a/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-client.md +++ b/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-client.md @@ -45,10 +45,10 @@ public Task GetDataAsync() Actor客户端支持两种不同的调用方式： -| Actor 客户端样式 | 说明 | -| ----------- | ------------------------------------------------------ | +| Actor 客户端样式 | 说明 | +| ----------- | -------------------------------------------------------------------------------------- | | 强类型 | 强类型的客户端是基于 .NET 接口的，提供了强类型的典型优点。 他们无法与非.NET actor 互操作。 | -| 弱类型 | 弱类型的客户端使用`ActorProxy`类。 建议仅在需要时，出于互操作或其他高级原因使用这些。 | +| 弱类型 | 弱类型的客户端使用`ActorProxy`类。 建议仅在需要时，出于互操作或其他高级原因使用这些。 | ### 使用强类型客户端 diff --git a/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-serialization.md b/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-serialization.md index a51665409..da63d5f41 100644 --- a/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-serialization.md +++ b/src/translated_content/zh_CN/sdks_dotnet/dotnet-actors/dotnet-actors-serialization.md @@ -275,7 +275,7 @@ public record Doodad( - [Uri](https://learn.microsoft.com/zh-cn/dotnet/api/system.uri) - [XmlQualifiedName](https://learn.microsoft.com/zh-cn/dotnet/api/system.xml.xmlqualifiedname) -再次，如果您想通过您的Actor方法传递这些类型，无需额外考虑，因为它们会被序列化和反序列化而无问题。 此外，自身标有(SerializeableAttribute)[https\://learn.microsoft.com/en-us/dotnet/api/system.serializableattribute]属性的类型将被序列化。 +再次，如果您想通过您的Actor方法传递这些类型，无需额外考虑，因为它们会被序列化和反序列化而无问题。 此外，自身标有(SerializeableAttribute)[https://learn.microsoft.com/en-us/dotnet/api/system.serializableattribute]属性的类型将被序列化。 ### 枚举类型 diff --git a/src/translated_content/zh_CN/sdks_dotnet/dotnet-client/_index.md b/src/translated_content/zh_CN/sdks_dotnet/dotnet-client/_index.md index b1b8723fe..83093fdfc 100644 --- a/src/translated_content/zh_CN/sdks_dotnet/dotnet-client/_index.md +++ b/src/translated_content/zh_CN/sdks_dotnet/dotnet-client/_index.md @@ -16,7 +16,7 @@ Dapr 客户端包允许您从 .NET 应用程序中与其他 Dapr 应用程序进 ## 构建块 -.NET SDK 允许您与所有的[Dapr构建块]({{< ref building-blocks >}})进行接口交互。 +.NET SDK 允许您与所有的[Dapr构建块]({{< ref building-blocks >}}}进行接口交互。 ### 调用服务 diff --git a/src/translated_content/zh_CN/sdks_dotnet/dotnet-troubleshooting/dotnet-troubleshooting-pubsub.md b/src/translated_content/zh_CN/sdks_dotnet/dotnet-troubleshooting/dotnet-troubleshooting-pubsub.md index 83525310a..353665e67 100644 --- a/src/translated_content/zh_CN/sdks_dotnet/dotnet-troubleshooting/dotnet-troubleshooting-pubsub.md +++ b/src/translated_content/zh_CN/sdks_dotnet/dotnet-troubleshooting/dotnet-troubleshooting-pubsub.md @@ -89,7 +89,7 @@ curl http://localhost:5000/dapr/subscribe -v ] ``` -*** +--- 有了这个命令的输出，你就可以诊断问题或进入下一步了。 @@ -121,7 +121,7 @@ app.UseEndpoints(endpoints => 如果JSON输出是一个空数组 (如 `[]`)，那么订阅处理程序将被注册，但没有任何topic终结点。 -*** +--- 如果你正在使用一个控制器来处理 发布/订阅 ，你应该有一个类似的方法： @@ -138,7 +138,7 @@ public async Task Withdraw(...) 在这个例子中，`Topic` 和 `HttpPost` 属性是必需的，但其他细节可能有所不同。 -*** +--- 如果你使用的是 发布/订阅 的路由，你应该有一个终结点，比如： @@ -148,7 +148,7 @@ endpoints.MapPost("deposit", ...).WithTopic("pubsub", "deposit"); 在这个示例中，调用 `WithTopic(...)` 是必需的，但其他细节可能不同。 -*** +--- **在纠正这段代码并重新测试后，如果JSON输出仍然是空数组（像 `[]` ），那么请在这个仓库上打开一个问题，并包含 `Startup.cs` 的内容和你的发布/订阅终结点。** diff --git a/src/translated_content/zh_CN/sdks_dotnet/dotnet-workflow/dotnet-workflow-howto.md b/src/translated_content/zh_CN/sdks_dotnet/dotnet-workflow/dotnet-workflow-howto.md index 9e02766d8..e4446befc 100644 --- a/src/translated_content/zh_CN/sdks_dotnet/dotnet-workflow/dotnet-workflow-howto.md +++ b/src/translated_content/zh_CN/sdks_dotnet/dotnet-workflow/dotnet-workflow-howto.md @@ -160,7 +160,7 @@ info: WorkflowConsoleApp.Activities.NotifyActivity[0] Order 12345678 processed successfully! ``` -如果您在计算机上本地为 Dapr 配置了 Zipkin，则可以在 Zipkin Web UI 中查看工作流的 trace span（通常在 http\://localhost:9411/zipkin/）。 +如果您在计算机上本地为 Dapr 配置了 Zipkin，则可以在 Zipkin Web UI 中查看工作流的 trace span（通常在 http://localhost:9411/zipkin/）。 ## 例子 diff --git a/src/translated_content/zh_CN/sdks_java/_index.md b/src/translated_content/zh_CN/sdks_java/_index.md index 30c3872a1..c5a2c5806 100644 --- a/src/translated_content/zh_CN/sdks_java/_index.md +++ b/src/translated_content/zh_CN/sdks_java/_index.md @@ -137,7 +137,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {

创建 Java 客户端，与 Dapr sidecar 和其他 Dapr 应用程序进行交互。

- + @@ -146,7 +146,7 @@ try (DaprClient client = (new DaprClientBuilder()).build()) {

创建和管理与其他Dapr API配合工作的工作流（Workflow）（使用Java）。

- + - + Dapr Server Dapr Client - + ## Getting Started @@ -45,23 +45,29 @@ To help you get started, check out the resources below:
-
Client
+
客户端

Create a JavaScript client and interact with the Dapr sidecar and other Dapr applications (e.g., publishing events, output binding support, etc.).

- + + +
-
Server
+
服务器

Create a JavaScript server and let the Dapr sidecar interact with your application (e.g., subscribing to events, input binding support, etc.).

- + + +
Actors

Create virtual actors with state, reminders/timers, and methods.

- + + +
Logging

Configure and customize the SDK logging.

- + + +
Examples

Clone the JavaScript SDK source code and try out some of the examples to get started quickly.

- + + + 编写Python应用程序与Dapr sidecar和其他Dapr应用程序进行交互，包括在Python中使用有状态的 virtual actors

- + @@ -72,7 +72,7 @@ Python SDK 导入是主 SDK 安装中包含的子包，但在使用时需要导

创建并与Dapr的Actor框架交互。

- + 使用 gRPC 服务器扩展创建 Dapr 服务。

- + @@ -99,7 +99,7 @@ SDK扩展主要作为接收发布/订阅事件的实用工具，以编程方式

使用Dapr FastAPI扩展与Dapr Python虚拟actor和发布/订阅进行集成。

- + @@ -108,7 +108,7 @@ SDK扩展主要作为接收发布/订阅事件的实用工具，以编程方式

使用Dapr Flask扩展与Dapr Python virtual actors 集成。

- + @@ -117,7 +117,7 @@ SDK扩展主要作为接收发布/订阅事件的实用工具，以编程方式

使用Python编写与其他Dapr API配合工作的工作流。

- + 了解Dapr SDK中的序列化更多信息。

- +