167fad20eb
- 新增 Nezha Agent client_secret 更新 playbook（两种实现方案） - 建立三层文档架构：docs/（用户文档）、examples/（配置示例）、llmdoc/（技术文档） - 添加项目主 README.md 和配置示例文件 - 初始化 .gitignore 保护敏感信息
94 lines
2.2 KiB
Markdown
94 lines
2.2 KiB
Markdown
# Examples - 示例文件目录
|
|
|
|
本目录包含各种 Ansible Playbook 的示例配置文件。
|
|
|
|
## 📁 文件说明
|
|
|
|
### Inventory 示例
|
|
|
|
- **[inventory.example.ini](inventory.example.ini)** - Ansible inventory 配置示例
|
|
- 单服务器和多服务器配置
|
|
- 不同认证方式示例
|
|
- 组变量配置示例
|
|
|
|
### 变量文件示例
|
|
|
|
- **[nezha_vars.example.yml](nezha_vars.example.yml)** - Nezha Agent 更新配置变量
|
|
- **[xxxigcc_vars.example.yml](xxxigcc_vars.example.yml)** - XXXigCC 安装配置变量
|
|
- **[journald_vars.example.yml](journald_vars.example.yml)** - Journald 日志配置变量
|
|
|
|
## 🚀 使用方法
|
|
|
|
### 1. Inventory 文件
|
|
|
|
```bash
|
|
# 复制示例文件
|
|
cp examples/inventory.example.ini inventory.ini
|
|
|
|
# 编辑文件，填入你的服务器信息
|
|
vim inventory.ini
|
|
|
|
# 测试连接
|
|
ansible all -i inventory.ini -m ping
|
|
```
|
|
|
|
### 2. 变量文件
|
|
|
|
```bash
|
|
# 复制相应的示例文件
|
|
cp examples/nezha_vars.example.yml nezha_vars.yml
|
|
|
|
# 编辑文件，填入实际配置
|
|
vim nezha_vars.yml
|
|
|
|
# 使用变量文件执行 playbook
|
|
ansible-playbook nezha_update_secret.yml \
|
|
-i inventory.ini \
|
|
-e @nezha_vars.yml
|
|
```
|
|
|
|
### 3. 直接命令行传参
|
|
|
|
不使用变量文件，直接在命令行传递参数：
|
|
|
|
```bash
|
|
ansible-playbook nezha_update_secret.yml \
|
|
-i inventory.ini \
|
|
-e "client_secret=YourNewSecret"
|
|
```
|
|
|
|
## 📋 最佳实践
|
|
|
|
1. **不要提交实际配置到版本控制**
|
|
- 将 `inventory.ini` 和 `*_vars.yml` 添加到 `.gitignore`
|
|
- 只提交 `.example` 示例文件
|
|
|
|
2. **使用 Ansible Vault 保护敏感信息**
|
|
```bash
|
|
# 加密变量文件
|
|
ansible-vault encrypt nezha_vars.yml
|
|
|
|
# 使用加密文件
|
|
ansible-playbook nezha_update_secret.yml \
|
|
-i inventory.ini \
|
|
-e @nezha_vars.yml \
|
|
--ask-vault-pass
|
|
```
|
|
|
|
3. **变量文件命名规范**
|
|
- 开发环境: `vars.dev.yml`
|
|
- 测试环境: `vars.test.yml`
|
|
- 生产环境: `vars.prod.yml`
|
|
|
|
## 🔗 相关文档
|
|
|
|
- [Nezha Agent 更新文档](../docs/nezha_update_secret_README.md)
|
|
- [Nezha Agent 快速开始](../docs/QUICKSTART_nezha.md)
|
|
- [项目主 README](../README.md)
|
|
|
|
## 💡 提示
|
|
|
|
- 所有 `.example` 文件都包含详细的注释说明
|
|
- 复制示例文件时，记得去掉 `.example` 后缀
|
|
- 根据实际需求修改示例文件中的值
|