How to Install Apache Atlas?: A Step-by-Step Setup Guide

Updated August 30th, 2023
header image

Share this article

Guide to Installing Apache Atlas

In this guide, we’ll look into the step-by-step process of setting up Apache Atlas understand the architectural components and how they communicate with each other, and learn about some of the data governance features that Apache Atlas offers.

For ease of understanding, the setup process has been sequentially divided into the following steps:

  1. Going through the prerequisites for installing Atlas
  2. An overview of Apache Atlas architecture
  3. Cloning the Docker Atlas repository
  4. Running Docker Compose to install Atlas and related components
  5. Loading Metadata into Atlas
  6. Navigating the UI and exploring data governance features

Is Open Source really free? Estimate the cost of deploying an open-source data catalog 👉 Download Free Calculator

Table of contents

  1. Guide to installing Apache Atlas
  2. Prerequisites for installing Apache Atlas
  3. How to set up Apache Atlas
  4. Load Metadata into Apache Atlas
  5. Navigate the UI
  6. Related Resources

Prerequisites for Installing Apache Atlas

Pro tip: Compared to the official guide on the Atlas website, you may find this GitHub repository by Lucas Miguel Ponce providing a better experience of setting up Atlas.

Set up Apache Atlas

Apache Atlas Architecture

  • Atlas Core—Similar to other metadata search and discovery engines, Atlas uses graph databases, a full-text search engine, and a metadata store to enable various search operations. Atlas uses JanusGraph as the graph database, Solr as the full-text search engine, and HBase as the metadata store.
  • Metadata Sources—Atlas currently supports six different hook-based input sources to get your metadata into the system — HBase, Hive, Sqoop, Storm, Kafka, and Falcon. You can integrate either of these metadata sources into an upstream data source like a relational database, or a data warehouse, and so on.
  • Integration Layer—Atlas enables the communication between the metadata sources, the application, and the Atlas core layers in two ways — REST APIs and Kafka. This guide will use the Atlas Hive hook for CRUD operations on the metadata in Atlas. These operations are performed using Kafka notifications.
  • Application Layer—Like other metadata search and discovery engines, Atlas exposes an admin UI that business users and product owners can use for data governance, classification, metadata search, contextualization, and lineage. Ranger-based policies back data governance features.

Apache Atlas Architecture

Apache Atlas Architecture - Source: Apache Atlas.

Start All Containers

Go to the root of the cloned repository and use the docker-compose up command to begin the setup:

cd docker-atlas-master
docker-compose up

The setup will start with the following output on the console:

Install Atlas using Docker Compose

Install Atlas using Docker Compose - Source: Apache Atlas.

After pulling the Docker images for Kafka, Hadoop, and Hive, as mentioned in the prerequisites, the setup will proceed with Docker Compose triggering a Maven build of Atlas as shown in the image below:

Maven Build Components for Atlas

Maven Build Components for Atlas - Source: Apache Atlas.

When the build is completed, the following eight containers will be created, the status of which you can check using the docker ps command in a separate console tab:

Docker Atlas Containers

Docker Atlas Containers - Source: Apache Atlas.

Note: This guide doesn’t use Spark. The spawning of these containers does take quite a bit of time. It might test your patience. You’ll be able to track the setup activity in a fairly detailed manner on the console, as shown in the image below:

Docker Compose Installation Progress

Docker Compose Installation Progress - Source: Apache Atlas.

The final step in the installation is the starting of the Apache Atlas Server. Once you see the following screen:

Apache Atlas Server Started

Apache Atlas Server Started - Source: Apache Atlas.

Atlas might only take a minute or two to get ready. You can check the status by either visiting https://localhost:21000 or running the following command:

curl -u admin:admin http://localhost:21000/api/atlas/admin/version

If all’s well, you’ll get a response like the following:

  "Description": "Metadata Management and Data Governance Platform over Hadoop",
  "Revision": "21b15842fd74bc91910b2d8901dbea57769065d0",
  "Version": "3.0.0-SNAPSHOT",
  "Name": "apache-atlas"

After verifying the status of Atlas and before logging into the Atlas admin UI, you can also check the status of all the containers using the docker ps command:

{% raw %}docker ps --format
  '{"ID": "{{ .ID }}",
    "Image": "{{ .Image }}",
    "Names": "{{ .Names }}"}' | jq -C --indent 4{% endraw %}

Check Installation Status using docker ps

Check Installation Status using docker ps - Source: Apache Atlas.

Load Metadata into Apache Atlas

This guide will use a simplified version of the MediaWiki schema. To ingest the metadata for this schema into Atlas, log into the Hive server container and enter the Hive server using the beeline CLI as shown below:

docker-compose exec hive-server bash

Please note that there’s an example of a table called mediawiki.archive which is created using the beeline CLI. You’ll see the following screen after logging in:

Log into Hive Server and Beehive Console

Log into Hive Server and Beehive Console - Source: Apache Atlas.

Note: Use admin/admin as username/password for logging into Apache Atlas UI.

What happens when you create a table in the Hive console? An event is published to the Kafka topic, which, in turn, is consumed by JanusGraph, HBase metadata store, and Solr. Give it a couple of seconds, and you’ll be able to see it in the Atlas UI.

Apache Atlas Login Screen

Apache Atlas Login Screen - Source: Apache Atlas.

When you create the schema in Hive, you’ll see the following output in the setup console. For debugging purposes, you will be able to see any SQL errors both in the Hive console and the Docker Compose console where you initially started Atlas setup, as shown in the image below:

Bulk Ingest Metadata into Hive

Bulk Ingest Metadata into Hive - Source: Apache Atlas.

Now that you’ve ingested some metadata into Atlas let’s see how to navigate it using the Admin UI.

Before we move ahead, let’s quickly look at what the Admin UI provides you. Atlas allows you to search through Entities, Classifications, and Glossaries.

Apache atlas User interface

Apache Atlas User Interface - Source: Apache Atlas.

  • Entities — are objects fetched either from the hook or the REST API from a metadata source. Entities can be database tables, schemas, views, object storage directories, and so on.
  • Classifications — enable you to implement effective data governance by classifying the data stored in different data objects. One common use case is to tag or classify PII data for data security and compliance purposes. You can apply classification to entities.
  • Glossaries — are business-specific. Entities and classifications are usually business agnostic and can be used across different businesses. Business-specific vocabularies help the business users and teams contextualize the data. These glossary terms can be mapped entities.

Note: You can also associate glossary terms with classifications. Atlas makes sure when you associate a classification with a glossary term, the classification is automatically propagated to all entities associated with the glossary term.

Add classification

In this guide, you’ll see four custom classifications — PII, HIGHLY_SENSITIVE, SENSITIVE, PUBLIC. You can make it more granular based on the use case. Notice how the Propagate option is chosen by default in the image below:

Create a new Classification

Create a new Classification - Source: Apache Atlas.

Apply Classifications

Apply classifications to your entities. As this guide is meant to explore the UI, don’t focus a lot right now on the aptness of the classifications. Notice in the image below that some entities have been assigned to all of the classifications, and a filter has been created and applied, which shows only PII and HIGHLY_SENSITIVE entities.

Apply Classifications to Entities

Apply Classifications to Entities - Source: Apache Atlas.

Refer to this document to learn more about classifications, data governance, and data stewardship using Atlas.

Note: A quick reminder that, in this guide, you’ve seen metadata ingested using a Hive schema created directly in Hive. In a production setup, metadata from a database or a data warehouse, etc. should ideally be written to Hive using a job scheduled using Airflow or something similar.

Entity Details

Clicking on any entity will take you to a screen where you’ll be able to see all the entity’s properties, such as comment, description, name, type, and so on. You’ll also be able to see a lineage graph, the relationships of this entity, the classifications applied to it, the user-defined properties, and so on. You’ll see the above-mentioned navigation options for the user_email field of the mediawiki.user table, which is classified as PII in the image below:

Entity description and details

Entity description and details - Source: Apache Atlas.

Now that you have the metadata ingested into Atlas start playing around with the different features. For instance, in the image below, you’re looking at notification details of one of the configured Hooks, i.e., the Atlas Hive Hook, using which you’ve ingested the metadata into Atlas. You can click the chart option on the top-right of the screen and see Atlas statistics. When dealing with many entities being ingested into the system, this can help identify the number of ingestion successes and failures and changes to the metadata.

Atlas Statistics

Atlas Statistics - Source: Apache Atlas.

Next Steps

This guide was a 101 course in setting up Atlas. Next up in this series of guides is a deep dive into applying data governance and stewardship using Atlas with a single metadata source. After that, we’ll look into integrating multiple metadata sources and automating the ingestion with a scheduler.

Like Apache Atlas? You will love Atlan. See Product Tour

Share this article

It would take six or seven people up to two years to build what Atlan gave us out of the box. We needed a solution on day zero, not in a year or two.

Akash Deep Verma
Akash Deep Verma

Director of Data Engineering

resource image

Build vs Buy: Delhivery’s Learnings from Implementing a Data Catalog

[Website env: production]