Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Butler <16944132+dbut023@users.noreply.github.com>
  • Loading branch information
dbut023 committed Sep 15, 2022
1 parent 605ea63 commit b78e35e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
7 changes: 7 additions & 0 deletions docs/components/query-frontend.md
Expand Up @@ -125,6 +125,13 @@ config:
get_multi_batch_size: 100
max_set_multi_concurrency: 100
set_multi_batch_size: 100
tls_enabled: false
tls_config:
ca_file: ""
cert_file: ""
key_file: ""
server_name: ""
insecure_skip_verify: false
expiration: 24h0m0s
```

Expand Down
18 changes: 16 additions & 2 deletions docs/components/store.md
Expand Up @@ -328,6 +328,13 @@ config:
get_multi_batch_size: 100
max_set_multi_concurrency: 100
set_multi_batch_size: 100
tls_enabled: false
tls_config:
ca_file: ""
cert_file: ""
key_file: ""
server_name: ""
insecure_skip_verify: false
```

The **required** settings are:
Expand All @@ -336,8 +343,8 @@ The **required** settings are:

While the remaining settings are **optional**:

- `username`: the username to connect redis, only redis 6.0 and grater need this field.
- `password`: the password to connect redis.
- `username`: the username to connect to redis, only redis 6.0 and grater need this field.
- `password`: the password to connect to redis.
- `db`: the database to be selected after connecting to the server.
- `dial_timeout`: the redis dial timeout.
- `read_timeout`: the redis read timeout.
Expand All @@ -350,6 +357,13 @@ While the remaining settings are **optional**:
- `get_multi_batch_size`: specifies the maximum size per batch for mget.
- `max_set_multi_concurrency`: specifies the maximum number of concurrent SetMulti() operations.
- `set_multi_batch_size`: specifies the maximum size per batch for pipeline set.
- `tls_enabled`: enables the use of TLS to connect to redis
- `tls_config`: TLS connection configuration:
- `ca_file`: path to Root CA certificate file to use
- `cert_file`: path to Client Certificate file to use
- `key_file`: path to the Key file for cert_file (NOTE: Both this and `cert_file` must be set if used)
- `servername`: Override the server name used to validate the server certificate
- `insecure_skip_verify`: Disable certificate verification

## Caching Bucket

Expand Down

0 comments on commit b78e35e

Please sign in to comment.