Reference: pubsub pulsar OIDC authentication #3655

JoshVanL · 2023-08-01T10:35:14Z

Document pulsar OIDC authentication options. implemented here.

msfussell · 2023-08-01T22:53:42Z

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md

@@ -80,6 +81,14 @@ spec:
 | 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 |
+| authType | N | One of `"none"`, `"token"` or `"oidc"`. The type of authentication mechanism to use. Defaults to `"none"`, unless `token` is defined in which case it defaults to `"token"`. | "oidc" |
+| token | N  | `authType: token`. Token used for authentication.  | [How to create pulsar token](https://pulsar.apache.org/docs/en/security-jwt/#generate-tokens)|


Given the settings required for oidc I suggest that there is a separate example of how these are set in the metadata. For example this component https://docs.dapr.io/reference/components-reference/supported-pubsub/setup-azure-eventhubs/#azure-active-directory-aad-authentication shows how to set AAD authentication correctly.

And if there are any particular gochas outside of the the description and examples, add this into a paragraph or two. In other words be more specific to user on how to use the oidc settings

Makes sense, will do 👍

msfussell · 2023-08-01T22:59:11Z

@JoshVanL - Also there are conflicts on the v1.12 branch https://v1-12.docs.dapr.io/reference/components-reference/supported-pubsub/setup-pulsar/

hhunter-ms

quick review

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md

Signed-off-by: joshvanl <[email protected]>

JoshVanL · 2023-08-03T14:07:42Z

@ItalyPaleAle please review

ItalyPaleAle · 2023-08-03T14:34:59Z

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md

@@ -128,6 +134,42 @@ curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.delive
      }'
 ```

+### OIDC Authentication
+
+Since `v3.0`, [Pulsar supports OIDC authentication](https://pulsar.apache.org/docs/3.0.x/security-openid-connect/).


@JoshVanL would the changes we made support OAuth2 (without OIDC) too? https://pulsar.apache.org/docs/3.0.x/security-oauth2/

No idea, we can add a certification test to see if it would work.

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md

ItalyPaleAle · 2023-08-03T14:36:43Z

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md

@@ -90,6 +89,13 @@ The above example uses secrets as plain strings. It is recommended to use a [sec
 | 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: `""` | |
+| token | N  | Token used for authentication. | [How to create Pulsar token](https://pulsar.apache.org/docs/en/security-jwt/#generate-tokens)|


Consider creating a separate table for each authentication profile? (and include a mention that it can work without any). Example: https://docs.dapr.io/reference/components-reference/supported-state-stores/setup-sqlserver/#spec-metadata-fields

@JoshVanL - Can you address this comment from @ItalyPaleAle?

@JoshVanL - ping

@msfussell all comments look to be resolved from my side I think.

github-actions · 2023-08-10T00:09:22Z

Stale PR, paging all reviewers

Signed-off-by: joshvanl <[email protected]>

github-actions · 2023-08-22T00:07:48Z

Stale PR, paging all reviewers

github-actions · 2023-08-29T00:08:14Z

Stale PR, paging all reviewers

hhunter-ms · 2023-08-31T20:34:31Z

@ItalyPaleAle could you review Josh's updates per your comments?

github-actions · 2023-09-11T00:08:19Z

Stale PR, paging all reviewers

github-actions · 2023-09-18T00:08:11Z

Stale PR, paging all reviewers

msfussell

Few comments

daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md

…ubsub/setup-pulsar.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Josh van Leeuwen <[email protected]>

msfussell

LGTM

JoshVanL requested review from a team as code owners August 1, 2023 10:35

JoshVanL mentioned this pull request Aug 1, 2023

Adds OIDC authentication support for pubsub Apache Pulsar dapr/components-contrib#3023

Merged

msfussell reviewed Aug 1, 2023

View reviewed changes

hhunter-ms assigned JoshVanL Aug 2, 2023

hhunter-ms requested changes Aug 2, 2023

View reviewed changes

JoshVanL added 2 commits August 3, 2023 15:04

Adds OIDC authentication to pulsar pubsub options

52d877f

Signed-off-by: joshvanl <[email protected]>

Updates the pulsar OIDC authentication docs to use oauth2 fields.

a7e5f1f

Signed-off-by: joshvanl <[email protected]>

JoshVanL force-pushed the reference-pubsub-pulsar-oidc branch from 12db85e to a7e5f1f Compare August 3, 2023 14:07

ItalyPaleAle reviewed Aug 3, 2023

View reviewed changes

github-actions bot added the stale label Aug 10, 2023

msfussell removed the stale label Aug 10, 2023

Merge branch 'v1.12' into reference-pubsub-pulsar-oidc

1cff2c1

msfussell added the area/components label Aug 15, 2023

msfussell added this to the 1.12 milestone Aug 15, 2023

Put pulsar authentication options into different sections

17de9f4

Signed-off-by: joshvanl <[email protected]>

github-actions bot added the stale label Aug 22, 2023

yaron2 removed the stale label Aug 23, 2023

github-actions bot added the stale label Aug 29, 2023

hhunter-ms removed the stale label Aug 31, 2023

hhunter-ms approved these changes Aug 31, 2023

View reviewed changes

ItalyPaleAle approved these changes Sep 5, 2023

View reviewed changes

github-actions bot added the stale label Sep 11, 2023

msfussell removed the stale label Sep 12, 2023

github-actions bot added the stale label Sep 18, 2023

msfussell removed the stale label Sep 18, 2023

Merge branch 'v1.12' into reference-pubsub-pulsar-oidc

0df1912

msfussell reviewed Sep 18, 2023

View reviewed changes

JoshVanL and others added 3 commits September 18, 2023 17:15

Update daprdocs/content/en/reference/components-reference/supported-p…

99f5797

…ubsub/setup-pulsar.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Josh van Leeuwen <[email protected]>

Update daprdocs/content/en/reference/components-reference/supported-p…

e74b613

…ubsub/setup-pulsar.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Josh van Leeuwen <[email protected]>

Update daprdocs/content/en/reference/components-reference/supported-p…

08a19b9

…ubsub/setup-pulsar.md Co-authored-by: Mark Fussell <[email protected]> Signed-off-by: Josh van Leeuwen <[email protected]>

msfussell approved these changes Sep 18, 2023

View reviewed changes

msfussell merged commit c2fc0a1 into dapr:v1.12 Sep 18, 2023
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reference: pubsub pulsar OIDC authentication #3655

Reference: pubsub pulsar OIDC authentication #3655

JoshVanL commented Aug 1, 2023 •

edited

Loading

msfussell Aug 1, 2023 •

edited

Loading

JoshVanL Aug 3, 2023

msfussell commented Aug 1, 2023

hhunter-ms left a comment

JoshVanL commented Aug 3, 2023

ItalyPaleAle Aug 3, 2023

JoshVanL Aug 4, 2023

ItalyPaleAle Aug 3, 2023

msfussell Aug 23, 2023

msfussell Sep 12, 2023

JoshVanL Sep 18, 2023

github-actions bot commented Aug 10, 2023

github-actions bot commented Aug 22, 2023

github-actions bot commented Aug 29, 2023

hhunter-ms commented Aug 31, 2023

github-actions bot commented Sep 11, 2023

github-actions bot commented Sep 18, 2023

msfussell left a comment

msfussell left a comment

Reference: pubsub pulsar OIDC authentication #3655

Reference: pubsub pulsar OIDC authentication #3655

Conversation

JoshVanL commented Aug 1, 2023 • edited Loading

msfussell Aug 1, 2023 • edited Loading

Choose a reason for hiding this comment

JoshVanL Aug 3, 2023

Choose a reason for hiding this comment

msfussell commented Aug 1, 2023

hhunter-ms left a comment

Choose a reason for hiding this comment

JoshVanL commented Aug 3, 2023

ItalyPaleAle Aug 3, 2023

Choose a reason for hiding this comment

JoshVanL Aug 4, 2023

Choose a reason for hiding this comment

ItalyPaleAle Aug 3, 2023

Choose a reason for hiding this comment

msfussell Aug 23, 2023

Choose a reason for hiding this comment

msfussell Sep 12, 2023

Choose a reason for hiding this comment

JoshVanL Sep 18, 2023

Choose a reason for hiding this comment

github-actions bot commented Aug 10, 2023

github-actions bot commented Aug 22, 2023

github-actions bot commented Aug 29, 2023

hhunter-ms commented Aug 31, 2023

github-actions bot commented Sep 11, 2023

github-actions bot commented Sep 18, 2023

msfussell left a comment

Choose a reason for hiding this comment

msfussell left a comment

Choose a reason for hiding this comment

JoshVanL commented Aug 1, 2023 •

edited

Loading

msfussell Aug 1, 2023 •

edited

Loading