From e23ae809da09cf2ba9e3d9932fef5aff070d7087 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Thu, 15 Jun 2023 14:34:03 -0400 Subject: [PATCH 1/9] add saslmechanism Signed-off-by: Hannah Hunter --- .../reference/components-reference/supported-bindings/kafka.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md b/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md index 3ec497552..cc40d1b95 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md @@ -39,6 +39,8 @@ spec: secretKeyRef: name: kafka-secrets key: saslPasswordSecret + - name: saslMechanism + value: "SHA-512" - name: initialOffset # Optional. Used for input bindings. value: "newest" - name: maxMessageBytes # Optional. @@ -61,6 +63,7 @@ spec: | 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, will default to `PLAINTEXT`, which could cause a break for some services, like Amazon Managed Service for Kafka. | `""`, `"SHA-512"` | | 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" | From e388bd56e7538ad9734f73c00e27ab4274e1000b Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Thu, 15 Jun 2023 15:44:20 -0400 Subject: [PATCH 2/9] duplicate changes from deleted repo Signed-off-by: Hannah Hunter --- .../supported-bindings/redis.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md index 8fe7638e0..d399d2650 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md @@ -96,6 +96,8 @@ An HTTP 204 (No Content) and empty body is returned if successful. You can get a record in Redis using the `get` operation. This gets a key that was previously set. +This takes an optional parameter `delete`, which is by default `false`. When it is set to `true`, this operation will use the `GETDEL` operation of Redis. For example, it will return the `value` which was previously set and delete it. + #### Request ```json @@ -120,6 +122,20 @@ You can get a record in Redis using the `get` operation. This gets a key that wa } ``` +#### Request with delete flag + +```json +{ + "operation": "get", + "metadata": { + "key": "key1", + "delete": "true" + }, + "data": { + } +} +``` + ### delete You can delete a record in Redis using the `delete` operation. Returns success whether the key exists or not. From df28a2745ab4eeb3985adffc1e2c6f41a144c189 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Thu, 15 Jun 2023 15:52:45 -0400 Subject: [PATCH 3/9] add suggested warning Signed-off-by: Hannah Hunter --- .../components-reference/supported-pubsub/setup-pulsar.md | 5 +++++ 1 file changed, 5 insertions(+) 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 5adca74a8..5e6bc861e 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 @@ -62,6 +62,11 @@ spec: } ``` +{{% alert title="Warning" color="warning" %}} +This component supports storing the `token` parameter and any other sensitive parameter and data as Kubernetes Secrets. +{{% /alert %}} + + ## Spec metadata fields | Field | Required | Details | Example | From 92e83e57defb92b5f8fd0d029afa134b45e2414f Mon Sep 17 00:00:00 2001 From: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Date: Fri, 16 Jun 2023 10:13:17 -0400 Subject: [PATCH 4/9] Update daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md Co-authored-by: Mark Fussell Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> --- .../reference/components-reference/supported-bindings/kafka.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md b/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md index cc40d1b95..912471cbb 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md @@ -63,7 +63,7 @@ spec: | 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, will default to `PLAINTEXT`, which could cause a break for some services, like Amazon Managed Service for Kafka. | `""`, `"SHA-512"` | +| 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" | From cf3afe5e84a7a00ba1ac7e9908ca5053cd837d50 Mon Sep 17 00:00:00 2001 From: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Date: Fri, 16 Jun 2023 10:22:44 -0400 Subject: [PATCH 5/9] Update daprdocs/content/en/reference/components-reference/supported-bindings/redis.md Co-authored-by: Mark Fussell Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> --- .../reference/components-reference/supported-bindings/redis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md index d399d2650..7d5fdc8ae 100644 --- a/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md +++ b/daprdocs/content/en/reference/components-reference/supported-bindings/redis.md @@ -96,7 +96,7 @@ An HTTP 204 (No Content) and empty body is returned if successful. You can get a record in Redis using the `get` operation. This gets a key that was previously set. -This takes an optional parameter `delete`, which is by default `false`. When it is set to `true`, this operation will use the `GETDEL` operation of Redis. For example, it will return the `value` which was previously set and delete it. +This takes an optional parameter `delete`, which is by default `false`. When it is set to `true`, this operation uses the `GETDEL` operation of Redis. For example, it returns the `value` which was previously set and then deletes it. #### Request From 26624224b9f29ec2860b2bda23c1f7a77c678955 Mon Sep 17 00:00:00 2001 From: Hannah Hunter Date: Fri, 16 Jun 2023 10:34:28 -0400 Subject: [PATCH 6/9] update notes Signed-off-by: Hannah Hunter --- .../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 5e6bc861e..45726e253 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 @@ -63,7 +63,7 @@ spec: ``` {{% alert title="Warning" color="warning" %}} -This component supports storing the `token` parameter and any other sensitive parameter and data as Kubernetes Secrets. +The above example uses secrets as plain strings. It is recommended to use a [secret store for the secrets]({{< ref component-secrets.md >}}). This component supports storing the `token` parameter and any other sensitive parameter and data as Kubernetes Secrets. {{% /alert %}} From 9d2ba33fd43def44371f414ea53c2b54c0936d37 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Mon, 19 Jun 2023 10:28:17 -0700 Subject: [PATCH 7/9] Add skip on missing secrets config Signed-off-by: Aaron Crawfis --- .github/workflows/website-root.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/website-root.yml b/.github/workflows/website-root.yml index ed8c3b491..0e160a426 100644 --- a/.github/workflows/website-root.yml +++ b/.github/workflows/website-root.yml @@ -61,6 +61,7 @@ jobs: api_location: "daprdocs/public/" output_location: "" skip_app_build: true + skip_deploy_on_missing_secretsL: true - name: Upload Hugo artifacts uses: actions/upload-artifact@v3 with: From a0e76ec1e0c7195cf2f8c2de440bae87751af75a Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Mon, 19 Jun 2023 10:28:49 -0700 Subject: [PATCH 8/9] Remove erroneous character Signed-off-by: Aaron Crawfis --- .github/workflows/website-root.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/website-root.yml b/.github/workflows/website-root.yml index 0e160a426..4e22b2c59 100644 --- a/.github/workflows/website-root.yml +++ b/.github/workflows/website-root.yml @@ -61,7 +61,7 @@ jobs: api_location: "daprdocs/public/" output_location: "" skip_app_build: true - skip_deploy_on_missing_secretsL: true + skip_deploy_on_missing_secrets: true - name: Upload Hugo artifacts uses: actions/upload-artifact@v3 with: From d1b94e4faa97206a713a6f4180ca72179de6a6a2 Mon Sep 17 00:00:00 2001 From: Aaron Crawfis Date: Mon, 19 Jun 2023 10:59:12 -0700 Subject: [PATCH 9/9] Skip on close without secret Signed-off-by: Aaron Crawfis --- .github/workflows/website-root.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/website-root.yml b/.github/workflows/website-root.yml index 4e22b2c59..1f8e503e4 100644 --- a/.github/workflows/website-root.yml +++ b/.github/workflows/website-root.yml @@ -80,6 +80,7 @@ jobs: with: azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PROUD_BAY_0E9E0E81E }} action: "close" + skip_deploy_on_missing_secrets: true algolia_index: name: Index site for Algolia