kiara/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 9c219341b1
commit 9f596ad820
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
deferredModuleWith
submodule
submoduleWith
optionType
functionTo
;
functionType = import ./function.nix;
application-resources = submodule {
_class = "fediversity-application-requirements";
options.resources = mkOption {
# TODO: maybe transpose, and group the resources by type instead
type = attrsOf (
@ -31,7 +33,6 @@ let
inputs.nixops4.modules.nixops4Deployment.default
{
_class = "nixops4Deployment";
_module.args = {
resourceProviderSystem = builtins.currentSystem;
resources = { };
@ -41,11 +42,15 @@ let
};
in
{
_class = "fediversity-settings";
options = {
resources = mkOption {
description = "Collection of deployment resources that can be required by applications and policed by hosting providers";
type = attrsOf (
submodule (
type = attrsOf (submoduleWith {
class = "fediversity-resource";
modules = [
(
{ ... }:
{
_class = "fediversity-resource";
@ -81,12 +86,15 @@ in
};
}
)
);
];
});
};
applications = mkOption {
description = "Collection of Fediversity applications";
type = attrsOf (
submodule (application: {
type = attrsOf (submoduleWith {
class = "fediversity-application";
modules = [
(application: {
_class = "fediversity-application";
options = {
description = mkOption {
@ -110,7 +118,10 @@ in
# TODO(@fricklerhandwerk): this needs a better name, it's just the type
config-mapping = mkOption {
description = "Function type for the mapping from application configuration to required resources";
type = submodule functionType;
type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true;
default = {
input-type = submodule application.config.module;
@ -119,13 +130,15 @@ in
};
};
})
);
];
});
};
environments = mkOption {
description = "Run-time environments for Fediversity applications to be deployed to";
type = attrsOf (
submodule (environment: {
_class = "fediversity-environment";
type = attrsOf (submoduleWith {
class = "fediversity-environment";
modules = [
(environment: {
options = {
resources = mkOption {
description = ''
@ -136,7 +149,15 @@ in
# TODO: maybe transpose, and group the resources by type instead
type = attrsOf (
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
)
);
};
@ -146,7 +167,10 @@ in
};
resource-mapping = mkOption {
description = "Function type for the mapping from resources to a (NixOps4) deployment";
type = submodule functionType;
type = submoduleWith {
class = "module-function";
modules = [ functionType ];
};
readOnly = true;
default = {
input-type = application-resources;
@ -173,7 +197,8 @@ in
};
};
})
);
];
});
};
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
@ -188,7 +213,10 @@ in
_name: application:
mkOption {
description = application.description;
type = submodule application.module;
type = submoduleWith {
class = "fediversity-application-config";
modules = [ application.module ];
};
default = { };
}
) config.applications;