Skip to content

Commit 45b0e1c

Browse files
brooksmtownsendbrooksmtownsend
committed
fix(keyvalue-nats): README link keys lowercase
Signed-off-by: Brooks Townsend <brooksmtownsend@gmail.com>
1 parent 7363191 commit 45b0e1c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

‎crates/provider-keyvalue-nats/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,18 @@ To configure this provider, use the following settings in link definitions:
1818

1919
| **Property** | **Description** |
2020
|:----------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
21-
| `BUCKET` | **Required**: The name of an existing NATS Kv Store. Additional links could be added if access to more Kv stores is needed; the buckets could be referenced by their respective `link_names` (please see the Rust **_keyvalue-messaging_** example for a comprehensive demonstration of this approach). |
22-
| `CLUSTER_URI` | NATS cluster connection URI. If not specified, the default is `nats://0.0.0.0:4222` |
23-
| `JS_DOMAIN` | Optional NATS Jetstream domain to connect to. |
24-
| `TLS_CA_FILE` | Alternatively, the path qualified name of the CA public key could be provided. If both are provided, the `TLS_CA` will be used. |
25-
| `ENABLE_BUCKET_AUTO_CREATE` | Enable automatic creation of buckets when links are established. If a bucket cannot be created, a warning is produced. |
21+
| `bucket` | **Required**: The name of an existing NATS Kv Store. Additional links could be added if access to more Kv stores is needed; the buckets could be referenced by their respective `link_names` (please see the Rust **_keyvalue-messaging_** example for a comprehensive demonstration of this approach). |
22+
| `cluster_uri` | NATS cluster connection URI. If not specified, the default is `nats://0.0.0.0:4222` |
23+
| `js_domain` | Optional NATS Jetstream domain to connect to. |
24+
| `tls_ca_file` | Alternatively, the path qualified name of the CA public key could be provided. If both are provided, the `tls_ca` will be used. |
25+
| `enable_bucket_auto_create` | Enable automatic creation of buckets when links are established. If a bucket cannot be created, a warning is produced. |
2626

2727
## Link Definition Secret Settings
2828

2929
While the provider supports receiving the following values via configuration (similar to values outlined in the configuration section above), the values below are _sensitive_, and thus _should_ be configured via link-time secrets.
3030

3131
| **Property** | **Description** |
3232
| :------------ | :-------------------------------------------------------------------------------------------------------------- |
33-
| `CLIENT_JWT` | Optional JWT auth token. For JWT authentication, both `CLIENT_JWT` and `CLIENT_SEED` must be provided. |
34-
| `CLIENT_SEED` | Private seed for JWT authentication. |
35-
| `TLS_CA` | To secure communications with the NATS server, the public key of its CA could be provided as an encoded string. |
33+
| `client_jwt` | Optional JWT auth token. For JWT authentication, both `client_jwt` and `client_seed` must be provided. |
34+
| `client_seed` | Private seed for JWT authentication. |
35+
| `tls_ca` | To secure communications with the NATS server, the public key of its CA could be provided as an encoded string. |

0 commit comments

Comments
 (0)