Skip to content

doc/reference/requirements: Document the network ports - #1622

Open
wak327 wants to merge 1 commit into
canonical:mainfrom
wak327:doc-network-ports
Open

wak327 wants to merge 1 commit into
canonical:mainfrom
wak327:doc-network-ports

Conversation

@wak327

@wak327 wak327 commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #1433

The requirements reference doesn't say which ports MicroCloud uses, so users can run into port conflicts, for example with the Ceph dashboard, without knowing why.

This adds a "Network ports" section under "Networking requirements" listing the ports from service/service_handler.go:

Port Protocol Used by
6443 TCP MicroOVN
7443 TCP MicroCeph
8443 TCP LXD (API and UI)
9443 TCP MicroCloud
9444 UDP MicroCloud multicast discovery

It also explains that the TCP ports must be reachable between all cluster members, while 9444 only needs to be reachable on the initiator when using multicast discovery. For the additional ports used by Ceph and OVN, it links to the MicroCeph and MicroOVN documentation.

Checklist

@github-actions github-actions Bot added the Documentation Documentation needs updating label Oct 22, 2026
@wak327

wak327 commented Oct 22, 2026

Copy link
Copy Markdown
Contributor Author

@roosterfish @elijahgreenstein a small docs addition, could you take a look when you have a moment?

@elijahgreenstein elijahgreenstein 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.

@wak327 thank you for this docs update. A few thoughts on adding some cross references to relevant docs pages.

Comment thread doc/reference/requirements.md Resolved
Comment thread doc/reference/requirements.md Resolved
@wak327
wak327 force-pushed the doc-network-ports branch from ffd8b5e to ce26092 Compare October 22, 2026 21:56
@wak327

wak327 commented Oct 22, 2026

Copy link
Copy Markdown
Contributor Author

@roosterfish I addressed @elijahgreenstein's review: the ports section now links to the MicroCeph and MicroOVN docs for their additional ports, and the Ceph dashboard note points to the Ceph documentation instead of giving a command. Could you take a look?

Comment thread doc/reference/requirements.md Resolved
@wak327
wak327 force-pushed the doc-network-ports branch from ce26092 to 09f027c Compare October 25, 2026 18:01
@wak327

wak327 commented Oct 25, 2026

Copy link
Copy Markdown
Contributor Author

@roosterfish @elijahgreenstein I applied the latest suggestions. Could you take another look?

@roosterfish roosterfish 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.

Thanks for your contribution, please see my comments.

Comment thread doc/reference/requirements.md Resolved
Comment thread doc/reference/requirements.md Resolved
@wak327
wak327 force-pushed the doc-network-ports branch from 09f027c to 2277a7d Compare October 29, 2026 22:24
@wak327

wak327 commented Oct 29, 2026

Copy link
Copy Markdown
Contributor Author

@roosterfish thanks for the review, I've addressed your comments. Could you take another look?

Comment thread doc/reference/requirements.md Resolved
Comment thread doc/reference/requirements.md Resolved
Signed-off-by: Waleed Khalid <wak327@gmail.com>
@wak327
wak327 force-pushed the doc-network-ports branch from 2277a7d to d69a156 Compare October 30, 2026 17:10
@wak327

wak327 commented Oct 30, 2026

Copy link
Copy Markdown
Contributor Author

@elijahgreenstein @roosterfish I applied the latest suggestions. Could you take another look?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ceph default port for https console

3 participants