GitBook: [#55] Provide detailed requirements and procedure steps for Run in Production

This commit is contained in:
Shannon Bradshaw 2021-12-01 15:08:26 +00:00 committed by Sriharsha Chintalapani
parent 09c18f3f20
commit c446374d77

View File

@ -1,31 +1,78 @@
---
description: >-
This installation doc will help you start a OpenMetadata instances on your
production.
This installation guide will help you deploy OpenMetadata on your own
machine(s) without the use of Docker.
---
# Run in Production
Please refer to the previous section [Run Openmetadata](run-openmetadata.md) for configuring OpenMetadata.
## Requirements
{% hint style="info" %}
**Prerequisites**
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. 
* MySQL >= 8.x
* ElasticSearch >= 7.x
* Airflow or other schedulers to run Ingestion Connectors
{% endhint %}
This guide also assumes that your command-line environment has access to the `tar` utility.
## Start OpenMetadata
Please review additional requirements listed in the subsections below.
OpenMetadata release ships with `./bin/openmetadata` init.d style script.
### 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.
```
java --version
```
To install Java or upgrade to Java 11 or greater, see the instructions for your operating system at [How do I install Java?](https://java.com/en/download/help/download\_options.html#mac)
### MySQL (version 8.0.0 or greater)
To install MySQL see the instructions for your operating system (OS) at [Installing and Upgrading MySQL](https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/installing.html) or visit one of the following OS-specific guides.
* [Installing MySQL on Linux](https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/linux-installation.html)
* [Installing MySQL on Microsoft Windows](https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/windows-installation.html)
* [Installing MySQL on macOS](https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/macos-installation.html)
### 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html).
### 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](https://airflow.apache.org/docs/apache-airflow/stable/installation/index.html) guide.
## Procedure
### 1. Download the distribution
Download the latest [binary release](https://github.com/open-metadata/OpenMetadata/releases/download/0.5.0/openmetadata-0.6.0.tar.gz). 
### 2. Untar the release download
Once the tar file has download, run the following command.
```bash
tar -zxvf openmetadata-0.6.0.tar.gz
```
### 3. Navigate to the directory created
```
cd openmetadata-0.6.0
```
### 4. Start OpenMetadata
OpenMetadata release ships with `./bin/openmetadata` init.d style script. Run the following command from the `openmetadata-0.6.0` directory.
```
cd openmetdata-0.6.0
./bin/openmetdata start
```
We recommend configuring serviced to monitor the OpenMetadata command to restart in case of any failures.
We recommend configuring `serviced` to monitor the OpenMetadata command to restart in case of any failures.Start OpenMetadata.
## Running with a load balancer