You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<td> <b>Multi-Tenancy | Partitioning | Linear Scalability</b> <br> Redis Connect can manage multi-tenant (jobs) data replication pipelines end-to-end within a single cluster node. Jobs with different source types can be collocated without becoming noisy neighbors. Streaming and Initial Load jobs can be partitioned for linear scalability across a single or multiple cluster nodes.</td>
54
+
<td> <b>Multi-Tenancy | Partitioning | Linear Scalability</b> <br> Redis Connect manages multi-tenant replication pipelines. A pipeline from source to sink is known as a job. Jobs with different source types can be collocated without becoming noisy neighbors. Jobs can be partitioned for linear scalability across one or more cluster nodes.</td>
<td> <b>High-Availability | Recovery</b> <br> Redis Connect jobs update their checkpoint upon each committed changed-data event within a transactional scope. In the occurrence of node failure, or network split, a job would failover to another node and seamlessly begin replication from the last committed checkpoint. Data would not be lost, and order would be maintained. Redis Connect is supported on Kubernetes environments including OpenShift.</td>
58
+
<td> <b>High-Availability | Recovery</b> <br> Redis Connect jobs update their checkpoint upon each committed changed-data event within a transactional scope. In the event of a node failure or network split, in-flight jobs will fail over to another node and seamlessly begin replication from the last committed checkpoint. Data is not lost, and order is preserved. Redis Connect works in container orchestration environments such as Kubernetes and OpenShift.</td>
<td> <b>Custom Transformations</b> <br> Redis Connect Jobs support user-defined business logic simply by adding a JAR to the /extlib directory. Users can create custom workflows that include user-defined stages for proprietary business rules, custom transformations, de-tokenization, and more. Users can also extend the supported list of Target Sinks.</td>
64
+
<td> <b>Custom Transformations</b> <br> Redis Connect jobs support user-defined business logic. You can create custom workflows that include user-defined stages for proprietary business rules, custom transformations, de-tokenization, and more. You can also extend the supported list of target sinks.</td>
<td> <b>REST API | CLI | Swagger UI</b> <br> Redis Connect is entirely data-driven and relies on Redis Enterprise as its metadata store. Users can configure, start, stop, migrate, and restart jobs via its built-in REST API and/or interactive CLI. Redis Connect also exposes a Swagger UI to simplify endpoint discovery and operational experience.</td>
68
+
<td> <b>REST API | CLI | Swagger UI</b> <br> Redis Connect is entirely data-driven and relies on Redis Enterprise as its metadata store. You can configure, start, stop, migrate, and restart jobs using the built-in REST API and interactive CLI. Redis Connect also exposes a Swagger UI to simplify endpoint discovery and operational experience.</td>
<td> <b>Enterprise-Grade Security</b> <br> Redis Connect jobs are stateless so changed-data events are always in-transit. Redis Connect benefits from Redis Enterprise’s enterprise-grade security capabilities including RBAC, TLS, and more. Credentials, secrets, and trust-store passwords are never stored within Redis Connect however can be dynamically rotated with minimal disruption to the replication pipeline. Vault integration is supported.</td>
74
+
<td> <b>Enterprise-Grade Security</b> <br> Redis Connect jobs are stateless, so changed-data events are always in-transit. Redis Connect benefits from Redis Enterprise’s security, including RBAC, TLS, and more. Credentials, secrets, and trust-store passwords are never stored in Redis Connect; these secrets can be dynamically rotated with minimal disruption to the replication pipeline. Vault integration is supported.</td>
74
75
</tr>
75
76
</table>
76
77
78
+
## Requirements
79
+
80
+
### Minimum production hardware requirements
81
+
82
+
* 1 GB of RAM
83
+
* 4 CPU cores
84
+
* 20 GB of disk space
85
+
* 1 Gbps network
86
+
87
+
### Runtime requirements
88
+
89
+
* JRE 11+ e.g. [Azul OpenJDK](https://www.azul.com/downloads/?package=jdk#download-openjdk)
90
+
77
91
## Quick Start
78
92
93
+
You can run Redis Connect as a container or by downloading the code and running in your environment of choice.
94
+
95
+
### Docker
96
+
97
+
You can run and deploy Redis Connect using the [Redis Connect Docker image](https://hub.docker.com/r/redislabs/redis-connect).
98
+
79
99
### Download
80
100
81
-
Download [latest release](https://github.com/redis-field-engineering/redis-connect-dist/releases) for `Linux` or `Windows` and unarchive redis-connect-`<version>.<build>`.[tar.gz|zip] archive<br>
82
-
Docker image can be found at [DockerHub](https://hub.docker.com/r/redislabs/redis-connect)
101
+
Download the [latest release](https://github.com/redis-field-engineering/redis-connect-dist/releases) for `Linux` or `Windows` and unarchive `redis-connect-<version>.<build>.[tar.gz|zip]` archive<br>
83
102
84
-
Linux:
85
-
```bash
86
-
tar vxf <tarfile name>
87
-
```
88
-
Windows:
89
-
```cmd
90
-
unzip <zipfile name>
91
-
```
103
+
The following subdirectories will be extracted under `/redis-connect`:
104
+
*`bin` – Startup scripts
105
+
*`lib` – Dependencies
106
+
*`config` – Credentials property files, jobmanager.properties, and job-config (JSON) examples
The following subdirectories will be extracted under /redis-connect -
94
-
<br>bin – Startup scripts
95
-
<br>lib – Dependencies
96
-
<br>config – Credentials property files, jobmanager.properties, and job-config (JSON) examples
97
-
<br>extlib – Custom/External dependencies e.g. [custom stage](https://github.com/redis-field-engineering/redis-connect-custom-stage-demo), source-database drivers, etc.
109
+
### Launch Redis Connect
98
110
99
-
### Getting Started
111
+
Redis Connect includes scripts for launching a single instance. You can run the scripts as follows:
100
112
101
-
**Review options by running Redis Connect startup script** <br>
| Update `credentials.file.path` and `redis.connection.url` within `/config/jobmanager.properties`<br/> Example - <ahref="/examples/postgres/demo/config/jobmanager.properties">jobmanager.properties</a> |
139
+
| Update `credentials.file.path` and `redis.connection.url` in `/config/jobmanager.properties`<br/> Example - <ahref="/examples/postgres/demo/config/jobmanager.properties">jobmanager.properties</a> |
**Open browser to access Swagger UI -**[http://localhost:8282/swagger-ui/index.html]()
153
+
### Swagger UI
154
+
155
+
The Redis Connect Swagger UI is available on port 8282 by default. If you're running locally, you can point your browser to [http://localhost:8282/swagger-ui/index.html]()
156
+
141
157
<br>_For quick start, use '**cdc_job**' as **jobName**_
142
158
<br><br><imgsrc="/images/quick-start/Redis Connect Swagger Front Page.jpg"style="float: right;"width = 700pxheight = 425px/>
| Update `credentialsFilePath`, `databaseURL`, `database.dbname`, `database.hostname`, `database.port`, `schemaAndTableName`, and `columns` within sample job configuration for source and target, where applicable |
166
+
| Update `credentialsFilePath`, `databaseURL`, `database.dbname`, `database.hostname`, `database.port`, `schemaAndTableName`, and `columns` within sample job configuration for source and target, where applicable.|
<br>_For quick start, use '**all**' as **jobStatus**_
158
174
<br><br><imgsrc="/images/quick-start/Redis Connect Get Claims.png"style="float: right;"width = 700pxheight = 250px/>
159
175
160
-
**Insert some records to the source and confirm they have arrived in Redis. Enjoy!**
161
-
162
-
## Requirements
163
-
164
-
### Minimum Production Hardware Requirements
176
+
Once you've configured a job, try inserting some records into the source database. Then confirm that they have arrived in Redis.
165
177
166
-
* 1GB of RAM
167
-
* 4 CPU cores
168
-
* 20GB of disk space
169
-
* 1G Network
170
-
171
-
### Runtime Requirements
172
-
173
-
* JRE 11+ e.g. [Azul OpenJDK](https://www.azul.com/downloads/?package=jdk#download-openjdk)
174
-
175
-
## Quick Start
176
-
177
-
### Download
178
-
179
-
Download [latest release](https://github.com/redis-field-engineering/redis-connect-dist/releases) for `Linux` or `Windows` and unarchive redis-connect-`<version>.<build>`.[tar.gz|zip] archive<br>
180
-
Docker image can be found at [DockerHub](https://hub.docker.com/r/redislabs/redis-connect)
181
-
182
-
Linux:
183
-
```bash
184
-
tar vxf <tarfile name>
185
-
```
186
-
Windows:
187
-
```cmd
188
-
unzip <zipfile name>
189
-
```
178
+
## Copyright
190
179
191
-
The following subdirectories will be extracted under /redis-connect -
192
-
<br>bin – Startup scripts
193
-
<br>lib – Dependencies
194
-
<br>config – Credentials property files, jobmanager.properties, and job-config (JSON) examples
195
-
<br>extlib – Custom/External dependencies e.g. [custom stage](https://github.com/redis-field-engineering/redis-connect-custom-stage-demo), source-database drivers, etc.
180
+
Redis Connect is developed by Redis, Inc. Copyright (C) 2023 Redis, Inc.
0 commit comments