1
0
Fork 0
mirror of https://github.com/postmannen/ctrl.git synced 2024-12-15 17:51:15 +00:00
ctrl/configuration_flags.go

691 lines
26 KiB
Go
Raw Normal View History

package steward
import (
"flag"
"fmt"
"log"
"os"
"path/filepath"
toml "github.com/pelletier/go-toml"
)
// Configuration are the structure that holds all the different
// configuration options used both with flags and the config file.
// If a new field is added to this struct there should also be
// added the same field to the ConfigurationFromFile struct, and
// an if check should be added to the checkConfigValues function
// to set default values when reading from config file.
type Configuration struct {
2021-12-21 06:21:12 +00:00
// RingBufferSize
RingBufferSize int
// The configuration folder on disk
ConfigFolder string
2021-05-12 07:50:03 +00:00
// The folder where the socket file should live
SocketFolder string
// TCP Listener for sending messages to the system
TCPListener string
2021-09-10 03:26:16 +00:00
// HTTP Listener for sending messages to the system
HTTPListener string
2021-05-12 07:50:03 +00:00
// The folder where the database should live
DatabaseFolder string
// some unique string to identify this Edge unit
NodeName string
// the address of the message broker
BrokerAddress string
2021-12-17 16:28:57 +00:00
// NatsConnOptTimeout the timeout for trying the connect to nats broker
NatsConnOptTimeout int
// nats connect retry
NatsConnectRetryInterval int
2021-12-16 10:01:01 +00:00
// NatsReconnectJitter in milliseconds
NatsReconnectJitter int
// NatsReconnectJitterTLS in seconds
NatsReconnectJitterTLS int
2022-04-07 07:34:06 +00:00
// PublicKeysGetInterval in seconds
PublicKeysGetInterval int
// The number of the profiling port
ProfilingPort string
// host and port for prometheus listener, e.g. localhost:2112
PromHostAndPort string
// set to true if this is the node that should receive the error log's from other nodes
DefaultMessageTimeout int
2021-11-18 05:36:16 +00:00
// Default value for how long can a request method max be allowed to run.
DefaultMethodTimeout int
// default amount of retries that will be done before a message is thrown away, and out of the system
DefaultMessageRetries int
// Publisher data folder
SubscribersDataFolder string
2021-03-12 09:41:03 +00:00
// central node to receive messages published from nodes
CentralNodeName string
2021-04-19 19:06:37 +00:00
// Path to the certificate of the root CA
RootCAPath string
// Full path to the NKEY's seed file
NkeySeedFile string
// NkeyPublicKey
NkeyPublicKey string `toml:"-"`
2021-08-23 10:47:33 +00:00
// The host and port to expose the data folder
ExposeDataFolder string
// Timeout for error messages
ErrorMessageTimeout int
// Retries for error messages.
ErrorMessageRetries int
2021-12-29 05:17:40 +00:00
// Compression
Compression string
2021-12-29 05:17:40 +00:00
// Serialization
Serialization string
// SetBlockProfileRate for block profiling
SetBlockProfileRate int
// EnableSocket for enabling the creation of a steward.sock file
EnableSocket bool
2022-01-07 10:17:10 +00:00
// EnableTUI will enable the Terminal User Interface
EnableTUI bool
// EnableSignatureCheck
EnableSignatureCheck bool
2022-02-09 08:06:06 +00:00
// IsCentralAuth
IsCentralAuth bool
2022-02-18 05:24:27 +00:00
// EnableDebug will also enable printing all the messages received in the errorKernel
// to STDERR.
EnableDebug bool
2021-04-05 06:37:24 +00:00
// Make the current node send hello messages to central at given interval in seconds
2021-04-06 03:46:07 +00:00
StartPubREQHello int
2022-04-07 07:34:06 +00:00
// Publisher for asking central for public keys
StartPubREQPublicKeysGet bool
// Subscriber for receiving updates of public keys from central
StartSubREQPublicKeysToNode bool
// Start the central error logger.
2021-09-08 16:56:23 +00:00
StartSubREQErrorLog bool
// Subscriber for hello messages
2021-09-08 16:56:23 +00:00
StartSubREQHello bool
// Subscriber for text logging
2021-09-08 16:56:23 +00:00
StartSubREQToFileAppend bool
2021-04-06 17:42:03 +00:00
// Subscriber for writing to file
2021-09-08 16:56:23 +00:00
StartSubREQToFile bool
2022-03-04 14:02:43 +00:00
// Subscriber for writing to file without ACK
StartSubREQToFileNACK bool
2021-11-17 12:02:48 +00:00
// Subscriber for reading files to copy
StartSubREQCopyFileFrom bool
2021-11-18 08:34:16 +00:00
// Subscriber for writing copied files to disk
StartSubREQCopyFileTo bool
// Subscriber for Echo Request
2021-09-08 16:56:23 +00:00
StartSubREQPing bool
// Subscriber for Echo Reply
2021-09-08 16:56:23 +00:00
StartSubREQPong bool
// Subscriber for CLICommandRequest
2021-09-08 16:56:23 +00:00
StartSubREQCliCommand bool
// Subscriber for REQToConsole
2021-09-08 16:56:23 +00:00
StartSubREQToConsole bool
2021-04-06 17:42:03 +00:00
// Subscriber for REQHttpGet
2021-09-08 16:56:23 +00:00
StartSubREQHttpGet bool
2022-02-11 06:27:51 +00:00
// Subscriber for REQHttpGetScheduled
StartSubREQHttpGetScheduled bool
2021-04-13 09:28:52 +00:00
// Subscriber for tailing log files
2021-09-08 16:56:23 +00:00
StartSubREQTailFile bool
// Subscriber for continously delivery of output from cli commands.
StartSubREQCliCommandCont bool
2021-11-10 10:21:38 +00:00
// Subscriber for relay messages.
StartSubREQRelay bool
}
// ConfigurationFromFile should have the same structure as
// Configuration. This structure is used when parsing the
// configuration values from file, so we are able to detect
// if a value were given or not when parsing.
type ConfigurationFromFile struct {
ConfigFolder *string
RingBufferSize *int
SocketFolder *string
TCPListener *string
HTTPListener *string
DatabaseFolder *string
NodeName *string
BrokerAddress *string
NatsConnOptTimeout *int
NatsConnectRetryInterval *int
NatsReconnectJitter *int
NatsReconnectJitterTLS *int
2022-04-07 07:34:06 +00:00
PublicKeysGetInterval *int
ProfilingPort *string
PromHostAndPort *string
DefaultMessageTimeout *int
DefaultMessageRetries *int
DefaultMethodTimeout *int
SubscribersDataFolder *string
CentralNodeName *string
RootCAPath *string
NkeySeedFile *string
ExposeDataFolder *string
ErrorMessageTimeout *int
ErrorMessageRetries *int
Compression *string
2021-12-29 05:17:40 +00:00
Serialization *string
SetBlockProfileRate *int
EnableSocket *bool
2022-01-07 10:17:10 +00:00
EnableTUI *bool
EnableSignatureCheck *bool
2022-02-09 08:06:06 +00:00
IsCentralAuth *bool
2022-02-18 05:24:27 +00:00
EnableDebug *bool
2022-02-11 06:27:51 +00:00
StartPubREQHello *int
2022-04-07 07:34:06 +00:00
StartPubREQPublicKeysGet *bool
StartSubREQPublicKeysToNode *bool
2022-02-11 06:27:51 +00:00
StartSubREQErrorLog *bool
StartSubREQHello *bool
StartSubREQToFileAppend *bool
StartSubREQToFile *bool
2022-03-04 14:02:43 +00:00
StartSubREQToFileNACK *bool
2022-02-11 06:27:51 +00:00
StartSubREQCopyFileFrom *bool
StartSubREQCopyFileTo *bool
StartSubREQPing *bool
StartSubREQPong *bool
StartSubREQCliCommand *bool
StartSubREQToConsole *bool
StartSubREQHttpGet *bool
StartSubREQHttpGetScheduled *bool
StartSubREQTailFile *bool
StartSubREQCliCommandCont *bool
StartSubREQRelay *bool
}
// NewConfiguration will return a *Configuration.
func NewConfiguration() *Configuration {
c := Configuration{}
return &c
}
// Get a Configuration struct with the default values set.
func newConfigurationDefaults() Configuration {
c := Configuration{
ConfigFolder: "./etc/",
RingBufferSize: 1000,
SocketFolder: "./tmp",
TCPListener: "",
2021-09-10 03:26:16 +00:00
HTTPListener: "",
DatabaseFolder: "./var/lib",
NodeName: "",
BrokerAddress: "127.0.0.1:4222",
2021-12-17 16:28:57 +00:00
NatsConnOptTimeout: 20,
NatsConnectRetryInterval: 10,
2021-12-16 10:01:01 +00:00
NatsReconnectJitter: 100,
NatsReconnectJitterTLS: 1,
2022-04-07 07:34:06 +00:00
PublicKeysGetInterval: 60,
ProfilingPort: "",
PromHostAndPort: "",
DefaultMessageTimeout: 10,
DefaultMessageRetries: 1,
2021-11-18 05:36:16 +00:00
DefaultMethodTimeout: 10,
SubscribersDataFolder: "./data",
CentralNodeName: "",
RootCAPath: "",
NkeySeedFile: "",
ExposeDataFolder: "",
ErrorMessageTimeout: 60,
ErrorMessageRetries: 10,
Compression: "",
2021-12-29 05:17:40 +00:00
Serialization: "",
SetBlockProfileRate: 0,
EnableSocket: true,
2022-01-07 10:17:10 +00:00
EnableTUI: false,
EnableSignatureCheck: false,
2022-02-09 08:06:06 +00:00
IsCentralAuth: false,
2022-02-18 05:24:27 +00:00
EnableDebug: false,
StartPubREQHello: 30,
2022-04-07 07:34:06 +00:00
StartPubREQPublicKeysGet: true,
StartSubREQPublicKeysToNode: true,
StartSubREQErrorLog: false,
2022-02-11 06:27:51 +00:00
StartSubREQHello: true,
StartSubREQToFileAppend: true,
StartSubREQToFile: true,
2022-03-04 14:02:43 +00:00
StartSubREQToFileNACK: true,
2022-02-11 06:27:51 +00:00
StartSubREQCopyFileFrom: true,
StartSubREQCopyFileTo: true,
StartSubREQPing: true,
StartSubREQPong: true,
StartSubREQCliCommand: true,
StartSubREQToConsole: true,
StartSubREQHttpGet: true,
StartSubREQHttpGetScheduled: true,
StartSubREQTailFile: true,
StartSubREQCliCommandCont: true,
StartSubREQRelay: false,
}
return c
}
// Check if all values are present in config file, and if not
// found use the default value.
func checkConfigValues(cf ConfigurationFromFile) Configuration {
var conf Configuration
cd := newConfigurationDefaults()
2021-12-21 06:21:12 +00:00
if cf.RingBufferSize == nil {
conf.RingBufferSize = cd.RingBufferSize
} else {
conf.RingBufferSize = *cf.RingBufferSize
}
if cf.ConfigFolder == nil {
conf.ConfigFolder = cd.ConfigFolder
} else {
conf.ConfigFolder = *cf.ConfigFolder
}
if cf.SocketFolder == nil {
conf.SocketFolder = cd.SocketFolder
} else {
conf.SocketFolder = *cf.SocketFolder
}
if cf.TCPListener == nil {
conf.TCPListener = cd.TCPListener
} else {
conf.TCPListener = *cf.TCPListener
}
2021-09-10 03:26:16 +00:00
if cf.HTTPListener == nil {
conf.HTTPListener = cd.HTTPListener
} else {
conf.HTTPListener = *cf.HTTPListener
}
if cf.DatabaseFolder == nil {
conf.DatabaseFolder = cd.DatabaseFolder
} else {
conf.DatabaseFolder = *cf.DatabaseFolder
}
if cf.NodeName == nil {
conf.NodeName = cd.NodeName
} else {
conf.NodeName = *cf.NodeName
}
if cf.BrokerAddress == nil {
conf.BrokerAddress = cd.BrokerAddress
} else {
conf.BrokerAddress = *cf.BrokerAddress
}
2021-12-17 16:28:57 +00:00
if cf.NatsConnOptTimeout == nil {
conf.NatsConnOptTimeout = cd.NatsConnOptTimeout
} else {
conf.NatsConnOptTimeout = *cf.NatsConnOptTimeout
}
if cf.NatsConnectRetryInterval == nil {
conf.NatsConnectRetryInterval = cd.NatsConnectRetryInterval
} else {
conf.NatsConnectRetryInterval = *cf.NatsConnectRetryInterval
}
2021-12-16 10:01:01 +00:00
if cf.NatsReconnectJitter == nil {
conf.NatsReconnectJitter = cd.NatsReconnectJitter
} else {
conf.NatsReconnectJitter = *cf.NatsReconnectJitter
}
if cf.NatsReconnectJitterTLS == nil {
conf.NatsReconnectJitterTLS = cd.NatsReconnectJitterTLS
} else {
conf.NatsReconnectJitterTLS = *cf.NatsReconnectJitterTLS
}
2022-04-07 07:34:06 +00:00
if cf.PublicKeysGetInterval == nil {
conf.PublicKeysGetInterval = cd.PublicKeysGetInterval
} else {
conf.PublicKeysGetInterval = *cf.PublicKeysGetInterval
}
if cf.ProfilingPort == nil {
conf.ProfilingPort = cd.ProfilingPort
} else {
conf.ProfilingPort = *cf.ProfilingPort
}
if cf.PromHostAndPort == nil {
conf.PromHostAndPort = cd.PromHostAndPort
} else {
conf.PromHostAndPort = *cf.PromHostAndPort
}
if cf.DefaultMessageTimeout == nil {
conf.DefaultMessageTimeout = cd.DefaultMessageTimeout
} else {
conf.DefaultMessageTimeout = *cf.DefaultMessageTimeout
}
if cf.DefaultMessageRetries == nil {
conf.DefaultMessageRetries = cd.DefaultMessageRetries
} else {
conf.DefaultMessageRetries = *cf.DefaultMessageRetries
}
2021-11-18 05:36:16 +00:00
if cf.DefaultMethodTimeout == nil {
conf.DefaultMethodTimeout = cd.DefaultMethodTimeout
} else {
conf.DefaultMethodTimeout = *cf.DefaultMethodTimeout
}
if cf.SubscribersDataFolder == nil {
conf.SubscribersDataFolder = cd.SubscribersDataFolder
} else {
conf.SubscribersDataFolder = *cf.SubscribersDataFolder
}
if cf.CentralNodeName == nil {
conf.CentralNodeName = cd.CentralNodeName
} else {
conf.CentralNodeName = *cf.CentralNodeName
}
if cf.RootCAPath == nil {
conf.RootCAPath = cd.RootCAPath
} else {
conf.RootCAPath = *cf.RootCAPath
}
if cf.NkeySeedFile == nil {
conf.NkeySeedFile = cd.NkeySeedFile
} else {
conf.NkeySeedFile = *cf.NkeySeedFile
}
if cf.ExposeDataFolder == nil {
conf.ExposeDataFolder = cd.ExposeDataFolder
} else {
conf.ExposeDataFolder = *cf.ExposeDataFolder
}
if cf.ErrorMessageTimeout == nil {
conf.ErrorMessageTimeout = cd.ErrorMessageTimeout
} else {
conf.ErrorMessageTimeout = *cf.ErrorMessageTimeout
}
if cf.ErrorMessageRetries == nil {
conf.ErrorMessageRetries = cd.ErrorMessageRetries
} else {
conf.ErrorMessageRetries = *cf.ErrorMessageRetries
}
2021-12-26 06:16:14 +00:00
if cf.Compression == nil {
conf.Compression = cd.Compression
} else {
conf.Compression = *cf.Compression
}
2021-12-29 05:17:40 +00:00
if cf.Serialization == nil {
conf.Serialization = cd.Serialization
} else {
conf.Serialization = *cf.Serialization
}
if cf.SetBlockProfileRate == nil {
conf.SetBlockProfileRate = cd.SetBlockProfileRate
} else {
conf.SetBlockProfileRate = *cf.SetBlockProfileRate
}
if cf.EnableSocket == nil {
conf.EnableSocket = cd.EnableSocket
} else {
conf.EnableSocket = *cf.EnableSocket
}
2022-01-07 10:17:10 +00:00
if cf.EnableTUI == nil {
conf.EnableTUI = cd.EnableTUI
} else {
conf.EnableTUI = *cf.EnableTUI
}
if cf.EnableSignatureCheck == nil {
conf.EnableSignatureCheck = cd.EnableSignatureCheck
2022-02-03 10:11:21 +00:00
} else {
conf.EnableSignatureCheck = *cf.EnableSignatureCheck
2022-02-03 10:11:21 +00:00
}
2022-02-09 08:06:06 +00:00
if cf.IsCentralAuth == nil {
conf.IsCentralAuth = cd.IsCentralAuth
} else {
conf.IsCentralAuth = *cf.IsCentralAuth
}
2022-02-18 05:24:27 +00:00
if cf.EnableDebug == nil {
conf.EnableDebug = cd.EnableDebug
} else {
conf.EnableDebug = *cf.EnableDebug
}
2022-01-07 10:17:10 +00:00
// --- Start pub/sub
2021-12-26 06:16:14 +00:00
if cf.StartPubREQHello == nil {
conf.StartPubREQHello = cd.StartPubREQHello
} else {
conf.StartPubREQHello = *cf.StartPubREQHello
}
2022-04-07 07:34:06 +00:00
if cf.StartPubREQPublicKeysGet == nil {
conf.StartPubREQPublicKeysGet = cd.StartPubREQPublicKeysGet
} else {
conf.StartPubREQPublicKeysGet = *cf.StartPubREQPublicKeysGet
}
if cf.StartSubREQPublicKeysToNode == nil {
conf.StartSubREQPublicKeysToNode = cd.StartSubREQPublicKeysToNode
2022-04-07 07:34:06 +00:00
} else {
conf.StartSubREQPublicKeysToNode = *cf.StartSubREQPublicKeysToNode
2022-04-07 07:34:06 +00:00
}
if cf.StartSubREQErrorLog == nil {
conf.StartSubREQErrorLog = cd.StartSubREQErrorLog
} else {
conf.StartSubREQErrorLog = *cf.StartSubREQErrorLog
}
if cf.StartSubREQHello == nil {
conf.StartSubREQHello = cd.StartSubREQHello
} else {
conf.StartSubREQHello = *cf.StartSubREQHello
}
if cf.StartSubREQToFileAppend == nil {
conf.StartSubREQToFileAppend = cd.StartSubREQToFileAppend
} else {
conf.StartSubREQToFileAppend = *cf.StartSubREQToFileAppend
}
if cf.StartSubREQToFile == nil {
conf.StartSubREQToFile = cd.StartSubREQToFile
} else {
conf.StartSubREQToFile = *cf.StartSubREQToFile
}
2022-03-04 14:02:43 +00:00
if cf.StartSubREQToFileNACK == nil {
conf.StartSubREQToFileNACK = cd.StartSubREQToFileNACK
} else {
conf.StartSubREQToFileNACK = *cf.StartSubREQToFileNACK
}
2021-11-17 12:02:48 +00:00
if cf.StartSubREQCopyFileFrom == nil {
conf.StartSubREQCopyFileFrom = cd.StartSubREQCopyFileFrom
} else {
conf.StartSubREQCopyFileFrom = *cf.StartSubREQCopyFileFrom
}
2021-11-18 08:34:16 +00:00
if cf.StartSubREQCopyFileTo == nil {
conf.StartSubREQCopyFileTo = cd.StartSubREQCopyFileTo
} else {
conf.StartSubREQCopyFileTo = *cf.StartSubREQCopyFileTo
}
if cf.StartSubREQPing == nil {
conf.StartSubREQPing = cd.StartSubREQPing
} else {
conf.StartSubREQPing = *cf.StartSubREQPing
}
if cf.StartSubREQPong == nil {
conf.StartSubREQPong = cd.StartSubREQPong
} else {
conf.StartSubREQPong = *cf.StartSubREQPong
}
if cf.StartSubREQCliCommand == nil {
conf.StartSubREQCliCommand = cd.StartSubREQCliCommand
} else {
conf.StartSubREQCliCommand = *cf.StartSubREQCliCommand
}
if cf.StartSubREQToConsole == nil {
conf.StartSubREQToConsole = cd.StartSubREQToConsole
} else {
conf.StartSubREQToConsole = *cf.StartSubREQToConsole
}
if cf.StartSubREQHttpGet == nil {
conf.StartSubREQHttpGet = cd.StartSubREQHttpGet
} else {
conf.StartSubREQHttpGet = *cf.StartSubREQHttpGet
}
2022-02-11 06:27:51 +00:00
if cf.StartSubREQHttpGetScheduled == nil {
conf.StartSubREQHttpGetScheduled = cd.StartSubREQHttpGetScheduled
} else {
conf.StartSubREQHttpGetScheduled = *cf.StartSubREQHttpGetScheduled
}
if cf.StartSubREQTailFile == nil {
conf.StartSubREQTailFile = cd.StartSubREQTailFile
} else {
conf.StartSubREQTailFile = *cf.StartSubREQTailFile
}
if cf.StartSubREQCliCommandCont == nil {
conf.StartSubREQCliCommandCont = cd.StartSubREQCliCommandCont
} else {
conf.StartSubREQCliCommandCont = *cf.StartSubREQCliCommandCont
}
2021-11-10 10:21:38 +00:00
if cf.StartSubREQRelay == nil {
conf.StartSubREQRelay = cd.StartSubREQRelay
} else {
conf.StartSubREQRelay = *cf.StartSubREQRelay
}
return conf
}
2021-04-06 09:02:58 +00:00
// CheckFlags will parse all flags
func (c *Configuration) CheckFlags() error {
// Create an empty default config
var fc Configuration
// Set default configfolder if no env was provided.
configFolder := os.Getenv("CONFIG_FOLDER")
2021-08-27 10:19:35 +00:00
if configFolder == "" {
configFolder = "./etc/"
}
// Read file config. Set system default if it can't find config file.
fc, err := c.ReadConfigFile(configFolder)
if err != nil {
log.Printf("%v\n", err)
fc = newConfigurationDefaults()
}
if configFolder == "" {
fc.ConfigFolder = "./etc/"
} else {
fc.ConfigFolder = configFolder
}
*c = fc
//flag.StringVar(&c.ConfigFolder, "configFolder", fc.ConfigFolder, "Defaults to ./usr/local/steward/etc/. *NB* This flag is not used, if your config file are located somwhere else than default set the location in an env variable named CONFIGFOLDER")
2021-12-21 06:21:12 +00:00
flag.IntVar(&c.RingBufferSize, "ringBufferSize", fc.RingBufferSize, "size of the ringbuffer")
2021-05-12 07:50:03 +00:00
flag.StringVar(&c.SocketFolder, "socketFolder", fc.SocketFolder, "folder who contains the socket file. Defaults to ./tmp/. If other folder is used this flag must be specified at startup.")
flag.StringVar(&c.TCPListener, "tcpListener", fc.TCPListener, "start up a TCP listener in addition to the Unix Socket, to give messages to the system. e.g. localhost:8888. No value means not to start the listener, which is default. NB: You probably don't want to start this on any other interface than localhost")
2021-09-10 03:26:16 +00:00
flag.StringVar(&c.HTTPListener, "httpListener", fc.HTTPListener, "start up a HTTP listener in addition to the Unix Socket, to give messages to the system. e.g. localhost:8888. No value means not to start the listener, which is default. NB: You probably don't want to start this on any other interface than localhost")
2021-05-12 07:50:03 +00:00
flag.StringVar(&c.DatabaseFolder, "databaseFolder", fc.DatabaseFolder, "folder who contains the database file. Defaults to ./var/lib/. If other folder is used this flag must be specified at startup.")
flag.StringVar(&c.NodeName, "nodeName", fc.NodeName, "some unique string to identify this Edge unit")
flag.StringVar(&c.BrokerAddress, "brokerAddress", fc.BrokerAddress, "the address of the message broker")
2021-12-28 11:05:09 +00:00
flag.IntVar(&c.NatsConnOptTimeout, "natsConnOptTimeout", fc.NatsConnOptTimeout, "default nats client conn timeout in seconds")
flag.IntVar(&c.NatsConnectRetryInterval, "natsConnectRetryInterval", fc.NatsConnectRetryInterval, "default nats retry connect interval in seconds.")
2021-12-16 10:01:01 +00:00
flag.IntVar(&c.NatsReconnectJitter, "natsReconnectJitter", fc.NatsReconnectJitter, "default nats ReconnectJitter interval in milliseconds.")
flag.IntVar(&c.NatsReconnectJitterTLS, "natsReconnectJitterTLS", fc.NatsReconnectJitterTLS, "default nats ReconnectJitterTLS interval in seconds.")
2022-04-07 07:34:06 +00:00
flag.IntVar(&c.PublicKeysGetInterval, "publicKeysGetInterval", fc.PublicKeysGetInterval, "default interval in seconds for asking the central for public keys")
flag.StringVar(&c.ProfilingPort, "profilingPort", fc.ProfilingPort, "The number of the profiling port")
flag.StringVar(&c.PromHostAndPort, "promHostAndPort", fc.PromHostAndPort, "host and port for prometheus listener, e.g. localhost:2112")
flag.IntVar(&c.DefaultMessageTimeout, "defaultMessageTimeout", fc.DefaultMessageTimeout, "default message timeout in seconds. This can be overridden on the message level")
flag.IntVar(&c.DefaultMessageRetries, "defaultMessageRetries", fc.DefaultMessageRetries, "default amount of retries that will be done before a message is thrown away, and out of the system")
2021-11-18 05:36:16 +00:00
flag.IntVar(&c.DefaultMethodTimeout, "defaultMethodTimeout", fc.DefaultMethodTimeout, "default amount of seconds a request method max will be allowed to run")
flag.StringVar(&c.SubscribersDataFolder, "subscribersDataFolder", fc.SubscribersDataFolder, "The data folder where subscribers are allowed to write their data if needed")
flag.StringVar(&c.CentralNodeName, "centralNodeName", fc.CentralNodeName, "The name of the central node to receive messages published by this node")
2021-04-19 19:06:37 +00:00
flag.StringVar(&c.RootCAPath, "rootCAPath", fc.RootCAPath, "If TLS, enter the path for where to find the root CA certificate")
flag.StringVar(&c.NkeySeedFile, "nkeySeedFile", fc.NkeySeedFile, "The full path of the nkeys seed file")
2021-08-23 10:47:33 +00:00
flag.StringVar(&c.ExposeDataFolder, "exposeDataFolder", fc.ExposeDataFolder, "If set the data folder will be exposed on the given host:port. Default value is not exposed at all")
flag.IntVar(&c.ErrorMessageTimeout, "errorMessageTimeout", fc.ErrorMessageTimeout, "The number of seconds to wait for an error message to time out")
flag.IntVar(&c.ErrorMessageRetries, "errorMessageRetries", fc.ErrorMessageRetries, "The number of if times to retry an error message before we drop it")
2022-01-03 11:30:28 +00:00
flag.StringVar(&c.Compression, "compression", fc.Compression, "compression method to use. defaults to no compression, z = zstd, g = gzip. Undefined value will default to no compression")
2021-12-29 05:17:40 +00:00
flag.StringVar(&c.Serialization, "serialization", fc.Serialization, "Serialization method to use. defaults to gob, other values are = cbor. Undefined value will default to gob")
flag.IntVar(&c.SetBlockProfileRate, "setBlockProfileRate", fc.SetBlockProfileRate, "Enable block profiling by setting the value to f.ex. 1. 0 = disabled")
flag.BoolVar(&c.EnableSocket, "enableSocket", fc.EnableSocket, "true/false, for enabling the creation of a steward.sock file")
2022-01-07 10:17:10 +00:00
flag.BoolVar(&c.EnableTUI, "enableTUI", fc.EnableTUI, "true/false for enabling the Terminal User Interface")
flag.BoolVar(&c.EnableSignatureCheck, "enableSignatureCheck", fc.EnableSignatureCheck, "true/false *TESTING* enable signature checking.")
flag.BoolVar(&c.IsCentralAuth, "isCentralAuth", fc.IsCentralAuth, "true/false, *TESTING* is this the central auth server")
2022-02-18 05:24:27 +00:00
flag.BoolVar(&c.EnableDebug, "enableDebug", fc.EnableDebug, "true/false, will enable debug logging so all messages sent to the errorKernel will also be printed to STDERR")
2021-04-06 03:46:07 +00:00
flag.IntVar(&c.StartPubREQHello, "startPubREQHello", fc.StartPubREQHello, "Make the current node send hello messages to central at given interval in seconds")
2022-04-07 07:34:06 +00:00
flag.BoolVar(&c.StartPubREQPublicKeysGet, "startPubREQPublicKeysGet", fc.StartPubREQPublicKeysGet, "true/false")
flag.BoolVar(&c.StartSubREQPublicKeysToNode, "startSubREQPublicKeysToNode", fc.StartSubREQPublicKeysToNode, "true/false")
2021-09-08 16:56:23 +00:00
flag.BoolVar(&c.StartSubREQErrorLog, "startSubREQErrorLog", fc.StartSubREQErrorLog, "true/false")
flag.BoolVar(&c.StartSubREQHello, "startSubREQHello", fc.StartSubREQHello, "true/false")
flag.BoolVar(&c.StartSubREQToFileAppend, "startSubREQToFileAppend", fc.StartSubREQToFileAppend, "true/false")
flag.BoolVar(&c.StartSubREQToFile, "startSubREQToFile", fc.StartSubREQToFile, "true/false")
2022-03-04 14:02:43 +00:00
flag.BoolVar(&c.StartSubREQToFileNACK, "startSubREQToFileNACK", fc.StartSubREQToFileNACK, "true/false")
2021-11-17 12:02:48 +00:00
flag.BoolVar(&c.StartSubREQCopyFileFrom, "startSubREQCopyFileFrom", fc.StartSubREQCopyFileFrom, "true/false")
2021-11-18 08:34:16 +00:00
flag.BoolVar(&c.StartSubREQCopyFileTo, "startSubREQCopyFileTo", fc.StartSubREQCopyFileTo, "true/false")
2021-09-08 16:56:23 +00:00
flag.BoolVar(&c.StartSubREQPing, "startSubREQPing", fc.StartSubREQPing, "true/false")
flag.BoolVar(&c.StartSubREQPong, "startSubREQPong", fc.StartSubREQPong, "true/false")
flag.BoolVar(&c.StartSubREQCliCommand, "startSubREQCliCommand", fc.StartSubREQCliCommand, "true/false")
flag.BoolVar(&c.StartSubREQToConsole, "startSubREQToConsole", fc.StartSubREQToConsole, "true/false")
flag.BoolVar(&c.StartSubREQHttpGet, "startSubREQHttpGet", fc.StartSubREQHttpGet, "true/false")
2022-02-11 06:27:51 +00:00
flag.BoolVar(&c.StartSubREQHttpGetScheduled, "startSubREQHttpGetScheduled", fc.StartSubREQHttpGetScheduled, "true/false")
2021-09-08 16:56:23 +00:00
flag.BoolVar(&c.StartSubREQTailFile, "startSubREQTailFile", fc.StartSubREQTailFile, "true/false")
flag.BoolVar(&c.StartSubREQCliCommandCont, "startSubREQCliCommandCont", fc.StartSubREQCliCommandCont, "true/false")
2021-11-10 10:21:38 +00:00
flag.BoolVar(&c.StartSubREQRelay, "startSubREQRelay", fc.StartSubREQRelay, "true/false")
2022-02-10 05:19:13 +00:00
purgeBufferDB := flag.Bool("purgeBufferDB", false, "true/false, purge the incoming buffer db and all it's state")
flag.Parse()
// Check that mandatory flag values have been set.
switch {
case c.NodeName == "":
return fmt.Errorf("error: the nodeName config option or flag cannot be empty, check -help")
case c.CentralNodeName == "":
return fmt.Errorf("error: the centralNodeName config option or flag cannot be empty, check -help")
}
if err := c.WriteConfigFile(); err != nil {
log.Printf("error: checkFlags: failed writing config file: %v\n", err)
os.Exit(1)
}
2022-02-10 05:19:13 +00:00
if *purgeBufferDB {
fp := filepath.Join(c.DatabaseFolder, "incomingBuffer.db")
err := os.Remove(fp)
if err != nil {
log.Printf("error: failed to purge buffer state database: %v\n", err)
}
}
return nil
}
// Reads the current config file from disk.
func (c *Configuration) ReadConfigFile(configFolder string) (Configuration, error) {
fPath := filepath.Join(configFolder, "config.toml")
if _, err := os.Stat(fPath); os.IsNotExist(err) {
return Configuration{}, fmt.Errorf("error: no config file found %v: %v", fPath, err)
}
f, err := os.OpenFile(fPath, os.O_RDONLY, 0600)
if err != nil {
return Configuration{}, fmt.Errorf("error: ReadConfigFile: failed to open file: %v", err)
}
defer f.Close()
var cFile ConfigurationFromFile
dec := toml.NewDecoder(f)
err = dec.Decode(&cFile)
if err != nil {
log.Printf("error: decoding config.toml file. The program will automatically try to correct the problem, and use sane default where it kind find a value to use, but beware of this error in case the program start to behave in not expected ways: path=%v: err=%v", fPath, err)
}
// Check that all values read are ok.
conf := checkConfigValues(cFile)
return conf, nil
}
// WriteConfigFile will write the current config to file. If the file or the
// directory for the config file does not exist it will be created.
func (c *Configuration) WriteConfigFile() error {
if _, err := os.Stat(c.ConfigFolder); os.IsNotExist(err) {
2021-05-12 07:50:03 +00:00
err := os.MkdirAll(c.ConfigFolder, 0700)
if err != nil {
2021-05-20 10:27:25 +00:00
return fmt.Errorf("error: failed to create config directory %v: %v", c.ConfigFolder, err)
}
}
fp := filepath.Join(c.ConfigFolder, "config.toml")
f, err := os.OpenFile(fp, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
if err != nil {
return fmt.Errorf("error: WriteConfigFile: failed to open file: %v", err)
}
defer f.Close()
enc := toml.NewEncoder(f)
enc.Encode(c)
return nil
}