https://github.com/mongey/terraform-provider-kafka-connect

Terraform provider for managing Apache Kafka Connect
https://github.com/mongey/terraform-provider-kafka-connect

kafka kafka-connect terraform terraform-provider

Last synced: 2 days ago
JSON representation

Terraform provider for managing Apache Kafka Connect

• Host: GitHub
• URL: https://github.com/mongey/terraform-provider-kafka-connect
• Owner: Mongey
• License: mit
• Created: 2018-02-11T17:51:59.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-02T09:05:24.000Z (5 months ago)
• Last Synced: 2025-01-12T13:06:05.763Z (9 days ago)
• Topics: kafka, kafka-connect, terraform, terraform-provider
• Language: Go
• Homepage:
• Size: 5.5 MB
• Stars: 110
• Watchers: 6
• Forks: 42
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `terraform-plugin-kafka-connect`

[![test](https://github.com/Mongey/terraform-provider-kafka-connect/actions/workflows/test.yml/badge.svg)](https://github.com/Mongey/terraform-provider-kafka-connect/actions/workflows/test.yml)

A [Terraform][1] plugin for managing [Apache Kafka Connect][2].

## Installation

Download and extract the [latest

release](https://github.com/Mongey/terraform-provider-kafka-connect/releases/latest) to

your [terraform plugin directory][third-party-plugins] (typically `~/.terraform.d/plugins/`)

## Example

Configure the provider directly, or set the ENV variable `KAFKA_CONNECT_URL`

```hcl

provider "kafka-connect" {

  url = "http://localhost:8083"

  basic_auth_username = "user" # Optional

  basic_auth_password = "password" # Optional

  

  # For TLS

  tls_auth_crt = "/tmp/cert.pem" # Optional

  tls_auth_key = "/tmp/key.pem " # Optional

  tls_auth_is_insecure = true   # Optionnal if you do not want to check CA   

}

resource "kafka-connect_connector" "sqlite-sink" {

  name = "sqlite-sink"

  config = {

    "name"            = "sqlite-sink"

    "connector.class" = "io.confluent.connect.jdbc.JdbcSinkConnector"

    "tasks.max"       = 1

    "topics"          = "orders"

    "connection.url"  = "jdbc:sqlite:test.db"

    "auto.create"     = "true"

    "connection.user" = "admin"

  }

  config_sensitive = {

    "connection.password" = "this-should-never-appear-unmasked"

  }

}

```

## Provider Properties

| Property              | Type   | Example                 | Alternative environment variable name |

|-----------------------|--------|-------------------------|---------------------------------------|

| `url`                 | URL    | "http://localhost:8083" | `KAFKA_CONNECT_URL`                   |

| `basic_auth_username` | String | "user"                  | `KAFKA_CONNECT_BASIC_AUTH_USERNAME`   |

| `basic_auth_password` | String | "password"              | `KAFKA_CONNECT_BASIC_AUTH_PASSWORD`   |

| `tls_auth_crt`        | String | "certificate"           | `KAFKA_CONNECT_TLS_AUTH_CRT`          |

| `tls_auth_key`        | String | "Key"                   | `KAFKA_CONNECT_TLS_AUTH_KEY`          |

| `tls_auth_is_insecure`| String | "Key"                   | `KAFKA_CONNECT_TLS_IS_INSECURE`       |

| `headers`             | Map[String]String | {foo = "bar"}           | N/A                                   |

## Resource Properties

| Property              | Type      | Description                                                          |

|-----------------------|-----------|----------------------------------------------------------------------|

| `name`                | String    | Connector name                                                       |

| `config`              | HCL Block | Connector configuration                                              |

| `config_sensitive`    | HCL Block | Sensitive connector configuration. Will be masked in output.         |

## Developing

0. [Install go][install-go]

0. Clone repository to: `$GOPATH/src/github.com/Mongey/terraform-provider-kafka-connect`

    ``` bash

    mkdir -p $GOPATH/src/github.com/Mongey/terraform-provider-kafka-connect; cd $GOPATH/src/github.com/Mongey/

    git clone https://github.com/Mongey/terraform-provider-kafka-connect.git

    ```

0. Build the provider `make build`

0. Run the tests `make test`

0. Run acceptance tests `make testacc`

[1]: https://www.terraform.io

[2]: https://kafka.apache.org/documentation/#connect

[third-party-plugins]: https://www.terraform.io/docs/configuration/providers.html#third-party-plugins

[install-go]: https://golang.org/doc/install#install