Cloudera Hortonworks Atlas - Import
Availability-note
AWS
AWS-only features are available at any of the following URLs: us.cloud.talend.com, eu.cloud.talend.com, ap.cloud.talend.com
Bridge Requirements
This bridge:requires Internet access to https://repo.maven.apache.org/maven2/ and/or other tool sites to download drivers into <TDC_HOME>/data/download/MIMB/.
requires the tool to be installed to access its SDK.
Bridge Specifications
| Vendor | Cloudera |
| Tool Name | Hortonworks Atlas |
| Tool Version | Atlas 2.x |
| Tool Web Site | https://www.cloudera.com/products/open-source/apache-hadoop/apache-atlas.html |
| Supported Methodology | [Metadata Management] Multi-Model, Metadata Repository, Data Store (Physical Data Model), ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing) via Java REST API |
| Data Profiling |  |
| Incremental Harvesting | |
| Multi-Model Harvesting |  |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: Cloudera / Hortonworks Atlas version Atlas 2.x via Java REST API
See https://www.cloudera.com/products/open-source/apache-hadoop/apache-atlas.html
Metadata: [Metadata Management] Multi-Model, Metadata Repository, Data Store (Physical Data Model), ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: ApacheAtlasImport.HortonworksAtlas version 11.2.0
DISCLAIMER
This import bridge requires internet access to download third-party libraries:
- such as https://repo.maven.apache.org/maven2/ to download open source third-party libraries,
- and more sites for other third-party software such as database specific JDBC drivers.
The downloaded third-party libraries are stored into $HOME/data/download/MIMB/
- If HTTPS fails, the import bridge then tries with HTTP.
- If a proxy is used to access internet, you must configure that proxy in the JRE (see the -j option in the Miscellaneous parameter).
- If the import bridge does not have full access to internet, that $HOME/data/download/MIMB/ directory can be copied from another server with internet access where the command $HOME/bin/MIMB.sh (or .bat) -d can be used to download all third-party libraries used by all bridges at once.
By running this import bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third-party software libraries.
OVERVIEW
Atlas repositories contain the Hadoop data store definitions of HDFS files and Hive tables, as well as the data flow lineage of operations between them.
Atlas repositories determine such data flow lineage from the execution log of various technologies (Map/Reduce, Pig, Impala, etc) produced by various applications, ingestion framework /ETL /DI jobs.
The purpose of this Atlas import bridge is NOT to extract the data store definitions, instead use the Hive and HDFS import bridges for that purpose.
However, the purpose of this Atlas import bridge is to extract the data flow lineage (DI processes) between previously imported HDFS and Hive data stores.
Note that the dedicated HiveQL or Spark import bridges should be preferred in order to get better detailed feature/column level lineage with correlation to the original scripts.
REQUIREMENTS
n/a
FREQUENTLY ASKED QUESTIONS
n/a
LIMITATIONS
Refer to the current general known limitations at MIMB Known Limitations or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
SUPPORT
Provide a troubleshooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with -backup option, although this common option is not implemented on all bridges for technical reasons).
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | |||
| URL | URL of the metadata server. e.g. http://localhost:21000/ |
STRING | Mandatory | |||||
| Login | Name of the user account used to connect to metadata server | STRING | holger_gov | |||||
| Password | Password for the user account used to connect to metadata server. | PASSWORD | holger_gov | |||||
| Entities filter | Bridge will import and build lineage using start entities set, filtered by this parameter. The query syntax is exactly the same as in Atlas search UI. It is allowed to use basic full-text and advanced DSL mode. Entity type will be set to 'DataSet' when full-text mode is used Some queries examples: schemaname.tablename hdfs://quickstart.cloudera:8020/user/hive/warehouse/customers* hive_table where name='test' To make import faster, please provide as precise as possible query and check filtered entities count in Atlas UI before import. |
STRING | Mandatory | |||||
| Lineage direction | Use this parameter to set lineage extract direction | ENUMERATED |
|
BP_LINEAGE_DIRECTION_BOTH | ||||
| Kerberos configuration file | Path to Kerberos krb5 config file (usually krb5.ini or krb5.conf with correct configuration inside) e.g. /etc/krb5/krb5.conf |
STRING | ||||||
| Kerberos login.conf file | Path to login.conf with correct keytab file path and principal name. F.e: client { com.sun.security.auth.module.Krb5LoginModule required useKeyTab=true storeKey=true keyTab=/path/to/userKeytab principal='userName'; }; |
STRING | ||||||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="MICROSOFT SQL SERVER" Some options can be used multiple times if applicable, e.g. -connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2; As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g. ETL/Miscellaneous.txt JAVA ENVIRONMENT OPTIONS -java.memory <Java Memory's maximum size> (previously -m) 1G by default on 64bits JRE or as set in conf/conf.properties, e.g. -java.memory 8G -java.memory 8000M -java.parameters <Java Runtime Environment command line options> (previously -j) This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g. -java.parameters -Dname=value -Xms1G The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ and exceptionally a few other tool sites) in order to download the necessary third-party software libraries. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass MODEL IMPORT OPTIONS -model.name <model name> Override the model name, e.g. -model.name "My Model Name" -prescript <script name> This option allows running a script before the bridge execution. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), and have .bat or .sh extension. The script path must not include any parent directory symbol (..). The script should return exit code 0 to indicate success, or another value to indicate failure. For example: -prescript "script.bat arg1 arg2" -postscript <script name> This option allows running a script after successful execution of the bridge. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), and have .bat or .sh extension. The script path must not include any parent directory symbol (..). The script should return exit code 0 to indicate success, or another value to indicate failure. For example: -postscript "script.bat arg1 arg2" -cache.clear Clears the cache before the import, and therefore will run a full import without incremental harvesting. If the model was not changed and the -cache.clear parameter is not used (incremental harvesting), then a new version will not be created. If the model was not changed and the -cache.clear parameter is set (full source import instead of incremental), then a new version will be created. -backup <directory> This option allows to save the bridge input metadata for further troubleshooting. The provided <directory> must be empty. The primary use of this option is for data store import bridges, in particular JDBC based database import bridges. Note that this option is not operational on some bridges including: - File based import bridges (as such input files can be used instead) - DI/BI repository import bridges (as the tool's repository native backup can be used instead) - Some API based import bridges (e.g. COM based) for technical reasons. DATA CONNECTION OPTIONS Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following option allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs. -connection.cast ConnectionName=ConnectionType Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g. -connection.cast "My Database"="MICROSOFT SQL SERVER". The list of supported data store connection types includes: ACCESS APACHE CASSANDRA DB2/UDB DENODO GOOGLE BIGQUERY HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE MICROSOFT SQL AZURE MICROSOFT SQL SERVER SYBASE SQL SERVER SYBASE AS ENTERPRISE TERADATA VECTORWISE HP VERTICA -connection.rename OldConnection=NewConnection Renames an existing connection to a new name, e.g. -connection.rename OldConnectionName=NewConnectionName Multiple existing database connections can be renamed and merged into one new database connection, e.g. -connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase -connection.split oldConnection.Schema1=newConnection Splits a database connection into one or multiple database connections. A single database connection can be split into one connection per schema, e.g. -connection.split MyDatabase All database connections can be split into one connection per schema, e.g. -connection.split * A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g. -connection.split MyDatabase.schema1=MySchema1 -connection.map SourcePath=DestinationPath Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file). On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a Hive table implemented (external) by the same file specified using a relative path with default file name and extension, e.g. -connection.map /user1/folder=hdfs://host:8020/users/user1/folder/file.csv On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g. -connection.map /data=/users/John -connection.map /data=/users/paul On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map C:\data=M:\ -connection.map C:\data=N:\ -connection.casesensitive ConnectionName Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.casesensitive "My Database" -connection.level AggregationLevel Specifies the aggregation level for the external connections, e.g.-connection.level catalog The list of the supported values: server catalog schema (default) ETL OPTIONS These options are available on all ETL/DI tools and scripting import bridges in order to: - Process all SQL parsing - Build runtime models from design models and runtime variables - Calculate runtime summary lineage -etl.summary.add.ultimate (previously -ppus) Adds the ultimate runtime lineage summary (may generate a very large model). -etl.summary.only.ultimate (previously -ppsp) Only produces the ultimate runtime lineage summary (may generate a very large model). -etl.connections.add.internal.design (previously -pppd) Adds the internal ETL design data connectors (needed for ETL conversion). -etl.connections.remove.input (previously -ri) Removes all input (source) data connections (to reduce the size of the generated model). -etl.transformations.enable.xml This option enables the parsing and support of XML transformations in DI/ETL import bridges such as Informatica PowerCenter, Informatica Developer, Microsoft SSIS, IBM DataStage, and Talend Data Integration. In case of Informatica, such XML transformations corresponds to the following PowerCenter features https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/midstream-xml-transformations.html https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/xml-source-qualifier-transformation.html Note that this option may significantly slow down the import. REPOSITORY OPTIONS -restore.dir <backup directory path> Specify the backup directory to be restored, e.g. -restore.dir C:\test\restoreDir -connection.timeout <number of seconds> Specify a connection time out (by default 20), e.g: -connection.timeout 20 -threads.count <number> Sets the number of threads to use while performing requests to API, e.g. -threads.count 5 -cs <comma separated list of connections> Creates Schemas per Connection, e.g. -cs * (create a separate connection for each schema in each connection) -cs c1, c2 (create separate connections for each schema in connections c1 and c2) -cs app1=c.s1 (create a connection named app1 for the schema s1 in the connection c) ATLAS OPTIONS -entities.limit <max number of entities> Specify the maximum number of entities to fetch per filtering by Entities filter parameter value, e.g. -entities.limit 1000 -request.limit <number of entities per one request> Specify the number of entities to fetch per one offset request filtering by Entities filter parameter value, e.g. -request.limit 1000 Unlimited by default (or limited by Atlas server configurations). -hive.support.quoted.identifiers <identifiers> Default is none, sets this option to enable regex-based column specification, e.g. -hive.support.quoted.identifiers none -ignore.deleted Use this option to disable loading of deleted entities |
STRING |
Bridge Mapping
Mapping information is not available