fricklerhandwerk/Fediversity
1
0
Fork 0
forked from Fediversity/Fediversity
Code Pull requests Activity

data model: add classes

Browse source 
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.
This commit is contained in:
Kiara Grouwstra 2025-07-31 17:28:13 +02:00
parent 1063be8c16
commit 6cba217e53
Signed by: kiara
SSH key fingerprint: SHA256:COspvLoLJ5WC5rFb9ZDe5urVCkK4LJZOsjfF4duRJFU
1 changed files with 147 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
deployment/data-model.nix
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 (
@ -31,6 +33,7 @@ let
inputs.nixops4.modules.nixops4Deployment.default inputs.nixops4.modules.nixops4Deployment.default
{ {
_class = "nixops4Deployment";
_module.args = { _module.args = {
resourceProviderSystem = builtins.currentSystem; resourceProviderSystem = builtins.currentSystem;
resources = { }; resources = { };
@ -40,13 +43,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";
@ -82,12 +87,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 +119,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 +131,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 +150,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 +168,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 +198,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 +214,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;