Building & Installing Apache Atlas

Building Atlas

git clone atlas

cd atlas

export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m" && mvn clean install

Once the build successfully completes, artifacts can be packaged for deployment.

mvn clean verify assembly:assembly -DskipTests

Tar can be found in atlas/target/apache-atlas-${project.version}-bin.tar.gz

Tar is structured as follows

|- bin
|- conf
   |- log4j.xml
|- docs
|- server
   |- webapp
      |- atlas.war
|- NOTICE.txt
|- LICENSE.txt
|- CHANGES.txt

Installing & Running Atlas

Installing Atlas

tar -xzvf apache-atlas-${project.version}-bin.tar.gz
* cd atlas-${project.version}

Configuring Atlas

By default config directory used by Atlas is {package dir}/conf. To override this set environment variable METADATA_CONF to the path of the conf dir. has been added to the Atlas conf. This file can be used to set various environment variables that you need for you services. In addition you can set any other environment variables you might need. This file will be sourced by atlas scripts before any commands are executed. The following environment variables are available to set.

# The java implementation to use. If JAVA_HOME is not found we expect java and jar to be in path
#export JAVA_HOME=

# any additional java opts you want to set. This will apply to both client and server operations

# any additional java opts that you want to set for client only

# java heap size we want to set for the client. Default is 1024MB

# any additional opts you want to set for atlas service.

# java heap size we want to set for the atlas server. Default is 1024MB

# What is is considered as atlas home dir. Default is the base locaion of the installed software

# Where log files are stored. Defatult is logs directory under the base install location

# Where pid files are stored. Defatult is logs directory under the base install location

# where the atlas titan db data is stored. Defatult is logs/data directory under the base install location

# Where do you want to expand the war file. By Default it is in /server/webapp dir under the base install dir.

NOTE for Mac OS users

If you are using a Mac OS, you will need to configure the METADATA_SERVER_OPTS (explained above).

In  {package dir}/conf/ uncomment the following line

and change it to look as below
export METADATA_SERVER_OPTS="-Djava.awt.headless=true"

Starting Atlas Server

bin/ [-port <port>]

By default, * To change the port, use -port option. * atlas server starts with conf from {package dir}/conf. To override this (to use the same conf with multiple atlas upgrades), set environment variable METADATA_CONF to the path of conf dir

Using Atlas

* Verify if the server is up and running
  curl -v http://localhost:21000/api/atlas/admin/version

* List the types in the repository
  curl -v http://localhost:21000/api/atlas/types

* List the instances for a given type
  curl -v http://localhost:21000/api/atlas/entities?type=hive_table

  curl -v http://localhost:21000/api/atlas/entities/list/hive_db

* Search for entities (instances) in the repository
  curl -v http://localhost:21000/api/atlas/discovery/search/dsl?query="from hive_table"


Once atlas is started, you can view the status of atlas entities using the Web-based dashboard. \You can open your browser at the corresponding port to use the web UI.

Stopping Atlas Server