Ansible-Doctor 项目教程

Ansible-Doctor 项目教程

1. 项目的目录结构及介绍

Ansible-Doctor 项目的目录结构如下：

ansible-doctor/
├── ansible_doctor/
│   ├── __init__.py
│   ├── config.py
│   ├── doctor.py
│   ├── templates/
│   │   └── readme.j2
│   └── utils.py
├── tests/
│   ├── __init__.py
│   └── test_doctor.py
├── .gitignore
├── LICENSE
├── README.md
├── setup.cfg
├── setup.py
└── requirements.txt

目录结构介绍

• ansible_doctor/: 包含项目的主要代码文件。
  • __init__.py: 初始化文件。
  • config.py: 配置文件处理模块。
  • doctor.py: 主逻辑处理模块。
  • templates/: 包含 Jinja2 模板文件。
    • readme.j2: 默认的 README 模板文件。
  • utils.py: 工具函数模块。
• tests/: 包含项目的测试文件。
  • __init__.py: 初始化文件。
  • test_doctor.py: 测试主逻辑的测试文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

项目的启动文件是 ansible_doctor/doctor.py。这个文件包含了项目的主要逻辑，负责读取配置、处理模板和生成文档。

启动文件介绍

• doctor.py:
  • 负责读取 Ansible 角色目录。
  • 检查目录是否为有效的 Ansible 角色。
  • 读取静态文件并生成字典。
  • 使用 Jinja2 模板生成文档。

3. 项目的配置文件介绍

项目的配置文件是 ansible_doctor/config.py。这个文件负责处理项目的配置选项，包括环境变量和命令行参数。

配置文件介绍

• config.py:
  • 定义了默认配置选项。
  • 处理环境变量和命令行参数。
  • 提供配置选项给主逻辑模块使用。

配置选项包括：

• ANSIBLE_DOCTOR_CONFIG_FILE: 配置文件路径。
• ANSIBLE_DOCTOR_ROLE_DIR: Ansible 角色目录。
• ANSIBLE_DOCTOR_DRY_RUN: 是否为干运行模式。
• ANSIBLE_DOCTOR_LOG_LEVEL: 日志级别。
• ANSIBLE_DOCTOR_LOG_JSON: 是否以 JSON 格式记录日志。
• ANSIBLE_DOCTOR_OUTPUT_DIR: 输出目录。
• ANSIBLE_DOCTOR_TEMPLATE_DIR: 模板目录。
• ANSIBLE_DOCTOR_TEMPLATE: 使用的模板文件。
• ANSIBLE_DOCTOR_FORCE_OVERWRITE: 是否强制覆盖输出文件。
• ANSIBLE_DOCTOR_CUSTOM_HEADER: 自定义头部内容。
• ANSIBLE_DOCTOR_EXCLUDE_FILES: 排除的文件。

通过这些配置选项，用户可以灵活地调整 Ansible-Doctor 的行为以满足不同的需求。