OpenMetadata
Search…
Try OpenMetadata in Docker
This installation doc will help you start a OpenMetadata standalone instance on your local machine.

Requirements (OSX and Linux)

Please ensure your host system meets the requirements listed below. Then continue to the Procedure for installing OpenMetadata.
OSX and Linux
Windows

Procedure

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
βœ… OpenMetadata is up and running
2
​
3
Open http://localhost:8585 in your browser to access OpenMetadata..
4
5
To checkout Ingestion via Airflow, go to http://localhost:8080
6
(username: admin, password: admin)
7
8
We are available on Slack , https://slack.open-metadata.org/ . Reach out to us if
9
you have any questions.
10
11
If you like what we are doing, please consider giving us a star on github at
12
https://github.com/open-metadata/OpenMetadata.
13
​
14
It helps OpenMetadata reach wider audience and helps our community.
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.
If you need support please get in touch on Slack: https://slack.open-metadata.org/.

Enable Security

OpenMetadata has support for Google SSO, Okta SSO, custom OIDC, Auth0, and Azure SSO as identity providers. Please check Secure OpenMetadata section about how to configure them.