Skip to content

Latest commit

 

History

History
196 lines (159 loc) · 10.3 KB

README.md

File metadata and controls

196 lines (159 loc) · 10.3 KB

Demo Outline

✅ Setup MongoDB database (Source)
✅ Setup and start Redis Enterprise database (Target)
✅ Setup and start Redis Connect
✅ Perform Initial load and CDC with Redis Connect

Prerequisites

Docker compatible *nix OS and Docker installed.
Please have 8 vCPU*, 8GB RAM and 50GB storage for this demo to function properly. Adjust the resources based on your requirements. For HA, at least have 2 Redis Connect Connector instances deployed on separate hosts.

Execute the following commands (copy & paste) to download and setup Redis Connect and demo scripts. i.e.

wget -c https://github.com/redis-field-engineering/redis-connect-dist/archive/main.zip && \
mkdir -p redis-connect/demo && \
unzip main.zip "redis-connect-dist-main/examples/mongodb/*" -d redis-connect && \
cp -R redis-connect/redis-connect-dist-main/examples/mongodb/demo/* redis-connect/demo && \
rm -rf main.zip redis-connect/redis-connect-dist-main && \
cd redis-connect && \
chmod a+x demo/*.sh && \
cd demo

Setup MongoDB database (Source)

MongoDB on Docker
Execute setup_mongodb.sh

demo$ ./setup_mongodb.sh

MongoDB in Cloud

https://www.mongodb.com/atlas/database

Setup Redis Enterprise cluster, databases and RedisInsight in docker (Target)


Execute setup_re.sh

demo$ ./setup_re.sh

NOTE

The above script will create a 1-node Redis Enterprise cluster in a docker container, Create a target database with RediSearch module, Create a job management and metrics database with RedisTimeSeries module, Create a RediSearch index for emp Hash, Start a docker instance of grafana with Redis Data Source and Start an instance of RedisInsight.

Start Redis Connect

Review options by running Redis Connect docker container 

demo$ docker run \
-it --rm --privileged=true \
--name redis-connect-$(hostname) \
-v $(pwd)/config:/opt/redislabs/redis-connect/config \
-v $(pwd)/config/samples/credentials:/opt/redislabs/redis-connect/config/samples/credentials \
--net host \
redislabs/redis-connect

Expected output: 

-------------------------------
Redis Connect startup script.
*******************************
Please ensure that these environment variables are correctly mapped before executing start and cli options. They can also be found in /opt/redislabs/redis-connect/bin/redisconnect.conf
Example environment variables and volume mapping for docker based deployments
-e REDISCONNECT_JOB_MANAGER_CONFIG_PATH=/opt/redislabs/redis-connect/config/jobmanager.properties [OPTIONAL]
-e REDISCONNECT_LOGBACK_CONFIG=/opt/redislabs/redis-connect/config/logback.xml [OPTIONAL]
-e REDISCONNECT_JAVA_OPTIONS=-Xms1g -Xmx2g [OPTIONAL]
-e REDISCONNECT_EXTLIB_DIR=/opt/redislabs/redis-connect/extlib [OPTIONAL]
-v <HOST_PATH_TO_JOB_MANAGER_PROPERTIES>:/opt/redislabs/redis-connect/config
-v <HOST_PATH_TO_CREDENTIALS>:/opt/redislabs/redis-connect/config/samples/credentials
-v <HOST_PATH_TO_EXTLIB>:/opt/redislabs/redis-connect/extlib [OPTIONAL]
-p 8282:8282

Usage: [-h|cli|start]
options:
-h: Print this help message and exit.
-v: Print version.
cli: init Redis Connect CLI
start: init Redis Connect Instance (Cluster Member)
-------------------------------

Start Redis Connect Instance 

docker run \
-it --rm --privileged=true \
--name redis-connect-$(hostname) \
-v $(pwd)/config:/opt/redislabs/redis-connect/config \
-v $(pwd)/extlib:/opt/redislabs/redis-connect/extlib \
--net host \
redislabs/redis-connect start

Expected output: 

-------------------------------
Starting redis-connect v0.9.2.4 Instance using JAVA 11.0.15 on virag-cdc started by root in /opt/redislabs/redis-connect/bin
Loading redis-connect Instance configuration from /opt/redislabs/redis-connect/config/jobmanager.properties
Instance classpath /opt/redislabs/redis-connect/lib/*:/opt/redislabs/redis-connect/extlib/*
03:59:45.190 [main] INFO  redis-connect-manager - ----------------------------------------------------------------------------------------------------------------------------
  /#######                  /## /##          	  /######                                                      /##
 | ##__  ##                | ## |__/          	 /##__  ##                                                    | ##
 | ##  \ ##  /######   /####### /##  /#######	| ##  \__/  /######  /#######  /#######   /######   /####### /######
 | #######/ /##__  ## /##__  ##| ## /##_____/	| ##       /##__  ##| ##__  ##| ##__  ## /##__  ## /##_____/|_  ##_/
 | ##__  ##| ########| ##  | ##| ##|  ###### 	| ##      | ##  \ ##| ##  \ ##| ##  \ ##| ########| ##        | ##
 | ##  \ ##| ##_____/| ##  | ##| ## \____  ##	| ##    ##| ##  | ##| ##  | ##| ##  | ##| ##_____/| ##        | ## /##
 | ##  | ##|  #######|  #######| ## /#######/	|  ######/|  ######/| ##  | ##| ##  | ##|  #######|  #######  |  ####/
 |__/  |__/ \_______/ \_______/|__/|_______/ 	 \______/  \______/ |__/  |__/|__/  |__/ \_______/ \_______/   \___/
Powered by Redis Enterprise
03:59:50.197 [main] INFO  redis-connect-manager - ----------------------------------------------------------------------------------------------------------------------------
03:59:52.100 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully established Redis connection for JobManager - JobManager
03:59:52.122 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully established Redis connection for JobManager - JobReaper
03:59:52.146 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully established Redis connection for JobManager - JobClaimer
03:59:52.168 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully established Redis connection for JobManager - HeartbeatManager
03:59:52.189 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully established Redis connection for JobManager - MetricsReporter
03:59:52.284 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully created Job Claim Assignment Stream and Consumer Group
03:59:52.289 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully started JobManager service
03:59:52.291 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully started JobReaper service
03:59:52.293 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc Metrics are not enabled so MetricsReporter threadpool will not be instantiated
03:59:52.296 [main] INFO  redis-connect-manager - Instance: 30@virag-cdc successfully started JobClaimer service
03:59:58.504 [main] INFO  redis-connect-manager - Started Redis Connect REST API listening on ["http-nio-8282"]
03:59:58.505 [main] INFO  redis-connect-manager - ----------------------------------------------------------------------------------------------------------------------------
03:59:58.505 [main] INFO  redis-connect-manager -
03:59:58.505 [main] INFO  redis-connect-manager - Started Redis Connect Instance
03:59:58.505 [main] INFO  redis-connect-manager -
03:59:58.505 [main] INFO  redis-connect-manager - ----------------------------------------------------------------------------------------------------------------------------
04:00:02.291 [JobManagerThreadpool-1] INFO  redis-connect-manager - Instance: 30@virag-cdc was successfully elected Redis Connect cluster leader

Open browser to access Swagger UI - http://localhost:8282/swagger-ui/index.html
For quick start, use 'cdc_job' as jobName

Create Job Configuration - /connect/api/vi/job/config/{jobName}
For quick start, use the sample cdc-job.json configuration: MongoDB


Or Use curl to create the cdc-job configuration
demo$ curl -v -X POST "http://localhost:8282/connect/api/v1/job/config/cdc-job" -H "accept: */*" -H "Content-Type: multipart/form-data" -F "file=@config/samples/payloads/cdc-job.json;type=application/json"

Initial Loader Steps

Start Job - /connect/api/vi/job/transition/start/{jobName}/{jobType}
Use 'load' as jobType

Or Use curl to start the initial load for cdc-job
demo$ curl -X POST "http://localhost:8282/connect/api/v1/job/transition/start/cdc-job/load" -H "accept: */*"

Query for the above inserted record in Redis (target)

CDC Steps

Start Job - /connect/api/vi/job/transition/start/{jobName}/{jobType}
Use 'stream' as jobType

Or Use curl to start the stream for cdc-job
demo$ curl -X POST "http://localhost:8282/connect/api/v1/job/transition/start/cdc-job/stream" -H "accept: */*"

Confirm Job Claim - /connect/api/vi/jobs/claim/{jobStatus}
For quick start, use 'all' as jobStatus

Or Use curl to query the cdc-job status
demo$ curl -X GET "http://localhost:8282/connect/api/v1/cluster/jobs/claim/all" -H "accept: */*"

Expected output: [{"jobId":"{connect}:job:cdc-job","jobName":"cdc-job","jobStatus":"CLAIMED","jobOwner":"30@virag-cdc","jobType":"STREAM"}]

INSERT/UPDATE a document in MongoDB (source)

Query for the above inserted record in Redis (target)