Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

controller

package

Go to main page

Versions in this module

v0

v0.8.0

Dec 2, 2025

v0.7.2

Dec 2, 2025

Changes in this version

+ var ErrLoggerRequired = errors.New("logger is required")

type Device

+ BgpCommunity uint16

+ Code string

+ ContributorCode string

+ DevicePathologies []string

+ ExchangeCode string

+ LocationCode string

type Interface

+ LinkStatus serviceability.LinkStatus

type Option

+ func WithLogger(log *slog.Logger) Option

+ type StringsHelper struct

+ func (StringsHelper) ToUpper(s string) string

v0.6.3

Sep 8, 2025

Changes in this version

type Option

+ func WithDeviceLocalASN(asn uint32) Option

+ func WithEnvironment(env string) Option

v0.6.2

Sep 2, 2025

v0.6.1

Sep 2, 2025

Changes in this version

type Interface

+ IsLink bool

+ Metric uint32

type Option

+ func WithTLSConfig(tlsConfig *tls.Config) Option

v0.6.0

Aug 28, 2025

v0.5.3

Aug 19, 2025

Changes in this version

+ const ISISAreaID

+ const ISISAreaNumber

+ const ISISNSelector

+ const ISISSystemIDPadding

+ var ErrServiceabilityRequired = errors.New("serviceability program client is required")

+ type BgpPeer struct

+ PeerIP net.IP

+ PeerName string

type Device

+ Interfaces []Interface

+ Ipv4LoopbackIP net.IP

+ Ipv4LoopbackIntfName string

+ IsisNet string

+ MgmtVrf string

+ Vpn4vLoopbackIP net.IP

+ Vpn4vLoopbackIntfName string

+ type Interface struct

+ InterfaceType InterfaceType

+ Ip netip.Prefix

+ IsSubInterface bool

+ IsSubInterfaceParent bool

+ LoopbackType LoopbackType

+ Name string

+ NodeSegmentIdx uint16

+ VlanId uint16

+ func NewInterface(name string, vlanId uint16, ip netip.Prefix, nodeSegmentIdx uint16, ...) Interface

+ func (i Interface) GetParent() (Interface, error)

+ func (i Interface) IsIpv4Loopback() bool

+ func (i Interface) IsLoopback() bool

+ func (i Interface) IsPhysical() bool

+ func (i Interface) IsVlanInterface() bool

+ func (i Interface) IsVpnv4Loopback() bool

+ type InterfaceType uint8

+ const InterfaceTypeLoopback

+ const InterfaceTypePhysical

+ const InterfaceTypeUnknown

+ type LoopbackType uint8

+ const LoopbackTypeIpv4

+ const LoopbackTypePimRpAddr

+ const LoopbackTypeReserved

+ const LoopbackTypeUnknown

+ const LoopbackTypeVpnv4

type Option

+ func WithEnableInterfacesAndPeers() Option

+ func WithServiceabilityProgramClient(s ServiceabilityProgramClient) Option

+ type ServiceabilityProgramClient interface

+ GetProgramData func(context.Context) (*serviceability.ProgramData, error)

+ ProgramID func() solana.PublicKey

v0.4.0

Aug 4, 2025

Changes in this version

+ var BuildInfo = prometheus.NewGaugeVec(prometheus.GaugeOpts{ ... }, []string{ ... })

+ type Controller struct

+ func NewController(options ...Option) (*Controller, error)

+ func (c *Controller) GetConfig(ctx context.Context, req *pb.ConfigRequest) (*pb.ConfigResponse, error)

+ func (c *Controller) Run(ctx context.Context) error

+ type Device struct

+ PubKey string

+ PublicIP net.IP

+ TunnelSlots int

+ Tunnels []*Tunnel

+ func NewDevice(ip net.IP, publicKey string) *Device

+ type Option func(*Controller)

+ func WithAccountFetcher(f accountFetcher) Option

+ func WithListener(listener net.Listener) Option

+ func WithNoHardware() Option

+ func WithProgramId(programId string) Option

+ func WithRpcEndpoint(rpcEndpoint string) Option

+ func WithSignalChan(ch chan struct{}) Option

+ type Tunnel struct

+ Allocated bool

+ DzIp net.IP

+ Id int

+ IsMulticast bool

+ MulticastBoundaryList []net.IP

+ MulticastPublishers []net.IP

+ MulticastSubscribers []net.IP

+ OverlayDstIP net.IP

+ OverlaySrcIP net.IP

+ PubKey string

+ UnderlayDstIP net.IP

+ UnderlaySrcIP net.IP