DISNIXOS-INSTANTIATE(1)

💖 DISNIXOS-INSTANTIATE(1) 💖

okay so welcome to the DISNIXOS-INSTANTIATE(1) page from the User Commands manual, bestie — we're about to make distributed derivations make sense, no cap ✨

🌸 NAME 🌸

disnixos-instantiate — instantiate a distributed derivation from DisnixOS expressions. that's the whole name, periodt 💅

✨ SYNOPSIS ✨

the three moods of this command are literally:

disnixos-instantiate -s services_nix -n network_nix [ -n network2_nix
... ] -d distribution_nix [OPTION]
disnixos-instantiate -P packages_nix -n network_nix [ -n network2_nix
... ] [OPTION]
disnixos-instantiate -n network_nix [ -n network2_nix ... ] [OPTION]

🦋 DESCRIPTION 🦋

okay so here's the tea: the command disnixos-instantiate generates a distributed derivation file from a service, network and distribution Nix expression, which can be used to build the services on the target machines from source code by using the disnix-build command. iconic behavior, honestly 🔥

if only network expressions are given without a services or distribution expression, then an infrastructure distributed derivation file is generated. different vibe, still valid 💖

real talk bestie: most users and developers don't need to use this command directly. the command disnixos-env performs instantiation of a distributed derivation automatically. it is mostly used for debugging purposes or to perform certain tasks manually.

💅 OPTIONS 💅

• -s, --services=services_nix — the Services Nix expression which describes all the components of the distributed system, bestie.
• -n, --network=network_nix — the Network Nix expression which declares a NixOS configuration for each machine in the network ✨.
• -d, --distribution=distribution_nix — the Distribution Nix expression which maps services to machines in the network.
• -P, --packages=packages_nix — the Packages Nix expression specifying the packages that should be deployed in a Nix profile mapped to each machine in the network.
• --target-property=PROP — the target property of an infrastructure model, that specifies how to connect to the remote Disnix interface. (Defaults to: hostname)
• --interface=INTERFACE — path to the executable that communicates with a Disnix interface. Defaults to: disnix-ssh-client
• --extra-params=PARAMS — a string with an attribute set in the Nix expression language propagating extra parameters to the input models.
• --no-out-link — do not create a 'result' symlink. no little result link for you, okay? 🎀
• --show-trace — shows a trace of the output.
• --vm — configures a manifest used for the NixOS test driver.
• --use-nixops — use NixOps instead of Disnix's deployment facilities.
• --disable-disnix — do not enable the Disnix service on the target machines by default.
• -h, --help — shows the usage of this command to the user.
• -v, --version — shows the version of this command to the user.

🌈 ENVIRONMENT 🌈

• DISNIX_CLIENT_INTERFACE — sets the client interface (defaults to: disnix-ssh-client).
• DISNIX_TARGET_PROPERTY — sets the target property of an infrastructure model, that specifies how to connect to the remote Disnix interface. (Defaults to: hostname)
• DISNIXOS_USE_NIXOPS — when set to 1, it specifies that NixOps is used to take care of the infrastructure deployment, so that it properly interprets NixOps configurations and uses NixOps tooling instead of Disnix's deployment facilities.

🎀 COPYRIGHT 🎀

Copyright © 2008-2022 Sander van der Burg

okay bye bestie! this page is from the disnixos... source/version line and it's dated January 1980 — mwah 💋🫶