Add cluster module

[MauroKinderknecht]

Summary by CodeRabbit

• New Features

  • Adds a Terraform module to provision a DevZero cluster and install zxporter and devzero-operator via Helm. Configurable inputs for runtime, cloud provider, Prometheus, scheduler, containerd paths, annotations, and extra Helm values. Exposes cluster ID and a sensitive cluster token output.

• Documentation

  • Expanded README with usage, requirements, and generated inputs/outputs tables; added docs generation support.

• Chores

  • Added CI linting for Terraform, updated ignore rules for Terraform artifacts and sensitive files, and added a docs Makefile target.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Adds Terraform resources to provision a DevZero cluster and install zxporter and devzero‑operator Helm charts; introduces providers, variables, and outputs. Also adds README/docs tooling, a Makefile docs target, an updated .gitignore, and a GitHub Actions workflow to run TFLint on PRs.

Changes

Cohort / File(s)	Summary
CI: TFLint workflow ​.github/workflows/lint.yaml	New GitHub Actions workflow running TFLint on PRs to main: checks out code, caches TFLint plugins, sets up setup-tflint v0.52.0, shows version, runs tflint --init with GITHUB_TOKEN, and runs tflint --format=compact.
Terraform: providers & core resources providers.tf, main.tf, outputs.tf	Adds required providers (devzero, helm), creates devzero_cluster.cluster, adds helm_release.zxporter and helm_release.devzero_operator with runtime-specific containerd path resolution and dependencies on the cluster; adds cluster_id and sensitive cluster_token outputs.
Terraform: inputs variables.tf	Introduces variables: cluster_name, endpoint, cloud_provider, provision_prometheus, operator_annotations, enable_scheduler, enable_live_migration_agent, runtime, containerd_config_path, containerd_socket_path, zxporter_extra_values, and operator_extra_values with validations/defaults.
Docs & tooling README.md, Makefile, .gitignore	Expands README.md with terraform-docs markers and documentation, adds Makefile docs target using terraform-docs markdown table --output-file README.md --output-mode inject, updates .gitignore to exclude Terraform artifacts, state, overrides, and CLI config.

Sequence Diagram(s)

sequenceDiagram
  participant U as User
  participant TF as Terraform CLI
  participant DZ as devzero Provider
  participant HM as helm Provider
  rect rgba(230,240,255,0.5)
    note right of U: Apply module
    U->>TF: terraform apply
  end
  TF->>DZ: create devzero_cluster.cluster
  activate DZ
  DZ-->>TF: returns cluster id, token
  deactivate DZ
  note over TF,DZ: outputs: cluster_id, cluster_token
  rect rgba(240,255,240,0.5)
    note over TF,HM: Helm releases depend on cluster
    TF->>HM: install helm_release.zxporter (context, token, provider, prometheus)
    TF->>HM: install helm_release.devzero_operator (cloud, token, runtime, containerd paths)
    HM-->>TF: release statuses
  end
  TF-->>U: apply complete

Loading

sequenceDiagram
  participant GH as GitHub
  participant GA as Actions Runner
  participant Repo as Repository
  rect rgba(255,245,230,0.6)
    GH-->>GA: PR opened / synchronized (base=main)
    GA->>Repo: actions/checkout
    GA->>GA: Cache ~/.tflint.d/plugins
    GA->>GA: setup-tflint v0.52.0
    GA->>GA: tflint --version
    GA->>GA: tflint --init (uses GITHUB_TOKEN)
    GA->>GA: tflint --format=compact
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Add cluster module #1 — Nearly identical edits adding TFLint workflow, Terraform resources (devzero_cluster, helm releases), outputs, providers, variables, README/Makefile/.gitignore; directly related.

Poem

I thump the ground—new clusters bloom,
Charts hop in line to fill the room.
Linting breezes sweep the patch,
Docs and tokens snugly matched.
I nibble code and dance—🥕 hooray!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title “Add cluster module” succinctly captures the primary change of introducing the Terraform cluster module and its associated resources, aligning directly with the bulk of the added configuration and infrastructure code. It is concise, clear, and specific enough for a reviewer scanning history to understand that this pull request primarily implements a new cluster module.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 51a8a59 and ae619b5.

📒 Files selected for processing (4)

• README.md (1 hunks)
• main.tf (1 hunks)
• outputs.tf (1 hunks)
• variables.tf (1 hunks)

---

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

[coderabbitai]

Actionable comments posted: 4

🧹 Nitpick comments (1)

providers.tf (1)

1-13: Add a Terraform required_version.

tflint is flagging the absence of required_version; without it consumers can run this module on Terraform releases that might lack functions/features we rely on. Please add a constraint (e.g., required_version = ">= 1.5.0" or whatever you officially support).

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e837186 and 35f3304.

📒 Files selected for processing (8)

• .github/workflows/lint.yaml (1 hunks)
• .gitignore (1 hunks)
• Makefile (1 hunks)
• README.md (1 hunks)
• main.tf (1 hunks)
• outputs.tf (1 hunks)
• providers.tf (1 hunks)
• variables.tf (1 hunks)

🧰 Additional context used

🪛 checkmake (0.2.2)

Makefile

[warning] 1-1: Missing required phony target "all"

(minphony)

---

[warning] 1-1: Missing required phony target "clean"

(minphony)

---

[warning] 1-1: Missing required phony target "test"

(minphony)

🪛 GitHub Actions: Lint

providers.tf

[warning] 1-1: tflint: terraform "required_version" attribute is not specified. (terraform_required_version)

variables.tf

[warning] 29-29: tflint: variable "operator_annotations" is declared but not used. (terraform_unused_declarations)

---

[warning] 6-6: tflint: variable "endpoint" is declared but not used. (terraform_unused_declarations)

🪛 GitHub Check: tflint (ubuntu-latest)

providers.tf

[warning] 1-1:
terraform "required_version" attribute is required

variables.tf

[warning] 6-6:
variable "endpoint" is declared but not used

---

[warning] 29-29:
variable "operator_annotations" is declared but not used

🪛 markdownlint-cli2 (0.18.1)

README.md

3-3: Bare URL used

(MD034, no-bare-urls)

---

5-5: Bare URL used

(MD034, no-bare-urls)

---

31-31: Multiple headings with the same content

(MD024, no-duplicate-heading)

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

3-5: Wrap bare URLs in Markdown links

Formatting these as [Website](...) and [Docs](...) avoids markdownlint MD034 and keeps the README consistent.

---

7-31: Avoid duplicate “Requirements” headings

Having two ## Requirements sections (manual + TF docs) triggers markdownlint MD024 and can confuse readers. Renaming the first one (e.g., “Prerequisites”) or merging the content would resolve it.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 35f3304 and 79506f7.

📒 Files selected for processing (4)

• README.md (1 hunks)
• main.tf (1 hunks)
• providers.tf (1 hunks)
• variables.tf (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (3)

• main.tf
• variables.tf
• providers.tf

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

README.md

3-3: Bare URL used

(MD034, no-bare-urls)

---

5-5: Bare URL used

(MD034, no-bare-urls)

---

31-31: Multiple headings with the same content

(MD024, no-duplicate-heading)