Skip to content

azaurus1/pulumi-kafka-connect

Repository files navigation

Pulumi Native Provider for Kafka Connect

A Pulumi Provider for Kafka Connect, allows for:

  • Creating a connector
  • Reading a connector
  • Deleting a connector

Prerequisites

Prerequisites for this repository are already satisfied by the Pulumi Devcontainer if you are using Github Codespaces, or VSCode.

If you are not using VSCode, you will need to ensure the following tools are installed and present in your $PATH:

Build & test the provider

  1. Create a new Github CodeSpaces environment using this repository.
  2. Open a terminal in the CodeSpaces environment.
  3. Run make build install to build and install the provider.
  4. Run make gen_examples to generate the example programs in examples/ off of the source examples/yaml example program.
  5. Run make up to run the example program in examples/yaml.
  6. Run make down to tear down the example program.

A brief repository overview

You now have:

  1. A provider/ folder containing the building and implementation logic
    1. cmd/pulumi-resource-kafkaconnect/main.go - holds the provider's sample implementation logic.
  2. deployment-templates - a set of files to help you around deployment and publication
  3. sdk - holds the generated code libraries created by pulumi-gen-kafkaconnect/main.go
  4. examples a folder of Pulumi programs to try locally and/or use in CI.
  5. A Makefile and this README.

Additional Details

This repository depends on the pulumi-go-provider library. For more details on building providers, please check the Pulumi Go Provider docs.

Build Examples

Create an example program using the resources defined in your provider, and place it in the examples/ folder.

You can now repeat the steps for build, install, and test.

References

Other resources/examples for implementing providers: