Documentation for Jetstream TLS configuration (#2698)

* docs(pubsub/jetstream): make table readable as plain text and easier to edit

Signed-off-by: NickLarsenNZ <nick@aptiv.co.nz>

* docs(pubsub/jetstream): add tls client authentication fields (see dapr/components-contrib#1924)

Signed-off-by: NickLarsenNZ <nick@aptiv.co.nz>

* docs(pubsub/jetstream): make example values consistent (strings quotes inside the code span)

Signed-off-by: NickLarsenNZ <nick@aptiv.co.nz>

* add to yaml example and mark as optional

Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>

Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>

Signed-off-by: NickLarsenNZ <nick@aptiv.co.nz>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
Co-authored-by: Yaron Schneider <schneider.yaron@live.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
This commit is contained in:
Nick 2022-10-08 00:13:38 +02:00 committed by GitHub
parent 47375831be
commit 44ed7a782a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 29 deletions

View File

@ -24,19 +24,23 @@ spec:
metadata: metadata:
- name: natsURL - name: natsURL
value: "nats://localhost:4222" value: "nats://localhost:4222"
- name: jwt - name: jwt # Optional. Used for decentralized JWT authentication.
value: "eyJhbGciOiJ...6yJV_adQssw5c" # Optional. Used for decentralized JWT authentication value: "eyJhbGciOiJ...6yJV_adQssw5c"
- name: seedKey - name: seedKey # Optional. Used for decentralized JWT authentication.
value: "SUACS34K232O...5Z3POU7BNIL4Y" # Optional. Used for decentralized JWT authentication value: "SUACS34K232O...5Z3POU7BNIL4Y"
- name: tls_client_cert # Optional. Used for TLS Client authentication.
value: "/path/to/tls.crt"
- name: tls_client_key # Optional. Used for TLS Client authentication.
value: "/path/to/tls.key"
- name: name - name: name
value: "connection name" value: "my-conn-name"
- name: durableName - name: durableName
value: "consumer durable name" value: "my-durable"
- name: queueGroupName - name: queueGroupName
value: "queue group name" value: "my-queue"
- name: startSequence - name: startSequence
value: 1 value: 1
- name: startTime # in Unix format - name: startTime # In Unix format
value: 1630349391 value: 1630349391
- name: deliverAll - name: deliverAll
value: false value: false
@ -47,11 +51,13 @@ spec:
## Spec metadata fields ## Spec metadata fields
| Field | Required | Details | Example | | Field | Required | Details | Example |
|----------------|:--------:|---------|---------| | --------------- | :------: | ------------------------------------------ | -------------------------------- |
| natsURL | Y | NATS server address URL | "`nats://localhost:4222`"| | natsURL | Y | NATS server address URL | `"nats://localhost:4222"` |
| jwt | N | NATS decentralized authentication JWT | "`eyJhbGciOiJ...6yJV_adQssw5c`"| | jwt | N | NATS decentralized authentication JWT | `"eyJhbGciOiJ...6yJV_adQssw5c"` |
| seedKey | N | NATS decentralized authentication seed key | "`SUACS34K232O...5Z3POU7BNIL4Y`"| | seedKey | N | NATS decentralized authentication seed key | `"SUACS34K232O...5Z3POU7BNIL4Y"` |
| name | N | NATS connection name | `"my-conn-name"`| | tls_client_cert | N | NATS TLS Client Authentication Certificate | `"/path/to/tls.crt"` |
| tls_client_key | N | NATS TLS Client Authentication Key | `"/path/to/tls.key"` |
| name | N | NATS connection name | `"my-conn-name"` |
| durableName | N | [Durable name] | `"my-durable"` | | durableName | N | [Durable name] | `"my-durable"` |
| queueGroupName | N | Queue group name | `"my-queue"` | | queueGroupName | N | Queue group name | `"my-queue"` |
| startSequence | N | [Start Sequence] | `1` | | startSequence | N | [Start Sequence] | `1` |