blob: 9f210deab04d451bc4a072ba4184e3f16d713e1c [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
Holger Hildebrandt38985dc2021-02-18 16:25:20 +000057 defaultMaxTimeoutReconciling = 10 * time.Second
Andrea Campanella3d7c9312021-01-19 09:20:49 +010058 defaultOnuVendorIds = "OPEN,ALCL,BRCM,TWSH,ALPH,ISKT,SFAA,BBSM,SCOM,ARPX,DACM,ERSN,HWTC,CIGG,ADTN,ARCA,AVMG"
dbainbri4d3a0dc2020-12-02 00:33:42 +000059
60 // For Tracing
61 defaultTraceEnabled = false
62 defaultTraceAgentAddress = "127.0.0.1:6831"
63 defaultLogCorrelationEnabled = true
Girish Gowdraaf0ad632021-01-27 13:00:01 -080064
Holger Hildebrandte3677f12021-02-05 14:50:56 +000065 defaultMetricsEnabled = false
66 defaultMibAuditInterval = 0
Girish Gowdra0b235842021-03-09 13:06:46 -080067
68 defaultOmciTimeout = 3 * time.Second
Holger Hildebrandtfa074992020-03-27 15:42:06 +000069)
70
71// AdapterFlags represents the set of configurations used by the read-write adaptercore service
72type AdapterFlags struct {
73 // Command line parameters
74 InstanceID string
Matteo Scandolo127c59d2021-01-28 11:31:18 -080075 KafkaAdapterAddress string
76 KafkaClusterAddress string // NOTE this is unused across the adapter
Holger Hildebrandtfa074992020-03-27 15:42:06 +000077 KVStoreType string
mpagenkoaf801632020-07-03 10:00:42 +000078 KVStoreTimeout time.Duration
Matteo Scandolo127c59d2021-01-28 11:31:18 -080079 KVStoreAddress string
Holger Hildebrandtfa074992020-03-27 15:42:06 +000080 Topic string
81 CoreTopic string
82 EventTopic string
83 LogLevel string
84 OnuNumber int
85 Banner bool
86 DisplayVersionOnly bool
mpagenkodff5dda2020-08-28 11:52:01 +000087 AccIncrEvto bool
Holger Hildebrandtfa074992020-03-27 15:42:06 +000088 ProbeHost string
89 ProbePort int
90 LiveProbeInterval time.Duration
91 NotLiveProbeInterval time.Duration
92 HeartbeatCheckInterval time.Duration
93 HeartbeatFailReportInterval time.Duration
94 KafkaReconnectRetries int
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000095 CurrentReplica int
96 TotalReplicas int
Himani Chawlad96df182020-09-28 11:12:02 +053097 MaxTimeoutInterAdapterComm time.Duration
Holger Hildebrandt38985dc2021-02-18 16:25:20 +000098 MaxTimeoutReconciling time.Duration
dbainbri4d3a0dc2020-12-02 00:33:42 +000099 TraceEnabled bool
100 TraceAgentAddress string
101 LogCorrelationEnabled bool
Andrea Campanella3d7c9312021-01-19 09:20:49 +0100102 OnuVendorIds string
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800103 MetricsEnabled bool
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000104 MibAuditInterval time.Duration
Girish Gowdra0b235842021-03-09 13:06:46 -0800105 OmciTimeout time.Duration
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000106}
107
108// NewAdapterFlags returns a new RWCore config
109func NewAdapterFlags() *AdapterFlags {
110 var adapterFlags = AdapterFlags{ // Default values
111 InstanceID: defaultInstanceid,
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800112 KafkaAdapterAddress: defaultKafkaadapteraddress,
113 KafkaClusterAddress: defaultKafkaclusteraddress,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000114 KVStoreType: defaultKvstoretype,
115 KVStoreTimeout: defaultKvstoretimeout,
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800116 KVStoreAddress: defaultKvstoreaddress,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000117 Topic: defaultTopic,
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000118 CoreTopic: defaultCoreTopic,
119 EventTopic: defaultEventTopic,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000120 LogLevel: defaultLoglevel,
121 OnuNumber: defaultOnunumber,
122 Banner: defaultBanner,
123 DisplayVersionOnly: defaultDisplayVersionOnly,
mpagenkodff5dda2020-08-28 11:52:01 +0000124 AccIncrEvto: defaultAccIncrEvto,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000125 ProbeHost: defaultProbeHost,
126 ProbePort: defaultProbePort,
127 LiveProbeInterval: defaultLiveProbeInterval,
128 NotLiveProbeInterval: defaultNotLiveProbeInterval,
129 HeartbeatCheckInterval: defaultHearbeatCheckInterval,
130 HeartbeatFailReportInterval: defaultHearbeatFailReportInterval,
131 KafkaReconnectRetries: defaultKafkaReconnectRetries,
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000132 CurrentReplica: defaultCurrentReplica,
133 TotalReplicas: defaultTotalReplicas,
Himani Chawlad96df182020-09-28 11:12:02 +0530134 MaxTimeoutInterAdapterComm: defaultMaxTimeoutInterAdapterComm,
Holger Hildebrandt38985dc2021-02-18 16:25:20 +0000135 MaxTimeoutReconciling: defaultMaxTimeoutReconciling,
dbainbri4d3a0dc2020-12-02 00:33:42 +0000136 TraceEnabled: defaultTraceEnabled,
137 TraceAgentAddress: defaultTraceAgentAddress,
138 LogCorrelationEnabled: defaultLogCorrelationEnabled,
Andrea Campanella3d7c9312021-01-19 09:20:49 +0100139 OnuVendorIds: defaultOnuVendorIds,
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800140 MetricsEnabled: defaultMetricsEnabled,
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000141 MibAuditInterval: defaultMibAuditInterval,
Girish Gowdra0b235842021-03-09 13:06:46 -0800142 OmciTimeout: defaultOmciTimeout,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000143 }
144 return &adapterFlags
145}
146
147// ParseCommandArguments parses the arguments when running read-write adaptercore service
148func (so *AdapterFlags) ParseCommandArguments() {
149
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800150 help := fmt.Sprintf("Kafka - Adapter messaging address")
151 flag.StringVar(&(so.KafkaAdapterAddress), "kafka_adapter_address", defaultKafkaadapteraddress, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000152
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800153 help = fmt.Sprintf("Kafka - Cluster messaging address")
154 flag.StringVar(&(so.KafkaClusterAddress), "kafka_cluster_address", defaultKafkaclusteraddress, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000155
156 help = fmt.Sprintf("Open ONU topic")
Andrea Campanella961734c2021-01-18 11:44:47 +0100157 baseAdapterTopic := flag.String("adapter_topic", defaultTopic, help)
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000158
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000159 help = fmt.Sprintf("Core topic")
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000160 flag.StringVar(&(so.CoreTopic), "core_topic", defaultCoreTopic, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000161
162 help = fmt.Sprintf("Event topic")
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000163 flag.StringVar(&(so.EventTopic), "event_topic", defaultEventTopic, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000164
165 help = fmt.Sprintf("KV store type")
166 flag.StringVar(&(so.KVStoreType), "kv_store_type", defaultKvstoretype, help)
167
168 help = fmt.Sprintf("The default timeout when making a kv store request")
mpagenkoaf801632020-07-03 10:00:42 +0000169 flag.DurationVar(&(so.KVStoreTimeout), "kv_store_request_timeout", defaultKvstoretimeout, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000170
Matteo Scandolo127c59d2021-01-28 11:31:18 -0800171 help = fmt.Sprintf("KV store address")
172 flag.StringVar(&(so.KVStoreAddress), "kv_store_address", defaultKvstoreaddress, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000173
174 help = fmt.Sprintf("Log level")
175 flag.StringVar(&(so.LogLevel), "log_level", defaultLoglevel, help)
176
177 help = fmt.Sprintf("Number of ONUs")
178 flag.IntVar(&(so.OnuNumber), "onu_number", defaultOnunumber, help)
179
180 help = fmt.Sprintf("Show startup banner log lines")
181 flag.BoolVar(&(so.Banner), "banner", defaultBanner, help)
182
183 help = fmt.Sprintf("Show version information and exit")
184 flag.BoolVar(&(so.DisplayVersionOnly), "version", defaultDisplayVersionOnly, help)
185
mpagenkodff5dda2020-08-28 11:52:01 +0000186 help = fmt.Sprintf("Acceptance of incremental EVTOCD configuration")
187 flag.BoolVar(&(so.AccIncrEvto), "accept_incr_evto", defaultAccIncrEvto, help)
188
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000189 help = fmt.Sprintf("The address on which to listen to answer liveness and readiness probe queries over HTTP.")
190 flag.StringVar(&(so.ProbeHost), "probe_host", defaultProbeHost, help)
191
192 help = fmt.Sprintf("The port on which to listen to answer liveness and readiness probe queries over HTTP.")
193 flag.IntVar(&(so.ProbePort), "probe_port", defaultProbePort, help)
194
195 help = fmt.Sprintf("Number of seconds for the default liveliness check")
196 flag.DurationVar(&(so.LiveProbeInterval), "live_probe_interval", defaultLiveProbeInterval, help)
197
198 help = fmt.Sprintf("Number of seconds for liveliness check if probe is not running")
199 flag.DurationVar(&(so.NotLiveProbeInterval), "not_live_probe_interval", defaultNotLiveProbeInterval, help)
200
201 help = fmt.Sprintf("Number of seconds for heartbeat check interval.")
202 flag.DurationVar(&(so.HeartbeatCheckInterval), "hearbeat_check_interval", defaultHearbeatCheckInterval, help)
203
204 help = fmt.Sprintf("Number of seconds adapter has to wait before reporting core on the hearbeat check failure.")
205 flag.DurationVar(&(so.HeartbeatFailReportInterval), "hearbeat_fail_interval", defaultHearbeatFailReportInterval, help)
206
207 help = fmt.Sprintf("Number of retries to connect to Kafka.")
208 flag.IntVar(&(so.KafkaReconnectRetries), "kafka_reconnect_retries", defaultKafkaReconnectRetries, help)
209
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000210 help = "Replica number of this particular instance (default: %s)"
211 flag.IntVar(&(so.CurrentReplica), "current_replica", defaultCurrentReplica, help)
212
213 help = "Total number of instances for this adapter"
214 flag.IntVar(&(so.TotalReplicas), "total_replica", defaultTotalReplicas, help)
215
Himani Chawlad96df182020-09-28 11:12:02 +0530216 help = fmt.Sprintf("Maximum Number of seconds for the default interadapter communication timeout")
217 flag.DurationVar(&(so.MaxTimeoutInterAdapterComm), "max_timeout_interadapter_comm",
218 defaultMaxTimeoutInterAdapterComm, help)
219
Holger Hildebrandt38985dc2021-02-18 16:25:20 +0000220 help = fmt.Sprintf("Maximum Number of seconds for the default ONU reconciling timeout")
221 flag.DurationVar(&(so.MaxTimeoutReconciling), "max_timeout_reconciling",
222 defaultMaxTimeoutReconciling, help)
223
dbainbri4d3a0dc2020-12-02 00:33:42 +0000224 help = fmt.Sprintf("Whether to send logs to tracing agent?")
225 flag.BoolVar(&(so.TraceEnabled), "trace_enabled", defaultTraceEnabled, help)
226
227 help = fmt.Sprintf("The address of tracing agent to which span info should be sent.")
228 flag.StringVar(&(so.TraceAgentAddress), "trace_agent_address", defaultTraceAgentAddress, help)
229
230 help = fmt.Sprintf("Whether to enrich log statements with fields denoting operation being executed for achieving correlation?")
231 flag.BoolVar(&(so.LogCorrelationEnabled), "log_correlation_enabled", defaultLogCorrelationEnabled, help)
232
Andrea Campanella3d7c9312021-01-19 09:20:49 +0100233 help = fmt.Sprintf("List of Allowed ONU Vendor Ids")
234 flag.StringVar(&(so.OnuVendorIds), "allowed_onu_vendors", defaultOnuVendorIds, help)
235
Girish Gowdraaf0ad632021-01-27 13:00:01 -0800236 help = fmt.Sprintf("Whether to enable metrics collection")
237 flag.BoolVar(&(so.MetricsEnabled), "metrics_enabled", defaultMetricsEnabled, help)
238
Holger Hildebrandte3677f12021-02-05 14:50:56 +0000239 help = fmt.Sprintf("Mib Audit Interval in seconds - the value zero will disable Mib Audit")
240 flag.DurationVar(&(so.MibAuditInterval), "mib_audit_interval", defaultMibAuditInterval, help)
241
Girish Gowdra0b235842021-03-09 13:06:46 -0800242 help = fmt.Sprintf("OMCI timeout duration - this timeout value is used on the OMCI channel for waiting on response from ONU")
243 flag.DurationVar(&(so.OmciTimeout), "omci_timeout", defaultOmciTimeout, help)
244
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000245 flag.Parse()
246 containerName := getContainerInfo()
247 if len(containerName) > 0 {
248 so.InstanceID = containerName
249 }
250
Andrea Campanella961734c2021-01-18 11:44:47 +0100251 so.Topic = fmt.Sprintf("%s_%d", *baseAdapterTopic, int32(so.CurrentReplica))
252
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000253}
254
255func getContainerInfo() string {
256 return os.Getenv("HOSTNAME")
257}