Skip to content

Commit 4b86448

Browse files
authored
docs: add notice about the terraform provider (#382)
* docs: add notice about the terraform provider * add install instructions
1 parent 95e6e0b commit 4b86448

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

modules/manage/pages/terraform-provider.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,42 @@ Do not modify `throughput_tier` after it is set. When `allow_deletion` is set to
108108

109109
== Prerequisites
110110

111+
[IMPORTANT]
112+
====
113+
*Redpanda Terraform Provider - Windows Support Notice*
114+
115+
The Redpanda Terraform provider is not supported on Windows systems. If you're using Windows, you must use Windows Subsystem for Linux 2 (WSL2) to run the Redpanda Terraform provider.
116+
117+
To use WSL2 with the Redpanda Terraform provider:
118+
119+
. If WSL2 is not already installed, install it by running the following command in PowerShell as Administrator:
120+
+
121+
```powershell
122+
wsl --install
123+
```
124+
+
125+
Then restart your computer.
126+
127+
. Open your WSL2 Linux distribution (e.g., Ubuntu) from the Start menu or by running `wsl` in PowerShell.
128+
. Navigate to your project directory within WSL2.
129+
. Run all Terraform commands from within your WSL2 environment:
130+
+
131+
```bash
132+
# Initialize Terraform and download the Redpanda provider
133+
terraform init
134+
135+
# Plan your Redpanda infrastructure changes
136+
terraform plan
137+
138+
# Apply the configuration to create Redpanda resources
139+
terraform apply
140+
141+
# View created resources
142+
terraform show
143+
```
144+
145+
====
146+
111147
. Install at least version 1.0.0 of Terraform using the https://learn.hashicorp.com/tutorials/terraform/install-cli[official guide^].
112148
. Create a service account in Redpanda Cloud:
113149
.. Log in to https://cloud.redpanda.com[Redpanda Cloud^].

0 commit comments

Comments
 (0)