From 0cc4b38d8868991df20b8a5c7c070c120a2ad0c0 Mon Sep 17 00:00:00 2001 From: Zheng Dayu Date: Thu, 20 Jan 2022 06:28:25 +0800 Subject: [PATCH 1/6] add alibabacloud oos parameter store docs (#2111) Signed-off-by: Zheng Dayu Co-authored-by: Yaron Schneider --- .../supported-secret-stores/_index.md | 6 ++ .../alicloud-oos-parameter-store.md | 56 +++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md index 16dc4879f..a6509a8e4 100644 --- a/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md @@ -46,3 +46,9 @@ Table captions: | Name | Status | Component version | Since | |---------------------------------------------------------------------------------------|--------| ---- |--------------| | [Azure Key Vault]({{< ref azure-keyvault.md >}}) | Stable | v1 | 1.0 | + +### Alibaba Cloud + +| Name | Status | Component version | Since | +|---------------------------------------------------------------------------------------|--------| ---- |--------------| +| [AlibabaCloud OOS Parameter Store]({{< ref alicloud-oos-parameter-store.md >}}) | Alpha | v1 | 1.6 | diff --git a/daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md b/daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md new file mode 100644 index 000000000..7ceaefa84 --- /dev/null +++ b/daprdocs/content/en/reference/components-reference/supported-secret-stores/alicloud-oos-parameter-store.md @@ -0,0 +1,56 @@ +--- +type: docs +title: "AlibabaCloud OOS Parameter Store" +linkTitle: "AlibabaCloud OOS Parameter Store" +description: Detailed information on the AlibabaCloud OOS Parameter Store - secret store component +aliases: + - "/operations/components/setup-secret-store/supported-secret-stores/alibabacloud-oos-parameter-store/" +--- + +## Component format + +To setup AlibabaCloud OOS Parameter Store secret store create a component of type `secretstores.alicloud.parameterstore`. See [this guide]({{< ref "setup-secret-store.md#apply-the-configuration" >}}) on how to create and apply a secretstore configuration. See this guide on [referencing secrets]({{< ref component-secrets.md >}}) to retrieve and use the secret with Dapr components. + +```yaml +apiVersion: dapr.io/v1alpha1 +kind: Component +metadata: + name: alibabacloudparameterstore + namespace: default +spec: + type: secretstores.alicloud.parameterstore + version: v1 + metadata: + - name: regionId + value: "[alicloud_region_id]" + - name: accessKeyId + value: "[alicloud_access_key_id]" + - name: accessKeySecret + value: "[alicloud_access_key_secret]" + - name: securityToken + value: "[alicloud_security_token]" +``` + +{{% alert title="Warning" color="warning" %}} +The above example uses secrets as plain strings. It is recommended to use a local secret store such as [Kubernetes secret store]({{< ref kubernetes-secret-store.md >}}) or a [local file]({{< ref file-secret-store.md >}}) to bootstrap secure key storage. +{{% /alert %}} + +## Spec metadata fields + +| Field | Required | Details | Example | +|--------------------|:--------:|-------------------------------------------------------------------------|---------------------| +| regionId | Y | The specific region the AlibabaCloud OOS Parameter Store instance is deployed in | `"cn-hangzhou"` | +| accessKeyId | Y | The AlibabaCloud Access Key ID to access this resource | `"accessKeyId"` | +| accessKeySecret | Y | The AlibabaCloud Access Key Secret to access this resource | `"accessKeySecret"` | +| securityToken | N | The AlibabaCloud Security Token to use | `"securityToken"` | + +## 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. + +## Related links + +- [Secrets building block]({{< ref secrets >}}) +- [How-To: Retrieve a secret]({{< ref "howto-secrets.md" >}}) +- [How-To: Reference secrets in Dapr components]({{< ref component-secrets.md >}}) +- [Secrets API reference]({{< ref secrets_api.md >}}) From 604485977b22c9f66ac008f5b358fe03859fed5f Mon Sep 17 00:00:00 2001 From: greenie-msft <56556602+greenie-msft@users.noreply.github.com> Date: Wed, 19 Jan 2022 16:26:44 -0800 Subject: [PATCH 2/6] Upmerge v1.5 to v1.6 20220119 (#2119) * moving middleware to samples Signed-off-by: Paul Yuknewicz * Updated middleware doc to point to updated sample location Signed-off-by: Paul Yuknewicz * Fixing one more link after moving middleware code from quickstarts to samples repo Signed-off-by: Paul Yuknewicz Co-authored-by: Paul Yuknewicz --- daprdocs/content/en/developing-applications/middleware.md | 2 +- daprdocs/content/en/getting-started/quickstarts.md | 1 - .../supported-middleware/middleware-oauth2.md | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/developing-applications/middleware.md b/daprdocs/content/en/developing-applications/middleware.md index a48ceac16..282cffd2d 100644 --- a/daprdocs/content/en/developing-applications/middleware.md +++ b/daprdocs/content/en/developing-applications/middleware.md @@ -74,4 +74,4 @@ After the components-contrib change has been accepted, submit another pull reque * [Component schema]({{< ref component-schema.md >}}) * [Configuration overview]({{< ref configuration-overview.md >}}) -* [Middleware quickstart](https://github.com/dapr/quickstarts/tree/master/middleware) +* [Middleware sample](https://github.com/dapr/samples/tree/master/middleware-oauth-google) diff --git a/daprdocs/content/en/getting-started/quickstarts.md b/daprdocs/content/en/getting-started/quickstarts.md index de6a3313c..ecf04966a 100644 --- a/daprdocs/content/en/getting-started/quickstarts.md +++ b/daprdocs/content/en/getting-started/quickstarts.md @@ -22,7 +22,6 @@ The [Dapr Quickstarts](https://github.com/dapr/quickstarts/tree/v1.5.0) are a co | [Distributed Calculator](https://github.com/dapr/quickstarts/tree/v1.5.0/distributed-calculator) | Demonstrates a distributed calculator application that uses Dapr services to power a React web app. Highlights polyglot (multi-language) programming, service invocation and state management. | | [Pub/Sub](https://github.com/dapr/quickstarts/tree/v1.5.0/pub-sub) | Demonstrates how to use Dapr to enable pub-sub applications. Uses Redis as a pub-sub component. | | [Bindings](https://github.com/dapr/quickstarts/tree/v1.5.0/bindings) | Demonstrates how to use Dapr to create input and output bindings to other components. Uses bindings to Kafka. | -| [Middleware](https://github.com/dapr/quickstarts/tree/v1.5.0/middleware) | Demonstrates use of Dapr middleware to enable OAuth 2.0 authorization. | | [Observability](https://github.com/dapr/quickstarts/tree/v1.5.0/observability) | Demonstrates Dapr tracing capabilities. Uses Zipkin as a tracing component. | | [Secret Store](https://github.com/dapr/quickstarts/tree/v1.5.0/secretstore) | Demonstrates the use of Dapr Secrets API to access secret stores. | diff --git a/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md b/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md index 7097835a1..90e0a3fa1 100644 --- a/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md +++ b/daprdocs/content/en/reference/components-reference/supported-middleware/middleware-oauth2.md @@ -74,7 +74,7 @@ spec: ## Related links - [Configure API authorization with OAuth]({{< ref oauth >}}) -- [Middleware OAuth quickstart](https://github.com/dapr/quickstarts/tree/master/middleware) +- [Middleware OAuth sample (interactive)](https://github.com/dapr/samples/tree/master/middleware-oauth-google) - [Middleware]({{< ref middleware.md >}}) - [Configuration concept]({{< ref configuration-concept.md >}}) - [Configuration overview]({{< ref configuration-overview.md >}}) From 429bce6f30e4a7384d41ddcecf2d448441f1c35c Mon Sep 17 00:00:00 2001 From: Shivam Kumar Date: Fri, 21 Jan 2022 00:14:31 +0530 Subject: [PATCH 3/6] Update MQTT pubsub to beta (#2113) Signed-off-by: shivam Co-authored-by: Mark Fussell --- .../reference/components-reference/supported-pubsub/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md index fb78b1374..4d5c1ccd0 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md @@ -24,7 +24,7 @@ Table captions: |-------------------------------------------------------|--------| -----| ------------- | | [Apache Kafka]({{< ref setup-apache-kafka.md >}}) | Stable | v1 | 1.5 | | [Hazelcast]({{< ref setup-hazelcast.md >}}) | Alpha | v1 | 1.0 | -| [MQTT]({{< ref setup-mqtt.md >}}) | Alpha | v1 | 1.0 | +| [MQTT]({{< ref setup-mqtt.md >}}) | Beta | v1 | 1.6 | | [NATS Streaming]({{< ref setup-nats-streaming.md >}}) | Beta | v1 | 1.0 | | [In Memory]({{< ref setup-inmemory.md >}}) | Alpha | v1 | 1.4 | | [JetStream]({{< ref setup-jetstream.md >}}) | Alpha | v1 | 1.4 | From 888f47f145ee7f7c8d70409d9d73f7e943b02c28 Mon Sep 17 00:00:00 2001 From: Abel Perez Martinez Date: Thu, 20 Jan 2022 18:59:05 +0000 Subject: [PATCH 4/6] Added notes for EKS users to watch out for hostnework issue (#2112) Signed-off-by: Abel Perez Martinez Co-authored-by: Mark Fussell --- .../troubleshooting/common_issues.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/daprdocs/content/en/operations/troubleshooting/common_issues.md b/daprdocs/content/en/operations/troubleshooting/common_issues.md index f63e0d54d..c374dd00f 100644 --- a/daprdocs/content/en/operations/troubleshooting/common_issues.md +++ b/daprdocs/content/en/operations/troubleshooting/common_issues.md @@ -64,6 +64,32 @@ In order to further diagnose any issue, check the logs of the Dapr sidecar injec *Note: If you installed Dapr to a different namespace, replace dapr-system above with the desired namespace* +If you are deploying Dapr on Amazon EKS and using an overlay network such as Calico, you will need to set `hostNetwork` parameter to true, this is a limitation of EKS with such CNIs. + +You can set this parameter using Helm `values.yaml` file: + +``` +helm upgrade --install dapr dapr/dapr \ + --namespace dapr-system \ + --create-namespace \ + --values values.yaml +``` + +`values.yaml` +```yaml +dapr_sidecar_injector: + hostNetwork: true +``` + +or using command line: + +``` +helm upgrade --install dapr dapr/dapr \ + --namespace dapr-system \ + --create-namespace \ + --set dapr_sidecar_injector.hostNetwork=true +``` + ## My pod is in CrashLoopBackoff or another failed state due to the daprd sidecar If the Dapr sidecar (`daprd`) is taking too long to initialize, this might be surfaced as a failing health check by Kubernetes. From 33981f34f8752d87c3856873efdc98d583eb7177 Mon Sep 17 00:00:00 2001 From: greenie-msft <56556602+greenie-msft@users.noreply.github.com> Date: Thu, 20 Jan 2022 12:35:59 -0800 Subject: [PATCH 5/6] List the specific software dependencies tested for a given Dapr releaseList (#2105) * List the specific software dependencies tested for a given Dapr releaseList Signed-off-by: Nick Greenfield * Add OTEL link Signed-off-by: Nick Greenfield * Change OTEL link Signed-off-by: Nick Greenfield Co-authored-by: Mark Fussell --- .../en/operations/support/support-release-policy.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/daprdocs/content/en/operations/support/support-release-policy.md b/daprdocs/content/en/operations/support/support-release-policy.md index 6bd27c761..7bed1e92d 100644 --- a/daprdocs/content/en/operations/support/support-release-policy.md +++ b/daprdocs/content/en/operations/support/support-release-policy.md @@ -95,9 +95,14 @@ After announcing a future breaking change, the change will happen in 2 releases ## Upgrade on Hosting platforms Dapr can support multiple hosting platforms for production. With the 1.0 release the two supported platforms are Kubernetes and physical machines. For Kubernetes upgrades see [Production guidelines on Kubernetes]({{< ref kubernetes-production.md >}}) -### Supported Kubernetes versions +### Supported versions of dependencies +Below is a list of software that the latest version of Dapr (v{{% dapr-latest-version long="true" %}}) has been tested against. -Dapr follows [Kubernetes Version Skew Policy](https://kubernetes.io/releases/version-skew-policy). +| 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 | ## Related links * Read the [Versioning policy]({{< ref support-versioning.md >}}) From 6d7f5c86c68c9382c83f48f197caa176ed02bd63 Mon Sep 17 00:00:00 2001 From: Taction Date: Fri, 21 Jan 2022 05:15:57 +0800 Subject: [PATCH 6/6] Feature/pulsar: Add tenant namespace and backoff doc (#1930) * Add tenant namespace and backoff Signed-off-by: Taction * fix review Signed-off-by: Taction Co-authored-by: Mark Fussell --- .../supported-pubsub/setup-pulsar.md | 27 ++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md index 2c4a25a23..834df5457 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md @@ -24,14 +24,35 @@ spec: value: "localhost:6650" - name: enableTLS value: "false" -``` + - name: tenant + value: "public" + - name: namespace + value: "default" + - name: persistent + value: "true" + - name: backOffPolicy + value: "constant" + - name: backOffMaxRetries + value: "-1" +``` ## Spec metadata fields | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| -| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"`| -| enableTLS | N | Enable TLS. Default: `"false"` | `"true"`, `"false"`| +| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"` +| 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"` +| 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 kind 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. Note: the default retry behavior is to retry until it succeeds, so when you use a non-persistent theme, you can reduce or prohibit retries by defining `backOffMaxRetries` to `0`. Default: `"true"` | `"true"`, `"false"` +| backOffPolicy | N | Retry policy, `"constant"` is a backoff policy that always returns the same backoff delay. `"exponential"` is a backoff policy that increases the backoff period for each retry attempt using a randomization function that grows exponentially. Defaults to `"constant"`. | `constant`、`exponential` | +| backOffDuration | N | The fixed interval only takes effect when the `backOffPolicy` is `"constant"`. 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". Defaults to `"5s"`. | `"5s"`、`"5000"` | +| backOffInitialInterval | N | The backoff initial interval on retry. Only takes effect when the `backOffPolicy` is `"exponential"`. 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". Defaults to `"500"` | `"50"` | +| backOffMaxInterval | N | The backoff initial interval on retry. Only takes effect when the `backOffPolicy` is `"exponential"`. 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". Defaults to `"60s"` | `"60000"` | +| backOffMaxRetries | N | The maximum number of retries to process the message before returning an error. Defaults to `"0"` which means the component will not retry processing the message. `"-1"` will retry indefinitely until the message is processed or the application is shutdown. Any positive number is treated as the maximum retry count. | `"3"` | +| backOffRandomizationFactor | N | Randomization factor, between 1 and 0, including 0 but not 1. Randomized interval = RetryInterval * (1 ± backOffRandomizationFactor). Defaults to `"0.5"`. | `"0.5"` | +| backOffMultiplier | N | Backoff multiplier for the policy. Increments the interval by multiplying it with the multiplier. Defaults to `"1.5"` | `"1.5"` | +| backOffMaxElapsedTime | N | After MaxElapsedTime the ExponentialBackOff returns Stop. 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". Defaults to `"15m"` | `"15m"` | ### Delay queue