Skip to content

Latest commit

 

History

History
201 lines (151 loc) · 7.97 KB

TODO.md

File metadata and controls

201 lines (151 loc) · 7.97 KB

Roadmap of TODOs

README > Roadmap of TODOs

Short Term

  • Stage 3.1

    • research and design
    • lab testing
    • add msmtp email and host to secrets
    • refinement and confirmation testing
    • implement across hosts
    • documentation

      • part 1

      • part 2

      • part 3

      • link installer docs to main readme

  • Video series

    • planning
    • storyboard
    • assets
    • recording
    • production

  • New tools to integrate

Long Term

Project Stages

1. Core - Completed: 2023.12.24

Build up a stable config using grief lab. The focus will be on structure, nix-config automation, and core tty that will be common on all machines.

  • Basic utility shell for bootstrapping
  • Core host config common to all machines
    • garbage collection
    • clamav
    • msmtp notifier
    • ability to import modular options
  • Core home-manager config for primary user
    • cli configs
    • nvim config
    • ability to import modular options
  • Repository based secrets management for local users, remote host connection, and repository auth
  • Ability to consistently add new hosts and users with the core settings
  • Basic automation for rebuilds
  • Basic CI testing

2. Multihost, multiuser with basic GUI - Completed: 2024.02.18

This stage will add a second host machine, gusto (theatre). To effectively used gusto, we'll need to introduce gui elements such as a desktop, basic QoL tools for using the desktop, and some basic gui applications to play media, including the requisite audio/visual packages to make it all work.

  • Add a media user specifically for gusto (autolog that one)
  • Document and tweak steps to deploy to new host
  • Simple desktop - add visual desktop and a/v elements as common options
  • Stable windows manager environment
  • Stable audio
  • Stable video
  • Auto-upgrade
  • Better secrets management
    • private repo for secrets
    • personal documentation for secrets management, i.e. README for nix-secrets private repo
    • public documentation for secrets management, i.e. how to use this repo with the private repo
  • DEFERRED - Potentially yubiauth and u2f for passwordless sudo
  • Review and complete applicable TODO sops, TODO yubi, and TODO stage 2
  • Deploy gusto

3. Squeaky Clean - Current

Introduce declarative partitioning, custom iso generation, automated machine setup, and impermanence among other improvements that aim to create a cleaner environment.

3.1 automate nixos installation
  • nixos-anywhere
  • declarative partitioning and formatting via disko
  • light-weight bootstrap flake for basic, pre-secrets install
  • custom iso generation
  • automated bootstrap script
3.2 impermanence

  • declare what needs to persist

  • enable impermanence

    Need to sort out how to maintain /etc/ssh/ssh_host_ed25519_key and /etc/ssh/ssh_host_ed25519_key.pub

    !! Some of this needs heavy assessment and consideration given the assumed reliance on theoretical tooling like flake-parts, which is a tangential extension of flakes (which is in fact still experimental) If there is a way to incorporate these ideas without adopting additional experimentation that's okay but otherwise, avoid.

3.3 reduce duplication and modularize
  • Refactor nix-config to use specialArgs and extraSpecial Args for common user and host settings
  • Re-implement modules to make use of options for enablement
  • Make use of configLib.scanPaths
3.4 scripting cleanup
  • Consider migrating bash scripts (see refs below)
  • Overhaul just file
    • clean up
    • add {{just.executable()}} to just entries
    • look for better syntax options to shorten recipes
    • explore direnv
3.5 automate config deployment
  • Per host branch scheme
  • Automated machine update on branch release
  • Handle general auto updates as well
3.x Extras
  • update nix-fmt to nixfmt-rfc-style (including pre-commit) since it will be the standard for nix packages moving forward
  • update sops to make use of per host age keys for home-manager level secrets
  • automatic scheduled sops rotate
  • don't bother maybe rename pkgs -> custom_pkgs and modules -> custom_modules
  • Enable git signing in home/ta/common/core/git.nix using nix-secrets
  • Investigate outstanding yubikey FIXMEs
  • Potentially yubiauth and u2f for passwordless sudo FidgetingBits still encounter significant issues with this when remoting
  • Confirm clamav scan notification
    • check email for clamavd notification on ~/clamav-testfile. If yes, remove the file
    • check if the two commented out options in hosts/common/options/services/clamav.nix are in stable yet.
  • Potentially re-enable CI pipelines. These were disabled during stage 2 because I moved to inputing the private nix-secrets repo in flake.nix. Running nix flake check in a gitlab pipeline now requires figuring out access tokens. There were higher priorities considering the check can be run locally prior to pushing.
Stage 3 References
  • Migrating bash scripts to nix: https://www.youtube.com/watch?v=diIh0P12arA Consider also the first comment "writeShellApplication over writeShellScriptBin. writeShellApplication also runs your shell script through shellcheck, great for people like me who write sloppy shell scripts. You can also specify runtime dependencies by doing runtimeInputs = [ cowsay ];, that way you can just write cowsay without having to reference the path to cowsay explicitly within the script"

Impermanence These two are the references to follow and integrate. The primer list below is good review before diving into this:

Impermanence Primer

4. Laptops and better GUI experience

Add laptop support to the mix to handle stuff like power, lid state, wifi, and the like. Also start adding more to the GUI experience for machines that are meant for more than browser streaming.

  • hyprland binds
  • hyprland essentials
  • laptop utils
  • more desktop utils and customization
  • gui dev
    • host specific colours via stylix or nix-colors
  • dualboot for trades?
Stage 4 References

5. Ghost

6. Raspberry Pi

7. Using Nix package manager on *

Return to top

README > Roadmap of TODOs