feat: add docs to main (#1559)

This commit is contained in:
Peng Peng
2025-07-17 11:58:59 +08:00
committed by GitHub
parent e00018de59
commit af8e3b172c
1037 changed files with 40779 additions and 2 deletions

View File

@@ -0,0 +1,26 @@
# `prepare`
## 命令说明
`prepare` 命令用于配置 Olares 运行所需的环境,包括安装依赖项、导入容器镜像和启动 Olares 守护进程(`olaresd`)。
```bash
olares-cli prepare [选项]
```
## 选项
| 选项 | 简写 | 用途 | 是否必需 | 默认值 |
|----------------------|------|------------------------------------------------------------------------------------------------------------------------------------------|----------|------------------|
| `--base-dir` | `-b` | 设置 Olares 的基础目录。 | 否 | `$HOME/.olares` |
| `--help` | `-h` | 显示帮助信息。 | 否 | 无 |
| `--kube` | `-k` | 指定 Kubernetes 类型。支持 `k3s``k8s`。 | 否 | `k3s` |
| `--profile` | `-p` | 设置 Minikube 配置文件名称,仅适用于 macOS。 | 否 | `olares-0` |
| `--registry-mirrors` | `-r` | 设置 Docker 容器镜像仓库的镜像源。多个镜像源之间使用英文逗号分隔。 | 否 | 无 |
| `--with-juicefs` | `-j` | 将 JuiceFS 配置为 Olares 工作负载的根文件系统rootfs替代本地磁盘。 | 否 | 无 |
| `--version` | `-v` | 指定 Olares 版本。版本号格式为 `x.y.z`(如 `1.10.0`)或包含构建日期(如 `1.10.0-20241109`)。<br>可用版本请参考 [GitHub Releases](https://github.com/olares/releases)。 | 否 | 当前安装版本 |
## 使用示例
```bash
# 使用 JuiceFS 作为根文件系统
olares-cli prepare --with-juicefs=true
```