Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add installation docs #508

Merged
merged 2 commits into from
Sep 19, 2024
Merged

Add installation docs #508

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a25d07b
Add installation docs
guineveresaenger Sep 17, 2024
7c7c840
Do not add empty Overview section
guineveresaenger Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Kafka Provider
meta_desc: Provides an overview on how to configure the Pulumi Kafka provider.
layout: package
---
## Installation

The kafka provider is available as a package in all Pulumi languages:

* JavaScript/TypeScript: [`@pulumi/kafka`](https://www.npmjs.com/package/@pulumi/kafka)
* Python: [`pulumi-kafka`](https://pypi.org/project/pulumi-kafka/)
* Go: [`github.com/pulumi/pulumi-kafka/sdk/v3/go/kafka`](https://github.com/pulumi/pulumi-kafka)
* .NET: [`Pulumi.Kafka`](https://www.nuget.org/packages/Pulumi.Kafka)
* Java: [`com.pulumi/kafka`](https://central.sonatype.com/artifact/com.pulumi/kafka)
## Configuration Reference
### Required

- `bootstrapServers` (List of String) A list of kafka brokers

- `caCert` (String) CA certificate file to validate the server's certificate.
- `caCertFile` (String, Deprecated) Path to a CA certificate file to validate the server's certificate.
- `clientCert` (String) The client certificate.
- `clientCertFile` (String, Deprecated) Path to a file containing the client certificate.
- `clientKey` (String) The private key that the certificate was issued for.
- `clientKeyFile` (String, Deprecated) Path to a file containing the private key that the certificate was issued for.
- `clientKeyPassphrase` (String) The passphrase for the private key that the certificate was issued for.
- `kafkaVersion` (String) The version of Kafka protocol to use in `$MAJOR.$MINOR.$PATCH` format. Some features may not be available on older versions. Default is 2.7.0.
- `saslAwsCredsDebug` (Boolean) Set this to true to turn AWS credentials debug.
- `saslAwsProfile` (String) AWS profile name to use
- `saslAwsRegion` (String) AWS region where MSK is deployed.
- `saslAwsRoleArn` (String) Arn of an AWS IAM role to assume
- `saslMechanism` (String) SASL mechanism, can be plain, scram-sha512, scram-sha256, aws-iam
- `saslPassword` (String) Password for SASL authentication.
- `saslTokenUrl` (String) The url to retrieve oauth2 tokens from, when using sasl mechanism oauthbearer
- `saslUsername` (String) Username for SASL authentication.
- `skipTlsVerify` (Boolean) Set this to true only if the target Kafka server is an insecure development instance.
- `timeout` (Number) Timeout in seconds
- `tlsEnabled` (Boolean) Enable communication with the Kafka Cluster over TLS.
Loading