Installation & Usage
To install and start up Willow, clone this repo and run:
docker compose up
Navigate to Willow's home page at https://localhost:3000
.
Create a Pipeline
To initialize pipeline setup, click the "CREATE A CDC PIPELINE" button.
Enter PostgreSQL database details, including:
- The host and port to access the PostgreSQL server
- The database name containing the tables to replicate
- The username and password for Willow to use when replicating from PostgreSQL
Select which tables and columns to replicate and provide a unique source connection name. Primary keys (identified with PK) cannot be deselected. Tables without primary keys are not able to be replicated and are not shown.
Enter Redis cache details, including:
- The URL for the Redis cache. Must start with
redis://
. - The username and password for Willow to use when replicating to Redis.
Click the "VERIFY" button to verify that the Redis cache is accessible.
Provide a unique sink connection name and click "SUBMIT" to finish CDC pipeline creation.
After pipeline creation, an initial snapshot of the selected tables is taken to prepopulate the cache. Subsequent INSERT
, UPDATE
, DELETE
, and TRUNCATE
commands that affect the selected tables will be reflected in the cache.
View Existing Pipelines
All existing pipelines can be viewed at https://localhost:3000/pipelines
.
A single pipeline can be clicked on to view details on the associated source and sink connectors.
Teardown a Pipeline
Pipelines can be torn down by clicking the trash can icon.