Skip to content

Commit 35eb5c0

Browse files
committed
Update autogenerated docs
1 parent cf39a89 commit 35eb5c0

31 files changed

+1486
-1377
lines changed

content/integrate/redis-data-integration/reference/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@ Title: Reference
33
aliases: /integrate/redis-data-integration/ingest/reference/
44
alwaysopen: false
55
categories:
6-
- docs
7-
- integrate
8-
- rs
9-
- rdi
6+
- docs
7+
- integrate
8+
- rs
9+
- rdi
1010
description: View reference material for Redis Data Integration
1111
group: di
1212
hideListLinks: false
1313
linkTitle: Reference
14-
summary: Redis Data Integration keeps Redis in sync with the primary database in near
14+
summary:
15+
Redis Data Integration keeps Redis in sync with the primary database in near
1516
real time.
1617
type: integration
1718
weight: 60

content/integrate/redis-data-integration/reference/cli/_index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@ Title: CLI reference
33
aliases: /integrate/redis-data-integration/ingest/reference/cli/
44
alwaysopen: false
55
categories:
6-
- docs
7-
- integrate
8-
- rs
9-
- rdi
6+
- docs
7+
- integrate
8+
- rs
9+
- rdi
1010
description: Reference for the RDI CLI commands
1111
group: di
1212
hideListLinks: false
1313
linkTitle: CLI commands
14-
summary: Redis Data Integration keeps Redis in sync with the primary database in near
14+
summary:
15+
Redis Data Integration keeps Redis in sync with the primary database in near
1516
real time.
1617
type: integration
1718
weight: 60

content/integrate/redis-data-integration/reference/cli/redis-di-add-context.md

Lines changed: 47 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,100 @@
11
---
22
Title: redis-di add-context
33
linkTitle: redis-di add-context
4-
description: Adds a new context
4+
description: Adds a new context
55
weight: 10
66
alwaysopen: false
77
categories: ["redis-di"]
88
aliases:
99
---
1010

11+
Adds a new context
12+
1113
## Usage
1214

1315
```
1416
Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
1517
```
1618

1719
## Options
18-
* `context_name` (REQUIRED):
19-
* Type: STRING
20-
* Default: `none`
21-
* Usage: `context-name`
22-
23-
24-
25-
26-
* `log_level`:
27-
* Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
28-
* Default: `info`
29-
* Usage: `--log-level
30-
-l`
31-
32-
3320

21+
- `context_name` (REQUIRED):
3422

35-
* `cluster_host` (REQUIRED):
36-
* Type: STRING
37-
* Default: `none`
38-
* Usage: `--cluster-host`
23+
- Type: STRING
24+
- Default: `none`
25+
- Usage: `context-name`
3926

40-
Host/IP of Redis Enterprise Cluster (service name in case of k8s)
27+
- `log_level`:
4128

29+
- Type: Choice(['TRACE', 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'])
30+
- Default: `info`
31+
- Usage: `--log-level
32+
-l`
4233

43-
* `cluster_api_port` (REQUIRED):
44-
* Type: <IntRange 1<=x<=65535>
45-
* Default: `9443`
46-
* Usage: `--cluster-api-port`
47-
48-
API Port of Redis Enterprise Cluster
49-
34+
- `rdi_namespace`:
5035

51-
* `cluster_user` (REQUIRED):
52-
* Type: STRING
53-
* Default: `none`
54-
* Usage: `--cluster-user`
36+
- Type: STRING
37+
- Default: `rdi`
38+
- Usage: `--rdi-namespace`
5539

56-
Redis Enterprise Cluster username with either DB Member, Cluster Member or Cluster Admin roles
40+
RDI Kubernetes namespace
5741

42+
- `rdi_host` (REQUIRED):
5843

59-
* `rdi_host` (REQUIRED):
60-
* Type: STRING
61-
* Default: `none`
62-
* Usage: `--rdi-host`
44+
- Type: STRING
45+
- Default: `none`
46+
- Usage: `--rdi-host`
6347

6448
Host/IP of RDI Database
6549

50+
- `rdi_port` (REQUIRED):
6651

67-
* `rdi_port` (REQUIRED):
68-
* Type: <IntRange 1<=x<=65535>
69-
* Default: `none`
70-
* Usage: `--rdi-port`
52+
- Type: <IntRange 1<=x<=65535>
53+
- Default: `none`
54+
- Usage: `--rdi-port`
7155

7256
Port of RDI Database
7357

58+
- `rdi_user`:
7459

75-
* `rdi_user`:
76-
* Type: STRING
77-
* Default: `none`
78-
* Usage: `--rdi-user`
60+
- Type: STRING
61+
- Default: `none`
62+
- Usage: `--rdi-user`
7963

8064
RDI Database Username
8165

66+
- `rdi_key`:
8267

83-
* `rdi_key`:
84-
* Type: STRING
85-
* Default: `none`
86-
* Usage: `--rdi-key`
68+
- Type: STRING
69+
- Default: `none`
70+
- Usage: `--rdi-key`
8771

8872
Private key file to authenticate with
8973

74+
- `rdi_cert`:
9075

91-
* `rdi_cert`:
92-
* Type: STRING
93-
* Default: `none`
94-
* Usage: `--rdi-cert`
76+
- Type: STRING
77+
- Default: `none`
78+
- Usage: `--rdi-cert`
9579

9680
Client certificate file to authenticate with
9781

82+
- `rdi_cacert`:
9883

99-
* `rdi_cacert`:
100-
* Type: STRING
101-
* Default: `none`
102-
* Usage: `--rdi-cacert`
84+
- Type: STRING
85+
- Default: `none`
86+
- Usage: `--rdi-cacert`
10387

10488
CA certificate file to verify with
10589

90+
- `help`:
10691

107-
* `help`:
108-
* Type: BOOL
109-
* Default: `false`
110-
* Usage: `--help`
92+
- Type: BOOL
93+
- Default: `false`
94+
- Usage: `--help`
11195

11296
Show this message and exit.
11397

114-
115-
11698
## CLI help
11799

118100
```
@@ -121,16 +103,9 @@ Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
121103
Adds a new context
122104
123105
Options:
124-
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
106+
-l, --log-level [TRACE|DEBUG|INFO|WARNING|ERROR|CRITICAL]
125107
[default: INFO]
126-
--cluster-host TEXT Host/IP of Redis Enterprise Cluster (service
127-
name in case of k8s) [required]
128-
--cluster-api-port INTEGER RANGE
129-
API Port of Redis Enterprise Cluster
130-
[default: 9443; 1<=x<=65535; required]
131-
--cluster-user TEXT Redis Enterprise Cluster username with
132-
either DB Member, Cluster Member or Cluster
133-
Admin roles [required]
108+
--rdi-namespace TEXT RDI Kubernetes namespace [default: rdi]
134109
--rdi-host TEXT Host/IP of RDI Database [required]
135110
--rdi-port INTEGER RANGE Port of RDI Database [1<=x<=65535;
136111
required]

content/integrate/redis-data-integration/reference/cli/redis-di-config-rdi.md

Lines changed: 0 additions & 121 deletions
This file was deleted.

0 commit comments

Comments
 (0)