redis-di deploy

Deploys a pipeline with the specified configuration

Deploys a pipeline, creating it or updating it from the configuration in the --dir directory. The API validates the configuration and rejects an invalid one. By default, the command starts the pipeline after deploying and waits for it to reach the expected state. set is an alias for this command.

Pass --empty instead of --dir to deploy an empty configuration, which clears the pipeline. See Clear a pipeline for what clearing a pipeline removes and what it keeps.

Usage

redis-di deploy [pipeline] [flags]

The pipeline name is an optional argument that defaults to default. If the pipeline does not exist, the command creates it. A pipeline name must be 3 to 20 characters long, start with a lowercase letter, end with a letter or a digit, contain only lowercase letters, digits, and dashes, and not contain consecutive dashes. The name rdi is reserved. See Multiple pipelines in one RDI installation.

When the command creates a pipeline, RDI checks the configuration itself, but not against the source and target databases. RDI runs those checks through a component of the pipeline, which starts only once the pipeline exists, so --validate-tables and --validate-cdc have no effect on the first deployment. To have a new configuration checked against its databases, create the pipeline empty first and then deploy the configuration, as shown in the example.

Options

This command also accepts the global options.

Example

# Deploy the configuration in the current directory
redis-di deploy

# Validate a configuration folder without deploying it
redis-di deploy --dir /opt/rdi/config --dry-run

# Create the orders pipeline empty, then deploy and validate its configuration
redis-di deploy orders --empty
redis-di deploy orders --dir /opt/rdi/config

# Clear the pipeline by deploying an empty configuration
redis-di deploy --empty