znet

Documentation

Index

• func NewRedisClient(host string) (*redis.Client, error)
• type AEInterface
• type BGP
• type BGPGroup
• type Config
  • func (c *Config) Room(name string) (Room, error)
• type Data
• type EnvironmentConfig
• type EthernetInterface
• type EthernetSwitching
• type HTTPConfig
• type HostData
• type HueConfig
• type IRBInterface
• type JunosConfig
• type LDAPConfig
• type Listener
  • func NewListener(config *Config) (*Listener, error)
  • func (l *Listener) Listen(listenAddr string, ch chan bool)
  • func (l *Listener) Shutdown()
• type NatsConfig
• type NetworkHost
• type NetworkZone
• type RedisConfig
• type Room
• type RouterAdvertisement
• type Security
• type SecurityNATRule
• type SecurityNATRuleMatch
• type SecurityNATRuleSet
• type SecurityPolicies
• type SecurityPolicy
• type SecurityZone
• type SecurityZoneInterface
• type SimpleSecurityPolicy
• type VLAN
• type VaultConfig
• type Znet
  • func NewZnet(file string) *Znet
  • func (z *Znet) ConfigureNetworkHost(host *NetworkHost, commit bool, auth *junos.AuthMethod) error
  • func (z *Znet) DataForDevice(host NetworkHost) HostData
  • func (z *Znet) GetNetworkHosts(l *ldap.Conn, baseDN string) ([]NetworkHost, error)
  • func (z *Znet) GetNetworkZones(l *ldap.Conn, baseDN string) []NetworkZone
  • func (z *Znet) HierarchyForDevice(host NetworkHost) []string
  • func (z *Znet) Listen(listenAddr string, ch chan bool)
  • func (z *Znet) LoadConfig(file string)
  • func (z *Znet) LoadData(configDir string)
  • func (z *Znet) LoadEnvironment() error
  • func (z *Znet) NewLDAPClient(config LDAPConfig) (*ldap.Conn, error)
  • func (z *Znet) NewSecretClient(config VaultConfig) (*api.Client, error)
  • func (z *Znet) RenderHostTemplateFile(host NetworkHost, path string) string
  • func (z *Znet) TemplateStringsForDevice(host NetworkHost, templates []string) []string
  • func (z *Znet) TemplatesForDevice(host NetworkHost) []string

Functions

func NewRedisClient

func NewRedisClient(host string) (*redis.Client, error)

Types

type AEInterface

type AEInterface struct {
	Description string `yaml:"description"`
	Name        string `yaml:"name"`
	MTU         int    `yaml:"mtu"`
	Options     struct {
		MinimumLinks int      `yaml:"minimum_links"`
		LACP         []string `yaml:"lacp"`
	} `yaml:"options"`
	EthernetSwitching EthernetSwitching `yaml:"ethernet_switching"`
}

type BGP

type BGP struct {
	Groups []BGPGroup `yaml:"groups"`
}

type BGPGroup

type BGPGroup struct {
	Name      string   `yaml:"name"`
	Type      string   `yaml:"type"`
	ASN       int      `yaml:"asn"`
	Neighbors []string `yaml:"neighbors"`
	Import    []string `yaml:"import"`
	Export    []string `yaml:"export"`
}

type Config

type Config struct {
	Rooms        []Room              `yaml:"rooms,omitempty"`
	Endpoint     string              `yaml:"endpoint,omitempty"`
	Environments []EnvironmentConfig `yaml:"environments,omitempty"`
	Nats         NatsConfig          `yaml:"nats,omitempty"`
	Hue          HueConfig           `yaml:"hue,omitempty"`
	Junos        JunosConfig         `yaml:"junos,omitempty"`
	Redis        RedisConfig         `yaml:"redis,omitempty"`
	HTTP         HTTPConfig          `yaml:"http,omitempty"`
	LDAP         LDAPConfig          `yaml:"ldap,omitempty"`
	Vault        VaultConfig         `yaml:"vault,omitempty"`
}

Config stores the items that are required to configure this project.

func (*Config) Room

func (c *Config) Room(name string) (Room, error)

type Data

type Data struct {
	TemplateDir   string   `yaml:"template_dir"`
	TemplatePaths []string `yaml:"template_paths"`
	DataDir       string   `yaml:"data_dir"`
	Hierarchy     []string `yaml:"hierarchy"`
}

type EnvironmentConfig

type EnvironmentConfig struct {
	Name         string   `yaml:"name,omitempty"`
	SecretValues []string `yaml:"secret_values,omitempty"`
}

type EthernetInterface

type EthernetInterface struct {
	Description       string            `yaml:"description"`
	EthernetSwitching EthernetSwitching `yaml:"ethernet_switching"`
	EthernetOptions   []string          `yaml:"ethernet_options"`
	MTU               int               `yaml:"mtu"`
	Name              string            `yaml:"name"`
	NativeVlanId      int               `yaml:"native_vlan_id"`
}

type EthernetSwitching

type EthernetSwitching struct {
	Mode         string   `yaml:"mode"`
	StormControl string   `yaml:"storm_control"`
	VLANs        []string `yaml:"vlans"`
}

type HTTPConfig

type HTTPConfig struct {
	ListenAddress string
}

type HostData

type HostData struct {
	NTPServers            []string              `yaml:"ntp_servers"`
	DHCPServer            string                `yaml:"dhcp_server"`
	DHCPForwardInterfaces []string              `yaml:"dhcp_forward_interfaces"`
	LLDPInterfaces        []string              `yaml:"lldp_interfaces"`
	IRBInterfaces         []IRBInterface        `yaml:"irb_interfaces"`
	AEInterfaces          []AEInterface         `yaml:"ae_interfaces"`
	EthernetInterfaces    []EthernetInterface   `yaml:"eth_interfaces"`
	RouterAdvertisements  []RouterAdvertisement `yaml:"router_advertisements"`
	BGP                   BGP                   `yaml:"bgp"`
	Security              Security              `yaml:"security"`
	VLANs                 []VLAN                `yaml:"vlans"`
}

type HueConfig

type HueConfig struct {
	Endpoint string `yaml:"endpoint"`
	User     string `yaml:"user"`
}

type IRBInterface

type IRBInterface struct {
	Unit  string   `yaml:"unit"`
	Inet  []string `yaml:"inet"`
	Inet6 []string `yaml:"inet6"`
	MTU   int      `yaml:"mtu"`
}

type JunosConfig

type JunosConfig struct {
	Hosts      []string
	Username   string
	PrivateKey string
}

type LDAPConfig

type LDAPConfig struct {
	BaseDN string
	BindDN string
	BindPW string
	Host   string
}

type Listener

type Listener struct {
	Config *Config
	// contains filtered or unexported fields
}

Listener is a znet server

func NewListener

func NewListener(config *Config) (*Listener, error)

NewListener builds a new Listener object from the received configuration.

func (*Listener) Listen

func (l *Listener) Listen(listenAddr string, ch chan bool)

Listen starts the http listener

func (*Listener) Shutdown

func (l *Listener) Shutdown()

Shutdown closes down the to the message bus and shuts down the HTTP server.

type NatsConfig

type NatsConfig struct {
	URL   string
	Topic string
}

type NetworkHost

type NetworkHost struct {
	Name        string
	HostName    string
	Domain      string
	Platform    string
	Group       string
	Role        string
	DeviceType  string
	Data        HostData
	Watch       bool
	Description string
	MACAddress  []string
	Environment map[string]string
}

NetworkHost is a device that connects to the network.

type NetworkZone

type NetworkZone struct {
	Name       string
	NTPServers []string
}

type RedisConfig

type RedisConfig struct {
	Host string
}

type Room

type Room struct {
	Name   string `yaml:"name"`
	IDs    []int  `yaml:"ids"`
	HueIDs []int  `yaml:"hue"`
}

type RouterAdvertisement

type RouterAdvertisement struct {
	Interface string `yaml:"interface"`
	DNSServer string `yaml:"dns_server"`
	Prefix    string `yaml:"prefix"`
}

type Security

type Security struct {
	Zones          []SecurityZone         `yaml:"zones"`
	Policies       []SecurityPolicies     `yaml:"policies"`
	SimplePolicies []SimpleSecurityPolicy `yaml:"simple_policies"`
	NATRuleSets    []SecurityNATRuleSet   `yaml:"nat_rulesets"`
}

type SecurityNATRule

type SecurityNATRule struct {
	Name  string               `yaml:"name"`
	Match SecurityNATRuleMatch `yaml:"match"`
}

type SecurityNATRuleMatch

type SecurityNATRuleMatch struct {
	SourceAddressNames []string `yaml:"source_address_names"`
	SourceAddress      []string `yaml:"source_address"`
}

type SecurityNATRuleSet

type SecurityNATRuleSet struct {
	Name  string            `yaml:"name"`
	From  string            `yaml:"from_zone"`
	To    string            `yaml:"to_zone"`
	Rules []SecurityNATRule `yaml:"rules"`
}

type SecurityPolicies

type SecurityPolicies struct {
	From     string           `yaml:"from"`
	To       string           `yaml:"to"`
	Policies []SecurityPolicy `yaml:"policies"`
}

type SecurityPolicy

type SecurityPolicy struct {
	Name  string   `yaml:"name"`
	Match []string `yaml:"match"`
	Then  []string `yaml:"then"`
}

type SecurityZone

type SecurityZone struct {
	Name           string                  `yaml:"name"`
	Screen         string                  `yaml:"screen"`
	SystemServices []string                `yaml:"system_services"`
	Protocols      []string                `yaml:"protocols"`
	Interfaces     []SecurityZoneInterface `yaml:"interfaces"`
}

type SecurityZoneInterface

type SecurityZoneInterface struct {
	Name           string   `yaml:"name"`
	SystemServices []string `yaml:"system_services"`
}

type SimpleSecurityPolicy

type SimpleSecurityPolicy struct {
	From string   `yaml:"from"`
	To   []string `yaml:"to"`
	Then string   `yaml:"then"`
}

type VLAN

type VLAN struct {
	Name        string `yaml:"name"`
	ID          int    `yaml:"id"`
	Description string `yaml:"description"`
	L3Interface string `yaml:"l3_interface"`
}

type VaultConfig

type VaultConfig struct {
	Host      string
	TokenPath string `yaml:"token_path,omitempty"`
	VaultPath string `yaml:"vault_path,omitempty"`
}

type Znet

type Znet struct {
	ConfigDir   string
	Config      Config
	Data        Data
	Environment map[string]string
	// contains filtered or unexported fields
}

Znet is the core object for this project. It keeps track of the data, configuration and flow control for starting the server process.

func NewZnet

func NewZnet(file string) *Znet

NewZnet creates and returns a new Znet object.

func (*Znet) ConfigureNetworkHost

func (z *Znet) ConfigureNetworkHost(host *NetworkHost, commit bool, auth *junos.AuthMethod) error

ConfigureNetworkHost renders the templates using associated data for a network host. The hosts about which to load the templates, are retrieved from LDAP.

func (*Znet) DataForDevice

func (z *Znet) DataForDevice(host NetworkHost) HostData

DataForDevice returns HostData for a given NetworkHost.

func (*Znet) GetNetworkHosts

func (z *Znet) GetNetworkHosts(l *ldap.Conn, baseDN string) ([]NetworkHost, error)

GetNetworkHosts retrieves the NetworkHost objects from LDAP given an LDPA connection and baseDN.

func (*Znet) GetNetworkZones

func (z *Znet) GetNetworkZones(l *ldap.Conn, baseDN string) []NetworkZone

func (*Znet) HierarchyForDevice

func (z *Znet) HierarchyForDevice(host NetworkHost) []string

HierarchyForDevice retuns a list of file paths to consult for the data hierarchy.

func (*Znet) Listen

func (z *Znet) Listen(listenAddr string, ch chan bool)

Listen starts the znet listener

func (*Znet) LoadConfig

func (z *Znet) LoadConfig(file string)

LoadConfig receives a file path for a configuration to load.

func (*Znet) LoadData

func (z *Znet) LoadData(configDir string)

LoadData receives a configuration directory from which to load the data for Znet.

func (*Znet) LoadEnvironment

func (z *Znet) LoadEnvironment() error

func (*Znet) NewLDAPClient

func (z *Znet) NewLDAPClient(config LDAPConfig) (*ldap.Conn, error)

NewLDAPClient constructs an LDAP client to return.

func (*Znet) NewSecretClient

func (z *Znet) NewSecretClient(config VaultConfig) (*api.Client, error)

NewSecretClient receives a configuration and returns a client for Vault.

func (*Znet) RenderHostTemplateFile

func (z *Znet) RenderHostTemplateFile(host NetworkHost, path string) string

RenderHostTemplateFile renders a template file using a Host object.

func (*Znet) TemplateStringsForDevice

func (z *Znet) TemplateStringsForDevice(host NetworkHost, templates []string) []string

TemplateStringsForDevice renders a list of template strings given a host.

func (*Znet) TemplatesForDevice

func (z *Znet) TemplatesForDevice(host NetworkHost) []string

TemplatesForDevice returns a list of template paths for a given host.