Quadlet-nix 项目启动与配置教程

1. 项目的目录结构及介绍

quadlet-nix 项目是一个用于在 NixOS 上管理 Podman 容器、网络等的工具。项目的目录结构如下：

• ./: 项目根目录
  • ./ci: 包含持续集成相关的配置文件。
  • ./tests: 包含项目的测试脚本和代码。
  • ./flake.nix: Nix 的flake文件，用于定义项目依赖和构建环境。
  • ./configuration.nix: NixOS的配置文件，用于定义系统设置。
  • ./README.md: 项目说明文件。
  • ./LICENSE: 项目许可证文件。
  • ./build.nix: 定义构建过程的Nix表达式。
  • ./container.nix: 容器配置的Nix表达式。
  • ./network.nix: 网络配置的Nix表达式。
  • ./pod.nix: Pod配置的Nix表达式。
  • ./utils.nix: 工具和辅助函数的Nix表达式。
  • ./volume.nix: 存储卷配置的Nix表达式。

2. 项目的启动文件介绍

项目的启动主要通过 flake.nix 文件来管理。以下是 flake.nix 的基本结构和用法：

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
    home-manager.url = "github:nix-community/home-manager";
    quadlet-nix.url = "github:SEIAROTg/quadlet-nix";
  };
  outputs = {
    nixpkgs, home-manager, quadlet-nix, ...
  };
  @attrs: {
    nixosConfigurations.machine = {
      system = "x86_64-linux";
      modules = [
        ./configuration.nix
        quadlet-nix.nixosModules.quadlet
      ];
    };
  };
}

启动项目时，你需要使用 Nix 的 flake 命令来构建和部署配置。例如，构建一个 NixOS 系统配置可以使用以下命令：

nix build .#nixosConfigurations.machine

3. 项目的配置文件介绍

项目的配置主要通过 configuration.nix 文件来定义。以下是 configuration.nix 的基本结构和用法：

{
  config, ...
}: {
  # 定义 quadlet 的容器配置
  virtualisation.quadlet.containers = {
    nginx = {
      containerConfig = {
        image = "docker.io/library/nginx:latest";
        networks = [ "podman" ];
        pod = pods.foo;
      };
      serviceConfig = {
        TimeoutStartSec = "60";
      };
    };
  };

  # 定义网络配置
  networks = {
    internal = {
      networkConfig = {
        subnets = [ "10.0.123.1/24" ];
      };
    };
  };

  # 定义 Pod 配置
  pods = {
    foo = {};
  };
}

在 configuration.nix 文件中，你可以配置容器、网络和 Pod 的详细参数。这些配置将会影响 Podman 在 NixOS 上的行为。你需要根据实际需求调整这些配置。

完成配置后，可以通过 Nix 的 config 命令来应用这些配置，或者将其包含在 flake.nix 中，以便在构建时自动应用。