Kafka Sources > Before you begin > Create a connection
  

Create a connection

Before you configure the Kafka catalog source, create a connection object in Administrator.
    1In Administrator, select Connections.
    2Click Add Connection.
    3Select Kafka and click Next.
    4Enter the connection properties.
    The following table describes the connection properties:
    Property
    Description
    Connection Name
    Name of the connection.
    The name is not case sensitive. It must be unique within the domain. You can change this property after you create the connection. The name cannot exceed 128 characters, contain spaces, or contain the following special characters:
    ~ ` ! $ % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /
    Description
    Optional. Description that you use to identity the connection.
    The description cannot exceed 4,000 characters.
    Use Secret Vault
    Stores sensitive credentials for this connection in the secrets manager that is configured for your organization.
    This property appears only if secrets manager is set up for your organization.
    When you enable the secret vault in the connection, you can select which credentials that the Secure Agent retrieves from the secrets manager. If you don't enable this option, the credentials are stored in the repository or on a local Secure Agent, depending on how your organization is configured.
    Note:
    If you’re using this connection to apply data access policies through pushdown or proxy services, you cannot use the Secret Vault configuration option.
    For information about how to configure and use a secrets manager, see Secrets manager configuration.
    Runtime Environment
    Name of the runtime environment where you want to run tasks.
    Kafka Broker List
    Comma-separated list of the Kafka brokers.
    To list a Kafka broker, use the following format:
    <HostName>:<PortNumber>
    Note:
    When you connect to a Kafka broker over SSL, you must specify the fully qualified domain name for the host name. Otherwise, the test connection fails with SSL handshake error.
    Kafka Broker Version
    Kafka message broker version. The only valid value is Apache 0.10.1.1 and above.
    Additional Connection Properties
    Optional. Comma-separated list of additional configuration properties for the Kafka producer or consumer.
    For a streaming ingestion and replication task, ensure that you set the kerberos name property if you configure the <Security Protocol> as SASL_PLAINTEXT or SASL_SSL.
    For a database ingestion and replication task, you can specify security protocol properties here instead of in the Additional Security Properties property.
    For example:
    security.protocol=SSL,ssl.truststore.location=/
    opt/kafka/config/kafka.truststore.jks,ssl.truststore.password=<trustore_password>.
    The following table describes the Confluent section connection properties:
    Property
    Description
    Confluent Schema Registry URL
    Location and port of the Confluent schema registry service to access Avro sources and targets in Kafka.
    To list a schema registry URL, use the following format:
    <https>://<HostName or IP>:<PortNumber>
    or
    <http>://<HostName or IP>:<PortNumber>
    Example for the schema registry URL:
    https://kafkarnd.informatica.com:8082
    or
    http://10.65.146.181:8084
    Applies only when you import a Kafka topic in Avro format that uses the Confluent schema registry to store the metadata.
    The following table describes the Security Configuration section connection properties:
    Property
    Description
    SSL Mode
    Required. Determines the encryption type to use for the connection.
    You can choose a mode from the following SSL modes:
    • - Disabled. Establishes an unencrypted connection to the Kafka broker.
    • - One-way. Establishes an encrypted connection to the Kafka broker using truststore file and truststore password.
    • - Two-way. Establishes an encrypted connection to the Kafka broker using truststore file, truststore password, keystore file, and keystore password.
    SSL TrustStore File Path
    Required when you use the one-way or two-way SSL mode.
    Absolute path and file name of the SSL truststore file that contains the SSL certificate to connect to the Kafka broker.
    SSL TrustStore Password
    Required when you use the one-way or two-way SSL mode.
    Password for the SSL truststore.
    SSL KeyStore File Path
    Required when you use the two-way SSL mode.
    Absolute path and file name of the SSL keystore file that contains private keys and certificates to connect to the Kafka broker.
    SSL KeyStore Password
    Required when you use the two-way SSL mode.
    Password for the SSL keystore.
    Additional Security Properties
    Comma-separated list of additional configuration properties to connect to the Kafka broker in a secure way.
    To configure one-way or two-way SSL mode, enter the following value:
    security.protocol=SSL
    If you specify two different values for the same property in Additional Connection Properties and Additional Security Properties Schema Registry, the value in Additional Security Properties Schema Registry overrides the value in Additional Connection Properties.
    The following table describes the Schema Registry Security Configuration section connection properties:
    Property
    Description
    SSL Mode Schema Registry¹
    Required. Determines the encryption type to use for the connection.
    You can choose a mode from the following SSL modes:
    • - Disabled. Establishes an unencrypted connection to the Confluent schema registry.
    • - One-way. Establishes an encrypted connection to the Confluent schema registry using truststore file and truststore password.
    • - Two-way. Establishes an encrypted connection to the Confluent schema registry using truststore file, truststore password, keystore file, and keystore password.
    SSL TrustStore File Path Schema Registry¹
    Required when you use the one-way or two-way SSL mode.
    Absolute path and file name of the SSL truststore file that contains the SSL certificate to connect to the Confluent schema registry.
    SSL TrustStore Password Schema Registry¹
    Required when you use the one-way or two-way SSL mode.
    Password for the SSL truststore.
    SSL KeyStore File Path Schema Registry¹
    Required when you use the two-way SSL mode.
    Absolute path and file name of the SSL keystore file that contains private keys and certificates to connect to the Confluent schema registry.
    SSL KeyStore Password Schema Registry¹
    Required when you use the two-way SSL mode.
    Password for the SSL keystore.
    Additional Security Properties Schema Registry²
    Optional. Comma-separated list of additional security properties to connect to the Confluent schema registry in a secure way.
    For example, when you configure basic authentication to establish a secure communication with Confluent schema registry, specify the following value:
    basic.auth.credentials.source=USER_INFO,basic.auth.user.info=<username>:<password>
    If you specify two different values for the same property in Additional Connection Properties and Additional Security Properties Schema Registry, the value in Additional Security Properties Schema Registry overrides the value in Additional Connection Properties.
    ¹ Applies only to mappings in advanced mode.
    ² Applies to both mappings and mappings in advanced mode.
    5Click Test to test your connection to the source system.
    6Click Save.