Skip to content

doc/reference/requirements: Document the vxlan module requirement #1623

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 2 commits into
base: main
Choose a base branch
from
+3 −0
Open

doc/reference/requirements: Document the vxlan module requirement #1623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
518bb6f
doc/explanation/networking: Add a label to the alternatives section
wak327 Oct 30, 2026
ca9a973
doc/reference/requirements: Document the vxlan module requirement
wak327 Oct 20, 2026
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
1 change: 1 addition & 0 deletions doc/explanation/networking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ A dedicated underlay network serves as the physical infrastructure over which th
- **Optimized performance**: Enables predictable latency and bandwidth for sensitive applications.
- **Scalable design**: Allows the overlay network to scale independently of other networks.

(exp-networking-ovn-alternatives)=
### Alternatives

If you decide to not use MicroOVN, MicroCloud falls back on the [Ubuntu fan](https://github.com/ubuntu/wiki-archives/blob/main/UbuntuWiki/F/FanNetworking.wiki) for basic networking. MicroCloud will still be usable, but you will see some limitations, including:
Expand Down
2 changes: 2 additions & 0 deletions doc/reference/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,8 @@ We recommend an LTS version of Ubuntu 22.04 or newer. Production deployments sub

If you intend to use ZFS storage, use a non-HWE (Hardware Enabled) variant of Ubuntu 22.04.

If you do not set up distributed networking with MicroOVN, MicroCloud falls back on the Ubuntu Fan for networking (see {ref}`exp-networking-ovn-alternatives`), which requires the `vxlan` kernel module.

@roosterfish roosterfish Oct 30, 2026

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.

@elijahgreenstein is it "on Ubuntu Fan" or "on the Ubuntu Fan"? I would guess the first.

@elijahgreenstein elijahgreenstein Oct 30, 2026

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.

@roosterfish -- I don't think there's clear standard here, since I haven't seen that much writing on "the Ubuntu Fan" in other documentation or Ubuntu/Canonical pages. Elsewhere in the MicroCloud docs, though, we have "fall back on the Ubuntu Fan" (alternatives), and in the LXD docs on networking setups, we have "possibly in connection with the Ubuntu Fan," which links to an old video titled "Easy overlay networking in LXD with the Ubuntu Fan". Given that, I think we can leave the definite article in, as "on the Ubuntu Fan." If you prefer "on Ubuntu Fan", though, I'm not opposed to updating elsewhere in the docs too.


Also see LXD's {doc}`lxd:requirements` and Ceph's {doc}`ceph:start/os-recommendations`.

(reference-requirements-software-snaps)=
Expand Down