|
1 | 1 | --- |
2 | | -# generated by https://github.com/hashicorp/terraform-plugin-docs |
3 | | -page_title: "redpanda Provider" |
4 | | -subcategory: "" |
| 2 | +page_title: "Provider: Redpanda Data" |
5 | 3 | description: |- |
6 | | - The Redpanda Data Terraform provider is used to manage Redpanda Dedicated and Cloud clusters and Kafka resources within them. To use the provider to connect to a Redpanda Cloud cluster, you need to provide a client_id and client_secret. |
7 | | - Example Usage |
8 | | - This example demonstrates how to use the Redpanda Terraform provider with various fields populated with dummy values. Ensure you replace these values with your actual data. |
9 | | - ```hcl |
10 | | - provider "redpanda" { |
11 | | - clientid = "yourclientid" |
12 | | - clientsecret = "yourclientsecret" |
13 | | - cloud_provider = "AWS" # Supported values: GCP, AWS |
14 | | - region = "us-west-2" |
15 | | - zones = ["us-west-2a", "us-west-2b", "us-west-2c"] |
16 | | - } |
17 | | - Define a Redpanda cluster resource |
18 | | - resource "redpandacluster" "examplecluster" { |
19 | | - name = "example-cluster" |
20 | | - cloudprovider = "AWS" |
21 | | - region = "us-west-2" |
22 | | - nodecount = 3 |
23 | | - zones = ["us-west-2a", "us-west-2b"] |
24 | | - # Other necessary configuration here... |
25 | | - } |
26 | | - ``` |
27 | | - This configuration sets up the provider to manage resources in the AWS cloud, specifying the client_id and client_secret for authentication. The cloud_provider, region, and zones fields define where the resources will be located. The redpanda_cluster resource example shows how you could define a cluster with these settings. |
28 | | - Remember to replace your_client_id and your_client_secret with your actual credentials and adjust the cloud_provider, region, and zones according to your deployment needs. |
| 4 | + The Redpanda Data Terraform provider is used to manage Redpanda Dedicated and Cloud clusters and Kafka resources within them. To connect to a Redpanda Cloud cluster, a client_id and client_secret are required. |
29 | 5 | --- |
30 | 6 |
|
31 | | -# redpanda Provider |
| 7 | +# REDPANDA DATA Provider |
32 | 8 |
|
33 | | -The Redpanda Data Terraform provider is used to manage Redpanda Dedicated and Cloud clusters and Kafka resources within them. To use the provider to connect to a Redpanda Cloud cluster, you need to provide a `client_id` and `client_secret`. |
| 9 | +The Redpanda Data provider is designed for managing Redpanda clusters and Kafka resources in Redpanda Dedicated and Cloud environments. It supports the provisioning, management, and configuration of clusters and Kafka resources, facilitating seamless integration into Terraform workflows. |
34 | 10 |
|
35 | | -### Example Usage |
| 11 | +It is also able to provide management of Kafka resources (topics, ACLs, and more) within Redpanda clusters deployed outside of Redpanda Cloud. |
36 | 12 |
|
37 | | -This example demonstrates how to use the Redpanda Terraform provider with various fields populated with dummy values. Ensure you replace these values with your actual data. |
| 13 | +This provider requires a `client_id` and `client_secret` for authentication with Redpanda Cloud services, enabling users to securely manage their Redpanda resources. You can get these by creating an account in [Redpanda Cloud](https://cloudv2.redpanda.com/home) and then [creating a client in the ](https://cloudv2.redpanda.com/clients). |
| 14 | + |
| 15 | +## Example Usage |
| 16 | + |
| 17 | +Here's a basic example of how to use the provider: |
38 | 18 |
|
39 | 19 | ```hcl |
40 | 20 | provider "redpanda" { |
41 | 21 | client_id = "your_client_id" |
42 | 22 | client_secret = "your_client_secret" |
43 | | - cloud_provider = "AWS" # Supported values: GCP, AWS |
44 | | - region = "us-west-2" |
45 | | - zones = ["us-west-2a", "us-west-2b", "us-west-2c"] |
46 | | -} |
47 | | -
|
48 | | -# Define a Redpanda cluster resource |
49 | | -resource "redpanda_cluster" "example_cluster" { |
50 | | - name = "example-cluster" |
51 | | - cloud_provider = "AWS" |
| 23 | + cloud_provider = "aws" |
52 | 24 | region = "us-west-2" |
53 | | - node_count = 3 |
54 | 25 | zones = ["us-west-2a", "us-west-2b"] |
55 | | - # Other necessary configuration here... |
56 | 26 | } |
57 | | -``` |
58 | | - |
59 | | -This configuration sets up the provider to manage resources in the AWS cloud, specifying the `client_id` and `client_secret` for authentication. The `cloud_provider`, `region`, and `zones` fields define where the resources will be located. The `redpanda_cluster` resource example shows how you could define a cluster with these settings. |
60 | | - |
61 | | -Remember to replace `your_client_id` and `your_client_secret` with your actual credentials and adjust the `cloud_provider`, `region`, and `zones` according to your deployment needs. |
62 | | - |
63 | | - |
64 | | - |
65 | | -<!-- schema generated by tfplugindocs --> |
66 | | -## Schema |
67 | | - |
68 | | -### Optional |
69 | | - |
70 | | -- `client_id` (String, Sensitive) The id for the client. You need client_id AND client_secret to use this provider |
71 | | -- `client_secret` (String, Sensitive) Redpanda client secret. You need client_id AND client_secret to use this provider |
72 | | -- `cloud_provider` (String) Which supported cloud provider you are using (GCP, AWS). Can also be specified per resource |
73 | | -- `region` (String) Cloud provider regions for the clusters you wish to build. Can also be specified per resource |
74 | | -- `zones` (List of String) Cloud provider zones for the clusters you wish to build. Can also be specified per resource |
0 commit comments