Update autogenerated docs

RedisLabs · Apr 29, 2024 · d971f46 · d971f46
1 parent 9b43581
commit d971f46
Show file tree

Hide file tree

Showing 20 changed files with 53 additions and 56 deletions.
diff --git a/content/rdi/reference/cli/redis-di-add-context.md b/content/rdi/reference/cli/redis-di-add-context.md
@@ -41,7 +41,7 @@ Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
 
 - `cluster_api_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `9443`
   - Usage: `--cluster-api-port`
 
@@ -65,7 +65,7 @@ Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -125,12 +125,12 @@ Options:
                                   name in case of k8s)  [required]
   --cluster-api-port INTEGER RANGE
                                   API Port of Redis Enterprise Cluster
-                                  [default: 9443; 1000<=x<=65535; required]
+                                  [default: 9443; 1<=x<=65535; required]
   --cluster-user TEXT             Redis Enterprise Cluster username with
                                   either DB Member, Cluster Member or Cluster
                                   Admin roles  [required]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-key TEXT                  Private key file to authenticate with

diff --git a/content/rdi/reference/cli/redis-di-create.md b/content/rdi/reference/cli/redis-di-create.md
@@ -43,7 +43,7 @@ Usage: redis-di create [OPTIONS]
 
 - `cluster_api_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `9443`
   - Usage: `--cluster-api-port`
 
@@ -67,7 +67,7 @@ Usage: redis-di create [OPTIONS]
 
 - `rdi_port`:
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -145,13 +145,12 @@ Options:
                                   name in case of k8s)  [required]
   --cluster-api-port INTEGER RANGE
                                   API Port of Redis Enterprise Cluster
-                                  [default: 9443; 1000<=x<=65535; required]
+                                  [default: 9443; 1<=x<=65535; required]
   --cluster-user TEXT             Redis Enterprise Cluster username with
                                   either DB Member, Cluster Member or Cluster
                                   Admin roles  [required]
   --cluster-password TEXT         Redis Enterprise Cluster Password
-  --rdi-port INTEGER RANGE        Port for the new RDI Database
-                                  [1000<=x<=65535]
+  --rdi-port INTEGER RANGE        Port for the new RDI Database  [1<=x<=65535]
   --rdi-password TEXT             Password for the new RDI Database
                                   (alphanumeric characters with zero or more
                                   of the following: ! & # $ ^ < > -)

diff --git a/content/rdi/reference/cli/redis-di-delete.md b/content/rdi/reference/cli/redis-di-delete.md
@@ -35,7 +35,7 @@ Usage: redis-di delete [OPTIONS]
 
 - `cluster_api_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `9443`
   - Usage: `--cluster-api-port`
 
@@ -67,7 +67,7 @@ Usage: redis-di delete [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -152,13 +152,13 @@ Options:
                                   name in case of k8s)  [required]
   --cluster-api-port INTEGER RANGE
                                   API Port of Redis Enterprise Cluster
-                                  [default: 9443; 1000<=x<=65535; required]
+                                  [default: 9443; 1<=x<=65535; required]
   --cluster-user TEXT             Redis Enterprise Cluster username with
                                   either DB Member, Cluster Member or Cluster
                                   Admin roles  [required]
   --cluster-password TEXT         Redis Enterprise Cluster Password
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-deploy.md b/content/rdi/reference/cli/redis-di-deploy.md
@@ -35,7 +35,7 @@ Usage: redis-di deploy [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -116,7 +116,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-describe-job.md b/content/rdi/reference/cli/redis-di-describe-job.md
@@ -41,7 +41,7 @@ Usage: redis-di describe-job [OPTIONS] JOB_NAME
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -114,7 +114,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-dump-support-package.md b/content/rdi/reference/cli/redis-di-dump-support-package.md
@@ -35,7 +35,7 @@ Usage: redis-di dump-support-package [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -148,7 +148,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-get-rejected.md b/content/rdi/reference/cli/redis-di-get-rejected.md
@@ -35,7 +35,7 @@ Usage: redis-di get-rejected [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -133,7 +133,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-install-collector.md b/content/rdi/reference/cli/redis-di-install-collector.md
@@ -35,7 +35,7 @@ Usage: redis-di install-collector [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -108,7 +108,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-install-redisgears.md b/content/rdi/reference/cli/redis-di-install-redisgears.md
@@ -35,7 +35,7 @@ Usage: redis-di install-redisgears [OPTIONS]
 
 - `cluster_api_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `9443`
   - Usage: `--cluster-api-port`
 
@@ -87,7 +87,7 @@ Options:
                                   name in case of k8s)  [required]
   --cluster-api-port INTEGER RANGE
                                   API Port of Redis Enterprise Cluster
-                                  [default: 9443; 1000<=x<=65535; required]
+                                  [default: 9443; 1<=x<=65535; required]
   --cluster-user TEXT             Redis Enterprise Cluster username with
                                   either DB Member, Cluster Member or Cluster
                                   Admin roles  [required]

diff --git a/content/rdi/reference/cli/redis-di-install.md b/content/rdi/reference/cli/redis-di-install.md
@@ -27,7 +27,7 @@ Usage: redis-di install [OPTIONS]
 
 - `file`:
 
-  - Type: <click.types.Path object at 0x7f9b1e579b50>
+  - Type: <click.types.Path object at 0x7f79e917b970>
   - Default: `none`
   - Usage: `-f
 --file`

diff --git a/content/rdi/reference/cli/redis-di-list-jobs.md b/content/rdi/reference/cli/redis-di-list-jobs.md
@@ -35,7 +35,7 @@ Usage: redis-di list-jobs [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -108,7 +108,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-monitor.md b/content/rdi/reference/cli/redis-di-monitor.md
@@ -35,7 +35,7 @@ Usage: redis-di monitor [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -91,7 +91,7 @@ Usage: redis-di monitor [OPTIONS]
 
 - `exporter_port`:
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `9121`
   - Usage: `--exporter-port`
 
@@ -124,7 +124,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password
@@ -134,7 +134,7 @@ Options:
   --rdi-key-password TEXT         Password for unlocking an encrypted private
                                   key
   --exporter-port INTEGER RANGE   HTTP port to start the exporter on
-                                  [1000<=x<=65535]
+                                  [1<=x<=65535]
   --collect-interval INTEGER RANGE
                                   Metrics collection interval (seconds)
                                   [1<=x<=60]

diff --git a/content/rdi/reference/cli/redis-di-reset.md b/content/rdi/reference/cli/redis-di-reset.md
@@ -35,7 +35,7 @@ Usage: redis-di reset [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -125,7 +125,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-scaffold.md b/content/rdi/reference/cli/redis-di-scaffold.md
@@ -1,14 +1,14 @@
 ---
 Title: redis-di scaffold
 linkTitle: redis-di scaffold
-description: Generates configuration files for RDI and Debezium (when ingesting data to Redis)
+description: Generates configuration files for RDI
 weight: 10
 alwaysopen: false
 categories: ["redis-di"]
 aliases:
 ---
 
-Generates configuration files for RDI and Debezium (when ingesting data to Redis)
+Generates configuration files for RDI
 
 ## Usage
 
@@ -53,11 +53,11 @@ Usage: redis-di scaffold [OPTIONS]
 
 - `preview`:
 
-  - Type: Choice(['debezium/application.properties', 'config.yaml'])
+  - Type: STRING
   - Default: `none`
   - Usage: `--preview`
 
-  Print the content of specified config file to CLI output
+  Print the content of the scaffolded config file to CLI output
 
 - `help`:
 
@@ -72,8 +72,7 @@ Usage: redis-di scaffold [OPTIONS]
 ```
 Usage: redis-di scaffold [OPTIONS]
 
-  Generates configuration files for RDI and Debezium (when ingesting data to
-  Redis)
+  Generates configuration files for RDI
 
 Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
@@ -85,8 +84,7 @@ Options:
   Output formats: [mutually_exclusive, required]
                                   Output to directory or stdout
     --dir TEXT                    Directory containing RDI configuration
-    --preview [debezium/application.properties|config.yaml]
-                                  Print the content of specified config file
-                                  to CLI output
+    --preview TEXT                Print the content of the scaffolded config
+                                  file to CLI output
   --help                          Show this message and exit.
 ```
diff --git a/content/rdi/reference/cli/redis-di-start.md b/content/rdi/reference/cli/redis-di-start.md
@@ -35,7 +35,7 @@ Usage: redis-di start [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -108,7 +108,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-status.md b/content/rdi/reference/cli/redis-di-status.md
@@ -35,7 +35,7 @@ Usage: redis-di status [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -144,7 +144,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password

diff --git a/content/rdi/reference/cli/redis-di-stop.md b/content/rdi/reference/cli/redis-di-stop.md
@@ -35,7 +35,7 @@ Usage: redis-di stop [OPTIONS]
 
 - `rdi_port` (REQUIRED):
 
-  - Type: <IntRange 1000<=x<=65535>
+  - Type: <IntRange 1<=x<=65535>
   - Default: `none`
   - Usage: `--rdi-port`
 
@@ -108,7 +108,7 @@ Options:
   -l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
                                   [default: INFO]
   --rdi-host TEXT                 Host/IP of RDI Database  [required]
-  --rdi-port INTEGER RANGE        Port of RDI Database  [1000<=x<=65535;
+  --rdi-port INTEGER RANGE        Port of RDI Database  [1<=x<=65535;
                                   required]
   --rdi-user TEXT                 RDI Database Username
   --rdi-password TEXT             RDI Database Password