Skip to content

Commit 286c252

Browse files
authored
fix auth format in doc (#144)
Signed-off-by: ericsyh <ericshenyuhao@outlook.com>
1 parent 95c5d20 commit 286c252

1 file changed

Lines changed: 34 additions & 34 deletions

File tree

docs/pulsar_connection.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ Other `PulsarConnection` configuration examples:
4242
namespace: test
4343
spec:
4444
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
45-
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
46-
clusterName: pulsar-cluster
45+
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
46+
clusterName: pulsar-cluster
4747
authentication:
48-
token:
49-
# Use a Kubernetes Secret to store the JWT Token. https://kubernetes.io/docs/concepts/configuration/secret/
50-
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
51-
secretRef:
52-
name: test-pulsar-sn-platform-vault-secret-env-injection
53-
key: brokerClientAuthenticationParameters
48+
token:
49+
# Use a Kubernetes Secret to store the JWT Token. https://kubernetes.io/docs/concepts/configuration/secret/
50+
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
51+
secretRef:
52+
name: test-pulsar-sn-platform-vault-secret-env-injection
53+
key: brokerClientAuthenticationParameters
5454
```
5555

5656
* JWT Token authentication with value
@@ -63,12 +63,12 @@ Other `PulsarConnection` configuration examples:
6363
namespace: test
6464
spec:
6565
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
66-
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
67-
clusterName: pulsar-cluster
66+
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
67+
clusterName: pulsar-cluster
6868
authentication:
69-
token:
70-
# Use the JWT Token raw data as the token value
71-
value: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
69+
token:
70+
# Use the JWT Token raw data as the token value
71+
value: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
7272
```
7373

7474
* OAuth2 authentication with Secret
@@ -81,19 +81,19 @@ Other `PulsarConnection` configuration examples:
8181
namespace: test
8282
spec:
8383
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
84-
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
85-
clusterName: pulsar-cluster
84+
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
85+
clusterName: pulsar-cluster
8686
authentication:
87-
oauth2:
88-
issuerEndpoint: https://auth.streamnative.cloud
89-
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
90-
audience: urn:sn:pulsar:sndev:us-west
91-
key:
92-
# Use a Kubernetes Secret to store the OAuth2 keyFile contents. https://kubernetes.io/docs/concepts/configuration/secret/
93-
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
94-
secretRef:
95-
name: key-file-secret
96-
key: key-file
87+
oauth2:
88+
issuerEndpoint: https://auth.streamnative.cloud
89+
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
90+
audience: urn:sn:pulsar:sndev:us-west
91+
key:
92+
# Use a Kubernetes Secret to store the OAuth2 keyFile contents. https://kubernetes.io/docs/concepts/configuration/secret/
93+
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
94+
secretRef:
95+
name: key-file-secret
96+
key: key-file
9797
```
9898

9999
* OAuth2 authentication with value
@@ -106,16 +106,16 @@ Other `PulsarConnection` configuration examples:
106106
namespace: test
107107
spec:
108108
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
109-
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
110-
clusterName: pulsar-cluster
109+
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
110+
clusterName: pulsar-cluster
111111
authentication:
112-
oauth2:
113-
issuerEndpoint: https://auth.streamnative.cloud
114-
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
115-
audience: urn:sn:pulsar:sndev:us-west
116-
key:
117-
# Use the keyFile contents as the oauth2 key value
118-
value: {"type":"sn_service_account","client_id":"zvex72oGvFQMBQGZ2ozMxOus2s4tQASJ","client_secret":"60J6fo81j-h69_vVvYvqFOHs2NfOyy6pqGqwIhTgnxpQ7O3UH8PdCbVtdm_SJjIf","client_email":"contoso@sndev.auth.streamnative.cloud","issuer_url":"https://auth.streamnative.cloud"}
112+
oauth2:
113+
issuerEndpoint: https://auth.streamnative.cloud
114+
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
115+
audience: urn:sn:pulsar:sndev:us-west
116+
key:
117+
# Use the keyFile contents as the oauth2 key value
118+
value: {"type":"sn_service_account","client_id":"zvex72oGvFQMBQGZ2ozMxOus2s4tQASJ","client_secret":"60J6fo81j-h69_vVvYvqFOHs2NfOyy6pqGqwIhTgnxpQ7O3UH8PdCbVtdm_SJjIf","client_email":"contoso@sndev.auth.streamnative.cloud","issuer_url":"https://auth.streamnative.cloud"}
119119
120120
This table lists specifications available for the `PulsarConnection` resource.
121121

0 commit comments

Comments
 (0)