Skip to content

Latest commit

 

History

History
115 lines (78 loc) · 3.88 KB

README.md

File metadata and controls

115 lines (78 loc) · 3.88 KB
title hide_title
Deploying with Docker
true

Docker Images

Prerequisites

You need to install docker and docker-compose (if using Linux; on Windows and Mac compose is included with Docker Desktop).

Make sure to allocate enough hardware resources for Docker engine. Tested & confirmed config: 2 CPUs, 8GB RAM, 2GB Swap area.

Quickstart

The easiest way to bring up and test DataHub is using DataHub Docker images which are continuously deployed to Docker Hub with every commit to repository.

You can easily download and run all these images and their dependencies with our quick start guide.

DataHub Docker Images:

Dependencies:

Ingesting demo data.

If you want to test ingesting some data once DataHub is up, see Ingestion for more details.

Using Docker Images During Development

See Using Docker Images During Development.

Building And Deploying Docker Images

We use GitHub Actions to build and continuously deploy our images. There should be no need to do this manually; a successful release on Github will automatically publish the images.

Building images

This is not our recommended development flow and most developers should be following the Using Docker Images During Development guide.

To build the full images (that we are going to publish), you need to run the following:

COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose -p datahub build

This is because we're relying on builtkit for multistage builds. It does not hurt also set DATAHUB_VERSION to something unique.

React

To serve the incubating React UI, follow the instructions below.

Before continuing: If you've already run a deploy script, don't forget to clear containers using docker container prune

Serving React Only

All Containers

Use the quickstart-react.sh script to launch all containers in DataHub, including a frontend server that returns a React UI

./quickstart-react.sh

The Bare Minimum

Run the following command to launch only the React server and its required dependencies

docker-compose -f docker-compose.react.yml -f docker-compose.yml -f docker-compose.override.yml up datahub-frontend-react

Once complete, navigate to localhost:9002/ in your browser to see the React app.

Serving React + Ember

If you'd like to serve the React and Ember UIs side-by-side, you can deploy the datahub-frontend-react container manually.

All Containers

To deploy all DataHub containers, run the quickstart script:

./quickstart.sh

Next, deploy the container that serves the React UI:

docker-compose -f docker-compose.react.yml -f docker-compose.yml -f docker-compose.override.yml up --no-deps datahub-frontend-react

The Bare Minimum

First, start the Ember frontend server & its required dependencies:

docker-compose up datahub-frontend

Then, start the React frontend server & its required dependencies:

docker-compose -f docker-compose.react.yml -f docker-compose.yml -f docker-compose.override.yml up datahub-frontend-react

Navigate to localhost:9001/ to view the Ember app & localhost:9002/ to view the React app.