OpenMetadata
Search…
Run in Production
This installation guide will help you deploy OpenMetadata on your own machine(s) without the use of Docker.

Requirements

This guide assumes you have access to a command-line environment or shell such as bash, zsh, etc. or Linux or Mac OS X or PowerShell on Microsoft Windows.
This guide also assumes that your command-line environment has access to the tar utility.
Please review additional requirements listed in the subsections below.

Java (version 11.0.0 or greater)

OpenMetadata is built using Java, DropWizard, and Jetty.
Type the following command to verify that you have a supported version of the Java runtime installed.
1
java --version
Copied!
To install Java or upgrade to Java 11 or greater, see the instructions for your operating system at How do I install Java?

MySQL (version 8.0.0 or greater)

To install MySQL see the instructions for your operating system (OS) at Installing and Upgrading MySQL or visit one of the following OS-specific guides.
Make sure to configure required databases and users for OpenMetadata.
You can refer a sample script from here.

Elasticsearch (version 7.0.0 or greater)

To install or upgrade Elasticsearch to a supported version please see the instructions for your operating system at Installing Elasticsearch.

Airflow (version 2.0.0 or greater) or other workflow schedulers

OpenMetadata performs metadata ingestion using ingestion connectors designed to run in Airflow or another workflow scheduler.
To install Airflow, please see the Airflow Installation guide.

Procedure

1. Download the distribution

Visit the releases page and download the latest binary release. Release binaries follow the naming convention of openmetadata-x.y.z.tar.gz. Where x, y, and z represent the major, minor, and patch release numbers.
For example, the release for version 0.6 is found in the Assets section at the link highlighted in the figure below.

2. Untar the release download

Once the tar file has download, run the following command, updated if necessary for the version of OpenMetadata that you downloaded.
1
tar -zxvf openmetadata-0.6.0.tar.gz
Copied!

3. Navigate to the directory created

1
cd openmetadata-0.6.0
Copied!

4. Start OpenMetadata

OpenMetadata release ships with ./bin/openmetadata init.d style script. Run the following command from the openmetadata-0.6.0 directory.
1
./bin/openmetdata.sh start
Copied!
We recommend configuring serviced to monitor the OpenMetadata command to restart in case of any failures.

Running with a load balancer

One or more OpenMetadata instances can be put behind a load balancer for reverse proxying, in that case, an appropriate OpenMetdata URL must be mentioned in the load balancer's configuration file.
For example, in case Apache mod proxy the VirtualHost tag in the configuration file should be edited out with the following
1
<VirtualHost *:80>
2
<Proxy balancer://mycluster>
3
BalancerMember http://127.0.0.1:8585 <!-- First OpenMetadata server -->
4
BalancerMember http://127.0.0.2:8686 <!-- Second OpenMetadata server -->
5
</Proxy>
6
7
ProxyPreserveHost On
8
9
ProxyPass / balancer://mycluster/
10
ProxyPassReverse / balancer://mycluster/
11
</VirtualHost>
Copied!
Last modified 23h ago