Compare commits

...
Sign in to create a new pull request.

34 commits

Author SHA1 Message Date
1ddece3bd2
reproduce issue of missing default value for wheel attribute, fixed by uncommenting environment resource type 2025-07-22 22:20:27 +02:00
4c9db0d540
[HACK] comment environment resources type, making the test go through 2025-07-22 19:12:58 +02:00
63d668a69d
[HACK] explicitly set resource options, as defaults seem insufficient 2025-07-22 19:12:58 +02:00
d24738133f
[HACK] explicitly pass instantiated policy to apply 2025-07-22 19:12:58 +02:00
0b4aa2e084
[HACK] unwire deployment resource-mapping output-type, fixes error: Expected a module, but found a value of type "option-type" 2025-07-22 19:12:58 +02:00
91c5d16f06
[HACK] swap out nixops4 deployments for raw nixos modules
rm deployment

rm imports
2025-07-22 19:12:58 +02:00
a8fdc72460
reproduce nixops4-nixos importing issue: The option environments.single-nixos-vm.deployment.<function body>.resources.the-machine.nixos' does not exist`
add comment explaining our nixops4 type problem
2025-07-22 19:12:58 +02:00
5ab9f3afeb
swap out dummy module for actual import
clean deployment module a bit

simplify imports
2025-07-22 19:12:58 +02:00
f7da88c919
model: [DUMMY] use mock deployment to temporarily simplify the problem
type policy.apply

remove `apply`'s optionType, fixes duplicate definition error
2025-07-22 19:12:58 +02:00
9b5eb50fbc
environment: fix implementation type 2025-07-22 19:12:58 +02:00
3efe6f347f
pass resourceProviderSystem to nixops4Deployment 2025-07-22 19:12:58 +02:00
cd097a7afd
resolve resource mapping input discrepancy according to actual implementation, adjusting the type accordingly 2025-07-22 19:12:58 +02:00
e668239f8a
properly flatten out application layer at users.users 2025-07-22 19:12:58 +02:00
4f024c8030
fix application resource type 2025-07-22 19:12:58 +02:00
7ec11ebde8
fix application-requirements 2025-07-22 19:12:58 +02:00
a6fc12709d
resolve rebase 2025-07-22 19:12:58 +02:00
cce6a06bf3
untangle applications from function type, as they seem to not need the introspection (and may type-check input without it) 2025-07-22 19:12:58 +02:00
9f43c8a278
make packages filter return a list 2025-07-22 19:12:56 +02:00
8173f65f18
add trivial unit test for deployment - now to find how to make it work!
test proper expectation

test proper expectation

settle for counting packages over comparing them, solves an infinite recursion
2025-07-22 19:12:52 +02:00
1b3dc70466
fix environment deployment 2025-07-22 19:12:51 +02:00
eba4be2b1e
model: add classes
remove _class for application requirements to allow iterating over values

rm function class

re-add nix-unit class
2025-07-22 19:12:50 +02:00
1cc6a31c9c
use submodule to turn module into type for functionTo 2025-07-22 19:12:48 +02:00
c94d575392
use mapAttrs right
`mapAttrs'` takes two args rather than a set, whereas if only the val
changes `mapAttrs (_: v: ...)` should do
2025-07-22 19:12:47 +02:00
307ff1d6ac
fix typos, lint, format 2025-07-19 18:38:46 +02:00
4b031652f7
WIP: illustrate an entire NixOS configuration as a resource 2025-07-19 18:38:43 +02:00
71446a891f
WIP: (broken) implement test 2025-07-19 18:38:36 +02:00
37df0f370d
WIP: implement mappings 2025-07-19 18:34:18 +02:00
5b1993c800
WIP: start writing an evaluation test
turns out we also need a collection of configurations, obviously
next: figure out where to wire everything up to obtain a deployment
2025-07-19 18:31:26 +02:00
17647b194b
WIP: add missing types 2025-07-19 18:31:07 +02:00
dd0aff13d7
WIP: implement data model as in diagram
this doesn't update the tests yet because we don't have all the data
types in place anyway yet, and I still need to come up with testable examples.
2025-07-19 18:30:26 +02:00
15967158bc
better reflect naming from diagram configuration data flow 2025-07-19 18:29:41 +02:00
e3e2a3359c
data model: migration 2025-07-19 18:29:09 +02:00
9230ea540c
data model: deployment 2025-07-19 18:29:02 +02:00
765183cd0d fix typo in users (#475)
Reviewed-on: Fediversity/Fediversity#475
Co-authored-by: Kiara Grouwstra <kiara@procolix.eu>
Co-committed-by: Kiara Grouwstra <kiara@procolix.eu>
2025-07-17 19:02:14 +02:00
3 changed files with 280 additions and 64 deletions

View file

@ -1,7 +1,7 @@
let
inherit (import ../default.nix { }) pkgs inputs;
inherit (pkgs) lib;
inherit (lib) mkOption;
inherit (lib) mkOption types;
eval =
module:
(lib.evalModules {
@ -23,34 +23,144 @@ in
fediversity = eval (
{ config, ... }:
{
_class = "fediversity-settings";
config = {
resources.nixos-configuration = {
description = "An entire NixOS configuration";
request =
{ ... }:
{
_class = "fediversity-resource-request";
options.config = mkOption {
description = "Any options from NixOS";
};
};
policy =
{ ... }:
{
_class = "fediversity-resource-policy";
options = {
extra-config = mkOption {
description = "Any options from NixOS";
};
apply = mkOption {
type = with types; functionTo raw;
default = policy: requests: lib.mkMerge (requests ++ [ policy.extra-config ]);
};
};
};
};
resources.login-shell = {
_class = "fediversity-resource";
description = "The operator needs to be able to log into the shell";
request =
{ ... }:
{
_class = "fediversity-resource-request";
options = {
wheel = mkOption {
description = "Whether the login user needs root permissions";
type = types.bool;
default = false;
};
packages = mkOption {
description = "Packages that need to be available in the user environment";
type = with types; attrsOf package;
};
};
};
policy =
{ ... }:
{
_class = "fediversity-resource-policy";
options = {
username = mkOption {
description = "Username for the operator";
type = types.str; # TODO: use the proper constraints from NixOS
};
wheel = mkOption {
description = "Whether to allow login with root permissions";
type = types.bool;
default = false;
};
apply = mkOption {
type = with types; functionTo raw; # TODO: splice out the user type from NixOS
default =
policy: requests:
let
# Filter out requests that need wheel if policy doesn't allow it
validRequests = lib.filterAttrs (_name: req: !req.wheel || policy.wheel) requests;
in
lib.optionalAttrs (validRequests != { }) {
${policy.username} = {
isNormalUser = true;
packages = with lib; concatMap (request: attrValues request.packages) (attrValues validRequests);
extraGroups = lib.optional policy.wheel "wheel";
};
};
};
};
};
};
applications.hello =
{ ... }:
{
_class = "fediversity-application";
description = ''Command-line tool that will print "Hello, world!" on the terminal'';
module =
{ ... }:
{
_class = "fediversity-application-config";
options = {
enable = lib.mkEnableOption "Hello in the shell";
};
};
implementation =
resources =
cfg:
lib.optionalAttrs cfg.enable {
dummy.login-shell.packages.hello = pkgs.hello;
dummy.login-shell.packages = {
# hello = pkgs.hello;
};
};
};
environments.single-nixos-vm = environment: {
_class = "fediversity-environment";
resources.shell.login-shell = {
username = "operator";
# wheel = false; # FIXME: why do i need to make this explicit, if a default was supposed to be set?
};
implementation = requests: {
_class = "nixos";
users.users = (
config.resources.login-shell.policy.apply environment.config.resources.shell.login-shell (
lib.concatMapAttrs (
_application: resources:
lib.mapAttrs (_k: lib.getAttr "login-shell") (
lib.filterAttrs (_name: value: value ? login-shell) resources
)
) requests
)
);
};
};
};
options = {
example-configuration = mkOption {
type = config.configuration;
readOnly = true;
default = {
_class = "fediversity-configuration";
enable = true;
applications.hello.enable = true;
};
};
example-deployment = mkOption {
type = types.raw;
readOnly = true;
default = config.environments.single-nixos-vm.deployment config.example-configuration;
};
};
}
);
@ -58,13 +168,16 @@ in
{
inherit (fediversity)
example-configuration
example-deployment
;
num-packages = lib.lists.length fediversity.example-deployment.users.users.operator.packages;
};
expected = {
example-configuration = {
enable = true;
applications.hello.enable = true;
};
num-packages = 1;
};
};
}

View file

@ -9,81 +9,184 @@ let
attrsOf
attrTag
deferredModuleWith
submodule
submoduleWith
optionType
functionTo
raw
;
functionType = import ./function.nix;
application-resources = {
options.resources = mkOption {
# TODO: maybe transpose, and group the resources by type instead
type = attrsOf (
attrTag (lib.mapAttrs (_name: resource: mkOption { type = resource.request; }) config.resources)
);
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
type = optionType;
readOnly = true;
default = submoduleWith {
class = "fediversity-configuration";
modules = [
{
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submoduleWith {
class = "fediversity-application-config";
modules = [ application.module ];
};
default = { };
}
) config.applications;
};
}
];
};
};
in
{
_class = "nixops4Deployment";
_class = "fediversity-settings";
options = {
inherit configuration;
resources = mkOption {
description = "Collection of deployment resources that can be required by applications and policed by hosting providers";
type = attrsOf (submoduleWith {
class = "fediversity-resource";
modules = [
(
{ ... }:
{
options = {
description = mkOption {
description = "Description of the resource to help application module authors and hosting providers to work with it";
type = types.str;
};
request = mkOption {
description = "Options for declaring resource requirements by an application, a description of how the resource is consumed or accessed";
type = deferredModuleWith { staticModules = [ { _class = "fediversity-resource-request"; } ]; };
};
policy = mkOption {
description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available";
type = submoduleWith {
class = "fediversity-resource-policy";
modules = [
{
options.apply = mkOption {
description = "Apply the policy to a request";
};
}
];
};
};
};
}
)
];
});
};
applications = mkOption {
description = "Collection of Fediversity applications";
type = attrsOf (
submodule (application: {
_class = "fediversity-application";
options = {
description = mkOption {
description = "Description to be shown in the application overview";
type = types.str;
};
module = mkOption {
description = "Operator-facing configuration options for the application";
type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; };
};
implementation = mkOption {
description = "Mapping of application configuration to deployment resources, a description of what an application needs to run";
type = application.config.config-mapping.function-type;
};
resources = mkOption {
description = "Compute resources required by an application";
type = functionTo application.config.config-mapping.output-type;
readOnly = true;
default = input: (application.config.implementation input).output;
};
config-mapping = mkOption {
description = "Function type for the mapping from application configuration to required resources";
type = submodule functionType;
readOnly = true;
default = {
input-type = application.config.module;
output-type = application-resources;
type = attrsOf (submoduleWith {
class = "fediversity-application";
modules = [
{
options = {
description = mkOption {
description = "Description to be shown in the application overview";
type = types.str;
};
module = mkOption {
description = "Operator-facing configuration options for the application";
type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; };
};
resources = mkOption {
description = "Mapping of application configuration to deployment resources, a description of what an application needs to run";
# TODO: maybe transpose, and group the resources by type instead
type = functionTo (
attrsOf (
attrTag (
lib.mapAttrs (
_name: resource: mkOption { type = types.submodule resource.request; }
) config.resources
)
)
);
};
};
};
})
);
}
];
});
};
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
type = optionType;
readOnly = true;
default = submodule {
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submodule application.module;
default = { };
}
) config.applications;
};
};
environments = mkOption {
description = "Run-time environments for Fediversity applications to be deployed to";
type = attrsOf (submoduleWith {
class = "fediversity-environment";
modules = [
(environment: {
options = {
resources = mkOption {
description = ''
Resources made available by the hosting provider, and their policies.
Setting this is optional, but provides a place to declare that information for programmatic use in the resource mapping.
'';
# TODO: maybe transpose, and group the resources by type instead
# # FIXME: error: The option `environments.single-nixos-vm.resources.shell.login-shell.apply' does not exist. Definition values:
# # - In `<unknown-file>': <function>
# # However there are no options defined in `environments.single-nixos-vm.resources.shell.login-shell'. Are you sure you've
# # declared your options properly? This can happen if you e.g. declared your options in `types.submodule'
# # under `config' rather than `options'.
# type = attrsOf (
# attrTag (
# lib.mapAttrs (
# _name: resource:
# mkOption {
# type = submoduleWith {
# class = "fediversity-resource-policy";
# modules = [ resource.policy ];
# };
# }
# ) config.resources
# )
# );
};
implementation = mkOption {
description = "Mapping of resources required by applications to available resources; the result can be deployed";
type = functionTo raw;
};
resource-mapping = mkOption {
description = "Function type for the mapping from resources to a (NixOps4) deployment";
type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true;
default = {
input-type = configuration;
output-type = raw;
};
};
deployment = mkOption {
description = "Generate a deployment from a configuration";
type = functionTo raw;
readOnly = true;
default =
cfg:
# TODO: check cfg.enable.true
let
required-resources = lib.mapAttrs (
name: application-settings: config.applications.${name}.resources application-settings
) cfg.applications;
in
(environment.config.implementation required-resources);
};
};
})
];
});
};
};
}

View file

@ -6,7 +6,7 @@
_class = "nixos";
users.users = {
root.openssh.authorizedKeys.keys = config.user.users.procolix.openssh.authorizedKeys.keys;
root.openssh.authorizedKeys.keys = config.users.users.procolix.openssh.authorizedKeys.keys;
procolix = {
isNormalUser = true;