blob: 59b8da6e32b904bfd6d166be1c7480cec5c575bf [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"
31 defaultKafkaadapterhost = "192.168.0.20"
32 defaultKafkaadapterport = 9092
33 defaultKafkaclusterhost = "10.100.198.220"
34 defaultKafkaclusterport = 9092
Himani Chawla6d2ae152020-09-02 13:11:20 +053035 defaultKvstoretype = etcdStoreName
mpagenkoaf801632020-07-03 10:00:42 +000036 defaultKvstoretimeout = 5 * time.Second
Holger Hildebrandtfa074992020-03-27 15:42:06 +000037 defaultKvstorehost = "localhost"
38 defaultKvstoreport = 2379 // Consul = 8500; Etcd = 2379
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +000039 defaultLoglevel = "WARN"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000040 defaultBanner = false
41 defaultDisplayVersionOnly = false
mpagenkodff5dda2020-08-28 11:52:01 +000042 defaultAccIncrEvto = false
Holger Hildebrandtfa074992020-03-27 15:42:06 +000043 defaultTopic = "openonu"
Holger Hildebrandta768fe92020-10-01 13:06:21 +000044 defaultCoreTopic = "rwcore"
45 defaultEventTopic = "voltha.events"
Holger Hildebrandtfa074992020-03-27 15:42:06 +000046 defaultOnunumber = 1
47 defaultProbeHost = ""
48 defaultProbePort = 8080
49 defaultLiveProbeInterval = 60 * time.Second
50 defaultNotLiveProbeInterval = 5 * time.Second // Probe more frequently when not alive
51 //defaultHearbeatFailReportInterval is the time in seconds the adapter will keep checking the hardware for heartbeat.
52 defaultHearbeatCheckInterval = 30 * time.Second
53 // defaultHearbeatFailReportInterval is the time adapter will wait before updating the state to the core.
54 defaultHearbeatFailReportInterval = 180 * time.Second
55 //defaultKafkaReconnectRetries -1: reconnect endlessly.
Himani Chawlad96df182020-09-28 11:12:02 +053056 defaultKafkaReconnectRetries = -1
57 defaultCurrentReplica = 1
58 defaultTotalReplicas = 1
59 defaultMaxTimeoutInterAdapterComm = 30 * time.Second
Andrea Campanella3d7c9312021-01-19 09:20:49 +010060 defaultOnuVendorIds = "OPEN,ALCL,BRCM,TWSH,ALPH,ISKT,SFAA,BBSM,SCOM,ARPX,DACM,ERSN,HWTC,CIGG,ADTN,ARCA,AVMG"
dbainbri4d3a0dc2020-12-02 00:33:42 +000061
62 // For Tracing
63 defaultTraceEnabled = false
64 defaultTraceAgentAddress = "127.0.0.1:6831"
65 defaultLogCorrelationEnabled = true
Holger Hildebrandtfa074992020-03-27 15:42:06 +000066)
67
68// AdapterFlags represents the set of configurations used by the read-write adaptercore service
69type AdapterFlags struct {
70 // Command line parameters
71 InstanceID string
72 KafkaAdapterHost string
73 KafkaAdapterPort int
74 KafkaClusterHost string
75 KafkaClusterPort int
76 KVStoreType string
mpagenkoaf801632020-07-03 10:00:42 +000077 KVStoreTimeout time.Duration
Holger Hildebrandtfa074992020-03-27 15:42:06 +000078 KVStoreHost string
79 KVStorePort int
80 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
dbainbri4d3a0dc2020-12-02 00:33:42 +000098 TraceEnabled bool
99 TraceAgentAddress string
100 LogCorrelationEnabled bool
Andrea Campanella3d7c9312021-01-19 09:20:49 +0100101 OnuVendorIds string
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000102}
103
104// NewAdapterFlags returns a new RWCore config
105func NewAdapterFlags() *AdapterFlags {
106 var adapterFlags = AdapterFlags{ // Default values
107 InstanceID: defaultInstanceid,
108 KafkaAdapterHost: defaultKafkaadapterhost,
109 KafkaAdapterPort: defaultKafkaadapterport,
110 KafkaClusterHost: defaultKafkaclusterhost,
111 KafkaClusterPort: defaultKafkaclusterport,
112 KVStoreType: defaultKvstoretype,
113 KVStoreTimeout: defaultKvstoretimeout,
114 KVStoreHost: defaultKvstorehost,
115 KVStorePort: defaultKvstoreport,
116 Topic: defaultTopic,
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000117 CoreTopic: defaultCoreTopic,
118 EventTopic: defaultEventTopic,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000119 LogLevel: defaultLoglevel,
120 OnuNumber: defaultOnunumber,
121 Banner: defaultBanner,
122 DisplayVersionOnly: defaultDisplayVersionOnly,
mpagenkodff5dda2020-08-28 11:52:01 +0000123 AccIncrEvto: defaultAccIncrEvto,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000124 ProbeHost: defaultProbeHost,
125 ProbePort: defaultProbePort,
126 LiveProbeInterval: defaultLiveProbeInterval,
127 NotLiveProbeInterval: defaultNotLiveProbeInterval,
128 HeartbeatCheckInterval: defaultHearbeatCheckInterval,
129 HeartbeatFailReportInterval: defaultHearbeatFailReportInterval,
130 KafkaReconnectRetries: defaultKafkaReconnectRetries,
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000131 CurrentReplica: defaultCurrentReplica,
132 TotalReplicas: defaultTotalReplicas,
Himani Chawlad96df182020-09-28 11:12:02 +0530133 MaxTimeoutInterAdapterComm: defaultMaxTimeoutInterAdapterComm,
dbainbri4d3a0dc2020-12-02 00:33:42 +0000134 TraceEnabled: defaultTraceEnabled,
135 TraceAgentAddress: defaultTraceAgentAddress,
136 LogCorrelationEnabled: defaultLogCorrelationEnabled,
Andrea Campanella3d7c9312021-01-19 09:20:49 +0100137 OnuVendorIds: defaultOnuVendorIds,
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000138 }
139 return &adapterFlags
140}
141
142// ParseCommandArguments parses the arguments when running read-write adaptercore service
143func (so *AdapterFlags) ParseCommandArguments() {
144
145 help := fmt.Sprintf("Kafka - Adapter messaging host")
146 flag.StringVar(&(so.KafkaAdapterHost), "kafka_adapter_host", defaultKafkaadapterhost, help)
147
148 help = fmt.Sprintf("Kafka - Adapter messaging port")
149 flag.IntVar(&(so.KafkaAdapterPort), "kafka_adapter_port", defaultKafkaadapterport, help)
150
151 help = fmt.Sprintf("Kafka - Cluster messaging host")
152 flag.StringVar(&(so.KafkaClusterHost), "kafka_cluster_host", defaultKafkaclusterhost, help)
153
154 help = fmt.Sprintf("Kafka - Cluster messaging port")
155 flag.IntVar(&(so.KafkaClusterPort), "kafka_cluster_port", defaultKafkaclusterport, help)
156
157 help = fmt.Sprintf("Open ONU topic")
Andrea Campanella961734c2021-01-18 11:44:47 +0100158 baseAdapterTopic := flag.String("adapter_topic", defaultTopic, help)
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000159
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000160 help = fmt.Sprintf("Core topic")
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000161 flag.StringVar(&(so.CoreTopic), "core_topic", defaultCoreTopic, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000162
163 help = fmt.Sprintf("Event topic")
Holger Hildebrandta768fe92020-10-01 13:06:21 +0000164 flag.StringVar(&(so.EventTopic), "event_topic", defaultEventTopic, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000165
166 help = fmt.Sprintf("KV store type")
167 flag.StringVar(&(so.KVStoreType), "kv_store_type", defaultKvstoretype, help)
168
169 help = fmt.Sprintf("The default timeout when making a kv store request")
mpagenkoaf801632020-07-03 10:00:42 +0000170 flag.DurationVar(&(so.KVStoreTimeout), "kv_store_request_timeout", defaultKvstoretimeout, help)
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000171
172 help = fmt.Sprintf("KV store host")
173 flag.StringVar(&(so.KVStoreHost), "kv_store_host", defaultKvstorehost, help)
174
175 help = fmt.Sprintf("KV store port")
176 flag.IntVar(&(so.KVStorePort), "kv_store_port", defaultKvstoreport, help)
177
178 help = fmt.Sprintf("Log level")
179 flag.StringVar(&(so.LogLevel), "log_level", defaultLoglevel, help)
180
181 help = fmt.Sprintf("Number of ONUs")
182 flag.IntVar(&(so.OnuNumber), "onu_number", defaultOnunumber, help)
183
184 help = fmt.Sprintf("Show startup banner log lines")
185 flag.BoolVar(&(so.Banner), "banner", defaultBanner, help)
186
187 help = fmt.Sprintf("Show version information and exit")
188 flag.BoolVar(&(so.DisplayVersionOnly), "version", defaultDisplayVersionOnly, help)
189
mpagenkodff5dda2020-08-28 11:52:01 +0000190 help = fmt.Sprintf("Acceptance of incremental EVTOCD configuration")
191 flag.BoolVar(&(so.AccIncrEvto), "accept_incr_evto", defaultAccIncrEvto, help)
192
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000193 help = fmt.Sprintf("The address on which to listen to answer liveness and readiness probe queries over HTTP.")
194 flag.StringVar(&(so.ProbeHost), "probe_host", defaultProbeHost, help)
195
196 help = fmt.Sprintf("The port on which to listen to answer liveness and readiness probe queries over HTTP.")
197 flag.IntVar(&(so.ProbePort), "probe_port", defaultProbePort, help)
198
199 help = fmt.Sprintf("Number of seconds for the default liveliness check")
200 flag.DurationVar(&(so.LiveProbeInterval), "live_probe_interval", defaultLiveProbeInterval, help)
201
202 help = fmt.Sprintf("Number of seconds for liveliness check if probe is not running")
203 flag.DurationVar(&(so.NotLiveProbeInterval), "not_live_probe_interval", defaultNotLiveProbeInterval, help)
204
205 help = fmt.Sprintf("Number of seconds for heartbeat check interval.")
206 flag.DurationVar(&(so.HeartbeatCheckInterval), "hearbeat_check_interval", defaultHearbeatCheckInterval, help)
207
208 help = fmt.Sprintf("Number of seconds adapter has to wait before reporting core on the hearbeat check failure.")
209 flag.DurationVar(&(so.HeartbeatFailReportInterval), "hearbeat_fail_interval", defaultHearbeatFailReportInterval, help)
210
211 help = fmt.Sprintf("Number of retries to connect to Kafka.")
212 flag.IntVar(&(so.KafkaReconnectRetries), "kafka_reconnect_retries", defaultKafkaReconnectRetries, help)
213
Holger Hildebrandt0f9b88d2020-04-20 13:33:25 +0000214 help = "Replica number of this particular instance (default: %s)"
215 flag.IntVar(&(so.CurrentReplica), "current_replica", defaultCurrentReplica, help)
216
217 help = "Total number of instances for this adapter"
218 flag.IntVar(&(so.TotalReplicas), "total_replica", defaultTotalReplicas, help)
219
Himani Chawlad96df182020-09-28 11:12:02 +0530220 help = fmt.Sprintf("Maximum Number of seconds for the default interadapter communication timeout")
221 flag.DurationVar(&(so.MaxTimeoutInterAdapterComm), "max_timeout_interadapter_comm",
222 defaultMaxTimeoutInterAdapterComm, 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
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000236 flag.Parse()
237 containerName := getContainerInfo()
238 if len(containerName) > 0 {
239 so.InstanceID = containerName
240 }
241
Andrea Campanella961734c2021-01-18 11:44:47 +0100242 so.Topic = fmt.Sprintf("%s_%d", *baseAdapterTopic, int32(so.CurrentReplica))
243
Holger Hildebrandtfa074992020-03-27 15:42:06 +0000244}
245
246func getContainerInfo() string {
247 return os.Getenv("HOSTNAME")
248}