From 032b2b08ba7aa02f9b26eea62abd9bdc2cb19c1a Mon Sep 17 00:00:00 2001 From: seachen Date: Wed, 1 Sep 2021 10:37:51 +0800 Subject: [PATCH 1/6] feature/pubsub: add delay queue params for pulsar --- .../supported-pubsub/setup-pulsar.md | 42 +++++++++++++++++-- 1 file changed, 39 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 9f8b63a1e..7186bdedc 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,16 +24,52 @@ spec: value: "localhost:6650" - name: enableTLS value: "false" - ``` + ## Spec metadata fields | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| -| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"` +| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"`| | enableTLS | N | Enable TLS. Default: `"false"` | `"true"`, `"false"` +### Delay queue + +When invoking the Pulsar pub/sub, its possible to provide an optional delay queue by using the `metadata` query param in the request url. + +These param names are `deliverAt` or `deliverAfter`. + +| Field | Required | Details | Example | +|--------------------|:--------:|---------|---------| +| deliverAt | N | delay queue configuration param. Default is empty | `"2021-09-01 10:00:00"`| +| deliverAfter | N | delay queue configuration param. Default is empty | `"4h5m3s"`| + +Example: + + +```shell +curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAt='2021-09-01 10:00:00' \ + -H "Content-Type: application/json" \ + -d '{ + "data": { + "message": "Hi" + } + }' +``` + +Or + +```shell +curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAfter='4h5m3s' \ + -H "Content-Type: application/json" \ + -d '{ + "data": { + "message": "Hi" + } + }' +``` + ## Create a Pulsar instance {{< tabs "Self-Hosted" "Kubernetes">}} @@ -60,4 +96,4 @@ Refer to the following [Helm chart](https://pulsar.apache.org/docs/en/kubernetes ## Related links - [Basic schema for a Dapr component]({{< ref component-schema >}}) - Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components -- [Pub/Sub building block]({{< ref pubsub >}}) \ No newline at end of file +- [Pub/Sub building block]({{< ref pubsub >}}) From c4fecc12cfee1ace074d47f38b2b471d9c439cf9 Mon Sep 17 00:00:00 2001 From: yellow chicks Date: Wed, 1 Sep 2021 10:39:18 +0800 Subject: [PATCH 2/6] Update setup-pulsar.md --- .../components-reference/supported-pubsub/setup-pulsar.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 7186bdedc..339c460fd 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 @@ -31,7 +31,7 @@ spec: | 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"` +| enableTLS | N | Enable TLS. Default: `"false"` | `"true"`, `"false"`| ### Delay queue From 0abbfe901075a3fadfad1fa314b9e2b82ee9b96e Mon Sep 17 00:00:00 2001 From: seachen Date: Thu, 2 Sep 2021 10:08:53 +0800 Subject: [PATCH 3/6] feature/pubsub: add delay queue params for pulsar --- .../components-reference/supported-pubsub/setup-pulsar.md | 4 ++-- 1 file changed, 2 insertions(+), 2 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 7186bdedc..9f041616e 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 @@ -42,14 +42,14 @@ These param names are `deliverAt` or `deliverAfter`. | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| -| deliverAt | N | delay queue configuration param. Default is empty | `"2021-09-01 10:00:00"`| +| deliverAt | N | delay queue configuration param. use time RFC3339, Default is empty | `"2021-09-01T10:00:00Z"`| | deliverAfter | N | delay queue configuration param. Default is empty | `"4h5m3s"`| Example: ```shell -curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAt='2021-09-01 10:00:00' \ +curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAt='2021-09-01T10:00:00Z' \ -H "Content-Type: application/json" \ -d '{ "data": { From 07bca094e9d2178b79b730f0b2f5c05141db312c Mon Sep 17 00:00:00 2001 From: Bernd Verst <4535280+berndverst@users.noreply.github.com> Date: Thu, 30 Sep 2021 16:23:30 -0700 Subject: [PATCH 4/6] Deny iFrame embeds --- daprdocs/staticwebapp.config.json | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 daprdocs/staticwebapp.config.json diff --git a/daprdocs/staticwebapp.config.json b/daprdocs/staticwebapp.config.json new file mode 100644 index 000000000..df65c3647 --- /dev/null +++ b/daprdocs/staticwebapp.config.json @@ -0,0 +1,6 @@ +{ + "globalHeaders": { + "X-Frame-Options": "DENY" + } +} + From ff3a4997a4b8739972869679899e3fc404f818df Mon Sep 17 00:00:00 2001 From: seachen Date: Sat, 30 Oct 2021 08:22:25 +0800 Subject: [PATCH 5/6] (v1.5)feature/pubsub: add delay queue params for pulsar --- .../supported-pubsub/setup-pulsar.md | 9 ++++++--- 1 file changed, 6 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 3d636ceea..5f4baf959 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 @@ -36,16 +36,19 @@ spec: ### Delay queue -When invoking the Pulsar pub/sub, its possible to provide an optional delay queue by using the `metadata` query param in the request url. +When invoking the Pulsar pub/sub, it's possible to provide an optional delay queue by using the `metadata` query parameters in the request url. -These param names are `deliverAt` or `deliverAfter`. +These optional parameter names are `metadata.deliverAt` or `metadata.deliverAfter`: +- `deliverAt`: Delay message to deliver at a specified time (RFC3339 format), e.g. `"2021-09-01T10:00:00Z"` +- `deliverAfter`: Delay message to deliver after a specified amount of time, e.g.`"4h5m3s"` | Field | Required | Details | Example | |--------------------|:--------:|---------|---------| | deliverAt | N | delay queue configuration param. use time RFC3339, Default is empty | `"2021-09-01T10:00:00Z"`| | deliverAfter | N | delay queue configuration param. Default is empty | `"4h5m3s"`| -Example: + +Examples: ```shell From 62589d034809f9b15e9dca5d7d28c8bbe9bfdd72 Mon Sep 17 00:00:00 2001 From: yellow chicks Date: Sat, 6 Nov 2021 07:00:43 +0800 Subject: [PATCH 6/6] Update setup-pulsar.md --- .../components-reference/supported-pubsub/setup-pulsar.md | 7 ------- 1 file changed, 7 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 5f4baf959..2c4a25a23 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 @@ -42,15 +42,8 @@ These optional parameter names are `metadata.deliverAt` or `metadata.deliverAfte - `deliverAt`: Delay message to deliver at a specified time (RFC3339 format), e.g. `"2021-09-01T10:00:00Z"` - `deliverAfter`: Delay message to deliver after a specified amount of time, e.g.`"4h5m3s"` -| Field | Required | Details | Example | -|--------------------|:--------:|---------|---------| -| deliverAt | N | delay queue configuration param. use time RFC3339, Default is empty | `"2021-09-01T10:00:00Z"`| -| deliverAfter | N | delay queue configuration param. Default is empty | `"4h5m3s"`| - - Examples: - ```shell curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAt='2021-09-01T10:00:00Z' \ -H "Content-Type: application/json" \