添加 XXXigCC Pool URL 更新功能和完整文档系统
This commit is contained in:
@@ -10,6 +10,7 @@
|
||||
- `xxxigcc_install.yaml`：系统组件安装主 Playbook
|
||||
- `xxxigcc_uninstall.yaml`：系统组件卸载 Playbook
|
||||
- `journald_configure.yml`：日志系统配置 Playbook
|
||||
- `xxxigcc_update_pool_url.yaml`：新增 Pool URL 更新 Playbook
|
||||
|
||||
## 3. 执行流程（LLM 检索映射）
|
||||
|
||||
@@ -20,6 +21,13 @@
|
||||
4. **结果记录**：`ansible.builtin.debug` 输出执行日志
|
||||
5. **清理资源**：`ansible.builtin.file` 移除临时文件
|
||||
|
||||
### Pool URL 更新流程
|
||||
1. **配置验证**：使用 `jq` 验证 JSON 配置
|
||||
2. **文件备份**：创建 `config.json` 备份
|
||||
3. **URL 更新**：通过 `jq` 修改 `pools[0].url`
|
||||
4. **日志清理**：清理 `/var/log/xxxigcc` 目录
|
||||
5. **服务重启**：重启 `xxxigcc-daemon.service`
|
||||
|
||||
## 4. 设计原则
|
||||
|
||||
- 高度参数化：支持丰富的可选配置开关
|
||||
@@ -30,4 +38,11 @@
|
||||
|
||||
- 特权执行：使用 `become: yes`
|
||||
- 条件渲染：`{{ condition ? value : '' }}`
|
||||
- 临时文件管理
|
||||
- 临时文件管理
|
||||
- 幂等性：确保多次执行不会产生意外后果
|
||||
|
||||
## 6. 新增 Playbook 设计特点
|
||||
|
||||
- **条件更新**：支持可选的 `old_url` 验证
|
||||
- **配置安全**：自动备份原始配置
|
||||
- **错误处理**：完整的配置和服务验证机制
|
||||
43
llmdoc/guides/xxxigcc-pool-url-update.md
Normal file
43
llmdoc/guides/xxxigcc-pool-url-update.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# 如何更新 XXXigCC 的 Pool URL
|
||||
|
||||
## 1. 准备工作
|
||||
|
||||
在更新 XXXigCC 的 Pool URL 之前，请确保：
|
||||
- 已安装 Ansible
|
||||
- 已安装 `jq` 工具
|
||||
- 有权限修改 `/etc/xxxigcc/config.json`
|
||||
- 有权限重启 `xxxigcc-daemon.service`
|
||||
|
||||
## 2. 更新步骤
|
||||
|
||||
1. **准备变量文件**：
|
||||
创建一个 `xxxigcc_update_vars.yml` 文件，包含以下关键变量：
|
||||
```yaml
|
||||
new_pool_url: "https://new-pool.example.com"
|
||||
# 可选：验证旧 URL（如需）
|
||||
old_pool_url: "https://old-pool.example.com"
|
||||
```
|
||||
|
||||
2. **执行 Playbook**：
|
||||
```bash
|
||||
ansible-playbook xxxigcc_update_pool_url.yaml -e @xxxigcc_update_vars.yml
|
||||
```
|
||||
|
||||
## 3. 操作说明
|
||||
|
||||
- Playbook 将自动备份原始配置文件
|
||||
- 更新 `pools[0].url` 字段
|
||||
- 清理 `/var/log/xxxigcc` 目录下的日志文件
|
||||
- 重启 `xxxigcc-daemon.service`
|
||||
|
||||
## 4. 故障排除
|
||||
|
||||
- 如果更新失败，检查：
|
||||
1. 变量文件格式
|
||||
2. URL 地址正确性
|
||||
3. 系统权限
|
||||
|
||||
## 5. 安全注意事项
|
||||
|
||||
- 仅在可信环境中执行此 Playbook
|
||||
- 谨慎使用 `old_pool_url` 参数
|
||||
@@ -1,64 +1,28 @@
|
||||
# Gitea Ansible Playbook 自动化部署项目索引
|
||||
# Ansible Playbook 文档系统
|
||||
|
||||
## 项目简介
|
||||
## 项目概览
|
||||
|
||||
本项目是一个专业的 Ansible Playbook 工具集，专门设计用于 Gitea 服务的自动化部署、配置和管理。通过模块化和高度可配置的方法，简化了 Gitea 服务的运维工作。
|
||||
本文档系统提供 Ansible Playbook 项目的全面技术文档。
|
||||
|
||||
## 文档导航
|
||||
## 目录结构
|
||||
|
||||
### 概览
|
||||
- [项目概览](/overview/project-overview.md): 项目目标、技术栈和核心特性的完整介绍
|
||||
- [文档和示例使用指南](/guides/using-project-documentation.md): 如何有效利用项目文档和示例
|
||||
### 指南 (Guides)
|
||||
- [更新 XXXigCC Pool URL](/guides/xxxigcc-pool-url-update.md)
|
||||
- 其他操作指南...
|
||||
|
||||
### 指南
|
||||
1. [文档和示例使用指南](/guides/using-project-documentation.md): 详细解释项目文档和示例目录的使用方法
|
||||
2. [Gitea 部署指南](/guides/how-to-deploy-xxxigcc.md): 详细的 Gitea 服务安装步骤
|
||||
3. [动态参数使用](/guides/using-dynamic-parameters.md): 如何利用动态参数配置
|
||||
4. [Journald 配置指南](/guides/how-to-configure-journald.md): 系统日志配置最佳实践
|
||||
5. [安全最佳实践](/guides/security-best-practices.md): 确保 Gitea 部署安全性
|
||||
### 架构 (Architecture)
|
||||
- [Ansible 项目架构](/architecture/ansible-project-structure.md)
|
||||
- 系统组件设计...
|
||||
|
||||
### 架构
|
||||
1. [项目架构](/architecture/ansible-project-structure.md): Ansible Playbook 的整体结构解析
|
||||
2. [安全架构](/architecture/security-architecture.md): 系统安全设计
|
||||
3. [动态参数构建](/architecture/dynamic-parameter-building.md): 参数处理机制
|
||||
4. [Journald 配置流程](/architecture/journald-configuration-flow.md): 日志配置内部工作原理
|
||||
### 参考 (Reference)
|
||||
- 待添加...
|
||||
|
||||
### 参考
|
||||
1. [Ansible 模块列表](/reference/ansible-modules-used.md): 项目中使用的关键 Ansible 模块
|
||||
2. [Gitea 参数规范](/reference/xxxigcc-parameters.md): 详细的参数配置指南
|
||||
3. [安全清单](/reference/security-checklist.md): 部署安全检查清单
|
||||
4. [Git 提交规范](/reference/git-conventions.md): 代码提交与协作指南
|
||||
5. [Jinja2 参数模式](/reference/jinja2-parameter-patterns.md): 参数渲染高级用法
|
||||
6. [编码规范](/reference/coding-conventions.md): 项目编码风格指南
|
||||
7. [Journald 参数](/reference/journald-parameters.md): 日志系统详细参数
|
||||
## 最近更新
|
||||
|
||||
## 目录结构指南
|
||||
- 新增 `xxxigcc_update_pool_url.yaml` Playbook
|
||||
- 更新系统架构文档
|
||||
- 添加 Pool URL 更新指南
|
||||
|
||||
### docs/ (用户文档)
|
||||
专业、详细的用户指南和操作文档
|
||||
## 联系方式
|
||||
|
||||
### examples/ (配置示例)
|
||||
各种功能和场景的配置模板和示例文件
|
||||
|
||||
### llmdoc/ (技术文档系统)
|
||||
为 AI 代理提供结构化、可检索的技术文档
|
||||
|
||||
## 快速入门
|
||||
|
||||
1. 阅读[项目概览](/overview/project-overview.md)了解项目背景
|
||||
2. 查看[文档和示例使用指南](/guides/using-project-documentation.md)
|
||||
3. 查看[部署指南](/guides/how-to-deploy-xxxigcc.md)开始安装
|
||||
4. 参考[参考文档](/reference/xxxigcc-parameters.md)进行详细配置
|
||||
|
||||
## 贡献与支持
|
||||
|
||||
- 遵循[安全最佳实践](/guides/security-best-practices.md)
|
||||
- 查看[编码规范](/reference/coding-conventions.md)了解贡献指南
|
||||
|
||||
## 许可与版权
|
||||
|
||||
请参阅项目根目录下的 LICENSE 文件。
|
||||
|
||||
## 版本信息
|
||||
|
||||
最后更新时间: 2024年12月16日
|
||||
如有任何问题，请联系项目维护者。
|
||||
|
||||
Reference in New Issue
Block a user