bird

Documentation

Index

• Constants
• func CheckCli(ctx context.Context, lp string) error
• func CliCmd(ctx context.Context, lp string, arg ...string) (string, error)
• func Configure(ctx context.Context, lp, configFile string) (string, error)
• func LookupCli() (string, error)
• func NewProtocolMap() protocolMap
• func ParseProtocols(input string, out *string, f func(name string, options ...Option))
• func ProtocolDown(p *Protocol) bool
• func Run(ctx context.Context, configFile string, monitorLogs bool) error
• func ShowBfdSessions(ctx context.Context, lp, name string) (string, error)
• func ShowProtocolSessions(ctx context.Context, lp, pattern string) (string, error)
• func Verify(ctx context.Context, lp, configFile string) (string, error)
• type Option
  • func WithBfd(use bool) Option
  • func WithBfdSessions(bfd string) Option
  • func WithInfo(info string) Option
  • func WithInterface(itf string) Option
  • func WithName(name string) Option
  • func WithNeighbor(ip string) Option
  • func WithOutLog(log *string) Option
  • func WithProto(proto string) Option
  • func WithState(state string) Option
• type Protocol
  • func NewProtocol(options ...Option) *Protocol
  • func (p *Protocol) Bfd() bool
  • func (p *Protocol) BfdSessions() string
  • func (p *Protocol) Info() string
  • func (p *Protocol) Interface() string
  • func (p *Protocol) Log(out string)
  • func (p *Protocol) Name() string
  • func (p *Protocol) Neighbor() string
  • func (p *Protocol) Proto() string
  • func (p *Protocol) State() string

Constants

const (
	NoProtocolsLog     string = "No protocols match"
	ReconfigInProgress string = "Reconfiguration in progress"
	Reconfigured       string = "Reconfigured"
	ConfigurationOk    string = "Configuration OK"
)

const (
	BGP    string = "BGP"
	STATIC string = "Static"
)

Functions

func CheckCli

func CheckCli(ctx context.Context, lp string) error

CheckCli - Checks if birdc is available

func CliCmd

func CliCmd(ctx context.Context, lp string, arg ...string) (string, error)

CliCmd - Executes birdc commands

func Configure

func Configure(ctx context.Context, lp, configFile string) (string, error)

Configure - Orders BIRD via birdc to (try and) apply the config

func LookupCli

func LookupCli() (string, error)

LookupCli - Looks up birdc path

func NewProtocolMap

func NewProtocolMap() protocolMap

func ParseProtocols

func ParseProtocols(input string, out *string, f func(name string, options ...Option))

ParseProtocols - Parses output of 'birdc show protocols all' to pass details of a protocol session to the provided func pointer (while also writing relevant information to out log string)

func ProtocolDown

func ProtocolDown(p *Protocol) bool

ProtocolDown - Determines if protocol is down

func Run

func Run(ctx context.Context, configFile string, monitorLogs bool) error

Run - Starts BIRD process with the config file (blocks) Based on monitorLogs settings stderr of the started BIRD process can be monitored, so that important log snippets get appended to the container's log

func ShowBfdSessions

func ShowBfdSessions(ctx context.Context, lp, name string) (string, error)

ShowProtocolSessions - Retrieves information on the available BFD sessions (for the given BFD protocol name if any)

func ShowProtocolSessions

func ShowProtocolSessions(ctx context.Context, lp, pattern string) (string, error)

ShowProtocolSessions - Retrieves detailed routing protocol information via birdc

func Verify

func Verify(ctx context.Context, lp, configFile string) (string, error)

Verify - Verifies content of config file via birdc

Types

type Option

type Option func(o *protoOptions)

Option is an option pattern for NewProtocol

func WithBfd

func WithBfd(use bool) Option

WithBfd sets bfd indicating the protocol uses bfd

func WithBfdSessions

func WithBfdSessions(bfd string) Option

WithBfdSessions sets known bfd sessions

func WithInfo

func WithInfo(info string) Option

WithInfo sets protocol info (e.g. Established)

func WithInterface

func WithInterface(itf string) Option

WithInterface sets protocol interface (e.g. ext-vlan)

func WithName

func WithName(name string) Option

WithProtocolName sets protocol name

func WithNeighbor

func WithNeighbor(ip string) Option

WithNeighbor sets protocol neighbor (e.g. 169.254.100.254)

func WithOutLog

func WithOutLog(log *string) Option

WithOutLog sets out log

func WithProto

func WithProto(proto string) Option

WithProtocolName sets protocol type (e.g. BGP, Static)

func WithState

func WithState(state string) Option

WithState sets protocol state (e.g. up)

type Protocol

type Protocol struct {
	// contains filtered or unexported fields
}

func NewProtocol

func NewProtocol(options ...Option) *Protocol

func (*Protocol) Bfd

func (p *Protocol) Bfd() bool

func (*Protocol) BfdSessions

func (p *Protocol) BfdSessions() string

func (*Protocol) Info

func (p *Protocol) Info() string

func (*Protocol) Interface

func (p *Protocol) Interface() string

func (*Protocol) Log

func (p *Protocol) Log(out string)

func (*Protocol) Name

func (p *Protocol) Name() string

func (*Protocol) Neighbor

func (p *Protocol) Neighbor() string

func (*Protocol) Proto

func (p *Protocol) Proto() string

func (*Protocol) State

func (p *Protocol) State() string