Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

RDSC-1880-json-schema-for-config-yaml: Auto generated #3192

Draft
wants to merge 5 commits into
base: rdi-preview-build
Choose a base branch
from
Draft

RDSC-1880-json-schema-for-config-yaml: Auto generated #3192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c54367
Update autogenerated docs
spicy-sauce Mar 12, 2024
a899a9a
Update autogenerated docs
spicy-sauce Mar 13, 2024
d789c06
Update autogenerated docs
spicy-sauce Mar 13, 2024
f6f76d5
Update autogenerated docs
spicy-sauce Mar 13, 2024
4f4cbce
Update autogenerated docs
spicy-sauce Mar 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/rdi/reference/cli/redis-di-add-context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
- Default: `none`
- Usage: `context-name`

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `cluster_host` (REQUIRED):

Expand Down Expand Up @@ -119,7 +119,7 @@ Usage: redis-di add-context [OPTIONS] CONTEXT_NAME
Adds a new context

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--cluster-host TEXT Host/IP of Redis Enterprise Cluster (service
name in case of k8s) [required]
Expand Down
29 changes: 9 additions & 20 deletions content/rdi/reference/cli/redis-di-create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di create [OPTIONS]

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `silent`:

Expand All @@ -33,14 +33,6 @@ Usage: redis-di create [OPTIONS]

Silent install. Do not prompt to enter missing parameters

- `no_configure`:

- Type: BOOL
- Default: `false`
- Usage: `--no-configure`

Do not install RDI Engine to the RDI Database

- `cluster_host` (REQUIRED):

- Type: STRING
Expand Down Expand Up @@ -113,13 +105,13 @@ Usage: redis-di create [OPTIONS]

In-memory database replication

- `redisgears_module`:
- `with_redisgears`:

- Type: STRING
- Default: ``
- Usage: `--redisgears-module`
- Type: BOOL
- Default: `false`
- Usage: `--with-redisgears`

RedisGears module file
Include RedisGears module in the RDI database

- `with_rejson`:

Expand All @@ -145,12 +137,10 @@ Usage: redis-di create [OPTIONS]
Creates the RDI Database instance

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--silent Silent install. Do not prompt to enter
missing parameters
--no-configure Do not install RDI Engine to the RDI
Database
--cluster-host TEXT Host/IP of Redis Enterprise Cluster (service
name in case of k8s) [required]
--cluster-api-port INTEGER RANGE
Expand All @@ -169,6 +159,5 @@ Options:
--rdi-shards INTEGER RANGE Number of database server-side shards
[x>=1]
--replication In-memory database replication
--redisgears-module TEXT RedisGears module file
--help Show this message and exit.
```
8 changes: 4 additions & 4 deletions content/rdi/reference/cli/redis-di-delete-all-contexts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di delete-all-contexts [OPTIONS]

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `force`:

Expand All @@ -50,7 +50,7 @@ Usage: redis-di delete-all-contexts [OPTIONS]
Deletes all contexts

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
-f, --force Force operation. skips verification prompts
--help Show this message and exit.
Expand Down
8 changes: 4 additions & 4 deletions content/rdi/reference/cli/redis-di-delete-context.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di delete-context [OPTIONS] CONTEXT_NAME

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `context_name` (REQUIRED):

Expand Down Expand Up @@ -56,7 +56,7 @@ Usage: redis-di delete-context [OPTIONS] CONTEXT_NAME
Deletes a context

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
-f, --force Force operation. skips verification prompts
--help Show this message and exit.
Expand Down
8 changes: 4 additions & 4 deletions content/rdi/reference/cli/redis-di-delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di delete [OPTIONS]

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `cluster_host` (REQUIRED):

Expand Down Expand Up @@ -146,7 +146,7 @@ Usage: redis-di delete [OPTIONS]
Deletes RDI database permanently

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-l, --log-level [DEBUG|INFO|WARN|ERROR|CRITICAL]
[default: INFO]
--cluster-host TEXT Host/IP of Redis Enterprise Cluster (service
name in case of k8s) [required]
Expand Down
8 changes: 4 additions & 4 deletions content/rdi/reference/cli/redis-di-deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di deploy [OPTIONS]

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `rdi_host` (REQUIRED):

Expand Down Expand Up @@ -113,7 +113,7 @@ Usage: redis-di deploy [OPTIONS]
Deploys the RDI configurations including target

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-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;
Expand Down
8 changes: 4 additions & 4 deletions content/rdi/reference/cli/redis-di-describe-job.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di describe-job [OPTIONS] JOB_NAME

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `job_name` (REQUIRED):

Expand Down Expand Up @@ -111,7 +111,7 @@ Usage: redis-di describe-job [OPTIONS] JOB_NAME
Describes a transformation engine's job

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-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;
Expand Down
13 changes: 6 additions & 7 deletions content/rdi/reference/cli/redis-di-dump-support-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di dump-support-package [OPTIONS]

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `rdi_host` (REQUIRED):

Expand Down Expand Up @@ -119,7 +119,7 @@ Usage: redis-di dump-support-package [OPTIONS]
- Default: `10`
- Usage: `--max-change-records`

Maximum traced change records per shard
Maximum traced change records

- `trace_only_rejected`:

Expand All @@ -145,7 +145,7 @@ Usage: redis-di dump-support-package [OPTIONS]
Dumps RDI support package

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-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;
Expand All @@ -163,8 +163,7 @@ Options:
--trace-timeout INTEGER RANGE Stops the trace after exceeding this timeout
(in seconds) [1<=x<=600]
--max-change-records INTEGER RANGE
Maximum traced change records per shard
[x>=1]
Maximum traced change records [x>=1]
--trace-only-rejected Trace only rejected change records
--help Show this message and exit.
```
8 changes: 4 additions & 4 deletions content/rdi/reference/cli/redis-di-get-rejected.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Usage: redis-di get-rejected [OPTIONS]

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `rdi_host` (REQUIRED):

Expand Down Expand Up @@ -130,7 +130,7 @@ Usage: redis-di get-rejected [OPTIONS]
Returns all the stored rejected entries

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-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;
Expand Down
22 changes: 11 additions & 11 deletions ...t/rdi/reference/cli/redis-di-configure.md → ...ference/cli/redis-di-install-collector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
---
Title: redis-di configure
linkTitle: redis-di configure
description: Configures the RDI Database so it is ready to process data
Title: redis-di install-collector
linkTitle: redis-di install-collector
description: Installs RDI Redis Collector on Redis BDB with RedisGears
weight: 10
alwaysopen: false
categories: ["redis-di"]
aliases:
---

Configures the RDI Database so it is ready to process data
Installs RDI Redis Collector on Redis BDB with RedisGears

## Usage

```
Usage: redis-di configure [OPTIONS]
Usage: redis-di install-collector [OPTIONS]
```

## Options

- `loglevel`:
- `log_level`:

- Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])
- Default: `info`
- Usage: `--loglevel
-log-level`
- Usage: `--log-level
-l`

- `rdi_host` (REQUIRED):

Expand Down Expand Up @@ -100,12 +100,12 @@ Usage: redis-di configure [OPTIONS]
## CLI help

```
Usage: redis-di configure [OPTIONS]
Usage: redis-di install-collector [OPTIONS]

Configures the RDI Database so it is ready to process data
Installs RDI Redis Collector on Redis BDB with RedisGears

Options:
-log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]
-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;
Expand Down