Compare commits

...

14 commits

Author SHA1 Message Date
dbf76b6448
[HACK] unwire deployment resource-mapping output-type, fixes error: Expected a module, but found a value of type "option-type" 2025-07-22 11:35:29 +02:00
fe7ded4c6c
type: swap out nixops4 deployments for raw nixos modules 2025-07-22 11:35:29 +02:00
b70eb52755
fix application-requirements 2025-07-22 11:35:29 +02:00
6e77c55a98
reproduce nixops4-nixos importing issue: The option environments.single-nixos-vm.deployment.<function body>.resources.the-machine.nixos' does not exist`
add comment explaining our nixops4 type problem
2025-07-22 11:35:29 +02:00
54c8cbb7b3
swap out dummy module for actual import
clean deployment module a bit

simplify imports
2025-07-22 11:35:01 +02:00
b8aa301be1
environment: fix implementation type 2025-07-22 11:34:52 +02:00
cc38773763
resolve resource mapping input discrepancy according to actual implementation, adjusting the type accordingly 2025-07-22 11:29:35 +02:00
b94e9bb9ac
untangle applications from function type, as they seem to not need the introspection (and may type-check input without it) 2025-07-22 11:29:15 +02:00
cd3e9ef7eb
fix environment deployment 2025-07-22 11:29:15 +02:00
915c9f22f7
model: [DUMMY] use mock deployment to temporarily simplify the problem
type policy.apply

remove `apply`'s optionType, fixes duplicate definition error
2025-07-22 11:22:38 +02:00
94c0de2ba0
resolve rebase 2025-07-22 11:22:38 +02:00
54322ccc99
add trivial unit test for deployment - now to find how to make it work! 2025-07-22 11:22:38 +02:00
7a1ed05304
pass resourceProviderSystem to nixops4Deployment 2025-07-22 11:22:38 +02:00
883f24d1ad
model: add classes
remove _class for application requirements to allow iterating over values
2025-07-22 11:22:38 +02:00
5 changed files with 190 additions and 179 deletions

View file

@ -9,10 +9,9 @@ let
git-hooks
gitignore
;
inherit (import sources.flake-inputs) import-flake;
inputs = (import-flake { src = ./.; }).inputs;
inherit (pkgs) lib;
inherit (import sources.flake-inputs) import-flake;
inputs = (import-flake { src = ./.; }).inputs;
inherit ((import-flake { src = ./.; }).inputs) nixops4;
panel = import ./panel { inherit sources system; };
pre-commit-check =

View file

@ -1,7 +1,7 @@
let
inherit (import ../default.nix { }) pkgs inputs;
inherit (pkgs) lib;
inherit (lib) mkOption;
inherit (lib) mkOption types;
eval =
module:
(lib.evalModules {
@ -13,7 +13,6 @@ let
./data-model.nix
];
}).config;
nixops4Deployment = inputs.nixops4.modules.nixops4Deployment.default;
in
{
test-eval = {
@ -22,6 +21,7 @@ in
fediversity = eval (
{ config, ... }:
{
_class = "fediversity-settings";
config = {
resources.nixos-configuration = {
description = "An entire NixOS configuration";
@ -51,6 +51,7 @@ in
};
};
resources.login-shell = {
_class = "fediversity-resource";
description = "The operator needs to be able to log into the shell";
request =
{ ... }:
@ -104,43 +105,54 @@ in
applications.hello =
{ ... }:
{
_class = "fediversity-application";
description = ''Command-line tool that will print "Hello, world!" on the terminal'';
module =
{ ... }:
{
_class = "fediversity-application-config";
options = {
enable = lib.mkEnableOption "Hello in the shell";
};
};
implementation =
resources =
cfg:
lib.optionalAttrs cfg.enable {
dummy.login-shell.packages.hello = pkgs.hello;
};
};
environments.single-nixos-vm =
{ config, ... }:
{ ... }:
{
_class = "fediversity-environment";
resources.shell.login-shell.username = "operator";
implementation =
requests:
_requests:
{ providers, ... }:
{
_class = "nixops4Deployment";
providers = {
inherit (inputs.nixops4.modules.nixops4Provider) local;
};
# this seems checked according to {providers,resources,resource}.nix,
# values will not eagerly get checked, matching `providers.nix`'s `lazyAttrsOf`,
# whereas allowed keys seem to match those defined in `resource.nix`.
# the content of `resources.the-machine` however, follows `nixops4-nixos`,
# which is not allowed through our `type` yet.
resources.the-machine = {
_class = "nixops4Resource";
type = providers.local.exec;
imports = [
inputs.nixops4-nixos.modules.nixops4Resource.nixos
];
nixos.module =
{ ... }:
{
users.users = config.resources.shell.login-shell.apply (
lib.filterAttrs (_name: value: value ? login-shell) requests
);
};
# nixos.module =
# { ... }:
# {
# _class = "nixos";
# users.users = config.resources.shell.login-shell.apply (
# lib.filterAttrs (_name: value: value ? login-shell) requests
# );
# };
};
};
};
@ -150,18 +162,16 @@ in
type = config.configuration;
readOnly = true;
default = {
_class = "fediversity-configuration";
enable = true;
applications.hello.enable = true;
};
};
example-deployment = mkOption {
type = types.raw;
readOnly = true;
default = config.environments.single-nixos-vm.deployment config.example-configuration;
};
environments.single-nixos-vm = {
};
configurations.example = {
enable = true;
applications.hello.enable = true;
# default = config.environments.single-nixos-vm.deployment config.example-configuration;
};
}
);
@ -169,14 +179,15 @@ in
{
inherit (fediversity)
example-configuration
example-deployment
;
has-deployment = lib.isAttrs fediversity.example-deployment.resources.the-machine;
};
expected = {
example-configuration = {
enable = true;
applications.hello.enable = true;
};
has-deployment = true;
};
};
}

View file

@ -1,7 +1,6 @@
{
lib,
config,
inputs,
...
}:
let
@ -10,32 +9,55 @@ let
attrsOf
attrTag
deferredModuleWith
submodule
submoduleWith
optionType
functionTo
raw
;
functionType = import ./function.nix;
application-resources = {
options.resources = mkOption {
# TODO: maybe transpose, and group the resources by type instead
type = attrsOf (
attrTag (lib.mapAttrs (_name: resource: mkOption { type = resource.request; }) config.resources)
);
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
type = optionType;
readOnly = true;
default = submoduleWith {
class = "fediversity-configuration";
modules = [
{
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submoduleWith {
class = "fediversity-application-config";
modules = [ application.module ];
};
default = { };
}
) config.applications;
};
}
];
};
};
in
{
_class = "nixops4Deployment";
_class = "fediversity-settings";
options = {
inherit configuration;
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";
options = {
description = mkOption {
description = "Description of the resource to help application module authors and hosting providers to work with it";
@ -47,10 +69,10 @@ in
};
policy = mkOption {
description = "Options for configuring the resource policy for the hosting provider, a description of how the resource is made available";
type = deferredModuleWith {
staticModules = [
type = submoduleWith {
class = "fediversity-resource-policy";
modules = [
{
_class = "fediversity-resource-policy";
options.apply = mkOption {
description = "Apply the policy to a request";
};
@ -61,13 +83,15 @@ in
};
}
)
);
];
});
};
applications = mkOption {
description = "Collection of Fediversity applications";
type = attrsOf (
submodule (application: {
_class = "fediversity-application";
type = attrsOf (submoduleWith {
class = "fediversity-application";
modules = [
{
options = {
description = mkOption {
description = "Description to be shown in the application overview";
@ -77,54 +101,26 @@ in
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";
type = application.config.config-mapping.function-type;
};
resources = mkOption {
description = "Compute resources required by an application";
type = functionTo application.config.config-mapping.output-type;
readOnly = true;
default = input: (application.config.implementation input).output;
};
config-mapping = mkOption {
description = "Function type for the mapping from application configuration to required resources";
type = submodule functionType;
readOnly = true;
default = {
input-type = application.config.module;
output-type = application-resources;
};
};
};
})
description = "Mapping of application configuration to deployment resources, a description of what an application needs to run";
# TODO: maybe transpose, and group the resources by type instead
type = functionTo (
attrsOf (
attrTag (lib.mapAttrs (_name: resource: mkOption { type = resource.request; }) config.resources)
)
);
};
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
type = optionType;
readOnly = true;
default = submodule {
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submodule application.module;
default = { };
}
) config.applications;
};
};
];
});
};
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 = ''
@ -135,26 +131,37 @@ 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
)
);
};
implementation = mkOption {
description = "Mapping of resources required by applications to available resources; the result can be deployed";
type = environment.config.resource-mapping.function-type;
type = functionTo raw;
};
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;
output-type = nixops4Deployment;
input-type = configuration;
output-type = raw;
};
};
deployment = mkOption {
description = "Generate a deployment from a configuration";
type = functionTo (submodule environment.config.resource-mapping.output-type);
type = functionTo raw;
readOnly = true;
default =
cfg:
@ -164,32 +171,13 @@ in
name: application-settings: config.applications.${name}.resources application-settings
) cfg.applications;
in
(environment.config.implementation required-resources).output;
(environment.config.implementation required-resources);
};
};
})
);
};
configuration = mkOption {
description = "Configuration type declaring options to be set by operators";
type = optionType;
readOnly = true;
default = submodule {
options = {
enable = lib.mkEnableOption {
description = "your Fediversity configuration";
};
applications = lib.mapAttrs (
_name: application:
mkOption {
description = application.description;
type = submodule application.module;
default = { };
}
) config.applications;
};
};
];
});
};
};
}

12
deployment/deployment.nix Normal file
View file

@ -0,0 +1,12 @@
{
inputs,
...
}:
inputs.nixops4.modules.nixops4Deployment.default
# inherit lib config resources;
# # config = {
# # type providers provider inputs outputsSkeleton resourceType
# # };
# }

View file

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