blob: 5e76275b81ccbce08a1a3a0b64670916881952d9 [file] [log] [blame]
Holger Hildebrandtfa074992020-03-27 15:42:06 +00001/*
2* Copyright 2018-present Open Networking Foundation
3
4* Licensed under the Apache License, Version 2.0 (the "License");
5* you may not use this file except in compliance with the License.
6* You may obtain a copy of the License at
7
8* http://www.apache.org/licenses/LICENSE-2.0
9
10* Unless required by applicable law or agreed to in writing, software
11* distributed under the License is distributed on an "AS IS" BASIS,
12* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13* See the License for the specific language governing permissions and
14* limitations under the License.
15 */
16
17//Package config provides the Log, kvstore, Kafka configuration
18package config
19
20import (
21 "flag"
22 "fmt"
23 "os"
24 "time"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000025)
26
27// Open ONU default constants
28const (
Himani Chawla6d2ae152020-09-02 13:11:20 +053029 etcdStoreName = "etcd"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000030 defaultInstanceid = "openonu"
Matteo Scandolo127c59d2021-01-28 11:31:18 -080031 defaultKafkaadapteraddress = "127.0.0.1:9092"
32 defaultKafkaclusteraddress = "127.0.0.1:9092"
Himani Chawla6d2ae152020-09-02 13:11:20 +053033 defaultKvstoretype = etcdStoreName
mpagenkoaf801632020-07-03 10:00:42 +000034 defaultKvstoretimeout = 5 * time.Second
Matteo Scandolo127c59d2021-01-28 11:31:18 -080035 defaultKvstoreaddress = "127.0.0.1:2379"
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000036 defaultLoglevel = "WARN"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000037 defaultBanner = false
38 defaultDisplayVersionOnly = false
mpagenkodff5dda2020-08-28 11:52:01 +000039 defaultAccIncrEvto = false
Holger Hildebrandtfa074992020-03-27 15:42:06 +000040 defaultTopic = "openonu"
Holger Hildebrandta768fe92020-10-01 13:06:21 +000041 defaultCoreTopic = "rwcore"
42 defaultEventTopic = "voltha.events"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000043 defaultOnunumber = 1
44 defaultProbeHost = ""
45 defaultProbePort = 8080
46 defaultLiveProbeInterval = 60 * time.Second
47 defaultNotLiveProbeInterval = 5 * time.Second // Probe more frequently when not alive
48 //defaultHearbeatFailReportInterval is the time in seconds the adapter will keep checking the hardware for heartbeat.
49 defaultHearbeatCheckInterval = 30 * time.Second
50 // defaultHearbeatFailReportInterval is the time adapter will wait before updating the state to the core.
51 defaultHearbeatFailReportInterval = 180 * time.Second
52 //defaultKafkaReconnectRetries -1: reconnect endlessly.
Himani Chawlad96df182020-09-28 11:12:02 +053053 defaultKafkaReconnectRetries = -1
54 defaultCurrentReplica = 1
55 defaultTotalReplicas = 1
56 defaultMaxTimeoutInterAdapterComm = 30 * time.Second
Andrea Campanella3d7c9312021-01-19 09:20:49 +010057 defaultOnuVendorIds = "OPEN,ALCL,BRCM,TWSH,ALPH,ISKT,SFAA,BBSM,SCOM,ARPX,DACM,ERSN,HWTC,CIGG,ADTN,ARCA,AVMG"
dbainbri4d3a0dc2020-12-02 00:33:42 +000058
59 // For Tracing
60 defaultTraceEnabled = false
61 defaultTraceAgentAddress = "127.0.0.1:6831"
62 defaultLogCorrelationEnabled = true
Girish Gowdraaf0ad632021-01-27 13:00:01 -080063
64 defaultMetricsEnabled = false
Holger Hildebrandtfa074992020-03-27 15:42:06 +000065)
66
67// AdapterFlags represents the set of configurations used by the read-write adaptercore service
68type AdapterFlags struct {
69 // Command line parameters
70 InstanceID string
Matteo Scandolo127c59d2021-01-28 11:31:18 -080071 KafkaAdapterAddress string
72 KafkaClusterAddress string // NOTE this is unused across the adapter
Holger Hildebrandtfa074992020-03-27 15:42:06 +000073 KVStoreType string
mpagenkoaf801632020-07-03 10:00:42 +000074 KVStoreTimeout time.Duration
Matteo Scandolo127c59d2021-01-28 11:31:18 -080075 KVStoreAddress string
Holger Hildebrandtfa074992020-03-27 15:42:06 +000076 Topic string
77 CoreTopic string
78 EventTopic string
79 LogLevel string
80 OnuNumber int
81 Banner bool
82 DisplayVersionOnly bool
mpagenkodff5dda2020-08-28 11:52:01 +000083 AccIncrEvto bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000084 ProbeHost string
85 ProbePort int
86 LiveProbeInterval time.Duration
87 NotLiveProbeInterval time.Duration
88 HeartbeatCheckInterval time.Duration
89 HeartbeatFailReportInterval time.Duration
90 KafkaReconnectRetries int
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000091 CurrentReplica int
92 TotalReplicas int
Himani Chawlad96df182020-09-28 11:12:02 +053093 MaxTimeoutInterAdapterComm time.Duration
dbainbri4d3a0dc2020-12-02 00:33:42 +000094 TraceEnabled bool
95 TraceAgentAddress string
96 LogCorrelationEnabled bool
Andrea Campanella3d7c9312021-01-19 09:20:49 +010097 OnuVendorIds string
Girish Gowdraaf0ad632021-01-27 13:00:01 -080098 MetricsEnabled bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000099}
100
101// NewAdapterFlags returns a new RWCore config
102func NewAdapterFlags() *AdapterFlags {
103 var adapterFlags = AdapterFlags{ // Default values
104 InstanceID: defaultInstanceid,
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800105 KafkaAdapterAddress: defaultKafkaadapteraddress,
106 KafkaClusterAddress: defaultKafkaclusteraddress,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000107 KVStoreType: defaultKvstoretype,
108 KVStoreTimeout: defaultKvstoretimeout,
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800109 KVStoreAddress: defaultKvstoreaddress,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000110 Topic: defaultTopic,
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000111 CoreTopic: defaultCoreTopic,
112 EventTopic: defaultEventTopic,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000113 LogLevel: defaultLoglevel,
114 OnuNumber: defaultOnunumber,
115 Banner: defaultBanner,
116 DisplayVersionOnly: defaultDisplayVersionOnly,
mpagenkodff5dda2020-08-28 11:52:01 +0000117 AccIncrEvto: defaultAccIncrEvto,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000118 ProbeHost: defaultProbeHost,
119 ProbePort: defaultProbePort,
120 LiveProbeInterval: defaultLiveProbeInterval,
121 NotLiveProbeInterval: defaultNotLiveProbeInterval,
122 HeartbeatCheckInterval: defaultHearbeatCheckInterval,
123 HeartbeatFailReportInterval: defaultHearbeatFailReportInterval,
124 KafkaReconnectRetries: defaultKafkaReconnectRetries,
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000125 CurrentReplica: defaultCurrentReplica,
126 TotalReplicas: defaultTotalReplicas,
Himani Chawlad96df182020-09-28 11:12:02 +0530127 MaxTimeoutInterAdapterComm: defaultMaxTimeoutInterAdapterComm,
dbainbri4d3a0dc2020-12-02 00:33:42 +0000128 TraceEnabled: defaultTraceEnabled,
129 TraceAgentAddress: defaultTraceAgentAddress,
130 LogCorrelationEnabled: defaultLogCorrelationEnabled,
Andrea Campanella3d7c9312021-01-19 09:20:49 +0100131 OnuVendorIds: defaultOnuVendorIds,
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800132 MetricsEnabled: defaultMetricsEnabled,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000133 }
134 return &adapterFlags
135}
136
137// ParseCommandArguments parses the arguments when running read-write adaptercore service
138func (so *AdapterFlags) ParseCommandArguments() {
139
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800140 help := fmt.Sprintf("Kafka - Adapter messaging address")
141 flag.StringVar(&(so.KafkaAdapterAddress), "kafka_adapter_address", defaultKafkaadapteraddress, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000142
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800143 help = fmt.Sprintf("Kafka - Cluster messaging address")
144 flag.StringVar(&(so.KafkaClusterAddress), "kafka_cluster_address", defaultKafkaclusteraddress, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000145
146 help = fmt.Sprintf("Open ONU topic")
Andrea Campanella961734c2021-01-18 11:44:47 +0100147 baseAdapterTopic := flag.String("adapter_topic", defaultTopic, help)
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000148
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000149 help = fmt.Sprintf("Core topic")
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000150 flag.StringVar(&(so.CoreTopic), "core_topic", defaultCoreTopic, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000151
152 help = fmt.Sprintf("Event topic")
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000153 flag.StringVar(&(so.EventTopic), "event_topic", defaultEventTopic, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000154
155 help = fmt.Sprintf("KV store type")
156 flag.StringVar(&(so.KVStoreType), "kv_store_type", defaultKvstoretype, help)
157
158 help = fmt.Sprintf("The default timeout when making a kv store request")
mpagenkoaf801632020-07-03 10:00:42 +0000159 flag.DurationVar(&(so.KVStoreTimeout), "kv_store_request_timeout", defaultKvstoretimeout, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000160
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800161 help = fmt.Sprintf("KV store address")
162 flag.StringVar(&(so.KVStoreAddress), "kv_store_address", defaultKvstoreaddress, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000163
164 help = fmt.Sprintf("Log level")
165 flag.StringVar(&(so.LogLevel), "log_level", defaultLoglevel, help)
166
167 help = fmt.Sprintf("Number of ONUs")
168 flag.IntVar(&(so.OnuNumber), "onu_number", defaultOnunumber, help)
169
170 help = fmt.Sprintf("Show startup banner log lines")
171 flag.BoolVar(&(so.Banner), "banner", defaultBanner, help)
172
173 help = fmt.Sprintf("Show version information and exit")
174 flag.BoolVar(&(so.DisplayVersionOnly), "version", defaultDisplayVersionOnly, help)
175
mpagenkodff5dda2020-08-28 11:52:01 +0000176 help = fmt.Sprintf("Acceptance of incremental EVTOCD configuration")
177 flag.BoolVar(&(so.AccIncrEvto), "accept_incr_evto", defaultAccIncrEvto, help)
178
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000179 help = fmt.Sprintf("The address on which to listen to answer liveness and readiness probe queries over HTTP.")
180 flag.StringVar(&(so.ProbeHost), "probe_host", defaultProbeHost, help)
181
182 help = fmt.Sprintf("The port on which to listen to answer liveness and readiness probe queries over HTTP.")
183 flag.IntVar(&(so.ProbePort), "probe_port", defaultProbePort, help)
184
185 help = fmt.Sprintf("Number of seconds for the default liveliness check")
186 flag.DurationVar(&(so.LiveProbeInterval), "live_probe_interval", defaultLiveProbeInterval, help)
187
188 help = fmt.Sprintf("Number of seconds for liveliness check if probe is not running")
189 flag.DurationVar(&(so.NotLiveProbeInterval), "not_live_probe_interval", defaultNotLiveProbeInterval, help)
190
191 help = fmt.Sprintf("Number of seconds for heartbeat check interval.")
192 flag.DurationVar(&(so.HeartbeatCheckInterval), "hearbeat_check_interval", defaultHearbeatCheckInterval, help)
193
194 help = fmt.Sprintf("Number of seconds adapter has to wait before reporting core on the hearbeat check failure.")
195 flag.DurationVar(&(so.HeartbeatFailReportInterval), "hearbeat_fail_interval", defaultHearbeatFailReportInterval, help)
196
197 help = fmt.Sprintf("Number of retries to connect to Kafka.")
198 flag.IntVar(&(so.KafkaReconnectRetries), "kafka_reconnect_retries", defaultKafkaReconnectRetries, help)
199
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000200 help = "Replica number of this particular instance (default: %s)"
201 flag.IntVar(&(so.CurrentReplica), "current_replica", defaultCurrentReplica, help)
202
203 help = "Total number of instances for this adapter"
204 flag.IntVar(&(so.TotalReplicas), "total_replica", defaultTotalReplicas, help)
205
Himani Chawlad96df182020-09-28 11:12:02 +0530206 help = fmt.Sprintf("Maximum Number of seconds for the default interadapter communication timeout")
207 flag.DurationVar(&(so.MaxTimeoutInterAdapterComm), "max_timeout_interadapter_comm",
208 defaultMaxTimeoutInterAdapterComm, help)
209
dbainbri4d3a0dc2020-12-02 00:33:42 +0000210 help = fmt.Sprintf("Whether to send logs to tracing agent?")
211 flag.BoolVar(&(so.TraceEnabled), "trace_enabled", defaultTraceEnabled, help)
212
213 help = fmt.Sprintf("The address of tracing agent to which span info should be sent.")
214 flag.StringVar(&(so.TraceAgentAddress), "trace_agent_address", defaultTraceAgentAddress, help)
215
216 help = fmt.Sprintf("Whether to enrich log statements with fields denoting operation being executed for achieving correlation?")
217 flag.BoolVar(&(so.LogCorrelationEnabled), "log_correlation_enabled", defaultLogCorrelationEnabled, help)
218
Andrea Campanella3d7c9312021-01-19 09:20:49 +0100219 help = fmt.Sprintf("List of Allowed ONU Vendor Ids")
220 flag.StringVar(&(so.OnuVendorIds), "allowed_onu_vendors", defaultOnuVendorIds, help)
221
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800222 help = fmt.Sprintf("Whether to enable metrics collection")
223 flag.BoolVar(&(so.MetricsEnabled), "metrics_enabled", defaultMetricsEnabled, help)
224
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000225 flag.Parse()
226 containerName := getContainerInfo()
227 if len(containerName) > 0 {
228 so.InstanceID = containerName
229 }
230
Andrea Campanella961734c2021-01-18 11:44:47 +0100231 so.Topic = fmt.Sprintf("%s_%d", *baseAdapterTopic, int32(so.CurrentReplica))
232
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000233}
234
235func getContainerInfo() string {
236 return os.Getenv("HOSTNAME")
237}