Skip to main content
CommunityTeamEnterprise

Docker Compose

Follow these steps to start a Flink cluster—comprising one JobManager, three TaskManagers, and the SQL Gateway service—on your local machine using Docker Compose, and connect the latest version of Flex with either a community license or a 30-day trial license.

Prerequisites

Instructions

Clone the factorhouse-local repository which contains a functional Docker Compose file containing a 3-node Kafka cluster.

## clone the factor house local repository
$ git clone https://github.com/factorhouse/factorhouse-local.git
$ cd factorhouse-local

## configure your environment
# Edition (choose one by uncommenting the lines)
# For Enterprise Edition:
# unset FLEX_SUFFIX
# For Community Edition:
# export FLEX_SUFFIX="-ce"

# License (provide the path to your license .env files)
# export FLEX_LICENSE="/path/to/your/flex-license.env"

## start Flink with Flex
$ USE_EXT=false docker compose -p flex -f ./compose-flex.yml up -d

## clean up your environment
$ USE_EXT=false docker compose -p flex -f ./compose-flex.yml down
$ unset FLEX_SUFFIX FLEX_LICENSE

Notes

  • Flex's web UI is accessible at http://localhost:3001
  • The Flink REST API is accessible at http://localhost:8082.
  • For more details, visit: Playground > Factor House Local