Installation Guide: Custom Install

Download / Installation-Guide / Custom-Install

Running the Metatron Binary

For Linux and MacOS, we provide .tar.gz package for installing Metatron. These packages are the easiest formats to use when trying out Metatron. To run this Metatron Binary, you need to have Java installed on your system. Currently Metatron requires both oracle java sdk 1.8 and apache maven 3.3+. Please be aware that java 10 version does not supported yet.

Requirements

Install Metatron Version of Druid

It is essential to install Druid customized for Metatron. This is the link for the druid binary. Please be aware that general Apache Druid cannot fully support the Metatron Discovery. After downloading the Druid binary, unzip it to the proper directory.

Check for the Druid Installation

Below is the command for executing scripts to start | stop druid.

$ start-single.sh | stop-single.sh

Next is checking the connections. Enter the Druid Coordinator Console(http://localhost:8081). For the test, we already ingested “sales” dataset to the Druid. Make sure the dataset is on a datasource list in the consle.

Get the Metatron release binary

There is two way to get the running binary file.

  1. Directly download the final binary file.
  2. Clone and build from the Metatron Github repository.

First one is the easiest way. you just need to download the latest Metatron release binary(3.1.0). Simply save the .tar.gz file to a folder on your system where you wish to run Metatron. And you are ready to deploy it!

Or in case of building the project rather than just downloading the binary file, first thing to do is to clone the project from the Metatron github.

$ git clone https://github.com/metatron-app/metatron-discovery.git

And the project need to be build through Maven.

$ mvn clean install -DskipTests

The building process needs some time to complete the whole tasks. Especially for building frontend, it takes more time. Be aware that you don’t need to care about the “npm error”. Just wait for a minute.
After completing the build task, check the directory “discovery-distribution/target/metatron-discovery-{VERSION}-{TIMESTAMP}-bin.tar.gz”.

Deploy Metatron

Unzip the binary file through the command line below.

$ tar zxf metatron-discovery-{VERSION}-{TIMESTAMP}-bin.tar.gz

When decompressed, a directory with the following structure is created.

|-- bin
|    |- common.sh
|    |- metatron.sh
|
|-- conf
|    |- application-config.templete.yaml 
|    |- metatron-env.sh.templete
|
|-- discovery-server-{VERSION}.jar

Configure Metatron

Metatron loads its configuration from the files under “~conf” directory by default. We already wrote some frequent configurations in the template files. Detailed configuration setup guide described in the source code.

Run Metatron

Metatron can be started from the command line as follows:

$ ./bin/metatron.sh --init start

⚠️ Cautions! –init option initializes the whole data.
Add this argument only for the very first time or when you want to reset your development environment.

At this point, you are ready to go! Just access your new Metatron server on port 8180, most likely at http://localhost:8180.
Further running options also are provided as well.

$ ./bin/metatron.sh [--config=directory] [--init] [--management] [--debug=port] {start|stop|restart|status}

The default admin user account of Metatron client is provided as ID: admin, PW: admin.