/kafka-config-provider-aws

Kafka Configuration Provider for AWS Secrets Manager

Primary LanguageJava

Introduction

Documentation | Download from the Confluent Hub

This plugin provides integration with the AWS Secrets Manager service.

Installation

Confluent Hub

The following command can be used to install the plugin directly from the Confluent Hub using the Confluent Hub Client.

confluent-hub install jcustenborder/kafka-config-provider-aws:latest

Manually

The zip file that is deployed to the Confluent Hub is available under target/components/packages/. You can manually extract this zip file which includes all dependencies. All the dependencies that are required to deploy the plugin are under target/kafka-connect-target as well. Make sure that you include all the dependencies that are required to run the plugin.

  1. Create a directory under the plugin.path on your Connect worker.
  2. Copy all of the dependencies under the newly created subdirectory.
  3. Restart the Connect worker.

Config Providers

com.github.jcustenborder.kafka.config.aws.SecretsManagerConfigProvider

This config provider is used to retrieve secrets from the AWS Secrets Manager service.

Tip

Config providers can be used with anything that supports the AbstractConfig base class that is shipped with Apache Kafka.

Development

Building the source

mvn clean package

Contributions

Contributions are always welcomed! Before you start any development please create an issue and start a discussion. Create a pull request against your newly created issue and we're happy to see if we can merge your pull request. First and foremost any time you're adding code to the code base you need to include test coverage. Make sure that you run mvn clean package before submitting your pull to ensure that all of the tests, checkstyle rules, and the package can be successfully built.