Using a Connector License Key

A valid license key is necessary to guarantee the proper functioning of the connectors. The license key is provided by INIT Individuelle Softwareentwicklung & Beratung GmbH.

To obtain a license key, please contact connector-contact@init-software.de.

Once the license key expires, the connector automatically stops working. This guide provides instructions on how to add the license key to your connector configuration and describes the available methods.

---

There are several ways to set the license key for the connector, depending on your environment and security needs. Choose the method that fits your use case best.

Directly in the Connector Configuration

This method is simple and suitable for testing or during the evaluation phase.

Add the license key directly to the connector’s configuration in the following format:

sap.odata.license.key="Your license key here"

Limitations

Not recommended for production: You will need to update all connector configurations when the license key changes.

---

Using a Config Provider (Recommended for Production)

This method is recommended for production environments to securely handle the license key without exposing it in cleartext. Using a config provider also allows for more flexible management, as the license key can be stored separately and dynamically resolved.

Overview

The ConfigProvider class interface lets you use variables in your connector configurations. These variables are resolved dynamically when the connector starts or restarts. Kafka currently supports three types of ConfigProvider:

• DirectoryConfigProvider: Loads configuration from multiple files within a directory.
• EnvVarConfigProvider: Loads configuration from environment variables (useful for containerized environments).
• FileConfigProvider: Loads configuration from a specific file.

Instructions

1. Choose the appropriate ConfigProvider based on your setup (e.g., file-based, environment variable-based, or directory-based).
2. Enable one or more ConfigProvider by adding them to the Kafka worker configuration.

   config.providers=file,dir
   config.providers.file.class=org.apache.kafka.common.config.provider.FileConfigProvider
   config.providers.dir.class=org.apache.kafka.common.config.provider.DirectoryConfigProvider
   

3. Save the file(s) containing the license key(s) accessible to each Connect worker or create environment variables containing the key(s).

   External Properties File

   license="Your license key here"
   

4. Update the connector’s configuration to reference the external secret. The format {<config-provider-type>:<path>:<key>} is used to replace a config value in the configuration.

   Connector Configuration using FileConfigProvider

   sap.odata.license.key=${file:<pathToFile>:license}
   

   Note

   pathToFile specifies the full file path to the properties file where the license key is stored.

Benefits

• Secrets, like the license key, are not stored in cleartext in the connector configuration.
• You only need to update the external secret (e.g., the license key file) when the license key changes.