Jailmaker 项目使用教程

1. 项目目录结构及介绍

Jailmaker 项目的目录结构如下：

jailmaker/
├── docs/
│   ├── templates/
│   └── test/
├── LICENSE
├── README.md
└── jlmkr.py

目录结构介绍

• docs/: 包含项目的文档和模板文件。
  • templates/: 存放配置模板文件。
  • test/: 存放测试文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的介绍和使用说明。
• jlmkr.py: 项目的启动文件，用于创建和管理 TrueNAS SCALE 上的持久性 Linux 'jails'。

2. 项目的启动文件介绍

jlmkr.py

jlmkr.py 是 Jailmaker 项目的启动文件，主要用于创建和管理 TrueNAS SCALE 上的持久性 Linux 'jails'。该脚本使用 systemd-nspawn 来实现这一功能。

主要功能

• 创建 Jail: 通过命令行参数或交互式方式创建新的 Jail。
• 启动 Jail: 启动已创建的 Jail。
• 停止 Jail: 停止正在运行的 Jail。
• 删除 Jail: 删除指定的 Jail。
• 列出 Jails: 列出所有已创建的 Jails 及其状态。
• 执行命令: 在指定的 Jail 中执行命令。
• 编辑配置: 编辑指定 Jail 的配置文件。

使用示例

# 创建并启动一个名为 myjail 的 Jail
./jlmkr.py create --start myjail

# 列出所有 Jails
./jlmkr.py list

# 在 myjail 中执行命令
./jlmkr.py exec myjail ls

3. 项目的配置文件介绍

配置文件位置

Jailmaker 的配置文件通常位于 docs/templates/ 目录下。每个 Jail 的配置文件会根据用户的选择和输入生成，并存储在 jails/ 目录下。

配置文件示例

以下是一个典型的配置文件示例：

[jail]
name = myjail
distro = debian
release = 12
startup = 1
bind_mounts = /mnt/mypool/data

配置项说明

• name: Jail 的名称。
• distro: 使用的 Linux 发行版，如 Debian、Ubuntu 等。
• release: 发行版的版本号。
• startup: 是否在系统启动时自动启动 Jail。
• bind_mounts: 需要挂载到 Jail 中的目录。

配置文件的编辑

用户可以通过 jlmkr.py 脚本来编辑已创建的 Jail 的配置文件：

./jlmkr.py edit myjail

编辑完成后，需要重新启动 Jail 以应用更改：

./jlmkr.py restart myjail

总结

Jailmaker 是一个用于在 TrueNAS SCALE 上创建和管理持久性 Linux 'jails' 的工具。通过 jlmkr.py 脚本，用户可以方便地创建、启动、停止和删除 Jails，并通过配置文件进行自定义配置。