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

model: add classes

Browse source
This commit is contained in:
Kiara Grouwstra 2025-07-19 12:18:03 +02:00
parent 015ea16475
commit 9e59b27411
Signed by: kiara
SSH key fingerprint: SHA256:COspvLoLJ5WC5rFb9ZDe5urVCkK4LJZOsjfF4duRJFU
3 changed files with 170 additions and 123 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -22,6 +22,7 @@ in
fediversity = eval ( fediversity = eval (
{ config, ... }: { config, ... }:
{ {
_class = "fediversity-settings";
config = { config = {
resources.nixos-configuration = { resources.nixos-configuration = {
description = "An entire NixOS configuration"; description = "An entire NixOS configuration";
@ -51,6 +52,7 @@ in
}; };
}; };
resources.login-shell = { resources.login-shell = {
_class = "fediversity-resource";
description = "The operator needs to be able to log into the shell"; description = "The operator needs to be able to log into the shell";
request = request =
{ ... }: { ... }:
@ -104,10 +106,12 @@ in
applications.hello = applications.hello =
{ ... }: { ... }:
{ {
_class = "fediversity-application";
description = ''Command-line tool that will print "Hello, world!" on the terminal''; description = ''Command-line tool that will print "Hello, world!" on the terminal'';
module = module =
{ ... }: { ... }:
{ {
_class = "fediversity-application-config";
options = { options = {
enable = lib.mkEnableOption "Hello in the shell"; enable = lib.mkEnableOption "Hello in the shell";
}; };
@ -115,21 +119,25 @@ in
implementation = implementation =
cfg: cfg:
lib.optionalAttrs cfg.enable { lib.optionalAttrs cfg.enable {
_class = "fediversity-application-requirements";
dummy.login-shell.packages.hello = pkgs.hello; dummy.login-shell.packages.hello = pkgs.hello;
}; };
}; };
environments.single-nixos-vm = environments.single-nixos-vm =
{ config, ... }: { config, ... }:
{ {
_class = "fediversity-environment";
resources.shell.login-shell.username = "operator"; resources.shell.login-shell.username = "operator";
implementation = implementation =
requests: requests:
{ providers, ... }: { providers, ... }:
{ {
_class = "nixops4Deployment";
providers = { providers = {
inherit (inputs.nixops4.modules.nixops4Provider) local; inherit (inputs.nixops4.modules.nixops4Provider) local;
}; };
resources.the-machine = { resources.the-machine = {
_class = "nixops4Resource";
type = providers.local.exec; type = providers.local.exec;
imports = [ imports = [
inputs.nixops4-nixos.modules.nixops4Resource.nixos inputs.nixops4-nixos.modules.nixops4Resource.nixos
@ -137,6 +145,7 @@ in
nixos.module = nixos.module =
{ ... }: { ... }:
{ {
_class = "nixos";
users.users = config.resources.shell.login-shell.apply ( users.users = config.resources.shell.login-shell.apply (
lib.filterAttrs (_name: value: value ? login-shell) requests lib.filterAttrs (_name: value: value ? login-shell) requests
); );
@ -150,12 +159,16 @@ in
type = config.configuration; type = config.configuration;
readOnly = true; readOnly = true;
default = { default = {
_class = "fediversity-configuration";
enable = true; enable = true;
applications.hello.enable = true; applications.hello.enable = true;
}; };
}; };
example-deployment = mkOption { example-deployment = mkOption {
type = types.submodule nixops4Deployment; type = types.submoduleWith {
class = "nixops4Deployment";
modules = [ nixops4Deployment ];
};
readOnly = true; readOnly = true;
default = config.environments.single-nixos-vm.deployment config.example-configuration; default = config.environments.single-nixos-vm.deployment config.example-configuration;
}; };

277
deployment/data-model.nix
View file

@ -10,13 +10,14 @@ let
attrsOf attrsOf
attrTag attrTag
deferredModuleWith deferredModuleWith
submodule submoduleWith
optionType optionType
functionTo functionTo
; ;
functionType = import ./function.nix; functionType = import ./function.nix;
application-resources = { application-requirements = {
_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 (
@ -27,147 +28,179 @@ let
nixops4Deployment = inputs.nixops4.modules.nixops4Deployment.default; nixops4Deployment = inputs.nixops4.modules.nixops4Deployment.default;
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 = submoduleWith {
{ class = "fediversity-resource-policy";
_class = "fediversity-resource-policy"; modules = [
options.apply = mkOption { {
description = "Apply the policy to a request"; options.apply = mkOption {
}; description = "Apply the policy to a request";
} };
]; }
];
};
}; };
}; };
}; }
} )
) ];
); });
}; };
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 = application.config.module; modules = [ functionType ];
output-type = application-resources; };
readOnly = true;
default = {
input-type = application.config.module;
output-type = application-requirements;
};
}; };
}; };
}; })
}) ];
); });
}; };
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-requirements;
output-type = nixops4Deployment;
};
};
deployment = mkOption {
description = "Generate a deployment from a configuration";
type = functionTo (submoduleWith {
class = "nixops4Deployment";
modules = [ 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 (submodule 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";
type = optionType; type = optionType;
readOnly = true; readOnly = true;
default = submodule { default = submoduleWith {
options = { class = "fediversity-configuration";
enable = lib.mkEnableOption { modules = [
description = "your Fediversity configuration"; {
}; options = {
applications = lib.mapAttrs ( enable = lib.mkEnableOption {
_name: application: description = "your Fediversity configuration";
mkOption { };
description = application.description; applications = lib.mapAttrs (
type = submodule application.module; _name: application:
default = { }; mkOption {
} description = application.description;
) config.applications; type = submoduleWith {
}; class = "fediversity-application-config";
modules = [ application.module ];
};
default = { };
}
) config.applications;
};
}
];
}; };
}; };
}; };

1
deployment/function.nix
View file

@ -13,6 +13,7 @@ let
in in
{ {
options = { options = {
_class = "module-function";
input-type = mkOption { input-type = mkOption {
type = deferredModule; type = deferredModule;
}; };