Skip to content

Latest commit

 

History

History
116 lines (96 loc) · 4.82 KB

README.md

File metadata and controls

116 lines (96 loc) · 4.82 KB

Atlas version GitHub GitHub Workflow Status (branch) Docker Pulls Docker Image Size (latest by date)

Apache Atlas Docker image

This Apache Atlas image is built from the 2.2.0-release source tarball and patched (including the fix for Log4JShell CVE) to be run in a Docker container.

This image is configured to connect to Hbase and Solr that are running on separate machines or docker containers. This image needs the initialization step before you can use it.

If you want to configure the docker image, use the documentation.

Basic usage

  1. Pull the latest release image:
docker pull ntwine/apache-atlas:master

or

docker pull ghcr.io/hritvikpatel4/apache-atlas:master
  1. Start Apache Atlas in a container exposing Web-UI port 21000:
docker run -d \
    -p 21000:80 \
    --name atlas \
    -e HBASE_TABLE=apache_atlas_janus \
    -e ZK_QUORUM=zookeeper:2181 \
    -e KAFKA_BOOTSTRAP_SERVERS=broker:9092 \
    -e HOSTNAME=atlas \
    -e SOLR_HOST=solr \
    -e SOLR_PORT=8983 \
    ntwine/apache-atlas:master \
    atlas_start

Please, take into account that the first startup of Atlas may take up to few mins depending on host machine performance before web-interface become available at http://localhost:21000/

Web-UI default credentials: admin / admin

Usage options

Gracefully stop Atlas:

docker exec -it atlas /opt/apache-atlas-2.2.0/bin/atlas_stop.py

Check Atlas startup script output:

docker logs atlas

Check interactively Atlas application.log (useful at the first run and for debugging during workload):

docker exec -it atlas tail -f /opt/apache-atlas-2.2.0/logs/application.log

Start Atlas overriding settings by environment variables (to support large number of metadata objects for example):

docker run -d \
    -e "ATLAS_SERVER_OPTS=-server -XX:SoftRefLRUPolicyMSPerMB=0 \
    -XX:+CMSClassUnloadingEnabled -XX:+UseConcMarkSweepGC \
    -XX:+CMSParallelRemarkEnabled -XX:+PrintTenuringDistribution \
    -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=dumps/atlas_server.hprof \
    -Xloggc:logs/gc-worker.log -verbose:gc -XX:+UseGCLogFileRotation \
    -XX:NumberOfGCLogFiles=10 -XX:GCLogFileSize=1m -XX:+PrintGCDetails \
    -XX:+PrintHeapAtGC -XX:+PrintGCTimeStamps" \
    -e HBASE_TABLE=apache_atlas_janus \
    -e ZK_QUORUM=zookeeper:2181 \
    -e KAFKA_BOOTSTRAP_SERVERS=broker:9092 \
    -e HOSTNAME=atlas \
    -e SOLR_HOST=solr \
    -e SOLR_PORT=8983 \
    -p 21000:80 \
    --name atlas \
    ntwine/apache-atlas:master \
    atlas_start

Environment Variables

The following environment variables are available for configuration:

Name Default Description
JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64 The java implementation to use. If JAVA_HOME is not found we expect java and jar to be in path
ATLAS_OPTS any additional java opts you want to set. This will apply to both client and server operations
ATLAS_CLIENT_OPTS any additional java opts that you want to set for client only
ATLAS_CLIENT_HEAP java heap size we want to set for the client. Default is 1024MB
ATLAS_SERVER_OPTS any additional opts you want to set for atlas service.
ATLAS_SERVER_HEAP java heap size we want to set for the atlas server. Default is 1024MB
ATLAS_HOME_DIR What is is considered as atlas home dir. Default is the base location of the installed software
ATLAS_LOG_DIR Where log files are stored. Defatult is logs directory under the base install location
ATLAS_PID_DIR Where pid files are stored. Defatult is logs directory under the base install location
ATLAS_EXPANDED_WEBAPP_DIR Where do you want to expand the war file. By Default it is in /server/webapp dir under the base install dir.

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there to see if your issue has already been reported. If you spotted it first, help us smash it by providing detailed and welcomed feedback.

Maintainer

This image is maintained by Hritvik Patel