Compare commits

...

5 commits

Author SHA1 Message Date
9f596ad820
data model: add classes
specifies classes in the data model, raising these to from `_class`
model attributes to `subModuleWith`'s `class` parameter where possible.

note: resource policy has remained as to use `deferredModuleWith`
(rather than `submoduleWith`) to ensure evaluation will go thru.
2025-07-31 20:55:27 +02:00
9c219341b1 Merge pull request 'move nixops4Deployment class' (#6) from kiara/Fediversity:data-model-fix-root-class into deployment-data-model-with-tests
Reviewed-on: #6
Reviewed-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2025-07-31 18:17:56 +02:00
8e8787d662
move nixops4Deployment class 2025-07-31 17:13:24 +02:00
7ce3902851
put config stuff in an attrset 2025-07-31 17:08:40 +02:00
68b834b6d7
fix linter gripes 2025-07-31 17:03:43 +02:00
2 changed files with 168 additions and 139 deletions

View file

@ -68,8 +68,9 @@ in
default = false; default = false;
}; };
}; };
config.resource-type = types.raw; # TODO: splice out the user type from NixOS config = {
config.apply = resource-type = types.raw; # TODO: splice out the user type from NixOS
apply =
requests: requests:
let let
# Filter out requests that need wheel if policy doesn't allow it # Filter out requests that need wheel if policy doesn't allow it
@ -88,6 +89,7 @@ in
}; };
}; };
}; };
};
applications.hello = applications.hello =
{ ... }: { ... }:
{ {
@ -151,7 +153,7 @@ in
} }
); );
resources = fediversity.applications.hello.resources fediversity.example-configuration.applications.hello; resources = fediversity.applications.hello.resources fediversity.example-configuration.applications.hello;
hello-shell = (resources).resources.hello.login-shell; hello-shell = resources.resources.hello.login-shell;
environment = fediversity.environments.single-nixos-vm.resources.operator-environment.login-shell; environment = fediversity.environments.single-nixos-vm.resources.operator-environment.login-shell;
result = mkDeployment { result = mkDeployment {
modules = [ modules = [
@ -160,7 +162,7 @@ in
}; };
in in
rec { {
number-of-resources = with lib; length (attrNames fediversity.resources); number-of-resources = with lib; length (attrNames fediversity.resources);
inherit (fediversity) example-configuration; inherit (fediversity) example-configuration;
hello-package-exists = hello-shell.packages ? hello; hello-package-exists = hello-shell.packages ? hello;
@ -172,7 +174,7 @@ in
in in
{ {
inherit (operator) isNormalUser; inherit (operator) isNormalUser;
packages = with lib; map (p: "${p.pname}") operator.packages; packages = map (p: "${p.pname}") operator.packages;
extraGroups = operator.extraGroups; extraGroups = operator.extraGroups;
}; };
deployment = { deployment = {

View file

@ -11,12 +11,14 @@ let
attrTag attrTag
deferredModuleWith deferredModuleWith
submodule submodule
submoduleWith
optionType optionType
functionTo functionTo
; ;
functionType = import ./function.nix; functionType = import ./function.nix;
application-resources = submodule { application-resources = submodule {
_class = "fediversity-application-requirements";
options.resources = mkOption { options.resources = mkOption {
# TODO: maybe transpose, and group the resources by type instead # TODO: maybe transpose, and group the resources by type instead
type = attrsOf ( type = attrsOf (
@ -40,13 +42,15 @@ let
}; };
in in
{ {
_class = "nixops4Deployment"; _class = "fediversity-settings";
options = { options = {
resources = mkOption { resources = mkOption {
description = "Collection of deployment resources that can be required by applications and policed by hosting providers"; description = "Collection of deployment resources that can be required by applications and policed by hosting providers";
type = attrsOf ( type = attrsOf (submoduleWith {
submodule ( class = "fediversity-resource";
modules = [
(
{ ... }: { ... }:
{ {
_class = "fediversity-resource"; _class = "fediversity-resource";
@ -73,7 +77,7 @@ in
# and then also rename this to be consistent with the application's resource mapping # and then also rename this to be consistent with the application's resource mapping
options.apply = mkOption { options.apply = mkOption {
description = "Apply the policy to a request"; description = "Apply the policy to a request";
type = with types; functionTo policy.config.resource-type; type = functionTo policy.config.resource-type;
}; };
}) })
]; ];
@ -82,12 +86,15 @@ in
}; };
} }
) )
); ];
});
}; };
applications = mkOption { applications = mkOption {
description = "Collection of Fediversity applications"; description = "Collection of Fediversity applications";
type = attrsOf ( type = attrsOf (submoduleWith {
submodule (application: { class = "fediversity-application";
modules = [
(application: {
_class = "fediversity-application"; _class = "fediversity-application";
options = { options = {
description = mkOption { description = mkOption {
@ -111,7 +118,10 @@ in
# TODO(@fricklerhandwerk): this needs a better name, it's just the type # TODO(@fricklerhandwerk): this needs a better name, it's just the type
config-mapping = mkOption { config-mapping = mkOption {
description = "Function type for the mapping from application configuration to required resources"; description = "Function type for the mapping from application configuration to required resources";
type = submodule functionType; type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true; readOnly = true;
default = { default = {
input-type = submodule application.config.module; input-type = submodule application.config.module;
@ -120,13 +130,15 @@ in
}; };
}; };
}) })
); ];
});
}; };
environments = mkOption { environments = mkOption {
description = "Run-time environments for Fediversity applications to be deployed to"; description = "Run-time environments for Fediversity applications to be deployed to";
type = attrsOf ( type = attrsOf (submoduleWith {
submodule (environment: { class = "fediversity-environment";
_class = "fediversity-environment"; modules = [
(environment: {
options = { options = {
resources = mkOption { resources = mkOption {
description = '' description = ''
@ -137,7 +149,15 @@ in
# TODO: maybe transpose, and group the resources by type instead # TODO: maybe transpose, and group the resources by type instead
type = attrsOf ( type = attrsOf (
attrTag ( attrTag (
lib.mapAttrs (_name: resource: mkOption { type = submodule resource.policy; }) config.resources lib.mapAttrs (
_name: resource:
mkOption {
type = submoduleWith {
class = "fediversity-resource-policy";
modules = [ resource.policy ];
};
}
) config.resources
) )
); );
}; };
@ -147,7 +167,10 @@ in
}; };
resource-mapping = mkOption { resource-mapping = mkOption {
description = "Function type for the mapping from resources to a (NixOps4) deployment"; description = "Function type for the mapping from resources to a (NixOps4) deployment";
type = submodule functionType; type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true; readOnly = true;
default = { default = {
input-type = application-resources; input-type = application-resources;
@ -174,7 +197,8 @@ in
}; };
}; };
}) })
); ];
});
}; };
configuration = mkOption { configuration = mkOption {
description = "Configuration type declaring options to be set by operators"; description = "Configuration type declaring options to be set by operators";
@ -189,7 +213,10 @@ in
_name: application: _name: application:
mkOption { mkOption {
description = application.description; description = application.description;
type = submodule application.module; type = submoduleWith {
class = "fediversity-application-config";
modules = [ application.module ];
};
default = { }; default = { };
} }
) config.applications; ) config.applications;