Fix: Update security guidelines and add missing ports to documentation [master]

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

Issue: #10472

Type: Documentation / Suggestions

Summary: Updated the Network-level Security guidelines to include considerations for dynamic ports and added missing ports (10711, 8099, 9021, 8021, 8672) to the default-product-ports documentation.

Changes Made:

1. Updated security-guidelines-for-production-deployment.md to add a note about dynamic port allocation in the "Check open ports and services" guideline.
2. Updated default-product-ports.md to include the following missing ports:
   • 10711: SSL port for secure transport used in data publishing and analytics
   • 8099: Web Socket secure port (WSS)
   • 9021: TCP port used for internal event streaming and communication
   • 8021: Port used for internal event streaming communication
   • 8672: Port used for message broker AMQP transport with SSL

Style Scope Verification: Microsoft Style Guidelines have been applied ONLY to newly added content without modifying existing content style unless specifically requested.

Verification: mkdocs build passed successfully

Summary by CodeRabbit

Documentation

• Updated security guidelines documentation for production deployment with clarification about dynamic port allocation
• Enhanced default product ports reference documentation by adding five new API-M port specifications: secure transport for data publishing (10711), WebSocket secure port (8099), TCP port for internal event streaming (9021), event communication port (8021), and AMQP transport with SSL (8672)

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation updates to deployment security guidelines and API-M port references. Added five new port entries to the port reference table and included explanatory notes about dynamic port allocation in the security guidelines with corrected cross-reference links.

Changes

Cohort / File(s)	Summary
Port Reference Documentation en/docs/install-and-setup/setup/reference/default-product-ports.md	Added five new API-M port entries: 10711 (SSL data publishing), 8099 (WebSocket Secure), 9021 (TCP internal events), 8021 (internal event streaming), 8672 (AMQP with SSL). Inserted before existing 9099 WebSocket ports.
Deployment Security Guidelines en/docs/install-and-setup/setup/deployment-best-practices/security-guidelines-for-production-deployment.md	Corrected Default Product Ports reference link in two sections and added explanatory notes regarding dynamic port allocation. Adjusted surrounding HTML tags to accommodate new content.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

• Straightforward documentation additions with no code logic or control flow changes
• Port entries are simple table additions with consistent formatting
• Reference link corrections and explanatory notes are self-evident edits

Poem

🐰 With whiskers twitched and pen in paw,
I've added ports both great and small,
Eight thousand, nine, and ten so true,
Documentation now shines anew! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main changes: updating security guidelines and adding missing ports to documentation.
Description check	✅ Passed	The description provides purpose, summary of changes, verification, and references the related issue, though it deviates from the standard template structure.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fixing-issue-10472-master-1766398675

---

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.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

en/docs/install-and-setup/setup/reference/default-product-ports.md (1)

88-135: Port entries look good—minor suggestion on description polish.

The five new port entries are properly formatted and positioned with clear descriptions. The grouping before the 9099 Web Socket entry makes logical sense.

One optional refinement: Line 93 slightly repeats the "secure" concept ("SSL port for the secure transport... secure communication"). Consider simplifying to avoid redundancy:

💡 Optional refinement suggestion

-            SSL port for the secure transport used in data publishing and analytics. This port is used for secure communication with analytics servers.
+            SSL port for data publishing and analytics communication with analytics servers.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0ed2c3e and 7fac767.

📒 Files selected for processing (2)

• en/docs/install-and-setup/setup/deployment-best-practices/security-guidelines-for-production-deployment.md
• en/docs/install-and-setup/setup/reference/default-product-ports.md

🔇 Additional comments (1)

en/docs/install-and-setup/setup/deployment-best-practices/security-guidelines-for-production-deployment.md (1)

449-450: Dynamic port allocation note is timely and well-placed.

The addition of the note about dynamic port allocation strengthens the security guideline by alerting operators to verify expected ports during monitoring. The explanation of causes (JMX, clustering, runtime configs) is practical.