fix(redis): make auth profiles consistent for username/pwd (dapr#3565)

Signed-off-by: Samantha Coyle <[email protected]> Signed-off-by: Elena Kolevska <[email protected]>
elena-kolevska · Oct 24, 2024 · d68bcd0 · d68bcd0
1 parent 07b7404
commit d68bcd0
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 23 deletions.
diff --git a/pubsub/redis/metadata.yaml b/pubsub/redis/metadata.yaml
@@ -10,25 +10,34 @@ urls:
     url: https://docs.dapr.io/reference/components-reference/supported-pubsub/setup-redis-pubsub/
 capabilities:
   - ttl
+authenticationProfiles:
+  - title: "Username and password"
+    description: "Authenticate using username and password."
+    metadata:
+      - name: redisUsername
+        type: string
+        required: false
+        description: |
+          Username for Redis host. Defaults to empty. Make sure your Redis server
+          version is 6 or above, and have created ACL rule correctly.
+        example:  "my-username"
+        default: ""
+      - name: redisPassword
+        type: string
+        required: false
+        sensitive: true
+        description: |
+          Password for Redis host. No default. Use secretKeyRef for
+          secret reference
+        example:  "KeFg23!"
+        default: ""
 metadata:
   - name: redisHost
     required: true
     description: |
       Connection-string for the redis host. If "redisType" is "cluster" it can be multiple hosts separated by commas or just a single host
     example: '"redis-master.default.svc.cluster.local:6379"'
     type: string
-  - name: redisPassword
-    required: true
-    sensitive: true
-    description: |
-      Password for Redis host. No Default. Can be "secretKeyRef" to use a secret reference
-    example: '"KeFg23!"'
-    type: string
-  - name: redisUsername
-    required: false
-    description: Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly.
-    example: "default"
-    type: string
   - name: consumerID
     required: false
     description: The consumer group ID

diff --git a/state/redis/metadata.yaml b/state/redis/metadata.yaml
@@ -15,23 +15,33 @@ capabilities:
   - transactional
   - etag
   - query
+authenticationProfiles:
+  - title: "Username and password"
+    description: "Authenticate using username and password."
+    metadata:
+      - name: redisUsername
+        type: string
+        required: false
+        description: |
+          Username for Redis host. Defaults to empty. Make sure your Redis server
+          version is 6 or above, and have created ACL rule correctly.
+        example:  "my-username"
+        default: ""
+      - name: redisPassword
+        type: string
+        required: false
+        sensitive: true
+        description: |
+          Password for Redis host. No default. Use secretKeyRef for
+          secret reference
+        example:  "KeFg23!"
+        default: ""
 metadata:
   - name: redisHost
     required: true
     description: Connection-string for the redis host
     example: "redis-master.default.svc.cluster.local:6379"
     type: string
-  - name: redisPassword
-    required: false
-    sensitive: true
-    description: Password for Redis host. No Default. Can be secretKeyRef to use a secret reference
-    example:  "KeFg23!"
-    type: string
-  - name: redisUsername
-    required: false
-    description: Username for Redis host. Defaults to empty. Make sure your redis server version is 6 or above, and have created acl rule correctly.
-    example:  "default"
-    type: string
   - name: enableTLS
     required: false
     description: If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to false.