从项目文件生成运维手册。扫描 Dockerfile、docker‑compose.yml、systemd 单元、Makefile、package.json 及配置文件,以生成...
运行本生成器 : 通过扫描工程基础设施文件生成运行本是一项面向实际任务的技能,主要用于生产结构化的 Markdown 运行本, 并带有共同操作任务的程序;QQQ快速生成。
从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
通过扫描项目基础设施文件,自动生成运维操作手册(Runbook)。输出结构化的 Markdown 格式 Runbook,涵盖常见运维任务的操作流程。
python3 scripts/generate_runbook.py /path/to/project
# Markdown(默认格式) python3 scripts/generate_runbook.py /path/to/project # JSON(结构化格式) python3 scripts/generate_runbook.py /path/to/project --format json # 指定输出文件 python3 scripts/generate_runbook.py /path/to/project -o RUNBOOK.md
| 文件 | 提取信息 |
|---|---|
| Dockerfile | 基础镜像、暴露端口、入口点(entrypoint)、构建步骤 |
| docker-compose.yml | 服务定义、端口映射、卷(volumes)、依赖关系、环境变量 |
| systemd 单元文件(.service) | ExecStart/Stop/Reload 指令、依赖项、重启策略 |
| Makefile | 目标(targets):如 build、test、deploy、clean 等 |
| package.json | 脚本(scripts):如 start、build、test、dev、deploy 等 |
| .env / .env.example | 必需的环境变量 |
| nginx.conf | 上游服务器(upstream)、监听端口(listen)、路径配置(locations) |
相关专题
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.1万人学习
共49课时 | 82.6万人学习
最新文章