Terraform: Index page and usage guide

[amotl]

About

Continue adding integration guides from the community forum.

Preview

• https://cratedb-guide--308.org.readthedocs.build/integrate/terraform/

References

• Consolidate Integration Guides I vs. II #102

[coderabbitai]

Walkthrough

Adds a new Terraform integration section to documentation with an index page and a detailed AWS-focused tutorial for deploying a CrateDB cluster using the crate/cratedb-terraform module, including setup, apply, outputs/credentials, and destroy steps, plus links to official Terraform docs and Azure-related resources.

Changes

Cohort / File(s)	Summary
Terraform integration docs docs/integrate/terraform/index.md, docs/integrate/terraform/tutorial.md	Introduces a new Terraform docs section: an index page with overview/toctree and a tutorial describing end-to-end AWS deployment of a 3-node CrateDB cluster via the crate/cratedb-terraform module, including configuration, commands (init/plan/apply/destroy), outputs, connection, and teardown notes.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor U as User
  participant T as Terraform CLI
  participant R as Terraform Registry/Module
  participant A as AWS
  participant C as CrateDB Cluster

  U->>T: terraform init
  T->>R: Fetch module (crate/cratedb-terraform)
  R-->>T: Module code
  U->>T: terraform plan
  T->>A: Query state & plan resources
  A-->>T: Plan details
  U->>T: terraform apply
  T->>A: Create VPC/Subnets/EC2/SecurityGroups/… 
  A-->>T: Provisioned resources
  T-->>U: Outputs (incl. cratedb creds, URL)

  U->>C: Connect via Admin UI (TLS/basic auth)

  alt Teardown
    U->>T: terraform destroy
    T->>A: Delete resources
    A-->>T: Destroy complete
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

cross linking

Suggested reviewers

• hammerhead
• kneth

Poem

I nudge the clouds with gentle paws,
Terraform hums, obeying laws.
Three nodes sprout where subnets lie,
A cluster blinks beneath the sky.
Plan, apply—then snack, oh joy!
Destroy at dusk, a tidy toy.
Hop! Docs bloom—deploy, enjoy. 🐇🚀

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Title Check	✅ Passed	The title "Terraform: Index page and usage guide" concisely and accurately summarizes the primary change in this PR (adding Terraform documentation pages). It is short, specific to the files added under docs/integrate/terraform, and clear for teammates scanning history. The phrasing avoids vagueness and captures the developer's intent.
Description Check	✅ Passed	The PR description states the intent to add integration guides, provides a preview link, and references GH-102, which directly relate to the added Terraform index and tutorial pages. The description is on-topic and sufficiently linked to the changeset even though it is brief. It is not generic or unrelated.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch terraform

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[amotl]

@coderabbitai review and please refactor to active voice.