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
- API
  
  Reference documentation for the pkg.go.dev API
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

kernelforward

package

Go to main page

Versions in this module

v4

v4.2.1

Oct 12, 2026

v4.2.0

Oct 11, 2026

Changes in this version

+ const CheckFailed

+ const CheckInconclusive

+ const CheckOK

+ const CheckSkipped

+ const CodeAgentError

+ const CodeAgentTimeout

+ const CodeApplyFailed

+ const CodeBindingExists

+ const CodeCircuitOpen

+ const CodeControlUDP

+ const CodeDeadline

+ const CodeEntryHostnameRequired

+ const CodeHealthy

+ const CodeHopError

+ const CodeHostnameMismatch

+ const CodeImmutable

+ const CodeInvalidFormat

+ const CodeNameTaken

+ const CodeNeverReported

+ const CodeNoHealth

+ const CodeNodeOffline

+ const CodeNodeVantageUnavailable

+ const CodeNotApplied

+ const CodeNotPlanned

+ const CodeNotPublic

+ const CodeProviderInUse

+ const CodeReachable

+ const CodeRequired

+ const CodeRouteEnforced

+ const CodeRoutePaused

+ const CodeSecretStoreUnavailable

+ const CodeTargetNotAllowed

+ const CodeUnhealthy

+ const CodeUnknownField

+ const CodeUnknownProvider

+ const CodeUnknownRoute

+ const CodeUnreachable

+ const DNSAddAfter

+ const DNSDefaultTTL

+ const DNSEvaluateInterval

+ const DNSMaxTTL

+ const DNSMinPublishInterval

+ const DNSModeCNAME

+ const DNSModeDDNS

+ const DNSPresenceStaleAfter

+ const DNSProviderBurst

+ const DNSProviderRefill

+ const DNSRemoveAfter

+ const DNSReportStaleAfter

+ const DNSResyncInterval

+ const DNSRetryBase

+ const DNSRetryMax

+ const DefaultDiagnoseTimeout

+ const DefaultPortFirst

+ const DefaultPortLast

+ const DiagnoseCacheTTL

+ const EnforcedExpired

+ const EnforcedQuota

+ const MaintenanceInterval

+ const MaxConcurrentDiagnoses

+ const MaxDiagnoseTimeout

+ const MaxNodeAddresses

+ const MaxNodeLabels

+ const MaxRequestID

+ const MaxReservedPorts

+ const MaxTrafficBuckets

+ const MaxTrafficWindow

+ const RecoveryOperator

+ const RecoveryPlan

+ const RecoveryReport

+ const ReleaseGrace

+ const RequestRetention

+ var DefaultReservedPorts = []uint32

+ var ErrCheckUnavailable = errors.New("the node's Agent cannot run forward checks")

+ var ErrDNSBindingNotFound = errors.New("forward dns binding not found")

+ var ErrDNSProviderNotFound = errors.New("forward dns provider not found")

+ var ErrDNSPurge = errors.New("forward dns: the provider did not delete the published records")

+ var ErrDiagnoseBusy = errors.New("too many route diagnoses are running; retry shortly")

+ var ErrInvalidReport = errors.New("invalid forward report")

+ var ErrInvalidRequest = errors.New("invalid forward request")

+ var ErrNoState = errors.New("forward node has no stored forwarding state")

+ var ErrNodeNotFound = errors.New("forward node not found")

+ var ErrNotFound = errors.New("forward route not found")

+ var ErrRequestConflict = errors.New("request_id was used for another request")

+ var ErrRevisionMismatch = errors.New("forward route revision does not match")

+ func NodeConfigMember(db *gorm.DB, node agentcontrol.AgentNode) (negotiated bool, member map[string]any, err error)

+ func OnStateChange(listener StateListener) (cancel func())

+ func WritePrometheus(body *strings.Builder, db *gorm.DB)

+ type Authorizer interface

+ AuthorizeCapability func(ctx context.Context, host packagebridge.HostIdentity, capability string) error

+ type CheckItem struct

+ Code string

+ Message string

+ Protocol string

+ RTTMicro uint32

+ Status string

+ Target string

+ type CheckResult struct

+ Check string

+ Code string

+ Generation uint64

+ HopIndex uint32

+ Items []CheckItem

+ Message string

+ OperationID string

+ RouteID string

+ Status string

+ type Convergence struct

+ Applied bool

+ Desired uint64

+ Generation uint64

+ HopErrors int

+ NodeRef string

+ ObservedAt time.Time

+ Reported bool

+ func NodeConvergence(ctx context.Context, db *gorm.DB) ([]Convergence, error)

+ func (c Convergence) Converged() bool

+ func (c Convergence) Lag() uint64

+ type DNSRefusedError struct

+ Precondition bool

+ Violations []*forwardv1.Violation

+ func (e *DNSRefusedError) Error() string

+ type EntryHA struct

+ LocalSession func(node agentcontrol.AgentNode) bool

+ Service *Service

+ func (e *EntryHA) Evaluate(ctx context.Context) error

+ func (e *EntryHA) Run(ctx context.Context)

+ type ListOptions struct

+ NodeRef string

+ Owner string

+ PageSize uint32

+ PageToken string

+ type NodeChecker interface

+ Check func(ctx context.Context, node agentcontrol.AgentNode, action string, ...) (*CheckResult, error)

+ Vantage func(node agentcontrol.AgentNode) NodeVantage

+ type NodeFilter struct

+ Kind string

+ Transport forwardv1.NodeTransport

+ type NodeReset struct

+ Generation uint64

+ NodeRef string

+ Previous uint64

+ Reported uint64

+ StateHash string

+ type NodeSettings struct

+ Addresses []string

+ Labels map[string]string

+ PortFirst uint32

+ PortLast uint32

+ ReservedPorts []uint32

+ func SettingsFromProto(settings *forwardv1.NodeSettings) NodeSettings

+ type NodeStatus struct

+ Capabilities *forwardv1.NodeCapabilities

+ Info *forwardv1.NodeInfo

+ Negotiated bool

+ NodeRef string

+ ReportedAt *time.Time

+ ReservedPorts []uint32

+ type NodeVantage struct

+ Capable bool

+ Connected bool

+ Note string

+ type PlanOutcome struct

+ Changed []string

+ Refused bool

+ Violations []planner.RouteViolation

+ Warnings []string

+ type PlanStatus struct

+ PlannedAt *time.Time

+ Reason string

+ Refused bool

+ Revision uint64

+ Violations []*forwardv1.Violation

+ Warnings []string

+ type RefusedError struct

+ Precondition bool

+ Violations []planner.RouteViolation

+ func (e *RefusedError) Error() string

+ func (e *RefusedError) ProtoViolations() []*forwardv1.Violation

+ type ReportResult struct

+ Metered int

+ Recovered bool

+ Replanned bool

+ Stored bool

+ type RouteTraffic = model.KernelForwardTraffic

+ type Server struct

+ Authorizer Authorizer

+ Service *Service

+ func (s *Server) For(host packagebridge.HostIdentity) forwardv1.ForwardControlServer

+ type Service struct

+ AnixOps func() bool

+ Checks NodeChecker

+ Cluster func() string

+ DB *gorm.DB

+ DNSKEK func() string

+ NewDNSProvider func(kind string, config, credentials map[string]string) (forwardddns.Provider, error)

+ Now func() time.Time

+ Probes service.DiagnosisProbes

+ func New(db *gorm.DB) *Service

+ func (s *Service) CreateDNSBinding(ctx context.Context, requestID string, binding *forwardv1.DnsBinding) (*forwardv1.DnsBinding, error)

+ func (s *Service) CreateDNSProvider(ctx context.Context, requestID string, provider *forwardv1.DnsProvider, ...) (*forwardv1.DnsProvider, error)

+ func (s *Service) CreateForwardNode(ctx context.Context, requestID string, nodeRecord *forwardv1.ForwardNodeRecord, ...) (*forwardv1.NodeSummary, error)

+ func (s *Service) CreateRoute(ctx context.Context, requestID string, route *forwardv1.Route) (*forwardv1.Route, error)

+ func (s *Service) DeleteDNSBinding(ctx context.Context, requestID string, id uint64, purge bool) error

+ func (s *Service) DeleteDNSProvider(ctx context.Context, requestID string, id uint64) error

+ func (s *Service) DeleteForwardNode(ctx context.Context, requestID string, id uint64) error

+ func (s *Service) DeleteRoute(ctx context.Context, requestID, routeID string) error

+ func (s *Service) DiagnoseRoute(ctx context.Context, routeID string, timeout time.Duration) (*forwardv1.DiagnoseRouteResponse, error)

+ func (s *Service) Enforcement(ctx context.Context, routeIDs []string) (map[string]string, error)

+ func (s *Service) GetDNSProvider(ctx context.Context, id uint64) (*forwardv1.DnsProvider, error)

+ func (s *Service) GetNode(ctx context.Context, nodeRef string) (*forwardv1.GetNodeResponse, error)

+ func (s *Service) GetRoute(ctx context.Context, routeID string) (*forwardv1.Route, error)

+ func (s *Service) LatestReport(ctx context.Context, nodeRef string) (*forwardv1.NodeForwardReport, bool, error)

+ func (s *Service) ListDNSBindings(ctx context.Context, routeID string, providerID uint64) ([]*forwardv1.DnsBinding, error)

+ func (s *Service) ListDNSProviders(ctx context.Context) ([]*forwardv1.DnsProvider, error)

+ func (s *Service) ListNodes(ctx context.Context, filter NodeFilter) ([]*forwardv1.NodeSummary, error)

+ func (s *Service) ListRoutes(ctx context.Context, opts ListOptions) ([]*forwardv1.Route, string, error)

+ func (s *Service) Maintain(ctx context.Context) error

+ func (s *Service) Nodes(ctx context.Context) ([]NodeStatus, error)

+ func (s *Service) PlanRoute(ctx context.Context, request *forwardv1.PlanRouteRequest) (*forwardv1.PlanRouteResponse, error)

+ func (s *Service) PlanStatus(ctx context.Context) (PlanStatus, error)

+ func (s *Service) RecordHello(ctx context.Context, node agentcontrol.AgentNode, ...) (outcome PlanOutcome, replanned bool, err error)

+ func (s *Service) RecordReport(ctx context.Context, node agentcontrol.AgentNode, ...) (ReportResult, error)

+ func (s *Service) Replan(ctx context.Context, reason string) (PlanOutcome, error)

+ func (s *Service) ResetNode(ctx context.Context, nodeRef string) (NodeReset, error)

+ func (s *Service) RouteDNS(ctx context.Context, routeID string) (*forwardv1.RouteDnsStatus, error)

+ func (s *Service) RouteHealth(ctx context.Context, routeID string) ([]*forwardv1.UpstreamHealth, error)

+ func (s *Service) RouteStats(ctx context.Context, routeID string) ([]*forwardv1.Counters, error)

+ func (s *Service) Run(ctx context.Context)

+ func (s *Service) SetNodeSettings(ctx context.Context, node agentcontrol.AgentNode, settings NodeSettings) (PlanOutcome, error)

+ func (s *Service) SetNodeSettingsAnswer(ctx context.Context, nodeRef string, settings NodeSettings) (*forwardv1.SetNodeSettingsResponse, error)

+ func (s *Service) State(ctx context.Context, nodeRef string) (*forwardv1.NodeForwardState, bool, error)

+ func (s *Service) Traffic(ctx context.Context, routeID string, since, until time.Time) ([]RouteTraffic, error)

+ func (s *Service) TrafficBuckets(ctx context.Context, routeID, nodeRef string, since, until time.Time) ([]*forwardv1.TrafficBucket, bool, error)

+ func (s *Service) UpdateDNSBinding(ctx context.Context, requestID string, binding *forwardv1.DnsBinding) (*forwardv1.DnsBinding, error)

+ func (s *Service) UpdateDNSProvider(ctx context.Context, requestID string, provider *forwardv1.DnsProvider, ...) (*forwardv1.DnsProvider, error)

+ func (s *Service) UpdateForwardNode(ctx context.Context, requestID string, nodeRecord *forwardv1.ForwardNodeRecord) (*forwardv1.UpdateForwardNodeResponse, error)

+ func (s *Service) UpdateRoute(ctx context.Context, requestID string, route *forwardv1.Route, ...) (*forwardv1.Route, error)

+ type StateListener func(nodes []agentcontrol.AgentNode)

v4.2.0-rc.4

Oct 9, 2026

v4.2.0-rc.3

Oct 9, 2026

v4.2.0-rc.2

Oct 5, 2026

v4.2.0-rc.1

Oct 5, 2026