Skip to main content

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.

Willow's home page.

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
Willow's form for connecting to a source database.

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.

Willow's form for selecting which data should be replicated from the source database.

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.

Willow's form for selecting which data should be replicated from the source database.

Provide a unique sink connection name and click "SUBMIT" to finish CDC pipeline creation.

Willow's form for selecting which data should be replicated from the source database.

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.

Willow's page for displaying all running pipelines.

A single pipeline can be clicked on to view details on the associated source and sink connectors.

Willow's page for displaying a single pipeline's details.

Teardown a Pipeline

Pipelines can be torn down by clicking the trash can icon.

The trash can icon for a single pipeline is boxed in red on Willow's page showing all pipelines..