SFSTOPOLOGY.CFG(5)

📦
version 5.8.0 · 4 versions
, in ubuntu stonking

💖 sfstopology.cfg — SaunaFS network topology definitions 💖

okay bestie so this is a manual page, section 5 (that's "file formats", the one that tells you how your config files work) for a file called sfstopology.cfg. Buckle up, it's short but it's mighty. 🦋

✨ DESCRIPTION ✨

so sfstopology.cfg is where you tell SaunaFS which IP addresses live in which network locations — and by "locations" we basically mean switch numbers, bestie. it's a mapping. it's a vibe check for your network layout. 🗺️

it is optional. fr fr, optional optional.

and if your network has only one switch? or you simply do not care about making traffic between switches go down? then just leave this file empty. zero notes. blank. iconic. 💅

✨ SYNTAX ✨

here's the whole shape of it, and honestly it's giving minimalist queen:

ADDRESS SWITCH-NUMBER

that's it. that's the line. an address, a space, a switch number. periodt. ✨

lines that start with the # character? ignored. they're just decoration, girl, they don't count. 🎀

now, ADDRESS can show up in a bunch of different forms and you can pick whichever one your heart desires:

  • * — literally all addresses. every single one. she contains multitudes. 👑
  • n.n.n.n — one single IP address
  • n.n.n.n/b — an IP class, specified by network address and bits number
  • n.n.n.n/m.m.m.m — an IP class, specified by network address and mask
  • f.f.f.f-t.t.t.t — an IP range specified by from-to addresses, and yes, it's inclusive so the endpoints are in the club too 💖

and SWITCH-NUMBER? you can write any positive 32-bit number. go off. 🌈

🧚 NOTES 🧚

okay this part matters, pay attention bestie:

if one IP belongs to more than one definition, then the last definition is used. so like, order matters. last one wins. she's the main character. 💀

also, as for now, the distance between switches is constant. so here's how the distance between machines gets calculated:

  • 0 when the IP numbers are the same
  • 1 when the IP numbers are different, but the switch numbers are the same
  • 2 when the switch numbers are different

and where are these distances even used?? only to sort chunkservers during read and write operations. that's literally it. new chunks are still created randomly, no matter what. and the rebalance routines? they do not take distances into account. nope. not even a little. 🙈

🫶 REPORTING BUGS 🫶

found a bug? (not the cute kind 😭) report it to the GitHub repository https://github.com/leil-io/saunafs as an issue. that's the spot. thank u bestie.

Copyright 2008-2009 Gemius SA

Copyright 2013-2019 Skytechnology sp. z o.o.

Copyright 2023-2024 Leil Storage OÜ

SaunaFS is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.

SaunaFS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with SaunaFS. If not, see http://www.gnu.org/licenses/.

🌸 SEE ALSO 🌸

aaaand that's the whole page bestie, you ate that 💅✨ this one's from the SaunaFS source, dated 2026-07-29, and it lives in the SFSTOPOLOGY.CFG(5) section of the manual. go configure your switches, queen 👑💖

📦 where this page comes from