terraform-provider-redpanda

README

Redpanda Terraform Provider

The Redpanda terraform provider is a Terraform plugin that allows you to create and manage resources on Redpanda Cloud.

Getting started

To add the Redpanda provider:

terraform {
  required_providers {
    redpanda = {
      source = "redpanda-data/redpanda"
    }
  }
}

Authentication

Client credentials for authentication can be provided as:

Static credentials:

provider "redpanda" {
  client_id     = "<CLIENT_ID>"
  client_secret = "<CLIENT_SECRET>"
}

or

Environment variables:

REDPANDA_CLIENT_ID=<CLIENT_ID>
REDPANDA_CLIENT_SECRET=<CLIENT_SECRET>

Developing the provider

Requirements

• Go
• Terraform

Building the provider

After building the provider (go build), you may override the plugin with your locally built provider.

Follow Terraform documentation on dev overrides for provider developers.

Running Acceptance Test

The following environment variables are required to run the acceptance tests:

# For acceptance test
TF_ACC=true

  # For long-running cluster tests
RUN_CLUSTER_TESTS=true

  # For datasource tests, against existing cluster
TEST_AGAINST_EXISTING_CLUSTER=true
CLUSTER_ID=<CLUSTER_ID>

Generating Docs

To generate docs run the following commands

go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs@latest
tfplugindocs

Support

To raise issues, questions, or interact with the community:

• Github Issues
• Slack