Skip to content

A Kafka Pulumi resource package, providing multi-language access to Kafka

License

Notifications You must be signed in to change notification settings

pulumi/pulumi-kafka

Actions Status Slack NPM version Python version NuGet version PkgGoDev License

Kafka Resource Provider

The Kafka resource provider for Pulumi lets you manage Kafka resources in your cloud programs. To use this package, please install the Pulumi CLI first.

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

$ npm install @pulumi/kafka

or yarn:

$ yarn add @pulumi/kafka

Python

To use from Python, install using pip:

$ pip install pulumi_kafka

Go

To use from Go, use go get to grab the latest version of the library

$ go get github.com/pulumi/pulumi-kafka/sdk/v3

.NET

To use from .NET, install using dotnet add package:

$ dotnet add package Pulumi.Kafka

Configuration

The following configuration points are available:

  • kafka:bootstrapServers - (Required) A list of host:port addresses that will be used to discover the full set of alive brokers.
  • kafka:caCert - (Optional) The CA certificate or path to a CA certificate file to validate the server's certificate.
  • kafka:clientCert - (Optional) The client certificate or path to a file containing the client certificate -- Use for Client authentication to Kafka.
  • kafka:clientKey - (Optional) The private key or path to a file containing the private key that the client certificate was issued for.
  • kafka:skipTlsVerify - (Optional) Skip TLS verification. Default false.
  • kafka:tlsEnabled - (Optional) Enable communication with the Kafka Cluster over TLS. Default false.
  • kafka:saslUsername - (Optional) Username for SASL authentication.
  • kafka:saslPassword - (Optional) Password for SASL authentication.
  • kafka:saslMechanism - (Optional) Mechanism for SASL authentication. Allowed values are plain, scram-sha512 and scram-sha256. Default plain.
  • kafka:timeout - (Optional) Timeout in seconds. Default 120.

Reference

For further information, please visit the Kafka provider docs or for detailed reference documentation, please visit the API docs.