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 who enable the Ceph dashboard run into a port conflict with LXD without knowing why.

This adds a "Network ports" section under "Networking requirements" listing the API 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 (during setup)

It also adds a note that the Ceph dashboard's default HTTPS port, 8443, conflicts with LXD, with an example of moving it to a free port. As @roosterfish pointed out in the issue, 6443 and 7443 are already taken too.

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 Outdated
Comment thread doc/reference/requirements.md Outdated
@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 Outdated
Also add a note about the Ceph dashboard's default port conflicting with LXD.

Signed-off-by: Waleed Khalid <wak327@gmail.com>
@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?

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

2 participants