Skip to content

Commit 416c7d2

Browse files
authoredAug 7, 2024
Merge pull request #4298 from hhunter-ms/issue_4193
[Redis component] Update to make `redisPassword` optional
2 parents dd2e064 + c66d2d3 commit 416c7d2

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed
 

‎daprdocs/content/en/reference/components-reference/supported-bindings/redis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3737
| Field | Required | Binding support | Details | Example |
3838
|--------------------|:--------:|------------|-----|---------|
3939
| `redisHost` | Y | Output | The Redis host address | `"localhost:6379"` |
40-
| `redisPassword` | Y | Output | The Redis password | `"password"` |
40+
| `redisPassword` | N | Output | The Redis password | `"password"` |
4141
| `redisUsername` | N | Output | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `"username"` |
4242
| `enableTLS` | N | Output | If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"` | `"true"`, `"false"` |
4343
| `failover` | N | Output | Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to `"false"` | `"true"`, `"false"`

‎daprdocs/content/en/reference/components-reference/supported-configuration-stores/redis-configuration-store.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3939
| Field | Required | Details | Example |
4040
|--------------------|:--------:|---------|---------|
4141
| redisHost | Y | Output | The Redis host address | `"localhost:6379"` |
42-
| redisPassword | Y | Output | The Redis password | `"password"` |
42+
| redisPassword | N | Output | The Redis password | `"password"` |
4343
| redisUsername | N | Output | Username for Redis host. Defaults to empty. Make sure your Redis server version is 6 or above, and have created acl rule correctly. | `"username"` |
4444
| enableTLS | N | Output | If the Redis instance supports TLS with public certificates it can be configured to enable or disable TLS. Defaults to `"false"` | `"true"`, `"false"` |
4545
| failover | N | Output | Property to enabled failover configuration. Needs sentinelMasterName to be set. Defaults to `"false"` | `"true"`, `"false"`

‎daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ spec:
2020
metadata:
2121
- name: redisHost
2222
value: <HOST>
23-
- name: redisPassword
23+
- name: redisPassword #Optional.
2424
value: <PASSWORD>
2525
- name: enableTLS
2626
value: <bool> # Optional. Allowed: true, false.
@@ -80,7 +80,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
8080
| Field | Required | Details | Example |
8181
|--------------------|:--------:|---------|---------|
8282
| redisHost | Y | Connection-string for the redis host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379`
83-
| redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"`
83+
| redisPassword | N | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"`
8484
| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"`
8585
| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"`
8686
| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10`

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The above example uses secrets as plain strings. It is recommended to use a secr
3939
| Field | Required | Details | Example |
4040
|--------------------|:--------:|---------|---------|
4141
| redisHost | Y | Connection-string for the redis host. If `"redisType"` is `"cluster"` it can be multiple hosts separated by commas or just a single host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379`
42-
| redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"`
42+
| redisPassword | N | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"`
4343
| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"`
4444
| consumerID | N | The consumer group ID. | Can be set to string value (such as `"channel1"` in the example above) or string format value (such as `"{podName}"`, etc.). [See all of template tags you can use in your component metadata.]({{< ref "component-schema.md#templated-metadata-values" >}})
4545
| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"`

‎daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ spec:
2626
metadata:
2727
- name: redisHost
2828
value: <HOST>
29-
- name: redisPassword
29+
- name: redisPassword # Optional.
3030
value: <PASSWORD>
3131
- name: enableTLS
3232
value: <bool> # Optional. Allowed: true, false.
@@ -96,7 +96,7 @@ If you wish to use Redis as an actor store, append the following to the yaml.
9696
| Field | Required | Details | Example |
9797
|--------------------|:--------:|---------|---------|
9898
| redisHost | Y | Connection-string for the redis host | `localhost:6379`, `redis-master.default.svc.cluster.local:6379`
99-
| redisPassword | Y | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"`
99+
| redisPassword | N | Password for Redis host. No Default. Can be `secretKeyRef` to use a secret reference | `""`, `"KeFg23!"`
100100
| redisUsername | N | Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly. | `""`, `"default"`
101101
| enableTLS | N | If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to `"false"` | `"true"`, `"false"`
102102
| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10`

0 commit comments

Comments
 (0)