diff --git a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-message-ttl.md b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-message-ttl.md index bfffdd315..a30acdc52 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-message-ttl.md +++ b/daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-message-ttl.md @@ -55,9 +55,7 @@ with DaprClient() as d: pubsub_name='pubsub', topic='TOPIC_A', data=json.dumps(req_data), - metadata=( - ('ttlInSeconds', '120') - ) + publish_metadata={'ttlInSeconds': '120'} ) # Print the request print(req_data, flush=True) diff --git a/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-services-grpc.md b/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-services-grpc.md index 8639791a7..d4f810aa5 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-services-grpc.md +++ b/daprdocs/content/en/developing-applications/building-blocks/service-invocation/howto-invoke-services-grpc.md @@ -90,7 +90,7 @@ spec: Run the sidecar and the Go server: ```bash -dapr run --app-id server --app-protocol grpc --app-port 50051 --config config.yaml -- go run main.go +dapr run --app-id server --app-port 50051 --config config.yaml -- go run main.go ``` Using the Dapr CLI, we're assigning a unique id to the app, `server`, using the `--app-id` flag. diff --git a/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-state-query-api.md b/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-state-query-api.md index b0e4a040c..4a5bd7cca 100644 --- a/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-state-query-api.md +++ b/daprdocs/content/en/developing-applications/building-blocks/state-management/howto-state-query-api.md @@ -17,8 +17,13 @@ The state query API provides a way of querying the key/value data stored in stat Even though the state store is a key/value store, the `value` might be a JSON document with its own hierarchy, keys, and values. The query API allows you to use those keys and values to retrive corresponding documents. -This query API does not support querying of actor state stored in a state store. For that you need to use the query API for the specific database. -See [querying actor state]({{< ref "state-management-overview.md#querying-actor-state" >}}). +### Limitations +The state query API has the following limitations: + + - The API does not support querying of actor state stored in a state store. For that you need to use the query API for the specific database. See [querying actor state]({{< ref "state-management-overview.md#querying-actor-state" >}}). + - The API does not work with Dapr [encrypted state stores]({{}}) capability. Since the encryption is done by the Dapr runtime and stored as encrypted data, then this effectively prevents server side querying. + + You can find additional information in the [related links]({{< ref "#related-links" >}}) section. 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/operations/hosting/kubernetes/cluster/setup-kind.md b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-kind.md new file mode 100644 index 000000000..528781b1b --- /dev/null +++ b/daprdocs/content/en/operations/hosting/kubernetes/cluster/setup-kind.md @@ -0,0 +1,111 @@ +--- +type: docs +title: "Set up a KiND cluster" +linkTitle: "KiND" +weight: 1100 +description: > + How to set up Dapr on a KiND cluster. +--- + +# Set up a KiND cluster + +## Prerequisites + +- [Docker](https://docs.docker.com/install/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) + +> Note: For Windows, enable Virtualization in BIOS and [install Hyper-V](https://docs.microsoft.com/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v) + +## Install and configure KiND + +Make sure you follow one of the [Installation](https://kind.sigs.k8s.io/docs/user/quick-start) options for KiND. + +In case you are using Docker Desktop, double-check that you have performed the recommended [settings](https://kind.sigs.k8s.io/docs/user/quick-start#settings-for-docker-desktop) (4 CPUs and 8 GiB of RAM available to Docker Engine). + +## Configure and create the KiND cluster + +1. Create a file named `kind-cluster-config.yaml`, and paste the following: +```yaml +kind: Cluster +apiVersion: kind.x-k8s.io/v1alpha4 +nodes: +- role: control-plane + kubeadmConfigPatches: + - | + kind: InitConfiguration + nodeRegistration: + kubeletExtraArgs: + node-labels: "ingress-ready=true" + extraPortMappings: + - containerPort: 80 + hostPort: 8081 + protocol: TCP + - containerPort: 443 + hostPort: 8443 + protocol: TCP +- role: worker +- role: worker +``` + +This is going to request KiND to spin up a kubernetes cluster comprised of a control plane and two worker nodes. It also allows for future setup of ingresses and exposes container ports to the host machine. + +2. Run the `kind create cluster` providing the cluster configuration file: + +```bash +kind create cluster --config kind-cluster-config.yaml +``` + +Wait until the cluster is created, the output should look like this: + +```md +Creating cluster "kind" ... + โœ“ Ensuring node image (kindest/node:v1.21.1) ๐Ÿ–ผ + โœ“ Preparing nodes ๐Ÿ“ฆ ๐Ÿ“ฆ ๐Ÿ“ฆ + โœ“ Writing configuration ๐Ÿ“œ + โœ“ Starting control-plane ๐Ÿ•น๏ธ + โœ“ Installing CNI ๐Ÿ”Œ + โœ“ Installing StorageClass ๐Ÿ’พ + โœ“ Joining worker nodes ๐Ÿšœ +Set kubectl context to "kind-kind" +You can now use your cluster with: + +kubectl cluster-info --context kind-kind + +Thanks for using kind! ๐Ÿ˜Š +``` + +## Dapr + +1. Initialize Dapr: +```bash +dapr init --kubernetes +``` + +Once Dapr finishes initializing its core components are ready to be used on the cluster. + +To verify the status of these components run: +```bash +dapr status -k +``` +the output should look like this: + +```md + NAME NAMESPACE HEALTHY STATUS REPLICAS VERSION AGE CREATED + dapr-sentry dapr-system True Running 1 1.5.1 53s 2021-12-10 09:27.17 + dapr-operator dapr-system True Running 1 1.5.1 53s 2021-12-10 09:27.17 + dapr-sidecar-injector dapr-system True Running 1 1.5.1 53s 2021-12-10 09:27.17 + dapr-dashboard dapr-system True Running 1 0.9.0 53s 2021-12-10 09:27.17 + dapr-placement-server dapr-system True Running 1 1.5.1 52s 2021-12-10 09:27.18 +``` + +2. Forward a port to [Dapr dashboard](https://docs.dapr.io/reference/cli/dapr-dashboard/): + +```bash +dapr dashboard -k -p 9999 +``` + +So that you can validate that the setup finished successfully by navigating to `http://localhost:9999`. + +## Next steps +- [Try out a Dapr quickstart]({{< ref quickstarts.md >}}) + diff --git a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md index effa47c6b..f7c01a923 100644 --- a/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md +++ b/daprdocs/content/en/operations/hosting/kubernetes/kubernetes-production.md @@ -87,8 +87,9 @@ helm search repo dapr --devel --versions # create a values file to store variables touch values.yml cat << EOF >> values.yml -global.ha.enabled: true - +global: + ha: + enabled: true EOF # run install/upgrade 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 >}}) 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. 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 >}}) 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 | diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-aws-snssqs.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-aws-snssqs.md index 4d1c1b802..627055f5a 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-aws-snssqs.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-aws-snssqs.md @@ -26,16 +26,35 @@ spec: value: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" - name: region value: "us-east-1" - - name: sessionToken - value: "TOKEN" - - name: messageVisibilityTimeout - value: 10 - - name: messageRetryLimit - value: 10 - - name: messageWaitTimeSeconds - value: 1 - - name: messageMaxNumber - value: 10 + # - name: endpoint # Optional. + # value: "http://localhost:4566" + # - name: sessionToken # Optional (mandatory if using AssignedRole, i.e. temporary accessKey and secretKey) + # value: "TOKEN" + # - name: messageVisibilityTimeout # Optional + # value: 10 + # - name: messageRetryLimit # Optional + # value: 10 + # - name: messageReceiveLimit # Optional + # value: 10 + # - name: sqsDeadLettersQueueName # Optional + # - value: "myapp-dlq" + # - name: messageWaitTimeSeconds # Optional + # value: 1 + # - name: messageMaxNumber # Optional + # value: 10 + # - name: fifo # Optional + # value: "true" + # - name: fifoMessageGroupID # Optional + # value: "app1-mgi" + # - name: disableEntityManagement # Optional + # value: "false" + # - name: disableDeleteOnRetryLimit # Optional + # value: "false" + # - name: assetsManagementTimeoutSeconds # Optional + # value: 5 + + + ``` {{% alert title="Warning" color="warning" %}} @@ -46,22 +65,42 @@ The above example uses secrets as plain strings. It is recommended to use a secr | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| -| accessKey | Y | ID of the AWS account with appropriate permissions to SNS and SQS. Can be `secretKeyRef` to use a secret reference | `"AKIAIOSFODNN7EXAMPLE"` -| secretKey | Y | Secret for the AWS user. Can be `secretKeyRef` to use a secret reference |`"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"` -| region | Y | 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 SNS and SQS 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"` -| 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 |amount of time to await receipt of a message before making another request. Default: `1` | `1` -| messageMaxNumber | N |maximum number of messages to receive from the queue at a time. Default: `10`, Maximum: `10` | `10` +| 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"` +| 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 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"` +| 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` + + +* Dapr created SNS topic and SQS queue names conform with [AWS specifications](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-queues.html). By default, Dapr creates an SQS queue name based on the consumer `app-id`, therefore Dapr might perform name standardization to meet with AWS specifications. +* Using SQS FIFO (`fifo` metadata field set to `"true"`), per AWS specifications, provides message ordering and deduplication, but incurs a lower SQS processing throughput, among other caveats +* Be aware that specifying `fifoMessageGroupID` limits the number of concurrent consumers of the FIFO queue used to only one but guarantees global ordering of messages published by the app's Dapr sidecars. See [this](https://aws.amazon.com/blogs/compute/solving-complex-ordering-challenges-with-amazon-sqs-fifo-queues/) post to better understand the topic of Message Group IDs and FIFO queues. + + ## Create an SNS/SQS instance {{< tabs "Self-Hosted" "Kubernetes" "AWS" >}} {{% codetab %}} -For local development the [localstack project](https://github.com/localstack/localstack) is used to integrate AWS SNS/SQS. Follow the instructions [here](https://github.com/localstack/localstack#installing) to install the localstack CLI. +For local development the [localstack project](https://github.com/localstack/localstack) is used to integrate AWS SNS/SQS. Follow the instructions [here](https://github.com/localstack/localstack#running) to run localstack. + +To run localstack locally from the command line using Docker, apply the following cmd: +```shell +docker run --rm -it -p 4566:4566 -p 4571:4571 -e SERVICES="sts,sns,sqs" -e AWS_DEFAULT_REGION="us-east-1" localstack/localstack +``` + In order to use localstack with your pubsub binding, you need to provide the `endpoint` configuration in the component metadata. The `endpoint` is unncessary when running against production AWS. @@ -77,9 +116,13 @@ spec: type: pubsub.snssqs version: v1 metadata: + - name: accessKey + value: "anyString" + - name: secretKey + value: "anyString" - name: endpoint value: http://localhost:4566 - # Use us-east-1 for localstack + # Use us-east-1 or any other region if provided to localstack as defined by "AWS_DEFAULT_REGION" envvar - name: region value: us-east-1 ``` @@ -133,8 +176,71 @@ spec: {{% /codetab %}} {{% codetab %}} -In order to run in AWS, you should create an IAM user with permissions to the SNS and SQS services. +In order to run in AWS, you should create or assign an IAM user with permissions to the SNS and SQS services having a Policy such as: +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "YOUR_POLICY_NAME", + "Effect": "Allow", + "Action": [ + "sqs:CreateQueue", + "sqs:DeleteMessage", + "sqs:ReceiveMessage", + "sqs:ChangeMessageVisibility", + "sqs:GetQueueUrl", + "sqs:GetQueueAttributes", + "sqs:SetQueueAttributes", + "sns:CreateTopic", + "sns:ListSubscriptionsByTopic", + "sns:Publish", + "sns:Subscribe", + "sns:ListSubscriptionsByTopic", + "sns:GetTopicAttributes" + + ], + "Resource": [ + "arn:aws:sns:AWS_REGION:AWS_ACCOUNT_ID:*", + "arn:aws:sqs:AWS_REGION:AWS_ACCOUNT_ID:*" + ] + } + ] +} +``` Use the `AWS account ID` and `AWS account secret` and plug them into the `accessKey` and `secretKey` in the component metadata using Kubernetes secrets and `secretKeyRef`. + + +Alternatively, if you want to provision the SNS and SQS assets using your own tool of choice (e.g. Terraform), while preventing Dapr from doing so dynamically, you need to enable `disableEntityManagement` and assign your Dapr-using application with an IAM Role having a Policy such as: + +```json +{ + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "YOUR_POLICY_NAME", + "Effect": "Allow", + "Action": [ + "sqs:DeleteMessage", + "sqs:ReceiveMessage", + "sqs:ChangeMessageVisibility", + "sqs:GetQueueUrl", + "sqs:GetQueueAttributes", + "sns:Publish", + "sns:ListSubscriptionsByTopic", + "sns:GetTopicAttributes" + + ], + "Resource": [ + "arn:aws:sns:AWS_REGION:AWS_ACCOUNT_ID:APP_TOPIC_NAME", + "arn:aws:sqs:AWS_REGION:AWS_ACCOUNT_ID:APP_ID" + ] + } + ] +} +``` + +If you are running your applications on an EKS cluster with dynamic assets creation (the default Dapr behavior) {{% /codetab %}} {{< /tabs >}} 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 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 >}}) diff --git a/daprdocs/layouts/partials/sidebar-tree.html b/daprdocs/layouts/partials/sidebar-tree.html new file mode 100644 index 000000000..dfe8b40eb --- /dev/null +++ b/daprdocs/layouts/partials/sidebar-tree.html @@ -0,0 +1,71 @@ +{{/* We cache this partial for bigger sites and set the active class client side. */}} +{{ $sidebarCacheLimit := cond (isset .Site.Params.ui "sidebar_cache_limit") .Site.Params.ui.sidebar_cache_limit 2000 -}} +{{ $shouldDelayActive := ge (len .Site.Pages) $sidebarCacheLimit -}} +
+ {{ if not .Site.Params.ui.sidebar_search_disable -}} +
+ {{ partial "search-input.html" . }} + +
+ {{ else -}} +
+
+ {{ partial "search-input.html" . }} + +
+
+
+ {{ end -}} + +
+{{ define "section-tree-nav-section" -}} +{{ $s := .section -}} +{{ $p := .page -}} +{{ $shouldDelayActive := .shouldDelayActive -}} +{{ $sidebarMenuTruncate := .sidebarMenuTruncate -}} +{{ $treeRoot := cond (eq .ulNr 0) true false -}} +{{ $ulNr := .ulNr -}} +{{ $ulShow := .ulShow -}} +{{ $active := and (not $shouldDelayActive) (eq $s $p) -}} +{{ $activePath := and (not $shouldDelayActive) ($p.IsDescendant $s) -}} +{{ $show := cond (or (lt $ulNr $ulShow) $activePath (and (not $shouldDelayActive) (eq $s.Parent $p.Parent)) (and (not $shouldDelayActive) (eq $s.Parent $p)) (not $p.Site.Params.ui.sidebar_menu_compact) (and (not $shouldDelayActive) ($p.IsDescendant $s.Parent))) true false -}} +{{ $mid := printf "m-%s" ($s.RelPermalink | anchorize) -}} +{{ $pages_tmp := where (union $s.Pages $s.Sections).ByWeight ".Params.toc_hide" "!=" true -}} +{{ $pages := $pages_tmp | first $sidebarMenuTruncate -}} +{{ $withChild := gt (len $pages) 0 -}} +{{ $manualLink := cond (isset $s.Params "manuallink") $s.Params.manualLink ( cond (isset $s.Params "manuallinkrelref") (relref $s $s.Params.manualLinkRelref) $s.RelPermalink) -}} +{{ $manualLinkTitle := cond (isset $s.Params "manuallinktitle") $s.Params.manualLinkTitle $s.Title -}} +
  • + {{ if (and $p.Site.Params.ui.sidebar_menu_foldable (ge $ulNr 1)) -}} + + + {{ else -}} + {{ with $s.Params.Icon}}{{ end }}{{ $s.LinkTitle }} + {{- end }} + {{- if $withChild }} + {{- $ulNr := add $ulNr 1 }} + + {{- end }} +
    • +{{- end }} \ No newline at end of file diff --git a/daprdocs/layouts/shortcodes/tabs.html b/daprdocs/layouts/shortcodes/tabs.html index dbf753387..c1be42ca2 100644 --- a/daprdocs/layouts/shortcodes/tabs.html +++ b/daprdocs/layouts/shortcodes/tabs.html @@ -10,7 +10,7 @@ {{- $tabid := printf "%s-%s-tab" $guid $entry | anchorize -}} {{- $entryid := printf "%s-%s" $guid $entry | anchorize -}} - {{ . }} @@ -24,4 +24,4 @@
    {{ .Inner }} -
    \ No newline at end of file + diff --git a/daprdocs/static/docs/open-telemetry-collector/open-telemetry-collector-appinsights.yaml b/daprdocs/static/docs/open-telemetry-collector/open-telemetry-collector-appinsights.yaml index aa760183b..2b606b203 100644 --- a/daprdocs/static/docs/open-telemetry-collector/open-telemetry-collector-appinsights.yaml +++ b/daprdocs/static/docs/open-telemetry-collector/open-telemetry-collector-appinsights.yaml @@ -71,7 +71,7 @@ spec: spec: containers: - name: otel-collector - image: otel/opentelemetry-collector-contrib-dev:latest + image: otel/opentelemetry-collector-contrib:0.40.0 command: - "/otelcontribcol" - "--config=/conf/otel-collector-config.yaml" diff --git a/sdkdocs/dotnet b/sdkdocs/dotnet index d60eaf1c0..2ffbb113e 160000 --- a/sdkdocs/dotnet +++ b/sdkdocs/dotnet @@ -1 +1 @@ -Subproject commit d60eaf1c0e3bb75af480eda34307926be9865570 +Subproject commit 2ffbb113e7b5186a96ee38426a2c08526e83b0e0