modify component metadata.type for pubsub.redis (#2670)

This commit is contained in:
MregXN 2023-03-15 23:39:31 +08:00 committed by GitHub
parent a31f385281
commit 119fe8bd27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 20 deletions

View File

@ -35,27 +35,27 @@ metadata:
required: false
description: If the Redis instance supports TLS with public certificates, can be configured to be enabled or disabled. Defaults to \"false\".
example: "false"
type: string
type: bool
- name: redeliverInterval
required: false
description: The interval between checking for pending messages to redelivery. Defaults to \"60s\". \"0\" disables redelivery.
example: "30s"
type: string
type: duration
- name: processingTimeout
required: false
description: The amount time a message must be pending before attempting to redeliver it. Defaults to \"15s\". \"0\" disables redelivery.
example: "30s"
type: string
type: duration
- name: queueDepth
required: false
description: The size of the message queue for processing. Defaults to \"100\".
example: "1000"
type: string
type: number
- name: concurrency
required: false
description: The number of concurrent workers that are processing messages. Defaults to \"10\".
example: "15"
type: string
type: number
- name: redisType
required: false
description: The type of redis. There are two valid values, one is \"node\" for single node mode, the other is \"cluster\" for redis cluster mode. Defaults to \"node\".
@ -65,72 +65,72 @@ metadata:
required: false
description: Database selected after connecting to redis. If \"redisType\" is \"cluster\" this option is ignored. Defaults to \"0\".
example: "0"
type: string
type: number
- name: redisMaxRetries
required: false
description: Maximum number of times to retry commands before giving up. Default is to not retry failed commands.
example: "5"
type: string
type: number
- name: redisMinRetryInterval
required: false
description: Minimum backoff for redis commands between each retry. Default is \"8ms\"; \"-1\" disables backoff.
example: "8ms"
type: string
type: duration
- name: redisMaxRetryInterval
required: false
description: Maximum backoff for redis commands between each retry. Default is \"512ms\";\"-1\" disables backoff.
example: "5s"
type: string
type: duration
- name: dialTimeout
required: false
description: Dial timeout for establishing new connections. Defaults to \"5s\".
example: "5s"
type: string
type: duration
- name: readTimeout
required: false
description: Timeout for socket reads. If reached, redis commands will fail with a timeout instead of blocking. Defaults to \"3s\", \"-1\" for no timeout.
example: "3s"
type: string
type: duration
- name: writeTimeout
required: false
description: Timeout for socket writes. If reached, redis commands will fail with a timeout instead of blocking. Defaults is readTimeout.
example: "3s"
type: string
type: duration
- name: poolSize
required: false
description: Maximum number of socket connections. Default is 10 connections per every CPU as reported by runtime.NumCPU.
example: "20"
type: string
type: number
- name: poolTimeout
required: false
description: Amount of time client waits for a connection if all connections are busy before returning an error. Default is readTimeout + 1 second.
example: "5s"
type: string
type: duration
- name: maxConnAge
required: false
description: Connection age at which the client retires (closes) the connection. Default is to not close aged connections.
example: "30m"
type: string
type: duration
- name: minIdleConns
required: false
description: Minimum number of idle connections to keep open in order to avoid the performance degradation associated with creating new connections. Defaults to \"0\".
example: "2"
type: string
type: number
- name: idleCheckFrequency
required: false
description: Frequency of idle checks made by idle connections reaper. Default is \"1m\". \"-1\" disables idle connections reaper.
example: "-1"
type: string
type: duration
- name: idleTimeout
required: false
description: Amount of time after which the client closes idle connections. Should be less than server's timeout. Default is \"5m\". \"-1\" disables idle timeout check.
example: "10m"
type: string
type: duration
- name: failover
required: false
description: Property to enabled failover configuration. Needs sentinalMasterName to be set. Defaults to \"false\"
example: "false"
type: string
type: bool
- name: sentinelMasterName
required: false
description: The sentinel master name. See Redis Sentinel Documentation.
@ -140,4 +140,4 @@ metadata:
required: false
description: Maximum number of items inside a stream.The old entries are automatically evicted when the specified length is reached, so that the stream is left at a constant size. Defaults to unlimited.
example: "10000"
type: string
type: number