OpenMetadata
Search…
Local Deployment
These instructions have been tested on macOS, Windows 10, and Ubuntu 20.04.

Requirements (OSX and Linux)

Please ensure 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 that enables you to separate your applications from your infrastructure so you can deliver software quickly using OS-level virtualization to deliver software in packages called containers.
To check what version of Docker you have, please use the following command.
1
docker --version
Copied!
If you need to install Docker, please visit Get Docker.
Note: You must allocate at least 6GB of memory to Docker in order to run OpenMetadata. To change the memory allocation for Docker, please visit:
Preferences -> Resources -> Advanced

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

macOS X: Docker on macOS X ships with the compose command 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 an output similar to the following.
1
Docker Compose version v2.1.1
Copied!
Note: In 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.

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!

``

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. Create a directory for OpenMetadata

Create a new directory for OpenMetadata and navigate into that directory.
1
mkdir openmetadata-docker && cd openmetadata-docker
Copied!

2. Create a Python virtual environment

Create a virtual environment to avoid conflicts with other Python environments on your host system. A virtual environment is a self-contained directory tree that contains a Python installation for a particular version of Python, plus a number of additional packages.
In a later step you will install the openmetadata-ingestion Python module and its dependencies in this virtual environment.
1
python3 -m venv env
Copied!

3. Activate the virtual environment

1
source env/bin/activate
Copied!

4. Upgrade pip and setuptools

1
pip3 install --upgrade pip setuptools
Copied!

5. Install the OpenMetadata Python module using pip

1
pip3 install --upgrade 'openmetadata-ingestion[docker]'
Copied!

6. Ensure the module is installed and ready for use

1
metadata docker --help
Copied!
After running the command above, you should see output similar to the following.
1
Usage: metadata docker [OPTIONS]
2
​
3
Checks Docker Memory Allocation Run Latest Release Docker - metadata
4
docker --run Run Local Docker - metadata docker --run -t local -p
5
path/to/docker-compose.yml
6
​
7
Options:
8
--start Start release Docker containers
9
--stop Stop Docker containers (local and release)
10
--clean Prune unused containers, images, volumes and networks
11
-t, --type TEXT 'local' - local type will start local build of OpenMetadata
12
docker
13
​
14
-p, --path FILE Path to Local docker-compose.yml
15
--help Show this message and exit.
Copied!

7. Start the OpenMetadata Docker containers

1
metadata docker --start
Copied!
This will create a docker network and four containers for the following services:
  • MySQL to store the metadata catalog
  • Elasticsearch to maintain the metadata index which enables you to search the catalog
  • Apache Airflow which OpenMetadata uses for metadata ingestion
  • The OpenMetadata UI and API server
After starting the Docker containers, you should see an output similar to the following.
1
[2021-11-18 15:53:52,532] INFO {metadata.cmd:202} - Running Latest Release Docker
2
[+] Running 5/5
3
β Ώ Network tmp_app_net Created 0.3s
4
β Ώ Container tmp_mysql_1 Started 1.0s
5
β Ώ Container tmp_elasticsearch_1 Started 1.0s
6
β Ώ Container tmp_ingestion_1 Started 2.1s
7
β Ώ Container tmp_openmetadata-server_1 Started 2.2s
8
[2021-11-18 15:53:55,876] INFO {metadata.cmd:212} - Time took to get containers running: 0:00:03.124889
9
.......
Copied!
After starting the containers, metadata will launch Airflow tasks to ingest sample metadata and usage data for you to experiment with. This might take several minutes, depending on your system.
Note:
  • metadata docker --stop will stop the Docker containers.
  • metadata docker --clean will clean/prune the containers, volumes, and networks.

8. Wait for metadata ingestion to finish

Once metadata ingestion has finished and the OpenMetadata UI is ready for use, you will see output similar to the following.
1
[2021-11-18 15:54:51,165] INFO {metadata.cmd:232} - Time took to get OpenMetadata running: 0:00:58.414548
2
​
3
βœ” OpenMetadata is up and running
4
​
5
Head to http://localhost:8585 to play around with OpenMetadata UI.
6
7
To checkout Ingestion via Airflow, go to http://localhost:8080
8
(username: admin, password: admin)
9
10
Need support? Get in touch on Slack: https://slack.open-metadata.org/
Copied!

9. Log in to Airflow

Once metadata ingestion has finished and you see the message that OpenMetadata is up and running, visit the following url in your web browser.
1
http://localhost:8080
Copied!
You will see a login prompt similar to the one in the figure below. Use the following credentials to log in to Airflow.
Username: admin
Password: admin

10. 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.

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
pip3 install 'openmetadata-ingestion[docker]'
2
ERROR: Could not find a version that satisfies the requirement openmetadata-ingestion[docker] (from versions: none)
3
ERROR: No matching distribution found for openmetadata-ingestion[docker]
Copied!
If you see the above when attempting to install OpenMetadata, this can be due to using older version of Python and pip. Please check the Requirements section above and confirm that you have supported versions installed.