OpenMetadata
Search…
Deploy on Docker
These instructions have been tested on MacOS, Windows 10, and Ubuntu 20.04.

Requirements (OSX and Linux)

Please ensure that your host system meets the requirements listed below. Then continue to the procedure for installing OpenMetadata.

Docker (version 20.10.0 or greater)

​Docker is an open platform for developing, shipping, and running applications. It enables you to separate your applications from your infrastructure, so you can deliver software quickly in packages called containers, using OS-level virtualization.
Please use the following command to check the version of Docker you have.
1
docker --version
Copied!
If you need to install Docker, please visit Get Docker.
Note: You must allocate at least 6 GB of memory to Docker in order to run OpenMetadata. To change the memory allocation for Docker, please visit:
Preferences -> Resources -> Advanced

Install Docker Compose Version 2.0.0 on Linux

Follow the instructions here to install docker compose version 2.0.0
  1. 1.
    Run the following command to download the current stable release of Docker Compose
1
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
2
mkdir -p $DOCKER_CONFIG/cli-plugins
3
curl -SL https://github.com/docker/compose/releases/download/v2.2.3/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
Copied!
This command installs Compose V2 for the active user under $HOME directory. To install Docker Compose for all users on your system, replace ~/.docker/cli-plugins with /usr/local/lib/docker/cli-plugins.
2. Apply executable permissions to the binary
1
chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
Copied!
3. Test your installation
1
docker compose version
2
Docker Compose version v2.2.3
Copied!

compose Command for Docker (version v2.1.1 or greater)

The Docker compose the package enables you to define and run multi-container Docker applications. The compose command integrates compose functions into the Docker platform, making them available from the Docker command-line interface (CLI).
MacOS X: Docker on MacOS X ships with compose already available in the Docker CLI.
Linux: To install compose on Linux systems, please visit the Docker CLI command documentation and follow the instructions.
To verify that the docker compose command is installed and accessible on your system, run the following command.
1
docker compose version
Copied!
Upon running this command you should see output similar to the following.
1
Docker Compose version v2.1.1
Copied!
Note: In the previous releases of Docker, compose functions were delivered with the docker-compose tool. OpenMetadata uses Compose V2. Please see the paragraphs above for instructions on installing Compose V2.

Requirements (Windows)

WSL2, Ubuntu 20.04, and Docker for Windows

  1. 1.
    Install WSL2​
  2. 2.
    Install Ubuntu 20.04​
  3. 3.
    Install Docker for Windows​

In the Ubuntu Terminal

1
cd ~
2
sudo apt update
3
sudo apt upgrade
4
sudo apt install python3-pip python3-venv
Copied!

Setup and Launch OpenMetadata

1. Run the below commands to bring OpenMetadata docker up and running

Create a new directory for OpenMetadata and navigate into that directory.
1
mkdir -p openmetadata-docker && cd openmetadata-docker
2
curl -SL https://github.com/open-metadata/OpenMetadata/releases/download/0.10.1-release/docker-compose.yml -o docker-compose.yml -s
3
docker compose up -d
Copied!
For a secure OpenMetadata instance, follow the Enable Security guide

2. Verify all containers are up and running

1
docker ps
Copied!
After running the above command, you should see an output similar to the following.
1
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
2
7f031f096966 local-metadata_openmetadata-server "./openmetadata-star…" About an hour ago Up About an hour 3306/tcp, 9200/tcp, 9300/tcp, 0.0.0.0:8585->8585/tcp openmetadata_server
3
6f7992e02314 local-metadata_ingestion "./ingestion_depende…" About an hour ago Up About an hour 0.0.0.0:8080->8080/tcp openmetadata_ingestion
4
ca8e590de33f local-metadata_mysql "/entrypoint.sh mysq…" About an hour ago Up About an hour (healthy) 0.0.0.0:3306->3306/tcp, 33060-33061/tcp openmetadata_mysql
5
1f037580731e docker.elastic.co/elasticsearch/elasticsearch:7.10.2 "/tini -- /usr/local…" About an hour ago Up About an hour 0.0.0.0:9200->9200/tcp, 0.0.0.0:9300->9300/tcp openmetadata_elasticsearch
Copied!

3. Begin using OpenMetadata

Finally, visit the following URL to begin exploring OpenMetadata.
1
http://localhost:8585
Copied!
You should see a page similar to the following as the landing page for the OpenMetadata server.

Bind named volumes (Advanced)

Please make the following changes while mounting the volume for ingestion in OpenMetadata.
Update or add the volume in the docker-compose.yml file
1
nano OpenMetadata/docker/local-metadata/docker-compose.yml
Copied!
We'll need to perform the two changes mentioned below.
Define the volumes at the top level of the file:
1
volumes:
2
ingestion-volume-dag-airflow:
3
ingestion-volume-dags:
4
ingestion-volume-tmp:
Copied!
Changes in the ingestion service:
1
- ingestion-volume-dag-airflow:/airflow/dag_generated_configs
2
- ingestion-volume-dags:/airflow/dags
3
- ingestion-volume-tmp:/tmp
Copied!
Once these changes are done, redeploy the docker containers.

Next Steps

  1. 1.
    Visit the Features overview page and explore the OpenMetadata UI.
  2. 2.
    Visit the Connectors documentation to see what services you can integrate with OpenMetadata.
  3. 3.
    Visit the API documentation and explore the OpenMetadata APIs.

Troubleshooting

Could not find a version that satisfied the requirement

1
You don't have docker-compose installed, please install it and re-run the command
Copied!
If you come across the above error when attempting to install OpenMetadata, this can be due to an older version of docker-compose that you have, or because docker compose is not installed properly. Please check the Requirements section above and confirm that you have the supported versions installed.