From 2277a7d24f02eac70eae4e6f30cf9bfa6ddf5830 Mon Sep 17 00:00:00 2001 From: Waleed Khalid Date: Tue, 20 Oct 2026 15:39:01 +0500 Subject: [PATCH] doc/reference/requirements: Document the network ports Also add a note about the Ceph dashboard's default port conflicting with LXD. Signed-off-by: Waleed Khalid --- doc/reference/requirements.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/reference/requirements.md b/doc/reference/requirements.md index b429bd97c..0af8d28e7 100644 --- a/doc/reference/requirements.md +++ b/doc/reference/requirements.md @@ -125,6 +125,32 @@ To configure external connectivity, MicroCloud requires an uplink network that s The IP addresses of the cluster members must not change after installation, so they must be configured as static addresses. +(reference-requirements-network-ports)= +### Network ports + +MicroCloud and its components use the following ports on each cluster member. +Make sure that no other services use these ports: + +| 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) | + +The TCP ports must be reachable between all cluster members. +Port 9444 is only used for multicast discovery while setting up the cluster or adding new members. +It only needs to be reachable on the initiator, the cluster member on which you run {command}`microcloud init` or {command}`microcloud add`. + +Ceph and OVN use additional ports for their own services, as detailed in the {ref}`MicroCeph attack surface ` documentation and the {doc}`MicroOVN hardening guide `. + +```{note} +The Ceph dashboard is not enabled by MicroCloud, but you might enable it after deploying MicroCloud. +It uses port 8443 for HTTPS by default, which conflicts with LXD. +Visit the {ref}`Ceph dashboard documentation ` for details about how to configure the dashboard to use a different port. +``` + (reference-requirements-software)= ## Software requirements