Page tree
Skip to end of metadata
Go to start of metadata

Building Atlas

 git clone atlas
cd atlas

If you're using Atlas at version 0.8.x or below

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

If you're on levels above this, including master as of 27 Oct 2017, use:

 export MAVEN_OPTS="-Xmx1024m" && mvn clean install

as Atlas has now moved to Java8, and the -XX:MaxPermSize is no longer valid with this level

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

mvn clean package -DskipTests -DskipCheck=true

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

Tar is structured as follows

|- bin
|- conf
   |- log4j.xml
   |- solr
      |- currency.xml
      |- lang
         |- stopwords_en.txt
      |- protowords.txt
      |- schema.xml
      |- solrconfig.xml
      |- stopwords.txt
      |- synonyms.txt
|- 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"



Configuring ATLAS application properties 

All configuration in Atlas uses java properties style configuration.

Application Properties

The main configuration file is which is in the conf dir at the deployed location. It consists of the following sections:

Graph Database Configs

Graph persistence engine - BerkeleyDB

Refer link for more details. The example below uses BerkeleyDBJE.  
Graph persistence engine - Hbase

Basic configuration
#For standalone mode , specify localhost
#for distributed mode, specify zookeeper quorum here - For more information refer<ZooKeeper Quorum>

Advanced configuration


Graph Search Index - ElasticSearch

This section sets up the graph db - titan - to use an search indexing system. The example configuration below setsup to use an embedded Elastic search indexing system.  
Graph Search Index - Solr

For Solr, please refer the "Configuring SOLR as the Indexing Backend for the Graph Repository" section below.

Hive Lineage Configs

The higher layer services like hive lineage, schema, etc. are driven by the type system and this section encodes the specific types for the hive data model.

# This models reflects the base super types for Data and Process  ## Schema atlas.lineage.hive.table.schema.query=hive_table where name=?, columns  

Security Properties

SSL config

The following property is used to toggle the SSL feature.


Configuring SOLR as the Indexing Backend for the Graph Repository

By default, Atlas uses Titan as the graph repository and is the only graph repository implementation available currently.
For configuring Titan to work with Solr, please follow the instructions below
* Install solr if not already running. Versions of SOLR supported are 4.8.1 or 5.2.1.

* Start solr in cloud mode.
  SolrCloud mode uses a ZooKeeper Service as a highly available, central location for cluster management.
  For a small cluster, running with an existing ZooKeeper quorum should be fine. For larger clusters, you would want to run separate multiple ZooKeeper quorum with atleast 3 servers.
  Note: Atlas currently supports solr in "cloud" mode only. "http" mode is not supported. For more information, refer solr documentation -

* Run the following commands from SOLR_HOME directory to create collections in Solr corresponding to the indexes that Atlas uses
  bin/solr create -c vertex_index -d ATLAS_HOME/conf/solr -shards #numShards -replicationFactor #replicationFactor
  bin/solr create -c edge_index -d ATLAS_HOME/conf/solr -shards #numShards -replicationFactor #replicationFactor
  bin/solr create -c fulltext_index -d ATLAS_HOME/conf/solr -shards #numShards -replicationFactor #replicationFactor

  Note: If numShards and replicationFactor are not specified, they default to 1 which suffices if you are trying out solr with ATLAS on a single node instance.
  Otherwise specify numShards according to the number of hosts that are in the Solr cluster and the maxShardsPerNode configuration.
  The number of shards cannot exceed the total number of Solr nodes in your SolrCloud cluster

* Change ATLAS configuration to point to the Solr instance setup.

Please make sure the following configurations are set to the below values in ATLAS_HOME//conf/<'solr' for solr 4.8.1>/<'solr5' for solr 5.2.1><the ZK quorum setup for solr as comma separated value> eg:,

For more information on Titan solr configuration , please refer


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


Stopping Atlas Server

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
  {"results":["Process","Infrastructure","DataSet"],"count":3,"requestId":"1867493731@qtp-262860041-0 - 82d43a27-7c34-4573-85d1-a01525705091"}

* 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.


  • No labels