↓ 跳过正文

NixOS(四):用AI维护配置——维护者技能

·2079 字·5 分钟
锦李本鲤
作者
锦李本鲤
光锥之内,皆为命运。
NixOS系列 - 这篇文章属于一个选集。
§ 4: 本文

缘起
#

前面几篇介绍了NixOS的基本概念和配置仓库的组织方法。有了这些配置之后,就可以让AI帮忙修改和维护。不过,AI除了需要理解Nix语法,还需要知道仓库的结构。例如,只对笔记本生效的硬件设置,如果放进所有主机都会导入的公共配置,就可能影响其他电脑。这类问题不一定会产生语法错误。

为了减少每次维护时重复说明的内容,我把仓库结构、常用命令和注意事项整理成了一份维护说明,让AI修改前先阅读。实际维护时,这些内容分别保存在仓库约定、操作文档和更新记录里,也可以整理成AI工具支持的技能(skill)。这里介绍一下其中值得记录的内容,示例做了简化,可以根据自己的仓库调整。

维护说明的用途
#

维护说明首先需要说明配置的适用范围。例如,笔记本和服务器使用不同的主机配置,只对一台电脑生效的硬件设置应放在对应主机文件中。检查代码语法不能代替对配置用途的判断,所以修改前需要了解这些约定。

还有一些问题与代码无关。例如,工作区里已经有没提交的修改,AI继续改时需要保留它们;某次构建失败了,说明里就不能写成已经更新成功;配置仓库在哪里、重建时该选哪个主机,也需要说明白。

如果每次对话都临时补充这些要求,就容易遗漏。把它们写进文件后,新的对话也可以重新读取;仓库结构或使用方法改变时,再更新相应说明。

任务说明
#

维护说明不能代替具体需求。比如想给一台笔记本增加硬件支持,可以这样提出要求:

检查笔记本需要的硬件支持,把相关设置放在它自己的配置里。先检查现有修改,再修改和构建。告诉我是否需要重启,以及重启后怎么确认设备能用。这次先不要激活。

这里把涉及哪台电脑、希望完成什么、做到哪一步说清楚了。如果希望AI连激活也一起完成,也可以直接说明;如果电脑正在运行重要任务,就先把配置准备好,等合适的时候再切换。

我觉得没有必要把每次对话写成很长的提示词。重复的约定放在维护说明里,当前任务只补充这次不同的地方就可以了。

维护说明的内容
#

仓库结构
#

首先说明哪些文件是公共配置,哪些是主机配置,哪些是安装器生成的硬件描述。对应上一篇的示例,可以写成:

  • 通用工具和几台电脑共同使用的设置放在modules/common.nix;
  • 只影响一台电脑的设置放在hosts/<host>/configuration.nix;
  • 硬件描述由对应机器生成,不复制其他机器的磁盘配置;
  • 重建时使用当前机器对应的flake输出;
  • 更新flake.lock要单独检查,不能为了消除报错就随手更新全部输入。

这样,AI在编辑文件之前就知道大致该去哪里找。如果后面调整了目录结构,这份说明也要跟着改。

修改前检查
#

先看Git里有没有已有修改:

1
2
3
git status --short
git diff
git diff --cached

再读相关配置和最近的更新记录。如果需要确认机器实际使用的系统,可以查看:

1
2
readlink -f /run/current-system
readlink -f /run/booted-system

这两个路径可能不同。例如系统已经切换过一次,但还没重启。只看仓库里的最新提交,不能判断机器已经使用了它。

配置检查与构建
#

先检查diff和flake:

1
2
git diff --check
nix flake check --no-build --show-trace

第一条可以发现一些空白和补丁格式问题;第二条检查flake的评估结果,暂不构建声明的checks。涉及公共模块时,要检查受影响的主机输出,而不只是当前电脑。

接着构建这次要更新的系统,例如:

1
nixos-rebuild build --flake .#laptop

评估通过之后,构建仍可能因为下载、编译或磁盘空间等问题失败。所以完成说明里应当分别说清楚检查和构建的结果。构建很久时,可以继续监控;如果暂时没有完成,就记下来,下次从这里接着处理。

nix flake check的选项说明可以参看官方文档。第五篇会具体介绍评估、构建和激活的区别。

配置应用与验证
#

如果这次任务只准备配置,AI可以把需要运行的命令列出来,例如:

1
sudo nixos-rebuild switch --flake /path/to/nixos-config#laptop

然后说明是否需要重启、应该检查哪个服务、怎样使用一下新功能。早期迁移时,有些需要sudo或重启的操作就是由我在机器上执行的。

如果让AI直接应用配置,也要检查实际效果。修改服务之后,可以看对应的systemd状态和日志,再尝试连接;修改内核之后,则需要安排重启。远程操作网络配置时尤其要考虑连接断开后怎么恢复。

对于已经switch的配置,可以先检查保留的代次,再决定是否用sudo nixos-rebuild switch --rollback退回。临时test的恢复有所不同,后面第五篇会单独说明。数据库或文件已经改变时,还需要另外处理数据恢复。

文档与更新记录
#

我希望一次修改完成后,除了配置本身,相关使用说明也能跟上。例如命令换了、文件移动了、服务需要多一步初始化,就把新的做法写下来。否则下次照着旧说明操作,还是会遇到同一个问题。

更新记录可以简单一点,但要写实际发生的事情。构建通过、已经激活、已经重启,是不同的结果。只修改文档也不需要编一个系统代次;还没执行的步骤,直接写待完成就行。

提交之前,再看一遍完整diff,只加入这次需要提交的文件。是否推送按当前任务的要求处理,密码、密钥和原始私有日志不要放进提交或者对话里。

维护说明可以减少重复解释,也方便自己以后继续维护。它不能保证AI每次都正确执行,修改后仍然需要检查配置和实际效果。如果遇到新的问题,可以把适用范围和处理方法补充进去。

NixOS系列 - 这篇文章属于一个选集。
§ 4: 本文