blob: deae0f3bffd7c7a5a69ea128f92662f868e6462e [file] [log] [blame]
khenaidoobf6e7bb2018-08-14 22:27:29 -04001/*
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 */
khenaidoocfee5f42018-07-19 22:47:38 -040016package config
17
18import (
khenaidoocfee5f42018-07-19 22:47:38 -040019 "flag"
20 "fmt"
Scott Bakercb7c88a2019-10-16 18:32:48 -070021 "github.com/opencord/voltha-lib-go/pkg/log"
khenaidoocfee5f42018-07-19 22:47:38 -040022)
23
khenaidoo5c11af72018-07-20 17:21:05 -040024// RW Core service default constants
khenaidoocfee5f42018-07-19 22:47:38 -040025const (
khenaidoo2c6a0992019-04-29 13:46:56 -040026 ConsulStoreName = "consul"
27 EtcdStoreName = "etcd"
khenaidoo2c6a0992019-04-29 13:46:56 -040028 default_GrpcPort = 50057
29 default_GrpcHost = ""
30 default_KafkaAdapterHost = "127.0.0.1"
31 default_KafkaAdapterPort = 9092
32 default_KafkaClusterHost = "127.0.0.1"
33 default_KafkaClusterPort = 9094
34 default_KVStoreType = EtcdStoreName
35 default_KVStoreTimeout = 5 //in seconds
36 default_KVStoreHost = "127.0.0.1"
37 default_KVStorePort = 2379 // Consul = 8500; Etcd = 2379
38 default_KVTxnKeyDelTime = 60
39 default_KVStoreDataPrefix = "service/voltha"
40 default_LogLevel = 0
41 default_Banner = false
David K. Bainbridgef430cd52019-05-28 15:00:35 -070042 default_DisplayVersionOnly = false
khenaidoo2c6a0992019-04-29 13:46:56 -040043 default_CoreTopic = "rwcore"
44 default_RWCoreEndpoint = "rwcore"
45 default_RWCoreKey = "pki/voltha.key"
46 default_RWCoreCert = "pki/voltha.crt"
47 default_RWCoreCA = "pki/voltha-CA.pem"
48 default_AffinityRouterTopic = "affinityRouter"
49 default_InCompetingMode = true
khenaidoob6080322019-01-29 21:47:38 -050050 default_LongRunningRequestTimeout = int64(2000)
khenaidoo2c6a0992019-04-29 13:46:56 -040051 default_DefaultRequestTimeout = int64(500)
52 default_CoreTimeout = int64(500)
53 default_CoreBindingKey = "voltha_backend_name"
Kent Hagermana6d0c362019-07-30 12:50:21 -040054 default_CorePairTopic = "rwcore_1"
khenaidoob3244212019-08-27 14:32:27 -040055 default_MaxConnectionRetries = -1 // retries forever
56 default_ConnectionRetryInterval = 2 // in seconds
Kent Hagermanc4618832019-10-07 12:24:36 -040057 default_ProbeHost = ""
David K. Bainbridgeb4a9ab02019-09-20 15:12:16 -070058 default_ProbePort = 8080
khenaidoocfee5f42018-07-19 22:47:38 -040059)
60
khenaidoo5c11af72018-07-20 17:21:05 -040061// RWCoreFlags represents the set of configurations used by the read-write core service
khenaidoocfee5f42018-07-19 22:47:38 -040062type RWCoreFlags struct {
63 // Command line parameters
khenaidoo2c6a0992019-04-29 13:46:56 -040064 RWCoreEndpoint string
65 GrpcHost string
66 GrpcPort int
67 KafkaAdapterHost string
68 KafkaAdapterPort int
69 KafkaClusterHost string
70 KafkaClusterPort int
71 KVStoreType string
72 KVStoreTimeout int // in seconds
73 KVStoreHost string
74 KVStorePort int
75 KVTxnKeyDelTime int
76 KVStoreDataPrefix string
77 CoreTopic string
78 LogLevel int
79 Banner bool
David K. Bainbridgef430cd52019-05-28 15:00:35 -070080 DisplayVersionOnly bool
khenaidoo2c6a0992019-04-29 13:46:56 -040081 RWCoreKey string
82 RWCoreCert string
83 RWCoreCA string
84 AffinityRouterTopic string
85 InCompetingMode bool
khenaidoob6080322019-01-29 21:47:38 -050086 LongRunningRequestTimeout int64
khenaidoo2c6a0992019-04-29 13:46:56 -040087 DefaultRequestTimeout int64
88 DefaultCoreTimeout int64
89 CoreBindingKey string
Kent Hagermana6d0c362019-07-30 12:50:21 -040090 CorePairTopic string
khenaidoob3244212019-08-27 14:32:27 -040091 MaxConnectionRetries int
92 ConnectionRetryInterval int
Kent Hagermanc4618832019-10-07 12:24:36 -040093 ProbeHost string
David K. Bainbridgeb4a9ab02019-09-20 15:12:16 -070094 ProbePort int
khenaidoocfee5f42018-07-19 22:47:38 -040095}
96
khenaidoob9203542018-09-17 22:56:37 -040097func init() {
98 log.AddPackage(log.JSON, log.WarnLevel, nil)
99}
100
khenaidoo5c11af72018-07-20 17:21:05 -0400101// NewRWCoreFlags returns a new RWCore config
khenaidoocfee5f42018-07-19 22:47:38 -0400102func NewRWCoreFlags() *RWCoreFlags {
103 var rwCoreFlag = RWCoreFlags{ // Default values
khenaidoo2c6a0992019-04-29 13:46:56 -0400104 RWCoreEndpoint: default_RWCoreEndpoint,
105 GrpcHost: default_GrpcHost,
106 GrpcPort: default_GrpcPort,
107 KafkaAdapterHost: default_KafkaAdapterHost,
108 KafkaAdapterPort: default_KafkaAdapterPort,
109 KafkaClusterHost: default_KafkaClusterHost,
110 KafkaClusterPort: default_KafkaClusterPort,
111 KVStoreType: default_KVStoreType,
112 KVStoreTimeout: default_KVStoreTimeout,
113 KVStoreHost: default_KVStoreHost,
114 KVStorePort: default_KVStorePort,
115 KVStoreDataPrefix: default_KVStoreDataPrefix,
116 KVTxnKeyDelTime: default_KVTxnKeyDelTime,
117 CoreTopic: default_CoreTopic,
118 LogLevel: default_LogLevel,
119 Banner: default_Banner,
David K. Bainbridgef430cd52019-05-28 15:00:35 -0700120 DisplayVersionOnly: default_DisplayVersionOnly,
khenaidoo2c6a0992019-04-29 13:46:56 -0400121 RWCoreKey: default_RWCoreKey,
122 RWCoreCert: default_RWCoreCert,
123 RWCoreCA: default_RWCoreCA,
124 AffinityRouterTopic: default_AffinityRouterTopic,
125 InCompetingMode: default_InCompetingMode,
126 DefaultRequestTimeout: default_DefaultRequestTimeout,
127 LongRunningRequestTimeout: default_LongRunningRequestTimeout,
128 DefaultCoreTimeout: default_CoreTimeout,
129 CoreBindingKey: default_CoreBindingKey,
Kent Hagermana6d0c362019-07-30 12:50:21 -0400130 CorePairTopic: default_CorePairTopic,
khenaidoob3244212019-08-27 14:32:27 -0400131 MaxConnectionRetries: default_MaxConnectionRetries,
132 ConnectionRetryInterval: default_ConnectionRetryInterval,
Kent Hagermanc4618832019-10-07 12:24:36 -0400133 ProbeHost: default_ProbeHost,
David K. Bainbridgeb4a9ab02019-09-20 15:12:16 -0700134 ProbePort: default_ProbePort,
khenaidoocfee5f42018-07-19 22:47:38 -0400135 }
136 return &rwCoreFlag
137}
138
khenaidoo5c11af72018-07-20 17:21:05 -0400139// ParseCommandArguments parses the arguments when running read-write core service
khenaidoocfee5f42018-07-19 22:47:38 -0400140func (cf *RWCoreFlags) ParseCommandArguments() {
khenaidoocfee5f42018-07-19 22:47:38 -0400141
khenaidoo5c11af72018-07-20 17:21:05 -0400142 var help string
khenaidoocfee5f42018-07-19 22:47:38 -0400143
khenaidoo5c11af72018-07-20 17:21:05 -0400144 help = fmt.Sprintf("RW core endpoint address")
145 flag.StringVar(&(cf.RWCoreEndpoint), "vcore-endpoint", default_RWCoreEndpoint, help)
khenaidoocfee5f42018-07-19 22:47:38 -0400146
khenaidoo5c11af72018-07-20 17:21:05 -0400147 help = fmt.Sprintf("GRPC server - host")
148 flag.StringVar(&(cf.GrpcHost), "grpc_host", default_GrpcHost, help)
khenaidoocfee5f42018-07-19 22:47:38 -0400149
khenaidoo5c11af72018-07-20 17:21:05 -0400150 help = fmt.Sprintf("GRPC server - port")
151 flag.IntVar(&(cf.GrpcPort), "grpc_port", default_GrpcPort, help)
152
153 help = fmt.Sprintf("Kafka - Adapter messaging host")
154 flag.StringVar(&(cf.KafkaAdapterHost), "kafka_adapter_host", default_KafkaAdapterHost, help)
155
156 help = fmt.Sprintf("Kafka - Adapter messaging port")
157 flag.IntVar(&(cf.KafkaAdapterPort), "kafka_adapter_port", default_KafkaAdapterPort, help)
158
159 help = fmt.Sprintf("Kafka - Cluster messaging host")
160 flag.StringVar(&(cf.KafkaClusterHost), "kafka_cluster_host", default_KafkaClusterHost, help)
161
162 help = fmt.Sprintf("Kafka - Cluster messaging port")
163 flag.IntVar(&(cf.KafkaClusterPort), "kafka_cluster_port", default_KafkaClusterPort, help)
164
165 help = fmt.Sprintf("RW Core topic")
166 flag.StringVar(&(cf.CoreTopic), "rw_core_topic", default_CoreTopic, help)
167
khenaidoo79232702018-12-04 11:00:41 -0500168 help = fmt.Sprintf("Affinity Router topic")
khenaidoo9cdc1a62019-01-24 21:57:40 -0500169 flag.StringVar(&(cf.AffinityRouterTopic), "affinity_router_topic", default_AffinityRouterTopic, help)
170
171 help = fmt.Sprintf("In competing Mode - two cores competing to handle a transaction ")
172 flag.BoolVar(&cf.InCompetingMode, "in_competing_mode", default_InCompetingMode, help)
khenaidoo79232702018-12-04 11:00:41 -0500173
khenaidoo5c11af72018-07-20 17:21:05 -0400174 help = fmt.Sprintf("KV store type")
175 flag.StringVar(&(cf.KVStoreType), "kv_store_type", default_KVStoreType, help)
176
177 help = fmt.Sprintf("The default timeout when making a kv store request")
178 flag.IntVar(&(cf.KVStoreTimeout), "kv_store_request_timeout", default_KVStoreTimeout, help)
179
180 help = fmt.Sprintf("KV store host")
181 flag.StringVar(&(cf.KVStoreHost), "kv_store_host", default_KVStoreHost, help)
182
183 help = fmt.Sprintf("KV store port")
184 flag.IntVar(&(cf.KVStorePort), "kv_store_port", default_KVStorePort, help)
185
Richard Jankowskie4d77662018-10-17 13:53:21 -0400186 help = fmt.Sprintf("The time to wait before deleting a completed transaction key")
187 flag.IntVar(&(cf.KVTxnKeyDelTime), "kv_txn_delete_time", default_KVTxnKeyDelTime, help)
188
khenaidoo9cdc1a62019-01-24 21:57:40 -0500189 help = fmt.Sprintf("KV store data prefix")
190 flag.StringVar(&(cf.KVStoreDataPrefix), "kv_store_data_prefix", default_KVStoreDataPrefix, help)
191
khenaidoo5c11af72018-07-20 17:21:05 -0400192 help = fmt.Sprintf("Log level")
193 flag.IntVar(&(cf.LogLevel), "log_level", default_LogLevel, help)
194
khenaidoob6080322019-01-29 21:47:38 -0500195 help = fmt.Sprintf("Timeout for long running request")
196 flag.Int64Var(&(cf.LongRunningRequestTimeout), "timeout_long_request", default_LongRunningRequestTimeout, help)
197
198 help = fmt.Sprintf("Default timeout for regular request")
199 flag.Int64Var(&(cf.DefaultRequestTimeout), "timeout_request", default_DefaultRequestTimeout, help)
200
khenaidoo2c6a0992019-04-29 13:46:56 -0400201 help = fmt.Sprintf("Default Core timeout")
202 flag.Int64Var(&(cf.DefaultCoreTimeout), "core_timeout", default_CoreTimeout, help)
203
khenaidoo5c11af72018-07-20 17:21:05 -0400204 help = fmt.Sprintf("Show startup banner log lines")
205 flag.BoolVar(&cf.Banner, "banner", default_Banner, help)
khenaidoocfee5f42018-07-19 22:47:38 -0400206
David K. Bainbridgef430cd52019-05-28 15:00:35 -0700207 help = fmt.Sprintf("Show version information and exit")
208 flag.BoolVar(&cf.DisplayVersionOnly, "version", default_DisplayVersionOnly, help)
209
Richard Jankowski46464e92019-03-05 11:53:55 -0500210 help = fmt.Sprintf("The name of the meta-key whose value is the rw-core group to which the ofagent is bound")
211 flag.StringVar(&(cf.CoreBindingKey), "core_binding_key", default_CoreBindingKey, help)
212
Kent Hagermana6d0c362019-07-30 12:50:21 -0400213 help = fmt.Sprintf("Core pairing group topic")
214 flag.StringVar(&cf.CorePairTopic, "core_pair_topic", default_CorePairTopic, help)
215
khenaidoob3244212019-08-27 14:32:27 -0400216 help = fmt.Sprintf("The number of retries to connect to a dependent component")
217 flag.IntVar(&(cf.MaxConnectionRetries), "max_connection_retries", default_MaxConnectionRetries, help)
218
219 help = fmt.Sprintf("The number of seconds between each connection retry attempt ")
220 flag.IntVar(&(cf.ConnectionRetryInterval), "connection_retry_interval", default_ConnectionRetryInterval, help)
221
Kent Hagermanc4618832019-10-07 12:24:36 -0400222 help = fmt.Sprintf("The host on which to listen to answer liveness and readiness probe queries over HTTP.")
223 flag.StringVar(&(cf.ProbeHost), "probe_host", default_ProbeHost, help)
224
David K. Bainbridgeb4a9ab02019-09-20 15:12:16 -0700225 help = fmt.Sprintf("The port on which to listen to answer liveness and readiness probe queries over HTTP.")
226 flag.IntVar(&(cf.ProbePort), "probe_port", default_ProbePort, help)
227
khenaidoocfee5f42018-07-19 22:47:38 -0400228 flag.Parse()
khenaidoocfee5f42018-07-19 22:47:38 -0400229}