blob: 4e6fd5fddcce923af5934b0676568b44c3717865 [file] [log] [blame]
Girish Gowdru0c588b22019-04-23 23:24:56 -04001/*
cbabu116b73f2019-12-10 17:56:32 +05302* Copyright 2018-present Open Networking Foundation
Girish Gowdru0c588b22019-04-23 23:24:56 -04003
cbabu116b73f2019-12-10 17:56:32 +05304* 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
Girish Gowdru0c588b22019-04-23 23:24:56 -04007
cbabu116b73f2019-12-10 17:56:32 +05308* http://www.apache.org/licenses/LICENSE-2.0
Girish Gowdru0c588b22019-04-23 23:24:56 -04009
cbabu116b73f2019-12-10 17:56:32 +053010* 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.
Girish Gowdru0c588b22019-04-23 23:24:56 -040015 */
Girish Gowdru6a80bbd2019-07-02 07:36:09 -070016
17//Package config provides the Log, kvstore, Kafka configuration
Girish Gowdru0c588b22019-04-23 23:24:56 -040018package config
19
20import (
21 "flag"
22 "fmt"
Girish Gowdru0c588b22019-04-23 23:24:56 -040023 "os"
cbabu116b73f2019-12-10 17:56:32 +053024 "time"
Girish Gowdru0c588b22019-04-23 23:24:56 -040025)
26
27// Open OLT default constants
28const (
cbabu116b73f2019-12-10 17:56:32 +053029 EtcdStoreName = "etcd"
30 defaultInstanceid = "openOlt001"
Neha Sharma3f221ae2020-04-29 19:02:12 +000031 defaultKafkaadapteraddress = "127.0.0.1:9092"
32 defaultKafkaclusteraddress = "127.0.0.1:9094"
cbabu116b73f2019-12-10 17:56:32 +053033 defaultKvstoretype = EtcdStoreName
Neha Sharma3f221ae2020-04-29 19:02:12 +000034 defaultKvstoretimeout = 5 * time.Second
35 defaultKvstoreaddress = "127.0.0.1:2379" // Port: Consul = 8500; Etcd = 2379
David Bainbridge2b3d4882020-03-17 15:06:39 -070036 defaultLoglevel = "WARN"
cbabu116b73f2019-12-10 17:56:32 +053037 defaultBanner = false
38 defaultDisplayVersionOnly = false
39 defaultTopic = "openolt"
40 defaultCoretopic = "rwcore"
41 defaultEventtopic = "voltha.events"
42 defaultOnunumber = 1
Neha Sharma3f221ae2020-04-29 19:02:12 +000043 defaultProbeAddress = ":8080"
cbabu116b73f2019-12-10 17:56:32 +053044 defaultLiveProbeInterval = 60 * time.Second
45 defaultNotLiveProbeInterval = 5 * time.Second // Probe more frequently when not alive
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053046 //defaultHearbeatFailReportInterval is the time in seconds the adapter will keep checking the hardware for heartbeat.
Chaitrashree G Sa4649252020-03-11 21:24:11 -040047 defaultHearbeatCheckInterval = 15 * time.Second
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053048 // defaultHearbeatFailReportInterval is the time adapter will wait before updating the state to the core.
Chaitrashree G Sa4649252020-03-11 21:24:11 -040049 defaultHearbeatFailReportInterval = 0 * time.Second
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053050 //defaultGrpcTimeoutInterval is the time in seconds a grpc call will wait before returning error.
Girish Kumar11e15972020-06-15 14:51:10 +000051 defaultGrpcTimeoutInterval = 2 * time.Second
52 defaultCurrentReplica = 1
53 defaultTotalReplicas = 1
54 defaultTraceEnabled = false
55 defaultTraceAgentAddress = "127.0.0.1:6831"
56 defaultLogCorrelationEnabled = true
kesavand494c2082020-08-31 11:16:12 +053057 defaultOmccEncryption = false
Gamze Abakafcbd6e72020-12-17 13:25:16 +000058 defaultEnableONUStats = false
59 defaultEnableGEMStats = false
Girish Gowdru0c588b22019-04-23 23:24:56 -040060)
61
62// AdapterFlags represents the set of configurations used by the read-write adaptercore service
63type AdapterFlags struct {
64 // Command line parameters
Matteo Scandolodfa7a972020-11-06 13:03:40 -080065 AdapterName string
66 InstanceID string // NOTE what am I used for? why not cli but only ENV? TODO expose in the chart
Neha Sharma3f221ae2020-04-29 19:02:12 +000067 KafkaAdapterAddress string
68 KafkaClusterAddress string
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053069 KVStoreType string
Neha Sharma3f221ae2020-04-29 19:02:12 +000070 KVStoreTimeout time.Duration
71 KVStoreAddress string
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053072 Topic string
73 CoreTopic string
74 EventTopic string
Rohan Agrawal2488f192020-01-31 09:26:55 +000075 LogLevel string
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053076 OnuNumber int
77 Banner bool
78 DisplayVersionOnly bool
Neha Sharma3f221ae2020-04-29 19:02:12 +000079 ProbeAddress string
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053080 LiveProbeInterval time.Duration
81 NotLiveProbeInterval time.Duration
82 HeartbeatCheckInterval time.Duration
83 HeartbeatFailReportInterval time.Duration
84 GrpcTimeoutInterval time.Duration
Matteo Scandolo3ad5d2b2020-04-02 17:02:04 -070085 CurrentReplica int
86 TotalReplicas int
Girish Kumar11e15972020-06-15 14:51:10 +000087 TraceEnabled bool
88 TraceAgentAddress string
89 LogCorrelationEnabled bool
kesavand494c2082020-08-31 11:16:12 +053090 OmccEncryption bool
Gamze Abakafcbd6e72020-12-17 13:25:16 +000091 EnableONUStats bool
92 EnableGEMStats bool
Girish Gowdru0c588b22019-04-23 23:24:56 -040093}
94
Girish Gowdru6a80bbd2019-07-02 07:36:09 -070095// NewAdapterFlags returns a new RWCore config
Girish Gowdru0c588b22019-04-23 23:24:56 -040096func NewAdapterFlags() *AdapterFlags {
97 var adapterFlags = AdapterFlags{ // Default values
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +053098 InstanceID: defaultInstanceid,
Neha Sharma3f221ae2020-04-29 19:02:12 +000099 KafkaAdapterAddress: defaultKafkaadapteraddress,
100 KafkaClusterAddress: defaultKafkaclusteraddress,
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +0530101 KVStoreType: defaultKvstoretype,
102 KVStoreTimeout: defaultKvstoretimeout,
Neha Sharma3f221ae2020-04-29 19:02:12 +0000103 KVStoreAddress: defaultKvstoreaddress,
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +0530104 Topic: defaultTopic,
105 CoreTopic: defaultCoretopic,
106 EventTopic: defaultEventtopic,
107 LogLevel: defaultLoglevel,
108 OnuNumber: defaultOnunumber,
109 Banner: defaultBanner,
110 DisplayVersionOnly: defaultDisplayVersionOnly,
Neha Sharma3f221ae2020-04-29 19:02:12 +0000111 ProbeAddress: defaultProbeAddress,
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +0530112 LiveProbeInterval: defaultLiveProbeInterval,
113 NotLiveProbeInterval: defaultNotLiveProbeInterval,
114 HeartbeatCheckInterval: defaultHearbeatCheckInterval,
115 HeartbeatFailReportInterval: defaultHearbeatFailReportInterval,
116 GrpcTimeoutInterval: defaultGrpcTimeoutInterval,
Girish Kumar11e15972020-06-15 14:51:10 +0000117 TraceEnabled: defaultTraceEnabled,
118 TraceAgentAddress: defaultTraceAgentAddress,
119 LogCorrelationEnabled: defaultLogCorrelationEnabled,
kesavand494c2082020-08-31 11:16:12 +0530120 OmccEncryption: defaultOmccEncryption,
Gamze Abakafcbd6e72020-12-17 13:25:16 +0000121 EnableONUStats: defaultEnableONUStats,
122 EnableGEMStats: defaultEnableGEMStats,
Girish Gowdru0c588b22019-04-23 23:24:56 -0400123 }
124 return &adapterFlags
125}
126
127// ParseCommandArguments parses the arguments when running read-write adaptercore service
128func (so *AdapterFlags) ParseCommandArguments() {
129
Neha Sharma3f221ae2020-04-29 19:02:12 +0000130 help := fmt.Sprintf("Kafka - Adapter messaging address")
131 flag.StringVar(&(so.KafkaAdapterAddress), "kafka_adapter_address", defaultKafkaadapteraddress, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400132
Neha Sharma3f221ae2020-04-29 19:02:12 +0000133 help = fmt.Sprintf("Kafka - Cluster messaging address")
134 flag.StringVar(&(so.KafkaClusterAddress), "kafka_cluster_address", defaultKafkaclusteraddress, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400135
136 help = fmt.Sprintf("Open OLT topic")
Girish Gowdru6a80bbd2019-07-02 07:36:09 -0700137 flag.StringVar(&(so.Topic), "adapter_topic", defaultTopic, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400138
139 help = fmt.Sprintf("Core topic")
Girish Gowdru6a80bbd2019-07-02 07:36:09 -0700140 flag.StringVar(&(so.CoreTopic), "core_topic", defaultCoretopic, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400141
Devmalya Paulfb990a52019-07-09 10:01:49 -0400142 help = fmt.Sprintf("Event topic")
143 flag.StringVar(&(so.EventTopic), "event_topic", defaultEventtopic, help)
144
Girish Gowdru0c588b22019-04-23 23:24:56 -0400145 help = fmt.Sprintf("KV store type")
Girish Gowdru6a80bbd2019-07-02 07:36:09 -0700146 flag.StringVar(&(so.KVStoreType), "kv_store_type", defaultKvstoretype, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400147
148 help = fmt.Sprintf("The default timeout when making a kv store request")
Neha Sharmacc656962020-04-14 14:26:11 +0000149 flag.DurationVar(&(so.KVStoreTimeout), "kv_store_request_timeout", defaultKvstoretimeout, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400150
Neha Sharma3f221ae2020-04-29 19:02:12 +0000151 help = fmt.Sprintf("KV store address")
152 flag.StringVar(&(so.KVStoreAddress), "kv_store_address", defaultKvstoreaddress, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400153
154 help = fmt.Sprintf("Log level")
Rohan Agrawal2488f192020-01-31 09:26:55 +0000155 flag.StringVar(&(so.LogLevel), "log_level", defaultLoglevel, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400156
157 help = fmt.Sprintf("Number of ONUs")
Girish Gowdru6a80bbd2019-07-02 07:36:09 -0700158 flag.IntVar(&(so.OnuNumber), "onu_number", defaultOnunumber, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400159
160 help = fmt.Sprintf("Show startup banner log lines")
Matt Jeanneretf880eb62019-07-16 20:08:03 -0400161 flag.BoolVar(&(so.Banner), "banner", defaultBanner, help)
162
163 help = fmt.Sprintf("Show version information and exit")
164 flag.BoolVar(&(so.DisplayVersionOnly), "version", defaultDisplayVersionOnly, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400165
Rohan Agrawal828bf4e2019-10-22 10:13:19 +0000166 help = fmt.Sprintf("The address on which to listen to answer liveness and readiness probe queries over HTTP.")
Neha Sharma3f221ae2020-04-29 19:02:12 +0000167 flag.StringVar(&(so.ProbeAddress), "probe_address", defaultProbeAddress, help)
Rohan Agrawal828bf4e2019-10-22 10:13:19 +0000168
cbabu116b73f2019-12-10 17:56:32 +0530169 help = fmt.Sprintf("Number of seconds for the default liveliness check")
170 flag.DurationVar(&(so.LiveProbeInterval), "live_probe_interval", defaultLiveProbeInterval, help)
171
172 help = fmt.Sprintf("Number of seconds for liveliness check if probe is not running")
173 flag.DurationVar(&(so.NotLiveProbeInterval), "not_live_probe_interval", defaultNotLiveProbeInterval, help)
174
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +0530175 help = fmt.Sprintf("Number of seconds for heartbeat check interval.")
176 flag.DurationVar(&(so.HeartbeatCheckInterval), "hearbeat_check_interval", defaultHearbeatCheckInterval, help)
Girish Gowdru0c588b22019-04-23 23:24:56 -0400177
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +0530178 help = fmt.Sprintf("Number of seconds adapter has to wait before reporting core on the hearbeat check failure.")
179 flag.DurationVar(&(so.HeartbeatFailReportInterval), "hearbeat_fail_interval", defaultHearbeatFailReportInterval, help)
180
181 help = fmt.Sprintf("Number of seconds for GRPC timeout.")
182 flag.DurationVar(&(so.GrpcTimeoutInterval), "grpc_timeout_interval", defaultGrpcTimeoutInterval, help)
183
Matteo Scandolo3ad5d2b2020-04-02 17:02:04 -0700184 help = "Replica number of this particular instance (default: %s)"
185 flag.IntVar(&(so.CurrentReplica), "current_replica", defaultCurrentReplica, help)
186
187 help = "Total number of instances for this adapter"
188 flag.IntVar(&(so.TotalReplicas), "total_replica", defaultTotalReplicas, help)
189
Girish Kumar11e15972020-06-15 14:51:10 +0000190 help = fmt.Sprintf("Whether to send logs to tracing agent?")
191 flag.BoolVar(&(so.TraceEnabled), "trace_enabled", defaultTraceEnabled, help)
192
193 help = fmt.Sprintf("The address of tracing agent to which span info should be sent.")
194 flag.StringVar(&(so.TraceAgentAddress), "trace_agent_address", defaultTraceAgentAddress, help)
195
196 help = fmt.Sprintf("Whether to enrich log statements with fields denoting operation being executed for achieving correlation?")
197 flag.BoolVar(&(so.LogCorrelationEnabled), "log_correlation_enabled", defaultLogCorrelationEnabled, help)
198
kesavand494c2082020-08-31 11:16:12 +0530199 help = fmt.Sprintf("OMCI Channel encryption status")
200 flag.BoolVar(&(so.OmccEncryption), "omcc_encryption", defaultOmccEncryption, help)
201
Gamze Abakafcbd6e72020-12-17 13:25:16 +0000202 help = fmt.Sprintf("Enable ONU Statistics")
203 flag.BoolVar(&(so.EnableONUStats), "enable_onu_stats", defaultEnableONUStats, help)
204
205 help = fmt.Sprintf("Enable GEM Statistics")
206 flag.BoolVar(&(so.EnableGEMStats), "enable_gem_stats", defaultEnableGEMStats, help)
207
Abhilash Laxmeshwarf9942e92020-01-07 15:32:44 +0530208 flag.Parse()
Girish Gowdru0c588b22019-04-23 23:24:56 -0400209 containerName := getContainerInfo()
210 if len(containerName) > 0 {
211 so.InstanceID = containerName
212 }
213
214}
215
216func getContainerInfo() string {
217 return os.Getenv("HOSTNAME")
218}