Skip to content

Update k8s-cluster module example documentation#217

Merged
HiranAdikari merged 1 commit into
wso2:terraformfrom
iamtrazy:terraform
Jul 6, 2026
Merged

Update k8s-cluster module example documentation#217
HiranAdikari merged 1 commit into
wso2:terraformfrom
iamtrazy:terraform

Conversation

@iamtrazy

@iamtrazy iamtrazy commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Corrected the module source ref in the example from terraform/v0.4.0 to terraform/v0.1.7
  • Updated the default kubernetes_version in the example from v1.35.4+rke2r1 to v1.34.9+rke2r1
  • Added a new Grant Cluster Access section (§7) documenting the cluster_members input — covers both available roles, all five identity lookup methods, and an annotated HCL example with email, OIDC group, and local user patterns

Changes

File Change
examples/main.tf Module ref and kubernetes version corrected
examples/README.md Module ref and kubernetes version corrected; new §7 added; §7–10 renumbered to §8–11

Notes

  • cluster_members was already supported by the module but had no user-facing documentation or example; this closes that gap
  • The cluster-member / cluster-owner role table and the identity lookup method table are derived directly from the variable definition in variables.tf
  • The tip on finding principal IDs via Rancher UI → Users & Authentication covers both local and OIDC scenarios

Summary by CodeRabbit

  • Documentation
    • Updated the Kubernetes cluster example guide with corrected section numbering and refreshed version references.
    • Added a new “Grant Cluster Access” section explaining how to configure cluster members and assign access roles.
    • Included an updated example for granting access, along with clearer guidance on supported identity lookup options.
    • Refreshed the sample cluster version shown in the Terraform example to match the latest documented format.

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6b6b473a-9d5b-4e6e-87ca-997fb1b1b64b

📥 Commits

Reviewing files that changed from the base of the PR and between 1f4dbec and 61ee826.

📒 Files selected for processing (2)
  • modules/tenancy/k8s-cluster/examples/README.md
  • modules/tenancy/k8s-cluster/examples/main.tf

📝 Walkthrough

Walkthrough

This PR updates the k8s-cluster example's Terraform module reference and Kubernetes version pin, syncs the corresponding README sample snippet, and adds a new "Grant Cluster Access" documentation section with renumbered subsequent headings.

Changes

Example Version Bump and Access Documentation

Layer / File(s) Summary
Module reference and version update
modules/tenancy/k8s-cluster/examples/main.tf
Module source ref changed from terraform/v0.4.0 to terraform/v0.1.7, and kubernetes_version changed from v1.35.4+rke2r1 to v1.34.9+rke2r1.
README sample sync
modules/tenancy/k8s-cluster/examples/README.md
Sample main.tf snippet and Kubernetes version reference text updated to match the new module ref and version values.
Grant Cluster Access docs and TOC renumbering
modules/tenancy/k8s-cluster/examples/README.md
New "7. Grant Cluster Access" section documents cluster_members roles, identity lookup methods, and an example; Table of Contents and subsequent section headings are renumbered.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: HiranAdikari

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly reflects the main change: updating k8s-cluster example documentation.
Description check ✅ Passed Includes Summary, Changes, and Notes; only Testing and Checklist sections are missing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@HiranAdikari HiranAdikari merged commit bb7138b into wso2:terraform Jul 6, 2026
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants