https://github.com/pulumi/pulumi-kafka

A Kafka Pulumi resource package, providing multi-language access to Kafka
https://github.com/pulumi/pulumi-kafka

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/pulumi/pulumi-kafka
• Owner: pulumi
• License: apache-2.0
• Created: 2019-10-15T13:27:11.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-04-16T05:56:06.000Z (about 2 months ago)
• Last Synced: 2025-04-17T14:32:51.966Z (about 2 months ago)
• Language: Makefile
• Size: 2.9 MB
• Stars: 16
• Watchers: 24
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG_OLD.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE-OF-CONDUCT.md

Awesome Lists containing this project

README

        
[![Actions Status](https://github.com/pulumi/pulumi-kafka/workflows/master/badge.svg)](https://github.com/pulumi/pulumi-kafka/actions)

[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com)

[![NPM version](https://badge.fury.io/js/%40pulumi%2Fkafka.svg)](https://www.npmjs.com/package/@pulumi/kafka)

[![Python version](https://badge.fury.io/py/pulumi-kafka.svg)](https://pypi.org/project/pulumi-kafka)

[![NuGet version](https://badge.fury.io/nu/pulumi.kafka.svg)](https://badge.fury.io/nu/pulumi.kafka)

[![PkgGoDev](https://pkg.go.dev/badge/github.com/pulumi/pulumi-kafka/sdk/v3/go)](https://pkg.go.dev/github.com/pulumi/pulumi-kafka/sdk/v3/go)

[![License](https://img.shields.io/npm/l/%40pulumi%2Fpulumi.svg)](https://github.com/pulumi/pulumi-kafka/blob/master/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](https://pulumi.io/).

## 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](https://www.pulumi.com/docs/intro/cloud-providers/kafka) or for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/kafka).