Meta Integration® Model Bridge (MIMB)
"Metadata Integration" Solution

MIMB Bridge Documentation

MIMB Import Bridge from Apache Kafka

Bridge Specifications

Vendor Apache
Tool Name Kafka
Tool Version Kafka 2.x to 3.x
Tool Web Site http://kafka.apache.org/
Supported Methodology [File System] Multi-Model, Data Store (NoSQL / Hierarchical, Physical Data Model) via Java API on Kafka File

SPECIFICATIONS
Tool: Apache / Kafka version Kafka 2.x to 3.x via Java API on Kafka File
See http://kafka.apache.org/
Metadata: [File System] Multi-Model, Data Store (NoSQL / Hierarchical, Physical Data Model)
Component: ApacheKafka 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
Loads metadata from all or specified Kafka topics.

REQUIREMENTS
When using Confluent Schema Registry specify its URLs in the "Schema Registry URL" parameter.
Otherwise, each topic is assumed to have messages of the same type.
The bridge samples multiple latest messages to determine their common structure.
This bridge supports the following message formats:
- Delimited File (CSV)
- Open Office Excel (XSLX)
- COBOL Copybook
- JSON (JavaScript Object Notation)
- Apache Avro
- Apache Parquet
- Apache ORC
- W3C XML

as well as the compressed versions of the above formats:
- ZIP (as a compression format, not as archive format)
- BZIP
- GZIP
- LZ4
- Snappy (as standard Snappy format, not as Hadoop native Snappy format)

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
When you run both Kafka cluster (server) version 1.1.x and the bridge (client) on Windows systems the import could fail with a timeout error. The Kafka version 2.0.x resolved the issue.

When connecting to Kafka using:
"PLAIN authentication"
Specify 'JAAS configuration path' and leave empty 'Kafka brokers principal name' parameter.

"KERBEROS authentication"
Specify specify values of both parameters.

"without authentication"
Leave both of these parameters empty.

Please refer to the individual parameter's documentation for more details.

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
Driver version Choose driver version according to Kafka API.
Used to load the necessary version-specific libraries.
ENUMERATED
2.2.0
2.1.1
2.1.0
2.0.1
2.0.0
1.1.1
1.1.0
1.1.0  
Bootstrap servers List of 'host:port' pairs to use for establishing the initial connection to the Kafka cluster, and finding available servers and topics, e.g.
'host1:port1, host2:port2'

The list does not need to include all available servers but should have at least one.
You may want to include more than one server in case any of them are down.
STRING   localhost:9092 Mandatory
Schema Registry URL Comma-separated list of URLs for Schema Registry instances that can be used to look up schemas.
See https://docs.confluent.io/current/schema-registry/connect.html#configuration-options for details.
STRING   http://localhost:8081  
Topics List of topic names, such as 'topic1, topic2'.
If list is empty, then all topics are available.
You can specify topic names as an wildcard pattern:
'topic?'

'*topic*'

'topic_?,*topic*'
REPOSITORY_SUBSET      
Number of sample messages The maximum number of messages to sample from topics. These messages are used to identify topic format details, like field names and data types. STRING   1000  
Use SSL protocol to connect Set this parameter to True when the Kafka consumer uses TLS/SSL to encrypt Kafka's network traffic.

Kafka uses SSL to encrypt connections between the server and clients
BOOLEAN
False
True
False  
Truststore file The location of the trust store file.
If it is empty the bridge would try to locate it in 'java.home'\lib\security\{'jssecacerts'|'cacerts'}
FILE *.*    
Password of the truststore Password of the truststore. PASSWORD      
JAAS configuration path Enter the primary part of the Kerberos principal you defined for the brokers when you were creating the broker cluster. For example, in this principal kafka/kafka1.hostname.com@EXAMPLE.COM, the primary part to be used to fill in this field is kafka.

Kafka property value -
sasl.kerberos.service.name=value
FILE *.*    
Kafka brokers principal name Enter the primary part of the Kerberos principal you defined for the brokers when you were creating the broker cluster. For example, in this principal kafka/kafka1.hostname.com@EXAMPLE.COM, the primary part to be used to fill in this field is kafka.
This value is going to Kafka property: sasl.kerberos.service.name=value
STRING      
kinit command path Kerberos uses a default path to its kinit executable. If you have changed this path, select this check box and enter the custom access path.

Kafka property value -
sasl.kerberos.kinit.cmd=value
STRING      
Kerberos configuration path Kerberos uses a default path to its configuration file, the krb5.conf file (or krb5.ini in Windows) for Kerberos 5 for example. If you leave this parameter clear, a given strategy is applied by Kerberos to attempt to find the configuration information it requires.
For details about this strategy, see the Locating the krb5.conf Configuration File section in Kerberos requirements.

This value is going to JVM -
'-Djava.security.krb5.conf=value'
FILE *.*    
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
-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.
-java.parameters -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

-java.executable <Java Runtime Environment full path name> (previously -jre)

It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-java.executable "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-environment.variable <name>=<value> (previously -v)

None by default, e.g.
-environment.variable 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

-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"
STRING      

 

Bridge Mapping

Mapping information is not available

Last updated on Wed, 18 Nov 2020 17:34:26

Copyright © Meta Integration Technology, Inc. 1997-2020 All Rights Reserved.

Meta Integration® is a registered trademark of Meta Integration Technology, Inc.
All other trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.