Additional module options for enhanced control over VM configuration. #10
Conversation
|
@quinneden That's wild, I just ran into this OOM error and started delving into how I might increase the memory allocated to the Lima VM and concluded I'd have to fork the repo... and then I saw this PR, only 15 minutes old. Currently re-running in case I squeak past the memory constraint, but if it fails again I'll give this a shot. Many thanks! Edit: Worked like a charm. Increased memory size and even disabled Rosetta for a bit of extra oomph, and it went smooth! |
That's great! I'm glad to hear that it went smoothly. :) |
|
Thank you for the pull request. I’m traveling for the next day, but am interested to check it out. |
There was a problem hiding this comment.
Thank you for this pull request! I like the direction it takes this project and it's teaching me some things about Nix.
Minor changes mentioned below. If I find a few minutes I'll make the changes myself and merge (and happy to further discuss any of them if there are contrary opinions).
On the various formatting changes: is there a linter/Nix formatter that you use? I'm relatively new to the language and trying to learn (or, worse, police) style is exhausting. I would love something that can handle that automatically?
Currently away from home, I’ll read these more in depth in a few hrs but regarding the formatting, I prefer nixfmt-rfc-style. It’s not currently stable but will be the official formatting standard. I also just find it to be the easiest to read. However, I formatted the code in this pr with Alejandra because it looked like maybe you were using it already. |
|
I'll be taking a crack at addressing some of my comments in my module-options branch. |
In case the `default` ever changes for some reason. Resolves: #10 (comment)
Remove references to "Lima" (as it's an implementation detail) and add an example for `onDemand`. Resolves: #10 (comment) #10 (comment)
Make it clear that debuging provides potentially-dangerous access to the VM. (It auto-logs in to a user that can `sudo` to root.) Resolves: #10 (comment)
This may be reinstated in the future (it may provide better performance, see linked comment), but simplify the module for now. Resolves: #10 (comment)
Prevent potential insecure configurations. For now any flexibility that users request will be added as specific, known-safe options. If that becomes too onerous this option may be reinstated (with warnings and/or a more ominous option name). Resolves: #10 (comment)
Make it clear that debuging provides potentially-dangerous access to the VM. (Any user able to SSH into the VM could tamper with builds. See linked comment.) More context: #10 (comment)
Prevent the module from being configured in an insecure manner. This may be reversed in the future. Resolves: #10 (comment)
|
I merged with additional changes that addressed my review comments. |
Ok great! I apologize I never got a chance to look these over last night, had a personal situation come up but I’m excited to look when I can and I’m happy to have this merged! |
This pull request includes several changes to enhance the configurability and modularity of the VM. The most significant changes include additional options for
config.rosetta-builder, refactoring the package outputs inflake.nix, and updatingpackage.nixto support the additional options implemented inmodule.nix.New module options:
cores: specifies number of cpu cores for the Lima instance, as well as the maximum number of jobs allowed for the builder in theconfig.nix.buildMachinesspecification. Default is8.diskSize: specifies the size of the disk created for the instance, default is"100GiB".memory: specifies the amount of memory to allocate, default is"6GiB".enableRosetta: enable/disable Rosetta 2 for the VM,trueby default. I'd like to hear your thoughts on this one as it sort of contradicts the idea of this project (and the name), but I thought it might be beneficial to provide the option to disable it if it's not needed by the user, as running Rosetta 2 causes a slight performance decrease for the VM (lima-vm/lima#1269).port: specify SSH port for the instance, default is31122.Major changes:
flake.nix: Removedpackages.aarch64-linux.on-demand, sinceonDemandis passed as an override directly to the derivation that builds the image, so having an explicit output for each is unnecessary.module.nix: AddedimageWithFinalConfigwhich callspackages.aarch64-linux.image, passing the values of the options set in the module as overrides. ThevmYamlfunction now sets the values ofdisk,memory,cpus,ssh.localPortandrosetta.enabledto that of their respective module option instead of being hard-coded. The script for the launchd daemon has also been modified so that changes to the values of any module options that set parameter values invmYamlwill cause the existing Lima instance to be deleted and a new one will be created using the updatedvmYaml.Minor changes:
package.nix: Improved the readability of the configuration by usingwith liband restructuring the code blocks.flake.lock: Updated flake inputs.constants.nix: removedebugas it is now defined byconfig.rosetta-builder.debug.