gnt-os(8)

📦
version 3.1.0~rc2 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute

👑 gnt-os(8) — instance OS administration, but make it make sense

hiii bestie 💖 you've landed on gnt-os(8), and lowkey this one is your cluster's little OS menu. it's the command you use for managing the list of available operating system flavours for the instances in the Ganeti cluster. no cap, that's the whole vibe. 🦋

📛 NAME

gnt-os — Instance operating system administration

✨ SYNOPSIS

gnt-os {command} [arguments...]

💖 DESCRIPTION

okay so <rainbow>gnt-os</rainbow> is the tool you reach for when you wanna manage the list of available operating system flavours for the instances in your Ganeti cluster. that's it, that's the job. iconic behaviour, honestly 💅

🎀 COMMANDS

📋 LIST

list [--no-headers]

this one gives you the list of available/supported OSes you can use for your instances. when you're creating an instance, you can just hand it the OS-name as an option, easy peasy 🍓

⚠️ real talk though: hidden or blacklisted OSes are not displayed by this command. if you wanna see those, go use diagnose instead. iykyk.

🩺 DIAGNOSE

diagnose

this command is your little detective 🕵️♀️ — it helps you figure out why an installed OS is not available in the cluster. see, list only shows you the OSes that the cluster sees available on all nodes. it could be that some OS is missing from a node, or is only partially installed, and this command will show you the details of all the OSes plus the reasons they are or are not valid. so when something's acting sus, come here. 💀

🔍 INFO

info {OS}

this one lists detailed information about each OS available in the cluster — including its validity status, the supported API versions, the supported parameters and variants (if any), and their documentation, etc. if you give it an OS name, then only the specified OS details will be shown. queen behaviour, filtered and focused 👑

💡 note that this command, besides the information about the given OS(es), shows detailed information about the given available/supported OS variant(s), in terms of the modified per-OS hypervisor parameters and the modified per-OS parameters passed to the OS install scripts.

for the list of the available OSes, use list. also, go see modify for a description of how to modify the parameters for a specific operating system. 🫶

🛠️ MODIFY

modify [--submit] [--print-jobid]
[ [ -O | --os-parameters ] =*option*=*value*]
[ --os-parameters-private=*option*=*value*]
[-H HYPERVISOR:option=*value*[,...]]
[--hidden=*yesno*]
{OS}

this command will allow you to modify OS parameters. let's break it down, bestie:

  • --submit — one of the common options; ganeti(7) has the description of it and the other common options.
  • --print-jobid — also sitting right there in the synopsis, keeping --submit company.
  • -O, --os-parameters=option=value — use this to modify the parameters passed to the OS install scripts.
  • --os-parameters-private=option=value — same idea as --os-parameters, but for when the value of the parameter should not be saved to logs.
  • -H HYPERVISOR:option=value[,...] — for modifying the per-OS hypervisor parameters.
  • --hidden=yesno — flips an OS between hidden and not hidden.

now the details, because this is where it gets good:

to modify the per-OS hypervisor parameters (which override the global hypervisor parameters), you can run modify -H with the same syntax as in gnt-cluster init, to override the default hypervisor parameters of the cluster for the specified OS argument. 🔥

to modify the parameters passed to the OS install scripts, use the --os-parameters option. and listen — if the value of the parameter should not be saved to logs, use --os-parameters-private, and make sure that no Ganeti daemon or program is running in debug mode. ganeti-luxid in particular will issue a warning at startup time if ran in debug mode. so like, don't be messy about it 🙈

to modify the hidden and blacklisted states of an OS, pass the options --hidden yes|no, or respectively --blacklisted .... — the 'hidden' state means that an OS won't be listed by default in the OS list, but is available for installation. the 'blacklisted' state means that the OS is not listed and is also not allowed for new instance creations (but can be used for reinstalling old instances). so blacklisted is the serious one, fr fr.

💡 Note: the given operating system doesn't have to exist. this allows preseeding the settings for operating systems not yet known to gnt-os. future-proofing, we love to see it ✨

see ganeti(7) for a description of --submit and other common options.

🐛 REPORTING BUGS

found a bug? bestie, report it to the project's issue tracker or contact the developers using the Ganeti mailing list. they wanna hear it, promise 🫶

👀 SEE ALSO

Ganeti overview and specifications:

Ganeti commands:

Ganeti daemons:

Ganeti htools:

Copyright (C) 2006-2015 Google Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

and that's the whole page, bestie 🌈 this little icon of a manpage is Ganeti, Version 3.1.0~rc2, and it lives as gnt-os(8). go manage those OS flavours, you absolute main character 💖✨🎀

📦 where this page comes from