Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wak327 wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −0
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions doc/reference/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,27 @@ 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 for their APIs on each cluster member.
Make sure that no other services use these ports, and that they are reachable between all cluster members:

| 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) |

Ceph and OVN use additional ports for their own services, as detailed in the {ref}`MicroCeph attack surface <microceph:attack-surface>` documentation and the {doc}`MicroOVN hardening guide <microovn:reference/hardening>`.

```{note}
The Ceph dashboard uses port 8443 for HTTPS by default, which conflicts with LXD.
Visit the {ref}`Ceph dashboard documentation <ceph:mgr-dashboard>` for details about how to configure the dashboard to use a different port.
```

(reference-requirements-software)=
## Software requirements

Expand Down