Aug 4, 2020
README
gornir
Gornir is a pluggable framework with inventory management to help operate collections of devices. It's similar to nornir but in golang.
The goal is to be able to operate on many devices with little effort. For instance:
package main
import (
"os"
"github.com/nornir-automation/gornir/pkg/gornir"
"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())
results, err := gr.RunSync(
"What's my ip?",
&task.RemoteCommand{Command: "ip addr | grep \\/24 | awk '{ print $2 }'"},
)
if err != nil {
log.Fatal(err)
}
output.RenderResults(os.Stdout, results, true)
}
would render:
# What's my ip?
@ dev5.no_group
- err: failed to dial: ssh: handshake failed: ssh: unable to authenticate, attempted methods [none password], no supported methods remain
@ dev1.group_1
* Stdout: 10.21.33.101/24
* Stderr:
- err: <nil>
@ dev2.group_1
* Stdout: 10.21.33.102/24
* Stderr:
- err: <nil>
@ dev3.group_2
* Stdout: 10.21.33.103/24
* Stderr:
- err: <nil>
@ dev4.group_2
* Stdout: 10.21.33.104/24
* Stderr:
- err: <nil>
Examples
You can see more examples in the examples folder and run them with Docker-Compose as follows:
- Create a development enviroment
make start-dev-env
- Run any of the examples in the examples folder with
make example. Specify the name of the example withEXAMPLE; for instance2_simple_with_filter.
make example EXAMPLE=2_simple_with_filter
- After you are done, make sure you stop the development enviroment
make stop-dev-env
The project is still work in progress and feedback/help is welcomed.
Documentation
Overview ¶
Package gornir provides a pluggable framework with inventory management to help operate collections of devices. It's similar to https://github.com/nornir-automation/nornir/ but in Go.
The goal is to be able to operate on many devices with little effort. For instance:
package main
import (
"os"
"github.com/nornir-automation/gornir/pkg/gornir"
"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())
results, err := gr.RunSync(
"What's my ip?",
&task.RemoteCommand{Command: "ip addr | grep \\/24 | awk '{ print $2 }'"},
)
if err != nil {
log.Fatal(err)
}
output.RenderResults(os.Stdout, results, true)
}
would render:
# What's my ip? @ dev5.no_group - err: failed to dial: ssh: handshake failed: ssh: unable to authenticate, attempted methods [none password], no supported methods remain @ dev1.group_1 * Stdout: 10.21.33.101/24 * Stderr: - err: <nil> @ dev2.group_1 * Stdout: 10.21.33.102/24 * Stderr: - err: <nil> @ dev3.group_2 * Stdout: 10.21.33.103/24 * Stderr: - err: <nil> @ dev4.group_2 * Stdout: 10.21.33.104/24 * Stderr: - err: <nil>
You can see more examples here: https://github.com/nornir-automation/gornir/tree/master/examples
Source Files
Directories
| Path | Synopsis |
|---|---|
| examples/1_simple | this is the simplest example possible |
| examples/1_simple_processor | this example is similar to 1_simple but it uses processors to render the result instead |
| examples/2_simple_with_filter | Similar to the simple example but filtering the hosts |
| examples/2_simple_with_filter_bis | Similar to the simple_with_filter but leveraging included filters |
| examples/3_grouped_simple | Here is an example of how we can compose tasks |
| examples/4_advanced_1 | In this example we can see how we can call the runner asynchronously |
| examples/5_advanced_2 | In this example we can see how we can call the runner asynchronously and process the results without having to wait for all the hosts to complete |
| examples/6_custom_ssh_config | this is the simplest example possible |
| pkg/gornir | Package gornir implements the core functionality and define the needed interfaces to integrate with the framework |
| pkg/plugins/connection | Package connection implements various Connection plugins that can be run over Hosts |
| pkg/plugins/filter | Package filter provides a collection of gornir.FilterFunc |
| pkg/plugins/inventory | Package inventory implements various plugins to instantiate and populate a gornir.Inventor object |
| pkg/plugins/logger | Package logger implements various plugins to log events |
| pkg/plugins/output | Package output implements functions to help processing the results |
| pkg/plugins/processor | Package processor implements plugins to process the task events and results |
| pkg/plugins/runner | Package runner implements various plugins that can be used to defined the strategy to execute tasks over hosts |
| pkg/plugins/task | Package task implements various Task plugins that can be run over Hosts |
Valid 
Tagged version