Compare commits

...

21 commits

Author SHA1 Message Date
5709d4acc8
[HACK] comment environment resources type, making the test go through 2025-07-22 18:25:27 +02:00
0e60ff548f
[HACK] explicitly set resource options, as defaults seem insufficient 2025-07-22 18:25:27 +02:00
c9d07ce7e4
[HACK] explicitly pass instantiated policy to apply 2025-07-22 18:25:27 +02:00
1198af141f
[HACK] unwire deployment resource-mapping output-type, fixes error: Expected a module, but found a value of type "option-type" 2025-07-22 18:25:27 +02:00
fdf03af711
[HACK] swap out nixops4 deployments for raw nixos modules 2025-07-22 18:25:27 +02:00
ccbe6d9e83
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 18:25:27 +02:00
d836e2294f
swap out dummy module for actual import
clean deployment module a bit

simplify imports
2025-07-22 18:25:27 +02:00
4b9cf35e88
model: [DUMMY] use mock deployment to temporarily simplify the problem
type policy.apply

remove `apply`'s optionType, fixes duplicate definition error
2025-07-22 18:25:27 +02:00
532f87b2ff
environment: fix implementation type 2025-07-22 18:25:27 +02:00
a3b5b8b2fe
pass resourceProviderSystem to nixops4Deployment 2025-07-22 18:25:27 +02:00
cbfdeb0cd7
resolve resource mapping input discrepancy according to actual implementation, adjusting the type accordingly 2025-07-22 18:25:27 +02:00
e8551f2cc3
properly flatten out application layer at users.users 2025-07-22 18:25:27 +02:00
272b0f1584
fix application-requirements 2025-07-22 18:25:27 +02:00
f2a35dec24
untangle applications from function type, as they seem to not need the introspection (and may type-check input without it) 2025-07-22 18:25:27 +02:00
4767e0b97c
make packages filter return a list 2025-07-22 18:25:27 +02:00
ac81cc5780
add trivial unit test for deployment - now to find how to make it work!
test proper expectation

test proper expectation

settle for counting packages over comparing them, solves an infinite recursion
2025-07-22 18:25:25 +02:00
618a891062
fix environment deployment 2025-07-22 18:01:10 +02:00
3e34c0cf82
model: add classes
remove _class for application requirements to allow iterating over values
2025-07-22 17:59:50 +02:00
23677ecb80
use submodule to turn module into type for functionTo 2025-07-22 17:59:49 +02:00
446400212b
use mapAttrs right
`mapAttrs'` takes two args rather than a set, whereas if only the val
changes `mapAttrs (_: v: ...)` should do
2025-07-22 17:59:48 +02:00
c2646c98c4
resolve rebase 2025-07-22 17:59:16 +02:00
5 changed files with 204 additions and 204 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";
@ -35,7 +35,7 @@ in
};
policy =
{ config, ... }:
{ ... }:
{
_class = "fediversity-resource-policy";
@ -45,12 +45,13 @@ in
};
apply = mkOption {
type = with types; functionTo raw;
default = requests: lib.mkMerge (requests ++ [ config.extra-config ]);
default = policy: requests: lib.mkMerge (requests ++ [ policy.extra-config ]);
};
};
};
};
resources.login-shell = {
_class = "fediversity-resource";
description = "The operator needs to be able to log into the shell";
request =
{ ... }:
@ -69,7 +70,7 @@ in
};
};
policy =
{ config, ... }:
{ ... }:
{
_class = "fediversity-resource-policy";
options = {
@ -85,16 +86,16 @@ in
apply = mkOption {
type = with types; functionTo raw; # TODO: splice out the user type from NixOS
default =
requests:
policy: requests:
let
# Filter out requests that need wheel if policy doesn't allow it
validRequests = lib.filterAttrs (_name: req: !req.wheel || config.wheel) requests;
validRequests = lib.filterAttrs (_name: req: !req.wheel || policy.wheel) requests;
in
lib.optionalAttrs (validRequests != { }) {
${config.username} = {
${policy.username} = {
isNormalUser = true;
packages = with lib; concatMapAttrs (_name: request: attrValues request.packages) validRequests;
extraGroups = lib.optional config.wheel "wheel";
packages = with lib; concatMap (request: attrValues request.packages) (attrValues validRequests);
extraGroups = lib.optional policy.wheel "wheel";
};
};
};
@ -104,64 +105,58 @@ 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, ... }:
{
resources.shell.login-shell.username = "operator";
implementation =
requests:
{ providers, ... }:
{
providers = {
inherit (inputs.nixops4.modules.nixops4Provider) local;
};
resources.the-machine = {
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
);
};
};
};
environments.single-nixos-vm = environment: {
_class = "fediversity-environment";
resources.shell.login-shell = {
username = "operator";
wheel = false; # FIXME: why do i need to make this explicit, if a default was supposed to be set?
};
implementation = requests: {
_class = "nixos";
users.users = (
config.resources.login-shell.policy.apply environment.config.resources.shell.login-shell (
lib.concatMapAttrs (
_application: resources:
lib.mapAttrs (_k: lib.getAttr "login-shell") (
lib.filterAttrs (_name: value: value ? login-shell) resources
)
) requests
)
);
};
};
};
options = {
example-configuration = mkOption {
type = config.configuration;
readOnly = true;
default = {
_class = "fediversity-configuration";
enable = true;
applications.hello.enable = true;
};
};
};
environments.single-nixos-vm = {
};
configurations.example = {
enable = true;
applications.hello.enable = true;
# default = config.environments.single-nixos-vm.deployment config.example-configuration;
example-deployment = mkOption {
type = types.raw;
readOnly = true;
default = config.environments.single-nixos-vm.deployment config.example-configuration;
};
};
}
);
@ -170,12 +165,14 @@ in
inherit (fediversity)
example-configuration
;
num-packages = lib.lists.length fediversity.example-deployment.users.users.operator.packages;
};
expected = {
example-configuration = {
enable = true;
applications.hello.enable = true;
};
num-packages = 1;
};
};
}

View file

@ -1,7 +1,6 @@
{
lib,
config,
inputs,
...
}:
let
@ -10,188 +9,180 @@ 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 (
{ ... }:
{
_class = "fediversity-resource";
options = {
description = mkOption {
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";
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";
type = deferredModuleWith {
staticModules = [
{
_class = "fediversity-resource-policy";
options.apply = mkOption {
description = "Apply the policy to a request";
};
}
];
type = attrsOf (submoduleWith {
class = "fediversity-resource";
modules = [
(
{ ... }:
{
options = {
description = mkOption {
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";
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";
type = submoduleWith {
class = "fediversity-resource-policy";
modules = [
{
options.apply = mkOption {
description = "Apply the policy to a request";
};
}
];
};
};
};
};
}
)
);
}
)
];
});
};
applications = mkOption {
description = "Collection of Fediversity applications";
type = attrsOf (
submodule (application: {
_class = "fediversity-application";
options = {
description = mkOption {
description = "Description to be shown in the application overview";
type = types.str;
};
module = mkOption {
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;
type = attrsOf (submoduleWith {
class = "fediversity-application";
modules = [
{
options = {
description = mkOption {
description = "Description to be shown in the application overview";
type = types.str;
};
module = mkOption {
description = "Operator-facing configuration options for the application";
type = deferredModuleWith { staticModules = [ { _class = "fediversity-application-config"; } ]; };
};
resources = mkOption {
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";
options = {
resources = mkOption {
description = ''
Resources made available by the hosting provider, and their policies.
type = attrsOf (submoduleWith {
class = "fediversity-environment";
modules = [
(environment: {
options = {
resources = mkOption {
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
# # FIXME: error: The option `environments.single-nixos-vm.resources.shell.login-shell.apply' does not exist. Definition values:
# # - In `<unknown-file>': <function>
# # However there are no options defined in `environments.single-nixos-vm.resources.shell.login-shell'. Are you sure you've
# # declared your options properly? This can happen if you e.g. declared your options in `types.submodule'
# # under `config' rather than `options'.
# 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 = functionTo raw;
};
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 = configuration;
output-type = raw;
};
};
deployment = mkOption {
description = "Generate a deployment from a configuration";
type = functionTo raw;
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);
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: {
${name} = mkOption { type = 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 {
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;
};