Nornir 开源项目教程

Nornir 开源项目教程

nornirPluggable multi-threaded framework with inventory management to help operate collections of devices项目地址:https://gitcode.com/gh_mirrors/no/nornir

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

Nornir 项目的目录结构如下：

nornir/
├── docs/
├── nornir/
│   ├── core/
│   ├── plugins/
│   ├── utils/
│   └── ...
├── tests/
├── .dockerignore
├── .gitignore
├── .readthedocs.yml
├── CHANGELOG.rst
├── CONTRIBUTING.rst
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── SECURITY.md
├── poetry.lock
├── pyproject.toml
└── setup.cfg

目录介绍：

• docs/: 包含项目的文档文件。
• nornir/: 核心代码目录，包含核心模块、插件和工具。
  • core/: 核心功能模块。
  • plugins/: 插件模块。
  • utils/: 工具模块。
• tests/: 测试代码目录。
• .dockerignore: Docker 忽略文件。
• .gitignore: Git 忽略文件。
• .readthedocs.yml: Readthedocs 配置文件。
• CHANGELOG.rst: 变更日志文件。
• CONTRIBUTING.rst: 贡献指南文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 许可证文件。
• Makefile: Makefile 文件。
• README.md: 项目介绍文件。
• SECURITY.md: 安全政策文件。
• poetry.lock: Poetry 锁定文件。
• pyproject.toml: Poetry 配置文件。
• setup.cfg: 安装配置文件。

2. 项目的启动文件介绍

Nornir 项目的启动文件主要是 nornir/__init__.py，这个文件负责初始化 Nornir 项目并导入必要的模块。

# nornir/__init__.py
from nornir.core import Nornir
from nornir.init_nornir import InitNornir
from nornir.plugins import tasks
from nornir.utils import print_result

__all__ = ("Nornir", "InitNornir", "tasks", "print_result")

启动文件介绍：

• Nornir: 核心类，用于管理设备和任务。
• InitNornir: 初始化类，用于初始化 Nornir 实例。
• tasks: 任务模块，包含各种任务插件。
• print_result: 工具函数，用于打印任务结果。

3. 项目的配置文件介绍

Nornir 项目的配置文件主要是 nornir.yaml，这个文件用于配置 Nornir 实例的各种参数。

# nornir.yaml
inventory:
  plugin: SimpleInventory
  options:
    host_file: "inventory/hosts.yaml"
    group_file: "inventory/groups.yaml"
    defaults_file: "inventory/defaults.yaml"

runner:
  plugin: threaded
  options:
    num_workers: 20

logging:
  enabled: true
  level: DEBUG
  file: "nornir.log"

配置文件介绍：

• inventory: 配置库存插件和选项。
  • plugin: 库存插件类型。
  • options: 库存插件选项。
    • host_file: 主机文件路径。
    • group_file: 组文件路径。
    • defaults_file: 默认配置文件路径。
• runner: 配置任务执行器插件和选项。
  • plugin: 执行器插件类型。
  • options: 执行器插件选项。
    • num_workers: 工作线程数。
• logging: 配置日志记录。
  • enabled: 是否启用日志。
  • level: 日志级别。
  • file: 日志文件路径。

以上是 Nornir 开源项目的教程，包含了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

nornirPluggable multi-threaded framework with inventory management to help operate collections of devices项目地址:https://gitcode.com/gh_mirrors/no/nornir