datahub/docker/frontend/README.md
Mars Lan 4f221f9a12
build(docker): refactor docker build scripts (#1687)
* build(docker): refactor docker build scripts

- add "build" option to docker-compose files to simplify rebuilding of images
- create "start.sh" script so it's easier to override "command" in the quickstart's docker-compose file
- use dockerize to wait for requisite services to start up
- add a dedicated Dockerfile for kafka-setup

This fixes https://github.com/linkedin/datahub/issues/1549 & https://github.com/linkedin/datahub/issues/1550
2020-06-08 13:37:14 -07:00

51 lines
1.9 KiB
Markdown

# DataHub Frontend Docker Image
[![datahub-frontend docker](https://github.com/linkedin/datahub/workflows/datahub-frontend%20docker/badge.svg)](https://github.com/linkedin/datahub/actions?query=workflow%3A%22datahub-frontend+docker%22)
Refer to [DataHub Frontend Service](../../datahub-frontend) to have a quick understanding of the architecture and
responsibility of this service for the DataHub.
## Build & Run
```
cd docker/frontend && docker-compose up --build
```
This command will rebuild the docker image and start a container based on the image.
To start a container using an existing image, run the same command without the `--build` flag.
### Container configuration
#### External Port
If you need to configure default configurations for your container such as the exposed port, you will do that in
`docker-compose.yml` file. Refer to this [link](https://docs.docker.com/compose/compose-file/#ports) to understand
how to change your exposed port settings.
```
ports:
- "9001:9001"
```
#### Docker Network
All Docker containers for DataHub are supposed to be on the same Docker network which is `datahub_network`.
If you change this, you will need to change this for all other Docker containers as well.
```
networks:
default:
name: datahub_network
```
#### datahub-gms Container
Before starting `datahub-frontend` container, `datahub-gms` container should already be up and running.
`datahub-frontend` service creates a connection to `datahub-gms` service and this is configured with environment
variables in `docker-compose.yml`:
```
environment:
- DATAHUB_GMS_HOST=datahub-gms
- DATAHUB_GMS_PORT=8080
```
The value of `DATAHUB_GMS_HOST` variable should be set to the host name of the `datahub-gms` container within the Docker network.
## Checking out DataHub UI
After starting your Docker container, you can connect to it by typing below into your favorite web browser:
```
http://localhost:9001
```
You can sign in with `datahub` as username and password.