Skip to content

Commit

Permalink
fix auth format in doc (#144)
Browse files Browse the repository at this point in the history
Signed-off-by: ericsyh <[email protected]>
  • Loading branch information
ericsyh authored Aug 24, 2023
1 parent 95c5d20 commit 286c252
Showing 1 changed file with 34 additions and 34 deletions.
68 changes: 34 additions & 34 deletions docs/pulsar_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ Other `PulsarConnection` configuration examples:
namespace: test
spec:
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
authentication:
token:
# Use a Kubernetes Secret to store the JWT Token. https://kubernetes.io/docs/concepts/configuration/secret/
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
secretRef:
name: test-pulsar-sn-platform-vault-secret-env-injection
key: brokerClientAuthenticationParameters
token:
# Use a Kubernetes Secret to store the JWT Token. https://kubernetes.io/docs/concepts/configuration/secret/
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
secretRef:
name: test-pulsar-sn-platform-vault-secret-env-injection
key: brokerClientAuthenticationParameters
```

* JWT Token authentication with value
Expand All @@ -63,12 +63,12 @@ Other `PulsarConnection` configuration examples:
namespace: test
spec:
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
authentication:
token:
# Use the JWT Token raw data as the token value
value: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
token:
# Use the JWT Token raw data as the token value
value: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJKb2UifQ.ipevRNuRP6HflG8cFKnmUPtypruRC4fb1DWtoLL62SY
```

* OAuth2 authentication with Secret
Expand All @@ -81,19 +81,19 @@ Other `PulsarConnection` configuration examples:
namespace: test
spec:
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
authentication:
oauth2:
issuerEndpoint: https://auth.streamnative.cloud
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
audience: urn:sn:pulsar:sndev:us-west
key:
# Use a Kubernetes Secret to store the OAuth2 keyFile contents. https://kubernetes.io/docs/concepts/configuration/secret/
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
secretRef:
name: key-file-secret
key: key-file
oauth2:
issuerEndpoint: https://auth.streamnative.cloud
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
audience: urn:sn:pulsar:sndev:us-west
key:
# Use a Kubernetes Secret to store the OAuth2 keyFile contents. https://kubernetes.io/docs/concepts/configuration/secret/
# Secret data field have to be base64-encoded strings. https://kubernetes.io/docs/concepts/configuration/secret/#restriction-names-data
secretRef:
name: key-file-secret
key: key-file
```

* OAuth2 authentication with value
Expand All @@ -106,16 +106,16 @@ Other `PulsarConnection` configuration examples:
namespace: test
spec:
adminServiceURL: http://test-pulsar-sn-platform-broker.test.svc.cluster.local:8080
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
brokerServiceURL: pulsar://test-pulsar-sn-platform-broker.test.svc.cluster.local:6650
clusterName: pulsar-cluster
authentication:
oauth2:
issuerEndpoint: https://auth.streamnative.cloud
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
audience: urn:sn:pulsar:sndev:us-west
key:
# Use the keyFile contents as the oauth2 key value
value: {"type":"sn_service_account","client_id":"zvex72oGvFQMBQGZ2ozMxOus2s4tQASJ","client_secret":"60J6fo81j-h69_vVvYvqFOHs2NfOyy6pqGqwIhTgnxpQ7O3UH8PdCbVtdm_SJjIf","client_email":"[email protected]","issuer_url":"https://auth.streamnative.cloud"}
oauth2:
issuerEndpoint: https://auth.streamnative.cloud
clientID: pvqx76oGvWQMIGGP2ozMfOus2s4tDQAJ
audience: urn:sn:pulsar:sndev:us-west
key:
# Use the keyFile contents as the oauth2 key value
value: {"type":"sn_service_account","client_id":"zvex72oGvFQMBQGZ2ozMxOus2s4tQASJ","client_secret":"60J6fo81j-h69_vVvYvqFOHs2NfOyy6pqGqwIhTgnxpQ7O3UH8PdCbVtdm_SJjIf","client_email":"[email protected]","issuer_url":"https://auth.streamnative.cloud"}
This table lists specifications available for the `PulsarConnection` resource.

Expand Down

0 comments on commit 286c252

Please sign in to comment.