ipng/vpp-maglev
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Revision: Rename to 'maglevd'; Refactor config structure

Browse Source
This commit is contained in:
Pim van Pelt
2026-04-10 22:15:20 +02:00
parent b84b3274b1
commit 040d6f5853
16 changed files with 2852 additions and 1942 deletions
Download Patch File Download Diff File Expand all files Collapse all files

321
internal/config/config.go
View File

@@ -12,35 +12,28 @@ import (
"gopkg.in/yaml.v3"
)
// Frontend is the parsed and validated representation of frontend.yaml.
type Frontend struct {
ProbeIPv4Src net.IP
ProbeIPv6Src net.IP
HealthCheckNetns string
HealthChecker HealthCheckerConfig
VIPs map[string]VIP
// Config is the top-level parsed and validated configuration.
type Config struct {
HealthChecker HealthCheckerConfig
HealthChecks map[string]HealthCheck
Backends map[string]Backend
Frontends map[string]Frontend
}
// HealthCheckerConfig holds global health checker settings.
type HealthCheckerConfig struct {
TransitionHistory int
Netns string // network namespace for probes; "" = current netns
}
// VIP is a single virtual IP entry.
type VIP struct {
Description string
Address net.IP
Protocol string // "tcp", "udp", or "" (all traffic)
Port uint16 // 0 means omitted (all ports)
Backends []net.IP
HealthCheck HealthCheck
}
// HealthCheck describes how to probe backends for a VIP.
// HealthCheck describes how to probe a backend.
type HealthCheck struct {
Type string
Port uint16 // destination port; required for tcp/http/https
HTTP *HTTPParams // non-nil for type http and https
TCP *TCPParams // non-nil for type tcp
ProbeIPv4Src net.IP // source address for IPv4 probes; nil = OS picks
ProbeIPv6Src net.IP // source address for IPv6 probes; nil = OS picks
Interval time.Duration
FastInterval time.Duration // optional; used while health counter is degraded
DownInterval time.Duration // optional; used while fully down
@@ -65,41 +58,49 @@ type TCPParams struct {
SSL bool
ServerName string
InsecureSkipVerify bool
BannerRegexp *regexp.Regexp // nil if not configured; matched against the first line sent by the server
}
// Backend is a single named backend server.
type Backend struct {
Address net.IP
HealthCheck string // name reference into Config.HealthChecks; "" = no probing, assume healthy
Enabled bool // default true; false = exclude from serving entirely
Weight int // 0-100, default 100
}
// Frontend is a single virtual IP entry.
type Frontend struct {
Description string
Address net.IP
Protocol string // "tcp", "udp", or "" (all traffic)
Port uint16 // 0 means omitted (all ports)
Backends []string // backend names, each must exist in Config.Backends
}
// ---- raw YAML types --------------------------------------------------------
type rawConfig struct {
Maglev struct {
Frontend rawFrontend `yaml:"frontend"`
} `yaml:"maglev"`
Maglev rawMaglev `yaml:"maglev"`
}
type rawFrontend struct {
ProbeIPv4Src string `yaml:"probe-ipv4-src"`
ProbeIPv6Src string `yaml:"probe-ipv6-src"`
HealthCheckNetns string `yaml:"healthcheck-netns"`
HealthChecker rawHealthCheckerCfg `yaml:"healthchecker"`
VIPs map[string]rawVIP `yaml:"vips"`
type rawMaglev struct {
HealthChecker rawHealthCheckerCfg `yaml:"healthchecker"`
HealthChecks map[string]rawHealthCheck `yaml:"healthchecks"`
Backends map[string]rawBackend `yaml:"backends"`
Frontends map[string]rawFrontend `yaml:"frontends"`
}
type rawHealthCheckerCfg struct {
TransitionHistory int `yaml:"transition-history"`
}
type rawVIP struct {
Description string `yaml:"description"`
Address string `yaml:"address"`
Protocol string `yaml:"protocol"`
Port uint16 `yaml:"port"`
Backends []string `yaml:"backends"`
HealthCheck rawHealthCheck `yaml:"healthcheck"`
TransitionHistory int `yaml:"transition-history"`
Netns string `yaml:"netns"`
}
type rawHealthCheck struct {
Type string `yaml:"type"`
Port uint16 `yaml:"port"`
Params rawParams `yaml:"params"`
ProbeIPv4Src string `yaml:"probe-ipv4-src"`
ProbeIPv6Src string `yaml:"probe-ipv6-src"`
Interval string `yaml:"interval"`
FastInterval string `yaml:"fast-interval"`
DownInterval string `yaml:"down-interval"`
@@ -120,10 +121,25 @@ type rawParams struct {
SSL bool `yaml:"ssl"`
}
type rawBackend struct {
Address string `yaml:"address"`
HealthCheck string `yaml:"healthcheck"`
Enabled *bool `yaml:"enabled"` // nil → default true
Weight *int `yaml:"weight"` // nil → default 100
}
type rawFrontend struct {
Description string `yaml:"description"`
Address string `yaml:"address"`
Protocol string `yaml:"protocol"`
Port uint16 `yaml:"port"`
Backends []string `yaml:"backends"`
}
// ---- Load ------------------------------------------------------------------
// Load reads and validates the config file at path.
func Load(path string) (*Frontend, error) {
func Load(path string) (*Config, error) {
data, err := os.ReadFile(path)
if err != nil {
return nil, fmt.Errorf("read config %q: %w", path, err)
@@ -131,115 +147,82 @@ func Load(path string) (*Frontend, error) {
return parse(data)
}
func parse(data []byte) (*Frontend, error) {
func parse(data []byte) (*Config, error) {
var raw rawConfig
if err := yaml.Unmarshal(data, &raw); err != nil {
return nil, fmt.Errorf("parse yaml: %w", err)
}
return convert(&raw.Maglev.Frontend)
return convert(&raw.Maglev)
}
func convert(r *rawFrontend) (*Frontend, error) {
f := &Frontend{}
var err error
func convert(r *rawMaglev) (*Config, error) {
cfg := &Config{}
if f.ProbeIPv4Src, err = parseOptionalIPFamily(r.ProbeIPv4Src, 4, "probe-ipv4-src"); err != nil {
return nil, err
// ---- healthchecker --------------------------------------------------------
cfg.HealthChecker.Netns = r.HealthChecker.Netns
cfg.HealthChecker.TransitionHistory = r.HealthChecker.TransitionHistory
if cfg.HealthChecker.TransitionHistory == 0 {
cfg.HealthChecker.TransitionHistory = 5
}
if f.ProbeIPv6Src, err = parseOptionalIPFamily(r.ProbeIPv6Src, 6, "probe-ipv6-src"); err != nil {
return nil, err
}
f.HealthCheckNetns = r.HealthCheckNetns
f.HealthChecker.TransitionHistory = r.HealthChecker.TransitionHistory
if f.HealthChecker.TransitionHistory == 0 {
f.HealthChecker.TransitionHistory = 5
}
if f.HealthChecker.TransitionHistory < 1 {
if cfg.HealthChecker.TransitionHistory < 1 {
return nil, fmt.Errorf("healthchecker.transition-history must be >= 1")
}
f.VIPs = make(map[string]VIP, len(r.VIPs))
for name, rv := range r.VIPs {
vip, err := convertVIP(name, &rv)
// ---- healthchecks ---------------------------------------------------------
cfg.HealthChecks = make(map[string]HealthCheck, len(r.HealthChecks))
for name, rh := range r.HealthChecks {
hc, err := convertHealthCheck(&rh)
if err != nil {
return nil, fmt.Errorf("vip %q: %w", name, err)
return nil, fmt.Errorf("healthcheck %q: %w", name, err)
}
f.VIPs[name] = vip
cfg.HealthChecks[name] = hc
}
return f, nil
}
func convertVIP(name string, r *rawVIP) (VIP, error) {
v := VIP{
Description: r.Description,
Protocol: r.Protocol,
Port: r.Port,
}
ip := net.ParseIP(r.Address)
if ip == nil {
return VIP{}, fmt.Errorf("invalid address %q", r.Address)
}
v.Address = ip
switch r.Protocol {
case "", "tcp", "udp":
default:
return VIP{}, fmt.Errorf("protocol must be \"tcp\", \"udp\", or omitted, got %q", r.Protocol)
}
if r.Port != 0 && r.Protocol == "" {
return VIP{}, fmt.Errorf("port requires protocol to be set")
}
if r.Protocol != "" && r.Port == 0 {
return VIP{}, fmt.Errorf("protocol %q requires port to be set (1-65535)", r.Protocol)
}
if len(r.Backends) == 0 {
return VIP{}, fmt.Errorf("backends must not be empty")
}
var firstFamily int
for i, bs := range r.Backends {
ip := net.ParseIP(bs)
if ip == nil {
return VIP{}, fmt.Errorf("backend[%d] %q is not a valid IP", i, bs)
// ---- backends -------------------------------------------------------------
cfg.Backends = make(map[string]Backend, len(r.Backends))
for name, rb := range r.Backends {
b, err := convertBackend(name, &rb, cfg.HealthChecks)
if err != nil {
return nil, fmt.Errorf("backend %q: %w", name, err)
}
fam := ipFamily(ip)
if i == 0 {
firstFamily = fam
} else if fam != firstFamily {
return VIP{}, fmt.Errorf("backend[%d] %q has different address family than backend[0]", i, bs)
cfg.Backends[name] = b
}
// ---- frontends ------------------------------------------------------------
cfg.Frontends = make(map[string]Frontend, len(r.Frontends))
for name, rf := range r.Frontends {
fe, err := convertFrontend(name, &rf, cfg.Backends)
if err != nil {
return nil, fmt.Errorf("frontend %q: %w", name, err)
}
v.Backends = append(v.Backends, ip)
cfg.Frontends[name] = fe
}
hc, err := convertHealthCheck(&r.HealthCheck)
if err != nil {
return VIP{}, fmt.Errorf("healthcheck: %w", err)
}
v.HealthCheck = hc
return v, nil
return cfg, nil
}
func convertHealthCheck(r *rawHealthCheck) (HealthCheck, error) {
h := HealthCheck{
Type: r.Type,
}
h := HealthCheck{Type: r.Type, Port: r.Port}
switch r.Type {
case "icmp":
// no params
// ICMP does not use ports.
if r.Port != 0 {
return HealthCheck{}, fmt.Errorf("type icmp does not use a port")
}
case "tcp":
if r.Port == 0 {
return HealthCheck{}, fmt.Errorf("type tcp requires port")
}
h.TCP = &TCPParams{
SSL: r.Params.SSL,
ServerName: r.Params.ServerName,
InsecureSkipVerify: r.Params.InsecureSkipVerify,
}
case "http", "https":
if r.Port == 0 {
return HealthCheck{}, fmt.Errorf("type %s requires port", r.Type)
}
if r.Params.Path == "" {
return HealthCheck{}, fmt.Errorf("type http requires params.path")
}
@@ -272,25 +255,33 @@ func convertHealthCheck(r *rawHealthCheck) (HealthCheck, error) {
}
var err error
if r.ProbeIPv4Src != "" {
if h.ProbeIPv4Src, err = parseOptionalIPFamily(r.ProbeIPv4Src, 4, "probe-ipv4-src"); err != nil {
return HealthCheck{}, err
}
}
if r.ProbeIPv6Src != "" {
if h.ProbeIPv6Src, err = parseOptionalIPFamily(r.ProbeIPv6Src, 6, "probe-ipv6-src"); err != nil {
return HealthCheck{}, err
}
}
if r.Interval == "" {
return HealthCheck{}, fmt.Errorf("interval is required")
}
if h.Interval, err = time.ParseDuration(r.Interval); err != nil || h.Interval <= 0 {
return HealthCheck{}, fmt.Errorf("interval %q must be a positive duration", r.Interval)
}
if r.FastInterval != "" {
if h.FastInterval, err = time.ParseDuration(r.FastInterval); err != nil || h.FastInterval <= 0 {
return HealthCheck{}, fmt.Errorf("fast-interval %q must be a positive duration", r.FastInterval)
}
}
if r.DownInterval != "" {
if h.DownInterval, err = time.ParseDuration(r.DownInterval); err != nil || h.DownInterval <= 0 {
return HealthCheck{}, fmt.Errorf("down-interval %q must be a positive duration", r.DownInterval)
}
}
if r.Timeout == "" {
return HealthCheck{}, fmt.Errorf("timeout is required")
}
@@ -305,7 +296,6 @@ func convertHealthCheck(r *rawHealthCheck) (HealthCheck, error) {
if h.Fall < 1 {
return HealthCheck{}, fmt.Errorf("fall must be >= 1")
}
h.Rise = r.Rise
if h.Rise == 0 {
h.Rise = 2
@@ -317,10 +307,80 @@ func convertHealthCheck(r *rawHealthCheck) (HealthCheck, error) {
return h, nil
}
func convertBackend(name string, r *rawBackend, hcs map[string]HealthCheck) (Backend, error) {
ip := net.ParseIP(r.Address)
if ip == nil {
return Backend{}, fmt.Errorf("invalid address %q", r.Address)
}
b := Backend{
Address: ip,
HealthCheck: r.HealthCheck,
Enabled: boolDefault(r.Enabled, true),
Weight: intDefault(r.Weight, 100),
}
if b.Weight < 0 || b.Weight > 100 {
return Backend{}, fmt.Errorf("weight %d is out of range [0, 100]", b.Weight)
}
if b.HealthCheck != "" {
if _, ok := hcs[b.HealthCheck]; !ok {
return Backend{}, fmt.Errorf("healthcheck %q not defined", b.HealthCheck)
}
}
return b, nil
}
func convertFrontend(name string, r *rawFrontend, backends map[string]Backend) (Frontend, error) {
fe := Frontend{
Description: r.Description,
Protocol: r.Protocol,
Port: r.Port,
Backends: r.Backends,
}
ip := net.ParseIP(r.Address)
if ip == nil {
return Frontend{}, fmt.Errorf("invalid address %q", r.Address)
}
fe.Address = ip
switch r.Protocol {
case "", "tcp", "udp":
default:
return Frontend{}, fmt.Errorf("protocol must be \"tcp\", \"udp\", or omitted, got %q", r.Protocol)
}
if r.Port != 0 && r.Protocol == "" {
return Frontend{}, fmt.Errorf("port requires protocol to be set")
}
if r.Protocol != "" && r.Port == 0 {
return Frontend{}, fmt.Errorf("protocol %q requires port to be set (1-65535)", r.Protocol)
}
if len(r.Backends) == 0 {
return Frontend{}, fmt.Errorf("backends must not be empty")
}
var firstFamily int
for i, bName := range r.Backends {
b, ok := backends[bName]
if !ok {
return Frontend{}, fmt.Errorf("backends[%d] %q not defined", i, bName)
}
fam := ipFamily(b.Address)
if i == 0 {
firstFamily = fam
} else if fam != firstFamily {
return Frontend{}, fmt.Errorf("backends[%d] %q has different address family than backends[0]", i, bName)
}
}
return fe, nil
}
// ---- helpers ---------------------------------------------------------------
// parseOptionalIPFamily parses s as an IP of the given family.
// Returns nil (no error) if s is empty.
func parseOptionalIPFamily(s string, family int, field string) (net.IP, error) {
if s == "" {
return nil, nil
@@ -335,7 +395,6 @@ func parseOptionalIPFamily(s string, family int, field string) (net.IP, error) {
return ip, nil
}
// ipFamily returns 4 for IPv4, 6 for IPv6.
func ipFamily(ip net.IP) int {
if ip.To4() != nil {
return 4
@@ -343,8 +402,6 @@ func ipFamily(ip net.IP) int {
return 6
}
// parseCodeRange parses a response-code value which may be a single integer
// ("200") or an inclusive range ("200-299"). Returns (min, max, err).
func parseCodeRange(s string, defaultCode int) (min, max int, err error) {
if s == "" {
return defaultCode, defaultCode, nil
@@ -366,3 +423,17 @@ func parseCodeRange(s string, defaultCode int) (min, max int, err error) {
}
return min, min, nil
}
func boolDefault(p *bool, def bool) bool {
if p == nil {
return def
}
return *p
}
func intDefault(p *int, def int) int {
if p == nil {
return def
}
return *p
}