Cloudera Navigator - Technical Preview - Import - Cloud

Talend Cloud Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Catalog

Bridge Requirements

This bridge:
  • requires the tool to be installed to access its SDK.

  • requires Internet access to https://repo.maven.apache.org/maven2/ and/or other tool sites to download drivers into <TDC_HOME>/data/download/MIMB/.

Bridge Specifications

Vendor Cloudera
Tool Name Navigator
Tool Version 2.x
Tool Web Site http://www.cloudera.com/products/cloudera-navigator.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 REST API
Data Profiling
Remote Repository Browsing for Model Selection
Incremental Harvesting
Multi-Model Harvesting

SPECIFICATIONS
Tool: Cloudera / Navigator version 2.x via REST API
See http://www.cloudera.com/products/cloudera-navigator.html
Metadata: [Metadata Management] Multi-Model, Metadata Repository, Data Store (Physical Data Model), ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: ClouderaNavigator version 11.0.0

DISCLAIMER
This bridge requires internet access to https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites)
in order to download the necessary third party software libraries into $HOME/data/download/MIMB/
- If https fails, the 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 bridge does not have access to internet, that directory can be copied from another server with internet access.
By running this bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third party software libraries.

OVERVIEW
Navigator repositories contain the Hadoop data store definitions of HDFS files and HIVE tables, as well as the data flow lineage of operations between them.
Navigator repositories determine such data flow lineage from the execution log of various technologies (HiveQL, Spark, etc) produced by various applications, ingestion framework /ETL /DI jobs.

- Entities filter allows to define the data flow starting or end entities by location (e.g. files in various directories, and some precise files), and type (e.g. HIVE tables, HDFS files)
- Lineage Direction allows to pick a data flow direction from the above entities (i.e upstream or downstream)
- Operations filter allows to the data flow to some operation types (e.g. HiveQL, Spark) and time range (e.g. last week)

REQUIREMENTS
Navigator repositories can be extremely large as it contains any HDFS/HIVE transactions over multiple years of activities.
Therefore, it is important filter down the scope of a given Navigator import to a precise data flow activity.

FREQUENTLY ASKED QUESTIONS
n/a

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
The purpose of this Navigator 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 Navigator import bridge is to extract the data flow lineage (DI processes) between previously harvested HDFS and HIVE data stores.

SUPPORT
Provide a trouble shooting 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 option -backup)


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(tables, files and directories) set, filtered by this parameter. The query syntax is exactly the same as in Cloudera Navigator search ui.

Query examples:
path like data.csv
owner:impala
path like *hdfs://quickstart.cloudera:8020/user/hive/warehouse/customers
path like *dirname* and type:directory

To make import faster, please provide as precise as possible query and check filtered entities count in Navigator ui before import.
STRING     Mandatory
Operations filter Limit imported operations by date or sourceType, e.g.
started:[2019-02-25T00:00:000Z TO 2019-02-27T00:00:000Z] and sourceType:impala

Using of this option will bring additional requests to the API server which may slow down the import process.
STRING      
Lineage direction Use this parameter to set lineage extract direction. ENUMERATED
Both
Upstream
Downstream
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="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
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 8000M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -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.
-j -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

MODEL IMPORT OPTIONS
-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, 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"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

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 options 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"="SQL SERVER".
The list of supported data store connection types includes:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
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 DestinationPath=SourcePath
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 hdfs://host:8020/users/user1/folder/file.csv=/user1/folder
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 /users/John=/data -connection.map /users/paul=/data
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map M:\=C:\data -connection.map N:\=C:\data

-pppd
Create the connections and connection data sets in DI/ETL design models. This feature should only be used when intending to export to another DI/ETL tool.

REPOSTORY OPTIONS
-restore.dir <backup directory path>
Specify the backup directory to be restorted, 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)

NAVIGATOR OPTIONS
-request.limit <max number of entities>
Specify the maximum number of entities to fetch per one request, e.g.
-request.limit 1000

-s
Import System objects that are skipped by default

-cd <comma separated list of connections>
Creates Directories per connection, e.g.
-cd a_con=orig_con:/root/a (create a separate connection a_con for folder branch root/a in connection origin_con)
-cd hdfs://nameservice2/podium=hdfs://nameservice1/podium (create a separate connection hdfs://nameservice2/podium for connection hdfs://nameservice1/podium)

-load.physicals
Imports logical-physical relations
STRING      

 

Bridge Mapping

Mapping information is not available