FEATURE/MEDIUM: runtime: add maps support

Author: amelhusic

CONTRIBUTING.md

@@ -41,6 +41,12 @@ Data Plane API is generated using [go-swagger](https://github.com/go-swagger/go-
     --tags=ACL \
     --tags=Defaults \
     --tags=StickTable \
+    --tags=Maps \
+    --tags=Nameserver \
+    --tags=Cluster \
+    --tags=Peer \
+    --tags=PeerEntry \
+    --tags=Resolver \
     -r ~/dataplaneapi-specification/copyright.txt
 ```
 

README.md

@@ -53,6 +53,9 @@ Application Options:
       --tls-keep-alive=                            sets the TCP keep-alive timeouts on accepted connections. It prunes dead TCP connections ( e.g. closing laptop mid-download)
       --tls-read-timeout=                          maximum duration before timing out read of the request
       --tls-write-timeout=                         maximum duration before timing out write of the response
+      -p, --maps-dir=                              path to maps directory (default:"/etc/haproxy/maps")
+      --update-map-files=                          flag used for periodic syncing map files entries with runtime maps entries. Missing runtime entries are appended to the corresponding map file
+      --update-map-files-period=                   elapsed time in seconds between two maps syncing operations (default: 10s)
 
 HAProxy options:
   -c, --config-file=                               Path to the haproxy configuration file (default: /etc/haproxy/haproxy.cfg)

configuration/configuration.go

@@ -33,20 +33,23 @@ import (
 var cfg *Configuration
 
 type HAProxyConfiguration struct {
-	ConfigFile      string `short:"c" long:"config-file" description:"Path to the haproxy configuration file" default:"/etc/haproxy/haproxy.cfg"`
-	Userlist        string `short:"u" long:"userlist" description:"Userlist in HAProxy configuration to use for API Basic Authentication" default:"controller"`
-	HAProxy         string `short:"b" long:"haproxy-bin" description:"Path to the haproxy binary file" default:"haproxy"`
-	ReloadDelay     int    `short:"d" long:"reload-delay" description:"Minimum delay between two reloads (in s)" default:"5"`
-	ReloadCmd       string `short:"r" long:"reload-cmd" description:"Reload command"`
-	RestartCmd      string `short:"s" long:"restart-cmd" description:"Restart command"`
-	ReloadRetention int    `long:"reload-retention" description:"Reload retention in days, every older reload id will be deleted" default:"1"`
-	TransactionDir  string `short:"t" long:"transaction-dir" description:"Path to the transaction directory" default:"/tmp/haproxy"`
-	BackupsNumber   int    `short:"n" long:"backups-number" description:"Number of backup configuration files you want to keep, stored in the config dir with version number suffix" default:"0"`
-	MasterRuntime   string `short:"m" long:"master-runtime" description:"Path to the master Runtime API socket"`
-	ShowSystemInfo  bool   `short:"i" long:"show-system-info" description:"Show system info on info endpoint"`
-	DataplaneConfig string `short:"f" description:"Path to the dataplane configuration file" default:"" yaml:"-"`
-	UserListFile    string `long:"userlist-file" description:"Path to the dataplaneapi userlist file. By default userlist is read from HAProxy conf. When specified userlist would be read from this file"`
-	NodeIDFile      string `long:"fid" description:"Path to file that will dataplaneapi use to write its id (not a pid) that was given to him after joining a cluster"`
+	ConfigFile           string `short:"c" long:"config-file" description:"Path to the haproxy configuration file" default:"/etc/haproxy/haproxy.cfg"`
+	Userlist             string `short:"u" long:"userlist" description:"Userlist in HAProxy configuration to use for API Basic Authentication" default:"controller"`
+	HAProxy              string `short:"b" long:"haproxy-bin" description:"Path to the haproxy binary file" default:"haproxy"`
+	ReloadDelay          int    `short:"d" long:"reload-delay" description:"Minimum delay between two reloads (in s)" default:"5"`
+	ReloadCmd            string `short:"r" long:"reload-cmd" description:"Reload command"`
+	RestartCmd           string `short:"s" long:"restart-cmd" description:"Restart command"`
+	ReloadRetention      int    `long:"reload-retention" description:"Reload retention in days, every older reload id will be deleted" default:"1"`
+	TransactionDir       string `short:"t" long:"transaction-dir" description:"Path to the transaction directory" default:"/tmp/haproxy"`
+	BackupsNumber        int    `short:"n" long:"backups-number" description:"Number of backup configuration files you want to keep, stored in the config dir with version number suffix" default:"0"`
+	MasterRuntime        string `short:"m" long:"master-runtime" description:"Path to the master Runtime API socket"`
+	ShowSystemInfo       bool   `short:"i" long:"show-system-info" description:"Show system info on info endpoint"`
+	DataplaneConfig      string `short:"f" description:"Path to the dataplane configuration file" default:"" yaml:"-"`
+	UserListFile         string `long:"userlist-file" description:"Path to the dataplaneapi userlist file. By default userlist is read from HAProxy conf. When specified userlist would be read from this file"`
+	NodeIDFile           string `long:"fid" description:"Path to file that will dataplaneapi use to write its id (not a pid) that was given to him after joining a cluster"`
+	MapsDir              string `short:"p" long:"maps-dir" description:"Path to maps directory" default:"/etc/haproxy/maps"`
+	UpdateMapFiles       bool   `long:"update-map-files" description:"Flag used for syncing map files with runtime maps values"`
+	UpdateMapFilesPeriod int64  `long:"update-map-files-period" description:"Elapsed time in seconds between two maps syncing operations" default:"10"`
 }
 
 type LoggingOptions struct {

configure_data_plane.go

@@ -21,6 +21,9 @@ import (
 	"crypto/tls"
 	"encoding/json"
 	"fmt"
+	"hash/fnv"
+	"io/ioutil"
+	"math/rand"
 	"net/http"
 	"os"
 	"os/signal"
@@ -29,9 +32,11 @@ import (
 	"strconv"
 	"strings"
 	"syscall"
+	"time"
 
 	"github.com/haproxytech/dataplaneapi/adapters"
 	"github.com/haproxytech/dataplaneapi/operations/specification"
+	"github.com/haproxytech/models"
 
 	log "github.com/sirupsen/logrus"
 
@@ -140,6 +145,11 @@ func configureAPI(api *operations.DataPlaneAPI) http.Handler {
 	signal.Notify(sigs, syscall.SIGUSR1, syscall.SIGUSR2)
 	go handleSignals(sigs, client, haproxyOptions, users)
 
+	// Sync map physical file with runtime map entries
+	if haproxyOptions.UpdateMapFiles {
+		go syncMaps(client)
+	}
+
 	// Initialize reload agent
 	ra := &haproxy.ReloadAgent{}
 	if err := ra.Init(haproxyOptions.ReloadDelay, haproxyOptions.ReloadCmd, haproxyOptions.RestartCmd, haproxyOptions.ConfigFile, haproxyOptions.ReloadRetention); err != nil {
@@ -382,6 +392,17 @@ func configureAPI(api *operations.DataPlaneAPI) http.Handler {
 	api.StickTableGetStickTableHandler = &handlers.GetStickTableHandlerImpl{Client: client}
 	api.StickTableGetStickTableEntriesHandler = &handlers.GetStickTableEntriesHandlerImpl{Client: client}
 
+	// setup map handlers
+	api.MapsCreateRuntimeMapHandler = &handlers.MapsCreateRuntimeMapHandlerImpl{Client: client}
+	api.MapsGetAllRuntimeMapFilesHandler = &handlers.GetMapsHandlerImpl{Client: client}
+	api.MapsGetOneRuntimeMapHandler = &handlers.GetMapHandlerImpl{Client: client}
+	api.MapsClearRuntimeMapHandler = &handlers.ClearMapHandlerImpl{Client: client}
+	api.MapsShowRuntimeMapHandler = &handlers.ShowMapHandlerImpl{Client: client}
+	api.MapsAddMapEntryHandler = &handlers.AddMapEntryHandlerImpl{Client: client}
+	api.MapsGetRuntimeMapEntryHandler = &handlers.GetRuntimeMapEntryHandlerImpl{Client: client}
+	api.MapsReplaceRuntimeMapEntryHandler = &handlers.ReplaceRuntimeMapEntryHandlerImpl{Client: client}
+	api.MapsDeleteRuntimeMapEntryHandler = &handlers.DeleteRuntimeMapEntryHandlerImpl{Client: client}
+
 	// setup info handler
 	api.InformationGetInfoHandler = &handlers.GetInfoHandlerImpl{SystemInfo: haproxyOptions.ShowSystemInfo, BuildTime: BuildTime, Version: Version}
 
@@ -534,6 +555,7 @@ func serverShutdown() {
 	if logFile != nil {
 		logFile.Close()
 	}
+	MapQuitChan <- MapQuitNotice{}
 }
 
 func configureNativeClient(haproxyOptions dataplaneapi_config.HAProxyConfiguration, mWorker bool) *client_native.HAProxyClient {
@@ -575,7 +597,11 @@ func configureConfigurationClient(haproxyOptions dataplaneapi_config.HAProxyConf
 }
 
 func configureRuntimeClient(confClient *configuration.Client, haproxyOptions dataplaneapi_config.HAProxyConfiguration) *runtime_api.Client {
-	runtimeClient := &runtime_api.Client{}
+	runtimeParams := runtime_api.ClientParams{
+		MapsDir: haproxyOptions.MapsDir,
+	}
+	runtimeClient := &runtime_api.Client{ClientParams: runtimeParams}
+
 	_, globalConf, err := confClient.GetGlobalConfiguration("")
 
 	// First try to setup master runtime socket
@@ -584,7 +610,7 @@ func configureRuntimeClient(confClient *configuration.Client, haproxyOptions dat
 		// If master socket is set and a valid unix socket, use only this
 		if haproxyOptions.MasterRuntime != "" && misc.IsUnixSocketAddr(haproxyOptions.MasterRuntime) {
 			masterSocket := haproxyOptions.MasterRuntime
-			// if nbproc is set set nbproc sockets
+			// if nbproc is set, set nbproc sockets
 			if globalConf.Nbproc > 0 {
 				nbproc := int(globalConf.Nbproc)
 				if err = runtimeClient.InitWithMasterSocket(masterSocket, nbproc); err == nil {
@@ -672,3 +698,161 @@ func handleSignals(sigs chan os.Signal, client *client_native.HAProxyClient, hap
 		}
 	}
 }
+
+type MapQuitNotice struct{}
+
+var MapQuitChan = make(chan MapQuitNotice)
+
+//syncMaps sync maps file entries with runtime maps entries for all configured files.
+//Missing runtime entries are appended to the map file
+func syncMaps(client *client_native.HAProxyClient) {
+	cfg := dataplaneapi_config.Get()
+	haproxyOptions := cfg.HAProxy
+
+	d := time.Duration(haproxyOptions.UpdateMapFilesPeriod)
+	ticker := time.NewTicker(d * time.Second)
+
+	for {
+		select {
+		case <-ticker.C:
+			maps, err := client.Runtime.ShowMaps()
+			if err != nil {
+				log.Warning("syncMaps runtime API ShowMaps error: ", err.Error())
+			}
+			for _, mp := range maps {
+				go syncMapFilesToRuntimeEntries(mp, client)
+			}
+		case <-MapQuitChan:
+			return
+		}
+	}
+}
+
+func syncMapFilesToRuntimeEntries(mp *models.Map, client *client_native.HAProxyClient) {
+	//map file entries
+	raw, err := ioutil.ReadFile(mp.File)
+	if err != nil {
+		log.Warningf("error reading map file: %s %s", mp.File, err.Error())
+	}
+	fileEntries := client.Runtime.ParseMapEntries(string(raw))
+
+	//runtime map entries
+	id := fmt.Sprintf("#%s", mp.ID)
+	runtimeEntries, err := client.Runtime.ShowMapEntries(id)
+	if err != nil {
+		log.Warningf("error runtime API ShowMapEntries: id: %s %s", id, err.Error())
+	}
+
+	if len(runtimeEntries) < 1 {
+		return
+	}
+
+	if len(fileEntries) != len(runtimeEntries) {
+		if dumpRuntimeEntries(mp.File, runtimeEntries) {
+			log.Infof("map file %s synced with runtime entries", mp.File)
+			return
+		}
+	}
+
+	if !equalSomeFileAndRuntimeEntries(fileEntries, runtimeEntries) {
+		if dumpRuntimeEntries(mp.File, runtimeEntries) {
+			log.Infof("map file %s synced with runtime entries", mp.File)
+			return
+		}
+	}
+
+	if !equalHashFileAndRuntimeEntries(fileEntries, runtimeEntries) {
+		if dumpRuntimeEntries(mp.File, runtimeEntries) {
+			log.Infof("map file %s synced with runtime entries", mp.File)
+			return
+		}
+	}
+}
+
+//equalSomeFileAndRuntimeEntries compares last few runtime entries with file entries
+//if records differs, check is run against random entries
+func equalSomeFileAndRuntimeEntries(fEntries, rEntries models.MapEntries) bool {
+	if len(fEntries) != len(rEntries) {
+		return false
+	}
+
+	max := 0
+	switch l := len(rEntries); {
+	case l > 19:
+		for i := l - 20; i < l; i++ {
+			if rEntries[i].Key != fEntries[i].Key || rEntries[i].Value != fEntries[i].Value {
+				return false
+			}
+		}
+		max = l - 19
+	default:
+		max = l
+	}
+
+	for i := 0; i < 10; i++ {
+		rand.Seed(time.Now().UTC().UnixNano())
+		r := rand.Intn(max-1) + 1
+		if rEntries[r].Key != fEntries[r].Key || rEntries[r].Value != fEntries[r].Value {
+			return false
+		}
+	}
+	return true
+}
+
+func hash(s string) uint32 {
+	h := fnv.New32a()
+	_, _ = h.Write([]byte(s))
+	return h.Sum32()
+}
+
+//equalHashFileAndRuntimeEntries compares runtime and map entries in form of hash
+//Returns true if hashes are same, otherwise returns false
+func equalHashFileAndRuntimeEntries(fEntries, rEntries models.MapEntries) bool {
+	if len(fEntries) != len(rEntries) {
+		return false
+	}
+
+	var fb strings.Builder
+	for _, fe := range fEntries {
+		fb.WriteString(fe.Key + fe.Value)
+	}
+
+	var rb strings.Builder
+	for _, re := range rEntries {
+		rb.WriteString(re.Key + re.Value)
+	}
+
+	return hash(fb.String()) == hash(rb.String())
+}
+
+//dumpRuntimeEntries dumps runtime entries into map file
+func dumpRuntimeEntries(file string, me models.MapEntries) bool {
+	f, err := os.OpenFile(file, os.O_APPEND|os.O_WRONLY|os.O_TRUNC, 0600)
+	if err != nil {
+		log.Warningf("error opening map file: %s %s", file, err.Error())
+		return false
+	}
+	defer f.Close()
+
+	err = f.Truncate(0)
+	if err != nil {
+		log.Warningf("error truncating map file: %s %s", file, err.Error())
+		return false
+	}
+
+	_, err = f.Seek(0, 0)
+	if err != nil {
+		log.Warningf("error setting file to offset: %s %s", file, err.Error())
+		return false
+	}
+
+	for _, e := range me {
+		line := fmt.Sprintf("%s %s%s", e.Key, e.Value, "\n")
+		_, err = f.WriteString(line)
+		if err != nil {
+			log.Warningf("error writing map file: %s %s", file, err.Error())
+			return false
+		}
+	}
+	return true
+}