From d971f460bb93158b8f7a3c33d98d9267a79e8057 Mon Sep 17 00:00:00 2001 From: spicy-sauce Date: Mon, 29 Apr 2024 12:52:36 +0000 Subject: [PATCH] Update autogenerated docs --- .../rdi/reference/cli/redis-di-add-context.md | 8 ++++---- content/rdi/reference/cli/redis-di-create.md | 9 ++++----- content/rdi/reference/cli/redis-di-delete.md | 8 ++++---- content/rdi/reference/cli/redis-di-deploy.md | 4 ++-- .../rdi/reference/cli/redis-di-describe-job.md | 4 ++-- .../cli/redis-di-dump-support-package.md | 4 ++-- .../rdi/reference/cli/redis-di-get-rejected.md | 4 ++-- .../reference/cli/redis-di-install-collector.md | 4 ++-- .../reference/cli/redis-di-install-redisgears.md | 4 ++-- content/rdi/reference/cli/redis-di-install.md | 2 +- content/rdi/reference/cli/redis-di-list-jobs.md | 4 ++-- content/rdi/reference/cli/redis-di-monitor.md | 8 ++++---- content/rdi/reference/cli/redis-di-reset.md | 4 ++-- content/rdi/reference/cli/redis-di-scaffold.md | 16 +++++++--------- content/rdi/reference/cli/redis-di-start.md | 4 ++-- content/rdi/reference/cli/redis-di-status.md | 4 ++-- content/rdi/reference/cli/redis-di-stop.md | 4 ++-- content/rdi/reference/cli/redis-di-trace.md | 4 ++-- content/rdi/reference/cli/redis-di-upgrade.md | 8 ++++---- content/rdi/reference/cli/redis-di.md | 2 +- 20 files changed, 53 insertions(+), 56 deletions(-) diff --git a/content/rdi/reference/cli/redis-di-add-context.md b/content/rdi/reference/cli/redis-di-add-context.md index 093cd198c65..5a76b09b630 100644 --- 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: + - Type: - Default: `9443` - Usage: `--cluster-api-port` @@ -65,7 +65,7 @@ Usage: redis-di add-context [OPTIONS] CONTEXT_NAME - `rdi_port` (REQUIRED): - - Type: + - Type: - 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 index 83f9d28757c..0f255fe60ad 100644 --- 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: + - Type: - Default: `9443` - Usage: `--cluster-api-port` @@ -67,7 +67,7 @@ Usage: redis-di create [OPTIONS] - `rdi_port`: - - Type: + - Type: - 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 index 7e50b2ee477..eda4619ece4 100644 --- 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: + - Type: - Default: `9443` - Usage: `--cluster-api-port` @@ -67,7 +67,7 @@ Usage: redis-di delete [OPTIONS] - `rdi_port` (REQUIRED): - - Type: + - Type: - 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 index 7b2eba586bb..a20d2606666 100644 --- 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: + - Type: - 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 index fe983a28044..e054989f372 100644 --- 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: + - Type: - 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 index c7b0436e100..32fa4dac713 100644 --- 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: + - Type: - 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 index 678964f95cc..42df4b76e01 100644 --- 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: + - Type: - 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 index 23abbb83eed..3d479697293 100644 --- 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: + - Type: - 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 index 4ee79fd5115..b4fd4b9f2be 100644 --- 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: + - Type: - 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 index be62cfb0e6b..718e1055127 100644 --- 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: + - Type: - 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 index e4ec64e01a2..e0f53698e7f 100644 --- 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: + - Type: - 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 index 966745ed5f1..a4bc66d39cc 100644 --- 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: + - Type: - Default: `none` - Usage: `--rdi-port` @@ -91,7 +91,7 @@ Usage: redis-di monitor [OPTIONS] - `exporter_port`: - - Type: + - Type: - 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 index 7c31eaef27b..513ac53921e 100644 --- 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: + - Type: - 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 index 0da3bc33298..a8467dfc402 100644 --- 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 index 3209580a78d..00efd8d9b4c 100644 --- 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: + - Type: - 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 index 3ff3fc889ff..a275aa00b8d 100644 --- 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: + - Type: - 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 index 69165d9ae3f..4da2138a7c3 100644 --- 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: + - Type: - 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-trace.md b/content/rdi/reference/cli/redis-di-trace.md index e160d02f1c4..c34f4e1eed8 100644 --- a/content/rdi/reference/cli/redis-di-trace.md +++ b/content/rdi/reference/cli/redis-di-trace.md @@ -35,7 +35,7 @@ Usage: redis-di trace [OPTIONS] - `rdi_port` (REQUIRED): - - Type: + - Type: - Default: `none` - Usage: `--rdi-port` @@ -132,7 +132,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-upgrade.md b/content/rdi/reference/cli/redis-di-upgrade.md index 00ea8fbd7c6..88471e3bb9a 100644 --- a/content/rdi/reference/cli/redis-di-upgrade.md +++ b/content/rdi/reference/cli/redis-di-upgrade.md @@ -35,7 +35,7 @@ Usage: redis-di upgrade [OPTIONS] - `cluster_api_port` (REQUIRED): - - Type: + - Type: - Default: `9443` - Usage: `--cluster-api-port` @@ -67,7 +67,7 @@ Usage: redis-di upgrade [OPTIONS] - `rdi_port` (REQUIRED): - - Type: + - Type: - 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.md b/content/rdi/reference/cli/redis-di.md index 052e98c6868..fab6865bef2 100644 --- a/content/rdi/reference/cli/redis-di.md +++ b/content/rdi/reference/cli/redis-di.md @@ -62,7 +62,7 @@ Commands: list-jobs Lists transformation engine's jobs monitor Monitors RDI by collecting metrics and exporting... reset Resets the pipeline into initial full sync mode - scaffold Generates configuration files for RDI and... + scaffold Generates configuration files for RDI set-context Sets a context to be the active one set-secret Creates a secret of a specified key start Starts the pipeline