docs: add notice about the terraform provider #382
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughA notice was added to the "Prerequisites" section of the Terraform provider documentation, clarifying that the Redpanda Terraform provider does not natively support Windows. The update instructs Windows users to use Windows Subsystem for Linux 2 (WSL2) to run the provider, and provides step-by-step guidance and example commands for operating within WSL2. The information is presented in an important admonition block to ensure visibility. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
Depending on tests, this page might also be affected https://github.com/redpanda-data/docs/blob/main/modules/reference/partials/rpk-cloud-byoc-concept.adoc |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/manage/pages/terraform-provider.adoc (1)
100-124: Add reference link to WSL 2 docs and clarify provider binary requirementThe new admonition is helpful, but adding a link to Microsoft’s official WSL 2 installation guide will save readers a search.
You could also state that the Linux AMD 64 (or ARM 64) provider binary is downloaded automatically once Terraform runs inside WSL 2, so no additional manual steps are needed.[IMPORTANT] ==== *Redpanda Terraform Provider - Windows Support Notice* -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. +The Redpanda Terraform provider is not supported on Windows systems. If you're using Windows, you must run the provider inside +Windows Subsystem for Linux 2 (WSL 2). +See the official Microsoft guide for installing and setting up WSL 2: +https://learn.microsoft.com/windows/wsl/install + +Terraform will automatically download the Linux provider binary once it is executed inside WSL 2—no extra manual download is required.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
modules/manage/pages/terraform-provider.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
📚 Learning: the notification timeline for redpanda cloud deprecations has been deliberately removed from the doc...
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Applied to files:
modules/manage/pages/terraform-provider.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
|
|
||
| To use WSL2 with the Redpanda Terraform provider: | ||
|
|
||
| . Open your WSL2 Linux distribution (e.g., Ubuntu) from the Start menu or by running `wsl` in PowerShell. |
There was a problem hiding this comment.
This is more accurately, you need to run wsl --install and restart your computer before using wsl: https://learn.microsoft.com/en-us/windows/wsl/install
There was a problem hiding this comment.
I was assuming that the user already had WSL installed. Added e2aae26 to complement the install info
Description
Resolves https://github.com/redpanda-data/documentation-private/issues/DOC-1566
Review deadline:
Page previews
Checks