NixOps 技术文档

1. 安装指南

1.1 使用 nix-shell 安装

NixOps 可以通过 nix-shell 命令直接安装。以下是两种安装方式：

• 稳定版本：

  $ nix-shell -p nixops
  

• 不稳定版本（包含更多修复和新特性）：

  $ nix-shell -p nixopsUnstable
  

1.2 远程构建支持

如果你的系统不支持直接构建部署所需的 system，你可能需要访问 Nix 远程构建器。MacOS 用户可以使用 NixOS 虚拟机来实现这一点。

1.3 交叉编译

NixOps 支持交叉编译，可以通过设置 nixpkgs.localSystem 和 nixpkgs.crossSystem 来实现。你还可以混合使用远程、模拟和交叉构建，具体参考相关文档。

2. 项目的使用说明

2.1 运行 NixOps

安装完成后，你可以直接在 shell 中运行 NixOps。NixOps 是一个用于在网络或云中部署 NixOS 机器的工具。其主要特性包括：

• 声明式：NixOps 会自动确定并执行实现部署配置所需的操作。
• 可测试：你可以在 VirtualBox 或 libvirtd 上测试你的部署。
• 多云支持：目前支持 AWS、Hetzner 和 GCE 等云平台。
• 关注点分离：部署描述分为逻辑和物理两个方面，便于区分机器的“做什么”和“在哪里做”。
• 可扩展：通过插件基础设施，NixOps 可以扩展以支持额外的后端。

2.2 开发环境

如果你需要开发或修改 NixOps，可以使用 nix-shell 进入开发环境：

$ nix-shell

该环境包含了所有 Python 依赖，具体依赖项可以在 pyproject.toml 中查看。

3. 项目API使用文档

3.1 构建 Nix 包

你可以通过以下命令构建 Nix 包：

$ nix-build

3.2 执行测试

在开发环境中，你可以使用 pytest 命令执行测试：

$ pytest

3.3 文档编辑

NixOps 的文档使用 reStructuredText 格式。你可以使用 live-docs.py 脚本实时预览文档：

$ ./live-docs.py
Serving on http://127.0.0.1:5500

在提交更改前，请使用 lint-docs 命令检查文档的格式：

$ lint-docs

4. 项目安装方式

4.1 从源码构建

如果你需要从源码构建 NixOps，可以按照以下步骤操作：

1. 克隆项目仓库：

   $ git clone https://github.com/NixOS/nixops.git
   

2. 进入项目目录：

   $ cd nixops
   

3. 使用 nix-build 命令构建项目：

   $ nix-build
   

4.2 使用 nix-shell 进入开发环境

进入开发环境后，你可以进行代码修改和测试：

$ nix-shell

4.3 提交贡献

如果你希望为 NixOps 贡献代码，请遵循以下指南：

• 使用 black 格式化代码。
• 使用 mypy 添加类型签名。
• 在提交 PR 之前，请在 GitHub 上创建一个 issue 讨论你的计划。
• 如果你添加了新功能，请确保添加相应的测试。

5. 许可证

NixOps 使用 LGPL-3.0 许可证。