Skip to content

docs: view port requirements and configuration#1214

Merged
MicBun merged 1 commit intomainfrom
docsClarifyPorts
Oct 14, 2025
Merged

docs: view port requirements and configuration#1214
MicBun merged 1 commit intomainfrom
docsClarifyPorts

Conversation

@MicBun
Copy link
Member

@MicBun MicBun commented Oct 14, 2025

compliment for: https://github.com/trufnetwork/truf-network/issues/1124

Summary by CodeRabbit

  • Documentation

    • Added explicit Security Group/Firewall guidance with Required (SSH 22, P2P 6600, RPC 8484) and Optional (MCP 8000) ports.
    • Clarified port purposes and when each is needed, noting MCP as optional and P2P’s role in network health.
    • Updated AMI deployment and node operator guides with clearer, categorized port instructions.
  • Style

    • Revised AMI runtime and console welcome messages to reflect the new port sections and optional MCP guidance, improving clarity and consistency.

@MicBun MicBun requested a review from outerlook October 14, 2025 02:40
@MicBun MicBun self-assigned this Oct 14, 2025
@MicBun MicBun added the type: docs Improvements or additions to documentation label Oct 14, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 14, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Documentation and console message text updated to introduce explicit Security Group/port guidance: required ports 6600 (P2P) and 8484 (RPC), optional 8000 (MCP), plus SSH 22 in docs. AMI pipeline stack strings were revised to reflect these changes and mark MCP setup as optional. No code logic or APIs changed.

Changes

Cohort / File(s) Summary
Infra: AMI pipeline messaging
deployments/infra/stacks/ami_pipeline_stack.go
Replaced MCP setup block with a Security Group Ports section (6600 P2P, 8484 RPC); moved MCP to optional guidance; updated welcome/console output strings accordingly; no control-flow or API changes.
Docs: AMI deployment guide
docs/ami-deployment-guide.md
Added explicit inbound rules tables and notes; defined required ports (22, 6600, 8484) and optional MCP (8000); clarified port purposes and wording.
Docs: Node operator guide
docs/node-operator-guide.md
Reworded firewall/security group instructions; separated Required (6600, 8484) and Optional (8000 MCP) ports; added note on P2P connectivity behavior; commands unchanged.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • outerlook

Poem

I nudge the ports—6600, 8484—click!
SSH waves hello on 22, nice and quick.
MCP at 8000 waits, if you please,
Optional breezes on cloud-born seas.
A hop, a thump: docs align tight—
This rabbit sings, "Your nodes take flight!" 🐇✨

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docsClarifyPorts

📜 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 3f76e92 and 8c5fc32.

📒 Files selected for processing (3)
  • deployments/infra/stacks/ami_pipeline_stack.go (2 hunks)
  • docs/ami-deployment-guide.md (1 hunks)
  • docs/node-operator-guide.md (1 hunks)

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.

@holdex
Copy link

holdex bot commented Oct 14, 2025

Time Submission Status

Member Status Time Action Last Update
MicBun ✅ Submitted 2h 30min Update time Oct 14, 2025, 5:39 AM

@MicBun MicBun merged commit 3396806 into main Oct 14, 2025
5 checks passed
@MicBun MicBun deleted the docsClarifyPorts branch October 14, 2025 02:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant