aini

README

aini

Go library for Parsing Ansible inventory files.
We are trying to follow the logic of Ansible parser as close as possible.

Documentation on ansible inventory files can be found here:
https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html

Supported features:

• Variables
• Host patterns
• Nested groups

Public API

package aini // import "github.com/relex/aini"


TYPES

type Group struct {
        Name     string
        Vars     map[string]string
        Hosts    map[string]*Host
        Children map[string]*Group
        Parents  map[string]*Group
}
    Group represents ansible group

func GroupMapListValues(mymap map[string]*Group) []*Group
    GroupMapListValues transforms map of Groups into Group list

type Host struct {
        Name   string
        Port   int
        Vars   map[string]string
        Groups map[string]*Group
}
    Host represents ansible host

func HostMapListValues(mymap map[string]*Host) []*Host
    HostMapListValues transforms map of Hosts into Host list

type InventoryData struct {
        Groups map[string]*Group
        Hosts  map[string]*Host
}
    InventoryData contains parsed inventory representation Note: Groups and
    Hosts fields contain all the groups and hosts, not only top-level

func Parse(r io.Reader) (*InventoryData, error)
    Parse using some Reader

func ParseFile(f string) (*InventoryData, error)
    ParseFile parses Inventory represented as a file

func ParseString(input string) (*InventoryData, error)
    ParseString parses Inventory represented as a string

func (inventory *InventoryData) Match(m string) []*Host
    Match looks for a hosts that match the pattern

func (inventory *InventoryData) Reconcile()
    Reconcile ensures inventory basic rules, run after updates

Usage example

import (
    "strings"
    
    "github.com/relex/aini"
)

func main() {
    // Load from string example
    inventoryReader := strings.NewReader(`
	host1:2221
	[web]
	host2 ansible_ssh_user=root
    `)
    var inventory InventoryData = aini.Parse(inventoryReader)

    // Querying hosts
    _ = inventory.Hosts["host1"].Name == "host1"  // true
    _ = inventory.Hosts["host1"].Port == 2221     // true
    _ = inventory.Hosts["host2"].Name == "host2"] // true
    _ = inventory.Hosts["host2"].Post == 22]      // true
    
    _ = len(inventory.Hosts["host1"].Groups) == 2 // all, ungrouped
    _ = len(inventory.Hosts["host2"].Groups) == 2 // all, web
    
    _ = len(inventory.Match("host*")) == 2        // host1, host2

    _ = // Querying groups
    _ = inventory.Groups["web"].Hosts[0].Name == "host2" // true
    _ = len(inventory.Groups["all"].Hosts) == 2          // true
}

Documentation

Index

• type Group
  • func GroupMapListValues(mymap map[string]*Group) []*Group
• type Host
  • func HostMapListValues(mymap map[string]*Host) []*Host
• type InventoryData
  • func Parse(r io.Reader) (*InventoryData, error)
  • func ParseFile(f string) (*InventoryData, error)
  • func ParseString(input string) (*InventoryData, error)
  • func (inventory *InventoryData) Match(m string) []*Host
  • func (inventory *InventoryData) Reconcile()

Types

type Group

type Group struct {
	Name     string
	Vars     map[string]string
	Hosts    map[string]*Host
	Children map[string]*Group
	Parents  map[string]*Group
}

Group represents ansible group

func GroupMapListValues

func GroupMapListValues(mymap map[string]*Group) []*Group

GroupMapListValues transforms map of Groups into Group list

type Host

type Host struct {
	Name   string
	Port   int
	Vars   map[string]string
	Groups map[string]*Group
}

Host represents ansible host

func HostMapListValues

func HostMapListValues(mymap map[string]*Host) []*Host

HostMapListValues transforms map of Hosts into Host list

type InventoryData

type InventoryData struct {
	Groups map[string]*Group
	Hosts  map[string]*Host
}

InventoryData contains parsed inventory representation Note: Groups and Hosts fields contain all the groups and hosts, not only top-level

func Parse

func Parse(r io.Reader) (*InventoryData, error)

Parse using some Reader

func ParseFile

func ParseFile(f string) (*InventoryData, error)

ParseFile parses Inventory represented as a file

func ParseString

func ParseString(input string) (*InventoryData, error)

ParseString parses Inventory represented as a string

func (*InventoryData) Match

func (inventory *InventoryData) Match(m string) []*Host

Match looks for a hosts that match the pattern

func (*InventoryData) Reconcile

func (inventory *InventoryData) Reconcile()

Reconcile ensures inventory basic rules, run after updates