swift-ring-composer(1)

💅 swift-ring-composer — the manual page bestie

okay so you found swift-ring-composer, and honestly? she's a little niche but she works. This is the swift-ring-composer(1) page from the OpenStack Swift crew, and I'm gonna walk you through it like we're texting at 2am. 🌙✨

---

✨ NAME ✨

swift-ring-composer — that's literally the whole name, that's the manual page for swift-ring-composer. short. sweet. iconic. 💖

---

🦋 SYNOPSIS 🦋

swift-ring-composer [-h] <composite_builder_file> {show,compose} ...

so it's the command, then optionally -h, then a <composite_builder_file>, then you pick a subcommand from {show,compose} and off you go. the ... at the end is doing a little "and more, depending on which one you pick" moment. 🫶

---

🌸 DESCRIPTION 🌸

okay so here's the tea: this is a tool for building a composite ring file from other existing ring builder files. like, you take your little component rings and you smoosh them into one big composite ring. girl math but for storage. 💅

but there are rules, and you will respect them:

• The component ring builders must all have the same partition power. no mixing. not negotiable.
• Each device must only be used in a single component builder. one device, one home.
• Each region must only be used in a single component builder. same energy, regions edition.

⚠️ NOTE: This tool is for experimental use and may be removed in future versions of Swift. so like… she's serving, but she's on borrowed time. use her, love her, but don't build your whole personality on her. 💀

🌈 positional arguments: 🌈

• <composite_builder_file> — Name of composite builder file. that's the file you're working with, bestie, and you do have to hand it over. 🎀

⭐ optional arguments: ⭐

• -h, --help — show this help message and exit. the classic escape hatch, we love her. 💖

---

👑 COMMANDS 👑

show

show [-h]

show composite ring builder metadata. just… peek at the metadata. read-only queen behavior. no notes. 🔍✨

compose

compose [-h] [<builder_file> <builder_file> [<builder_file> ...]
    --output <ring_file> [--force]

compose composite ring. you feed her a whole lil lineup of <builder_file>s (one or more, the [<builder_file> ...] is saying "and keep 'em coming"), point --output <ring_file> at where the ring should land, and [--force] is there if you need to be a little forceful about it. 🔥

---

🧚 DOCUMENTATION 🧚

More in depth documentation about the swift ring and also OpenStack Swift as a whole can be found at https://swift.openstack.org

go read it, iykyk. the lore is deep and honestly? it ate. 📚💜

---

and that's the page!! this version of the manual is from Linux, June 2018, and it's the swift-ring-composer(1) page under the OpenStack Swift umbrella. mwah, sending you off with a 🎀 and a --help if you get lost. bye bestie!! 💖✨🦋🌸