Skip to content

Update README and architecture documentation - #29

Merged
HiranAdikari merged 2 commits into
wso2:mainfrom
HiranAdikari:docs/update-readme-architecture-new
Apr 10, 2026
Merged

Update README and architecture documentation#29
HiranAdikari merged 2 commits into
wso2:mainfrom
HiranAdikari:docs/update-readme-architecture-new

Conversation

@HiranAdikari

@HiranAdikari HiranAdikari commented Apr 2, 2026

Copy link
Copy Markdown
Contributor

This pull request updates the README.md and docs/architecture.md to reflect the current state of the repository.

Key changes:

  • Added descriptions for identity, monitoring, and vm modules.
  • Updated the repository URL in README.md from wso2-enterprise to wso2.
  • Corrected module references and version tags.
  • Added Phase 3 (Identity & Monitoring) and Phase 4 (Workloads) to the architecture documentation.
  • Fixed broken references and improved clarity of the deployment sequence.

Summary by CodeRabbit

  • New Features

    • Added Identity modules for OIDC-based authentication integration.
    • Added Monitoring module with alerting and Grafana dashboard capabilities.
    • Added standalone VM provisioning support for workloads with customizable storage and networking.
  • Documentation

    • Revised deployment phases and architecture diagrams to insert Identity & Monitoring and expand Workloads.
    • Updated module catalog and source references to reflect new modules and versions.

@coderabbitai

coderabbitai Bot commented Apr 2, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ee4c1f40-c672-4a02-aaee-e1374e6a6d27

📥 Commits

Reviewing files that changed from the base of the PR and between 6bc7894 and e8cea68.

📒 Files selected for processing (2)
  • docs/architecture.md
  • modules/management/storage/examples/basic/main.tf
✅ Files skipped from review due to trivial changes (2)
  • modules/management/storage/examples/basic/main.tf
  • docs/architecture.md

Walkthrough

Updated Terraform module source references (wso2-enterprise → wso2) and expanded documentation: added Identity (rancher-oidc, providers/asgardeo), Monitoring, and Workloads (VM) modules; restructured deployment phases from four to five, inserting Identity & Monitoring between Management and Workloads.

Changes

Cohort / File(s) Summary
README & top-level docs
README.md
Updated module "bootstrap" source from github.com/wso2-enterprise/...?ref=v0.1.0github.com/wso2/...?ref=v0.4.5; expanded module catalog (Identity, Monitoring, Workloads); reworked Management module listings; updated deployment sequencing (4→5 phases).
Architecture doc
docs/architecture.md
Renamed Phase 3 to “Identity & Monitoring”; added identity submodules (modules/identity/..., providers/asgardeo), modules/monitoring (calert, Alertmanager routing, Grafana), and modules/workloads/vm; updated provider dependency table and module dependency graph to reflect new flow.
Example module source updates
modules/management/storage/examples/basic/main.tf
Updated example module "storage" source git reference to github.com/wso2/open-cloud-datacenter//...?ref=v0.5.8 (no other input or logic changes).

Sequence Diagram(s)

mermaid
sequenceDiagram
participant Admin
participant Terraform
participant Rancher
participant Asgardeo
participant Monitoring
participant Harvester
Admin->>Terraform: apply bootstrap & management
Terraform->>Rancher: configure cluster & auth entrypoints
Admin->>Terraform: apply identity & monitoring
Terraform->>Asgardeo: provision OIDC providers
Terraform->>Monitoring: deploy Prometheus/Alertmanager/Grafana
Admin->>Terraform: apply workloads
Terraform->>Rancher: provision tenant k8s clusters
Terraform->>Harvester: provision standalone VMs

Estimated Code Review Effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nibble docs and hop with cheer,
New modules sprout, the path is clear.
Identity sings, Monitoring hums along,
Workloads bloom like a springtime song.
A tiny rabbit stamps—docs updated, all strong! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description provides a clear summary of key changes and aligns with the PR objectives, though it does not follow the repository's structured template with Purpose, Goals, Approach, and other required sections. Consider following the repository's PR description template to include sections like Purpose (with issue links), Goals, Approach, Release notes, and Documentation impact for consistency with contribution guidelines.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update README and architecture documentation' is directly related to the changeset, which consists of updates to README.md and docs/architecture.md files, making it clear and accurately representative of the main changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/architecture.md`:
- Around line 129-131: The document contains two sections both labeled "Phase 4"
which creates a numbering conflict: locate the headings "Phase 4 — Workloads"
and "Phase 4 — Asgardeo Auth (Future)" and make the sequence consistent by
renumbering the later "Phase 4 — Asgardeo Auth (Future)" to "Phase 5 — Asgardeo
Auth (Future)" (or remove the redundant section if intended), and update any
cross-references or the introductory flow summary so all phase headings and
references reflect the corrected numbering.
- Around line 170-171: Update the provider version matrix entries so they match
the module constraints: change the `rancher/rancher2 ~> 8.0.0` entry to
`rancher/rancher2 ~> 13.1` for both harvester-integration and identity, and
split or annotate the `hashicorp/kubernetes` entry so it shows
`hashicorp/kubernetes ~> 2.30.0` for harvester-integration and
`hashicorp/kubernetes ~> 3.0` for monitoring (replace the single `~> 2.30.0` row
with per-module versions to avoid misleading users).

In `@README.md`:
- Line 28: Update the stale example module source URLs so they match the
top-level source at v0.4.5: locate the example files (e.g.,
modules/management/storage/examples/basic/main.tf lines referencing
wso2-enterprise/...@v0.1.0) and replace their source string with the same
repo/org and tag used in README.md (wso2/open-cloud-datacenter@v0.4.5). Ensure
every "source =" entry in example files uses the unified value and verify there
are no remaining references to wso2-enterprise or v0.1.0.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 967eb9ff-8bcd-4662-8ddc-747237a5b82a

📥 Commits

Reviewing files that changed from the base of the PR and between dccbd51 and 6bc7894.

📒 Files selected for processing (2)
  • README.md
  • docs/architecture.md

Comment thread docs/architecture.md
Comment thread docs/architecture.md Outdated
Comment thread README.md
gnudeep
gnudeep previously approved these changes Apr 2, 2026
- Rename duplicate Phase 4 (Asgardeo Auth) to Phase 5 to resolve
  numbering conflict with the Workloads phase added in this PR
- Update Provider Dependency Summary table: replace stale ~> 0.6.0 /
  ~> 3.0 / ~> 8.0.0 constraints with versions from actual module
  versions.tf files (harvester ~> 1.7, rancher2 ~> 13.1,
  kubernetes ~> 3.0, asgardeo/asgardeo ~> 0.1)
- Fix storage example source: update from wso2-enterprise org and
  stale v0.1.0 tag to wso2/open-cloud-datacenter at v0.5.8

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@HiranAdikari
HiranAdikari merged commit f6324ee into wso2:main Apr 10, 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