Skip to content

Update self-hosted section in deployment guide#520

Merged
Dilhasha merged 6 commits into
wso2:mainfrom
Dilhasha:docs-updates
Jun 8, 2026
Merged

Update self-hosted section in deployment guide#520
Dilhasha merged 6 commits into
wso2:mainfrom
Dilhasha:docs-updates

Conversation

@Dilhasha

@Dilhasha Dilhasha commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Purpose

$subject

Summary by CodeRabbit

  • Documentation
    • Removed provider-specific cloud deployment guides for AWS, Azure, and GCP.
    • Removed guidance on environment promotion and environment-specific workflows.
    • Reorganized deployment docs to emphasize VM Deployment and updated related navigation.
    • Revised configuration guidance: updated precedence, environment-variable override behavior, and Kubernetes secret examples.
    • Clarified serverless build notes and adjusted "What’s next" links (including Metrics and VM-focused links).

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

This PR consolidates deployment documentation by removing cloud provider–specific and environment-promotion guides, refactoring configuration variable naming and precedence rules, reframing VM deployment as a standalone option, and updating cross-document navigation links to reflect the simplified structure.

Changes

Documentation Consolidation and Configuration Refactoring

Layer / File(s) Summary
Configuration System Updates
en/docs/deploy-operate/deploy/managing-configurations.md
Configuration documentation revised to prioritize environment variables over command-line arguments in precedence order. Introduces BAL_CONFIG_FILES for runtime config file selection (with OS-specific separator syntax), BAL_CONFIG_DATA for embedding TOML in environment variables, and replaces environment-variable override naming with BAL_CONFIG_VAR_<VARIABLE_NAME> convention (uppercase, underscores preserved). Adds module-level env-var mapping examples, documents supported vs unsupported env-var data types, removes encryption-related section (including bal encrypt and BAL_CONFIG_SECRET_KEY), and updates Kubernetes Secret stringData examples to use new BAL_CONFIG_VAR_* keys.
Sidebar Navigation and Deployment Options Consolidation
en/sidebars.ts, en/docs/deploy/overview.md
Sidebar Deploy→Self-Hosted entries updated: deploy/self-hosted/local-and-vm-deployment replaced with deploy/self-hosted/vm-deployment; legacy deploy-operate/deploy/aws-azure-gcp and deploy-operate/deploy/environments entries removed. Deployment options list rewritten to add "WSO2 Cloud" and replace separate "Local and VM" and "AWS, Azure, GCP" entries with unified "VM Deployment" option; Containerized Deployment, Serverless deployment, and GraalVM native images retained.
VM Deployment Page Reframing
en/docs/deploy/self-hosted/vm-deployment.md
Page reframed from "Local and VM Deployment" to standalone "VM Deployment" in front-matter (title, description, keywords) and introductory text. Removes "Run locally during development" section while preserving VM deployment guidance. Reorders "Run on a VM from source" section to later position (after executable JAR verification), retaining Git clone and bal run instructions and prerequisites notes intact.
Navigation Link Updates Across Documentation
en/docs/deploy-operate/deploy/graalvm-native-images.md, en/docs/deploy-operate/deploy/scaling-high-availability.md, en/docs/develop/understand-ide/views/integration-view.md, en/docs/develop/understand-ide/views/project-view.md, en/docs/reference/project/ballerinatoml-reference.md
Consistent updates to "What's next" and deployment option links: "Local and VM deployment" labels replaced with "VM Deployment" across GraalVM, integration view, project view, and Ballerinat.toml reference docs. Scaling-and-high-availability "What's next" section removes Environments and AWS/Azure/GCP links, adds Metrics monitoring link.
Serverless Deployment Notes
en/docs/deploy-operate/deploy/serverless-deployment.md
Adds notes that --cloud="azure_functions" and --cloud="aws_lambda" are optional for builds because the compiler auto-detects the respective extensions; updates "What's next" to "Containerized Deployment".

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • wso2/docs-integrator#519: Overlaps in documentation navigation updates by directing readers to VM Deployment and updating "What's next" links in graalvm-native-images.md and other deployment docs.
  • wso2/docs-integrator#518: Parallel changes to deploy documentation navigation in en/docs/deploy/overview.md, managing-configurations.md, and sidebar entries to consolidate deployment options.

Suggested reviewers

  • rosensilva
  • NipunaRanasinghe
  • KavinduZoysa
  • anupama-pathirage
  • anuruddhal

Poem

🐰 A rabbit’s note on tidy docs:

Cloud pages pruned, the paths align,
BAL_CONFIG_VAR sings in tidy lines,
VM Deployment hops into place,
Links now point with nimble grace ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is incomplete, containing only a placeholder '$subject' in the Purpose section with no actual content, and missing all other required template sections. Complete the description by replacing '$subject' with actual purpose, and fill in Goals, Approach, Release notes, and other relevant template sections.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title 'Update self-hosted section in deployment guide' accurately reflects the core objective of reorganizing deployment documentation, focusing on VM deployment while removing/consolidating AWS, Azure, GCP, and environments sections.

✏️ 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
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
en/docs/deploy-operate/deploy/managing-configurations.md (1)

34-34: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use sentence case for non-H1 headings.

These headings are in title case/mixed case and should be sentence case per repo rules. Suggested updates:

  • ## Per-environment config files
  • ### ConfigMap for non-sensitive values
  • ## Consolidated multi-service configuration
    As per coding guidelines, “Use sentence case for all non-H1 titles (H2, H3, H4, etc.).”

Also applies to: 280-280, 341-341

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@en/docs/deploy-operate/deploy/managing-configurations.md` at line 34, Change
the non-H1 headings from title case to sentence case: replace "Per-Environment
config files" with "Per-environment config files", "ConfigMap for non-sensitive
values" with "ConfigMap for non-sensitive values" (ensure only the first word
and proper nouns are capitalized), and "Consolidated multi-service
configuration" with "Consolidated multi-service configuration"; update any other
H2/H3/H4 headings in the file that currently use title/mixed case to follow the
repo rule of sentence case.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/docs/deploy-operate/deploy/managing-configurations.md`:
- Around line 17-20: The docs table wrongly groups `Config.toml` and
`BAL_CONFIG_DATA` as having equal precedence; update the table to split that row
into two separate rows (one for `Config.toml`/`BAL_CONFIG_FILES` and one for
`BAL_CONFIG_DATA`) and explicitly state that `BAL_CONFIG_DATA` overrides
`BAL_CONFIG_FILES`/`Config.toml` when both are present; reference the symbols
`BAL_CONFIG_DATA`, `BAL_CONFIG_FILES`, and `Config.toml` in the new rows and
adjust the precedence ordering text so it matches the repo's other docs.

---

Outside diff comments:
In `@en/docs/deploy-operate/deploy/managing-configurations.md`:
- Line 34: Change the non-H1 headings from title case to sentence case: replace
"Per-Environment config files" with "Per-environment config files", "ConfigMap
for non-sensitive values" with "ConfigMap for non-sensitive values" (ensure only
the first word and proper nouns are capitalized), and "Consolidated
multi-service configuration" with "Consolidated multi-service configuration";
update any other H2/H3/H4 headings in the file that currently use title/mixed
case to follow the repo rule of sentence case.
🪄 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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 67b7dc75-5000-4cb1-af58-67013acf74c2

📥 Commits

Reviewing files that changed from the base of the PR and between e0f4b5c and 16f1b83.

📒 Files selected for processing (11)
  • en/docs/deploy-operate/deploy/aws-azure-gcp.md
  • en/docs/deploy-operate/deploy/environments.md
  • en/docs/deploy-operate/deploy/graalvm-native-images.md
  • en/docs/deploy-operate/deploy/managing-configurations.md
  • en/docs/deploy-operate/deploy/scaling-high-availability.md
  • en/docs/deploy/overview.md
  • en/docs/deploy/self-hosted/vm-deployment.md
  • en/docs/develop/understand-ide/views/integration-view.md
  • en/docs/develop/understand-ide/views/project-view.md
  • en/docs/reference/project/ballerinatoml-reference.md
  • en/sidebars.ts
💤 Files with no reviewable changes (3)
  • en/docs/deploy-operate/deploy/scaling-high-availability.md
  • en/docs/deploy-operate/deploy/environments.md
  • en/docs/deploy-operate/deploy/aws-azure-gcp.md

Comment thread en/docs/deploy-operate/deploy/managing-configurations.md Outdated
@Dilhasha Dilhasha changed the title Update deployment guide Update self-hosted section in deployment guide Jun 8, 2026
@Dilhasha Dilhasha merged commit 50f5c02 into wso2:main Jun 8, 2026
3 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