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

add classes

Browse source 
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 16:50:36 +02:00
parent 0599a33916
commit 8cf73404fb
Signed by: kiara
SSH key fingerprint: SHA256:COspvLoLJ5WC5rFb9ZDe5urVCkK4LJZOsjfF4duRJFU
2 changed files with 147 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
deployment/data-model-test.nix
View file

@ -17,6 +17,8 @@ let
inherit (inputs.nixops4.lib) mkDeployment; inherit (inputs.nixops4.lib) mkDeployment;
in in
{ {
_class = "nix-unit";
test-eval = { test-eval = {
expr = expr =
let let

264
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 (
@ -40,140 +42,161 @@ let
}; };
in in
{ {
_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"; { ... }:
options = { {
description = mkOption { options = {
description = "Description of the resource to help application module authors and hosting providers to work with it"; description = mkOption {
type = types.str; 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"; request = mkOption {
type = deferredModuleWith { staticModules = [ { _class = "fediversity-resource-request"; } ]; }; 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"; policy = mkOption {
type = deferredModuleWith { description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available";
staticModules = [ type = deferredModuleWith {
(policy: { staticModules = [
_class = "fediversity-resource-policy"; (policy: {
# TODO(@fricklerhandwerk): not sure it can be made _class = "fediversity-resource-policy";
# sensible syntactically, but essentially we want to # TODO(@fricklerhandwerk): not sure it can be made
# ensure that `apply` is defined, but since its output # sensible syntactically, but essentially we want to
# depends on the specific policy we also need to # ensure that `apply` is defined, but since its output
# determine that somehow. # depends on the specific policy we also need to
# hopefully this also helps with correct composition down the line. # determine that somehow.
options.resource-type = mkOption { # hopefully this also helps with correct composition down the line.
description = "The type of resource this policy configures"; options.resource-type = mkOption {
type = types.optionType; description = "The type of resource this policy configures";
}; type = types.optionType;
# TODO(@fricklerhandwerk): do we need a function type here as well, or is it in the way? };
options.apply = mkOption { # TODO(@fricklerhandwerk): do we need a function type here as well, or is it in the way?
description = "Apply the policy to a request"; options.apply = mkOption {
type = with types; functionTo policy.config.resource-type; description = "Apply the policy to a request";
}; type = with types; functionTo policy.config.resource-type;
}) };
]; })
];
};
}; };
}; };
}; }
} )
) ];
); });
}; };
applications = mkOption { applications = mkOption {
description = "Collection of Fediversity applications"; description = "Collection of Fediversity applications";
type = attrsOf ( type = attrsOf (submoduleWith {
submodule (application: { class = "fediversity-application";
_class = "fediversity-application"; modules = [
options = { (application: {
description = mkOption { options = {
description = "Description to be shown in the application overview"; description = mkOption {
type = types.str; description = "Description to be shown in the application overview";
}; type = types.str;
module = mkOption { };
description = "Operator-facing configuration options for the application"; module = mkOption {
type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; }; 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"; implementation = mkOption {
type = application.config.config-mapping.function-type; 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"; resources = mkOption {
type = functionTo application.config.config-mapping.output-type; description = "Compute resources required by an application";
readOnly = true; type = functionTo application.config.config-mapping.output-type;
default = input: (application.config.implementation input).output; readOnly = true;
}; default = input: (application.config.implementation input).output;
config-mapping = mkOption { };
description = "Function type for the mapping from application configuration to required resources"; config-mapping = mkOption {
type = submodule functionType; description = "Function type for the mapping from application configuration to required resources";
readOnly = true; type = submoduleWith {
default = { class = "module-function";
input-type = submodule application.config.module; modules = [ functionType ];
output-type = application-resources; };
readOnly = true;
default = {
input-type = submodule application.config.module;
output-type = application-resources;
};
}; };
}; };
}; })
}) ];
); });
}; };
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 = [
options = { (environment: {
resources = mkOption { options = {
description = '' resources = mkOption {
Resources made available by the hosting provider, and their policies. 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
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 = environment.config.resource-mapping.function-type;
};
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 = application-resources;
output-type = nixops4Deployment;
};
};
deployment = mkOption {
description = "Generate a deployment from a configuration";
type = functionTo (environment.config.resource-mapping.output-type);
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).output;
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
type = attrsOf (
attrTag (
lib.mapAttrs (_name: resource: mkOption { type = submodule resource.policy; }) config.resources
)
);
};
implementation = mkOption {
description = "Mapping of resources required by applications to available resources; the result can be deployed";
type = environment.config.resource-mapping.function-type;
};
resource-mapping = mkOption {
description = "Function type for the mapping from resources to a (NixOps4) deployment";
type = submodule functionType;
readOnly = true;
default = {
input-type = application-resources;
output-type = nixops4Deployment;
}; };
}; };
deployment = mkOption { })
description = "Generate a deployment from a configuration"; ];
type = functionTo (environment.config.resource-mapping.output-type); });
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).output;
};
};
})
);
}; };
configuration = mkOption { configuration = mkOption {
description = "Configuration type declaring options to be set by operators"; description = "Configuration type declaring options to be set by operators";
@ -188,7 +211,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;