Gornir 开源项目使用教程

2024-08-24 01:02:01作者：滕妙奇

gornir

"Gornir，一款用Go编写的可扩展框架，用于便捷地管理和操作大量设备。类似Nornir，但采用Go语言实现。其目标是让您能轻松地对多个设备执行操作，如批量SSH连接和命令执行。通过插件系统支持库存管理、日志记录、输出处理及任务运行。示例代码清晰易懂，助您快速上手网络自动化。现在就加入，为您的设备管理工作注入速度与灵活性！"

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

Gornir 项目的目录结构如下：

gornir/
├── examples/
│   └── ...
├── pkg/
│   └── ...
├── .gitignore
├── .golangci.yml
├── .travis.yml
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── doc.go
├── docker-compose.yml
├── go.mod
├── go.sum

目录结构介绍

examples/: 包含项目的示例代码。
pkg/: 包含项目的核心包和插件。
.gitignore: Git 忽略文件列表。
.golangci.yml: GolangCI 配置文件。
.travis.yml: Travis CI 配置文件。
Dockerfile: Docker 构建文件。
LICENSE: 项目许可证（Apache-2.0）。
Makefile: 项目构建和测试的 Makefile。
README.md: 项目介绍和使用说明。
doc.go: 项目文档文件。
docker-compose.yml: Docker Compose 配置文件。
go.mod: Go 模块文件。
go.sum: Go 模块依赖校验文件。

2. 项目的启动文件介绍

Gornir 项目的启动文件是 main.go，位于 examples/ 目录下。以下是 main.go 的基本结构和功能介绍：

package main

import (
    "context"
    "os"
    "github.com/nornir-automation/gornir/pkg/gornir"
    "github.com/nornir-automation/gornir/pkg/plugins/connection"
    "github.com/nornir-automation/gornir/pkg/plugins/inventory"
    "github.com/nornir-automation/gornir/pkg/plugins/logger"
    "github.com/nornir-automation/gornir/pkg/plugins/output"
    "github.com/nornir-automation/gornir/pkg/plugins/runner"
    "github.com/nornir-automation/gornir/pkg/plugins/task"
)

func main() {
    log := logger.NewLogrus(false)
    file := "/go/src/github.com/nornir-automation/gornir/examples/hosts.yaml"
    plugin := inventory.FromYAML[HostsFile: file]
    inv, err := plugin.Create()
    if err != nil {
        log.Fatal(err)
    }
    gr := gornir.New().WithInventory(inv).WithLogger(log).WithRunner(runner.Parallel())
    // Open an SSH connection towards the devices
    results, err := gr.RunSync(context.Background(), &connection.SSHOpen[])
    if err != nil {
        log.Fatal(err)
    }
}

启动文件介绍

main.go: 主程序入口，初始化日志、库存、运行器等组件，并执行任务。
logger.NewLogrus(false): 初始化日志记录器。
inventory.FromYAML[HostsFile: file]: 从 YAML 文件加载库存信息。
gornir.New().WithInventory(inv).WithLogger(log).WithRunner(runner.Parallel()): 创建 Gornir 实例并配置库存、日志和运行器。
gr.RunSync(context.Background(), &connection.SSHOpen[]): 同步执行 SSH 连接任务。

3. 项目的配置文件介绍

Gornir 项目的配置文件主要包括 hosts.yaml 和 docker-compose.yml。

hosts.yaml

hosts.yaml 文件位于 examples/ 目录下，用于定义设备库存信息。以下是一个示例：

hosts:
  - name: device1
    hostname: 192.168.1.1
    username: admin
    password: password123
  - name: device2
    hostname: 192.168.1.2
    username: admin
    password: password123