-
Notifications
You must be signed in to change notification settings - Fork 348
/
config.go
2235 lines (2037 loc) · 80.4 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package config
import (
"flag"
"fmt"
"io/ioutil"
"net"
"net/url"
"os"
"path/filepath"
"reflect"
"runtime"
"strconv"
"strings"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"github.com/urfave/cli/v2"
gcfg "gopkg.in/gcfg.v1"
lumberjack "gopkg.in/natefinch/lumberjack.v2"
"k8s.io/klog/v2"
kexec "k8s.io/utils/exec"
utilnet "k8s.io/utils/net"
"github.com/ovn-org/ovn-kubernetes/go-controller/pkg/types"
)
// DefaultEncapPort number used if not supplied
const DefaultEncapPort = 6081
const DefaultAPIServer = "http://localhost:8443"
// Default IANA-assigned UDP port number for VXLAN
const DefaultVXLANPort = 4789
// The following are global config parameters that other modules may access directly
var (
// Build information. Populated at build-time.
// commit ID used to build ovn-kubernetes
Commit = ""
// branch used to build ovn-kubernetes
Branch = ""
// ovn-kubernetes build user
BuildUser = ""
// ovn-kubernetes build date
BuildDate = ""
// ovn-kubernetes version, to be changed with every release
Version = "0.3.0"
// version of the go runtime used to compile ovn-kubernetes
GoVersion = runtime.Version()
// os and architecture used to build ovn-kubernetes
OSArch = fmt.Sprintf("%s %s", runtime.GOOS, runtime.GOARCH)
// ovn-kubernetes cni config file name
CNIConfFileName = "10-ovn-kubernetes.conf"
// Default holds parsed config file parameters and command-line overrides
Default = DefaultConfig{
MTU: 1400,
ConntrackZone: 64000,
EncapType: "geneve",
EncapIP: "",
EncapPort: DefaultEncapPort,
InactivityProbe: 100000, // in Milliseconds
OpenFlowProbe: 180, // in Seconds
OfctrlWaitBeforeClear: 0, // in Milliseconds
MonitorAll: true,
LFlowCacheEnable: true,
RawClusterSubnets: "10.128.0.0/14/23",
}
// Logging holds logging-related parsed config file parameters and command-line overrides
Logging = LoggingConfig{
File: "", // do not log to a file by default
CNIFile: "",
Level: 4,
LogFileMaxSize: 100, // Size in Megabytes
LogFileMaxBackups: 5,
LogFileMaxAge: 5, //days
ACLLoggingRateLimit: 20,
}
// Monitoring holds monitoring-related parsed config file parameters and command-line overrides
Monitoring = MonitoringConfig{
RawNetFlowTargets: "",
RawSFlowTargets: "",
RawIPFIXTargets: "",
}
// IPFIX holds IPFIX-related performance configuration options. It requires that the
// IPFIXTargets value of the Monitoring section contains at least one endpoint.
IPFIX = IPFIXConfig{
Sampling: 400,
CacheActiveTimeout: 60,
CacheMaxFlows: 0,
}
// CNI holds CNI-related parsed config file parameters and command-line overrides
CNI = CNIConfig{
ConfDir: "/etc/cni/net.d",
Plugin: "ovn-k8s-cni-overlay",
}
// Kubernetes holds Kubernetes-related parsed config file parameters and command-line overrides
Kubernetes = KubernetesConfig{
APIServer: DefaultAPIServer,
RawServiceCIDRs: "172.16.1.0/24",
OVNConfigNamespace: "ovn-kubernetes",
HostNetworkNamespace: "",
PlatformType: "",
}
// Metrics holds Prometheus metrics-related parameters.
Metrics MetricsConfig
// OVNKubernetesFeatureConfig holds OVN-Kubernetes feature enhancement config file parameters and command-line overrides
OVNKubernetesFeature = OVNKubernetesFeatureConfig{
EgressIPReachabiltyTotalTimeout: 1,
}
// OvnNorth holds northbound OVN database client and server authentication and location details
OvnNorth OvnAuthConfig
// OvnSouth holds southbound OVN database client and server authentication and location details
OvnSouth OvnAuthConfig
// Gateway holds node gateway-related parsed config file parameters and command-line overrides
Gateway = GatewayConfig{
V4JoinSubnet: "100.64.0.0/16",
V6JoinSubnet: "fd98::/64",
}
// MasterHA holds master HA related config options.
MasterHA = MasterHAConfig{
ElectionLeaseDuration: 60,
ElectionRenewDeadline: 30,
ElectionRetryPeriod: 20,
}
// HybridOverlay holds hybrid overlay feature config options.
HybridOverlay = HybridOverlayConfig{
VXLANPort: DefaultVXLANPort,
}
// UnprivilegedMode allows ovnkube-node to run without SYS_ADMIN capability, by performing interface setup in the CNI plugin
UnprivilegedMode bool
// EnableMulticast enables multicast support between the pods within the same namespace
EnableMulticast bool
// IPv4Mode captures whether we are using IPv4 for OVN logical topology. (ie, single-stack IPv4 or dual-stack)
IPv4Mode bool
// IPv6Mode captures whether we are using IPv6 for OVN logical topology. (ie, single-stack IPv6 or dual-stack)
IPv6Mode bool
// OvnKubeNode holds ovnkube-node parsed config file parameters and command-line overrides
OvnKubeNode = OvnKubeNodeConfig{
Mode: types.NodeModeFull,
}
)
const (
kubeServiceAccountPath string = "/var/run/secrets/kubernetes.io/serviceaccount/"
kubeServiceAccountFileToken string = "token"
kubeServiceAccountFileCACert string = "ca.crt"
)
// DefaultConfig holds parsed config file parameters and command-line overrides
type DefaultConfig struct {
// MTU value used for the overlay networks.
MTU int `gcfg:"mtu"`
// RoutableMTU is the maximum routable MTU between nodes, used to facilitate
// an MTU migration procedure where different nodes might be using different
// MTU values
RoutableMTU int `gcfg:"routable-mtu"`
// ConntrackZone affects only the gateway nodes, This value is used to track connections
// that are initiated from the pods so that the reverse connections go back to the pods.
// This represents the conntrack zone used for the conntrack flow rules.
ConntrackZone int `gcfg:"conntrack-zone"`
// EncapType value defines the encapsulation protocol to use to transmit packets between
// hypervisors. By default the value is 'geneve'
EncapType string `gcfg:"encap-type"`
// The IP address of the encapsulation endpoint. If not specified, the IP address the
// NodeName resolves to will be used
EncapIP string `gcfg:"encap-ip"`
// The UDP Port of the encapsulation endpoint. If not specified, the IP default port
// of 6081 will be used
EncapPort uint `gcfg:"encap-port"`
// Maximum number of milliseconds of idle time on connection that
// ovn-controller waits before it will send a connection health probe.
InactivityProbe int `gcfg:"inactivity-probe"`
// Maximum number of seconds of idle time on the OpenFlow connection
// that ovn-controller will wait before it sends a connection health probe
OpenFlowProbe int `gcfg:"openflow-probe"`
// Maximum number of milliseconds that ovn-controller waits before clearing existing flows
// during start up, to make sure the initial flow compute is complete and avoid data plane
// interruptions.
OfctrlWaitBeforeClear int `gcfg:"ofctrl-wait-before-clear"`
// The boolean flag indicates if ovn-controller should monitor all data in SB DB
// instead of conditionally monitoring the data relevant to this node only.
// By default monitor-all is enabled.
MonitorAll bool `gcfg:"monitor-all"`
// The boolean flag indicates if ovn-controller should
// enable/disable the logical flow in-memory cache it uses
// when processing Southbound database logical flow changes.
// By default caching is enabled.
LFlowCacheEnable bool `gcfg:"enable-lflow-cache"`
// Maximum number of logical flow cache entries ovn-controller
// may create when the logical flow cache is enabled. By
// default the size of the cache is unlimited.
LFlowCacheLimit uint `gcfg:"lflow-cache-limit"`
// Maximum number of logical flow cache entries ovn-controller
// may create when the logical flow cache is enabled. By
// default the size of the cache is unlimited.
LFlowCacheLimitKb uint `gcfg:"lflow-cache-limit-kb"`
// RawClusterSubnets holds the unparsed cluster subnets. Should only be
// used inside config module.
RawClusterSubnets string `gcfg:"cluster-subnets"`
// ClusterSubnets holds parsed cluster subnet entries and may be used
// outside the config module.
ClusterSubnets []CIDRNetworkEntry
// EnableUDPAggregation is true if ovn-kubernetes should use UDP Generic Receive
// Offload forwarding to improve the performance of containers that transmit lots
// of small UDP packets by allowing them to be aggregated before passing through
// the kernel network stack. This requires a new-enough kernel (5.15 or RHEL 8.5).
EnableUDPAggregation bool `gcfg:"enable-udp-aggregation"`
}
// LoggingConfig holds logging-related parsed config file parameters and command-line overrides
type LoggingConfig struct {
// File is the path of the file to log to
File string `gcfg:"logfile"`
// CNIFile is the path of the file for the CNI shim to log to
CNIFile string `gcfg:"cnilogfile"`
// Level is the logging verbosity level
Level int `gcfg:"loglevel"`
// LogFileMaxSize is the maximum size in bytes of the logfile
// before it gets rolled.
LogFileMaxSize int `gcfg:"logfile-maxsize"`
// LogFileMaxBackups represents the the maximum number of old log files to retain
LogFileMaxBackups int `gcfg:"logfile-maxbackups"`
// LogFileMaxAge represents the maximum number of days to retain old log files
LogFileMaxAge int `gcfg:"logfile-maxage"`
// Logging rate-limiting meter
ACLLoggingRateLimit int `gcfg:"acl-logging-rate-limit"`
}
// MonitoringConfig holds monitoring-related parsed config file parameters and command-line overrides
type MonitoringConfig struct {
// RawNetFlowTargets holds the unparsed NetFlow targets. Should only be used inside the config module.
RawNetFlowTargets string `gcfg:"netflow-targets"`
// RawSFlowTargets holds the unparsed SFlow targets. Should only be used inside the config module.
RawSFlowTargets string `gcfg:"sflow-targets"`
// RawIPFIXTargets holds the unparsed IPFIX targets. Should only be used inside the config module.
RawIPFIXTargets string `gcfg:"ipfix-targets"`
// NetFlowTargets holds the parsed NetFlow targets and may be used outside the config module.
NetFlowTargets []HostPort
// SFlowTargets holds the parsed SFlow targets and may be used outside the config module.
SFlowTargets []HostPort
// IPFIXTargets holds the parsed IPFIX targets and may be used outside the config module.
IPFIXTargets []HostPort
}
// IPFIXConfig holds IPFIX-related performance configuration options. It requires that the ipfix-targets
// value of the [monitoring] section contains at least one endpoint.
type IPFIXConfig struct {
// Sampling is an optional integer in range 1 to 4,294,967,295. It holds the rate at which
// packets should be sampled and sent to each target collector. If not specified, defaults to
// 400, which means one out of 400 packets, on average, will be sent to each target collector.
Sampling uint `gcfg:"sampling"`
// CacheActiveTimeout is an optional integer in range 0 to 4,200. It holds the maximum period in
// seconds for which an IPFIX flow record is cached and aggregated before being sent. If not
// specified, defaults to 60. If 0, caching is disabled.
CacheActiveTimeout uint `gcfg:"cache-active-timeout"`
// CacheMaxFlows is an optional integer in range 0 to 4,294,967,295. It holds the maximum number
// of IPFIX flow records that can be cached at a time. If not specified in OVS, defaults to 0
// (however, this controller defaults it to 60). If 0, caching is disabled.
CacheMaxFlows uint `gcfg:"cache-max-flows"`
}
// CNIConfig holds CNI-related parsed config file parameters and command-line overrides
type CNIConfig struct {
// ConfDir specifies the CNI config directory in which to write the overlay CNI config file
ConfDir string `gcfg:"conf-dir"`
// Plugin specifies the name of the CNI plugin
Plugin string `gcfg:"plugin"`
}
// KubernetesConfig holds Kubernetes-related parsed config file parameters and command-line overrides
type KubernetesConfig struct {
Kubeconfig string `gcfg:"kubeconfig"`
CACert string `gcfg:"cacert"`
CAData []byte
APIServer string `gcfg:"apiserver"`
Token string `gcfg:"token"`
TokenFile string `gcfg:"tokenFile"`
CompatServiceCIDR string `gcfg:"service-cidr"`
RawServiceCIDRs string `gcfg:"service-cidrs"`
ServiceCIDRs []*net.IPNet
OVNConfigNamespace string `gcfg:"ovn-config-namespace"`
OVNEmptyLbEvents bool `gcfg:"ovn-empty-lb-events"`
PodIP string `gcfg:"pod-ip"` // UNUSED
RawNoHostSubnetNodes string `gcfg:"no-hostsubnet-nodes"`
NoHostSubnetNodes *metav1.LabelSelector
HostNetworkNamespace string `gcfg:"host-network-namespace"`
PlatformType string `gcfg:"platform-type"`
// CompatMetricsBindAddress is overridden by the corresponding option in MetricsConfig
CompatMetricsBindAddress string `gcfg:"metrics-bind-address"`
// CompatOVNMetricsBindAddress is overridden by the corresponding option in MetricsConfig
CompatOVNMetricsBindAddress string `gcfg:"ovn-metrics-bind-address"`
// CompatMetricsEnablePprof is overridden by the corresponding option in MetricsConfig
CompatMetricsEnablePprof bool `gcfg:"metrics-enable-pprof"`
}
// MetricsConfig holds Prometheus metrics-related parameters.
type MetricsConfig struct {
BindAddress string `gcfg:"bind-address"`
OVNMetricsBindAddress string `gcfg:"ovn-metrics-bind-address"`
ExportOVSMetrics bool `gcfg:"export-ovs-metrics"`
EnablePprof bool `gcfg:"enable-pprof"`
NodeServerPrivKey string `gcfg:"node-server-privkey"`
NodeServerCert string `gcfg:"node-server-cert"`
// EnableConfigDuration holds the boolean flag to enable OVN-Kubernetes master to monitor OVN-Kubernetes master
// configuration duration and optionally, its application to all nodes
EnableConfigDuration bool `gcfg:"enable-config-duration"`
EnableEIPScaleMetrics bool `gcfg:"enable-eip-scale-metrics"`
}
// OVNKubernetesFeatureConfig holds OVN-Kubernetes feature enhancement config file parameters and command-line overrides
type OVNKubernetesFeatureConfig struct {
// EgressIP feature is enabled
EnableEgressIP bool `gcfg:"enable-egress-ip"`
// EgressIP node reachability total timeout in seconds
EgressIPReachabiltyTotalTimeout int `gcfg:"egressip-reachability-total-timeout"`
EnableEgressFirewall bool `gcfg:"enable-egress-firewall"`
EnableEgressQoS bool `gcfg:"enable-egress-qos"`
EgressIPNodeHealthCheckPort int `gcfg:"egressip-node-healthcheck-port"`
}
// GatewayMode holds the node gateway mode
type GatewayMode string
const (
// GatewayModeDisabled indicates the node gateway mode is disabled
GatewayModeDisabled GatewayMode = ""
// GatewayModeShared indicates OVN shares a gateway interface with the node
GatewayModeShared GatewayMode = "shared"
// GatewayModeLocal indicates OVN creates a local NAT-ed interface for the gateway
GatewayModeLocal GatewayMode = "local"
)
// GatewayConfig holds node gateway-related parsed config file parameters and command-line overrides
type GatewayConfig struct {
// Mode is the gateway mode; if may be either empty (disabled), "shared", or "local"
Mode GatewayMode `gcfg:"mode"`
// Interface is the network interface to use for the gateway in "shared" mode
Interface string `gcfg:"interface"`
// Exgress gateway interface is the optional network interface to use for external gw pods traffic.
EgressGWInterface string `gcfg:"egw-interface"`
// NextHop is the gateway IP address of Interface; will be autodetected if not given
NextHop string `gcfg:"next-hop"`
// VLANID is the option VLAN tag to apply to gateway traffic for "shared" mode
VLANID uint `gcfg:"vlan-id"`
// NodeportEnable sets whether to provide Kubernetes NodePort service or not
NodeportEnable bool `gcfg:"nodeport"`
// DisableSNATMultipleGws sets whether to disable SNAT of egress traffic in namespaces annotated with routing-external-gws
DisableSNATMultipleGWs bool `gcfg:"disable-snat-multiple-gws"`
// V4JoinSubnet to be used in the cluster
V4JoinSubnet string `gcfg:"v4-join-subnet"`
// V6JoinSubnet to be used in the cluster
V6JoinSubnet string `gcfg:"v6-join-subnet"`
// DisablePacketMTUCheck disables adding openflow flows to check packets too large to be
// delivered to OVN due to pod MTU being lower than NIC MTU. Disabling this check will result in southbound packets
// exceeding pod MTU to be dropped by OVN. With this check enabled, ICMP needs frag/packet too big will be sent
// back to the original client
DisablePacketMTUCheck bool `gcfg:"disable-pkt-mtu-check"`
// RouterSubnet is the subnet to be used for the GR external port. auto-detected if not given.
// Must match the the kube node IP address. Currently valid for DPU only.
RouterSubnet string `gcfg:"router-subnet"`
}
// OvnAuthConfig holds client authentication and location details for
// an OVN database (either northbound or southbound)
type OvnAuthConfig struct {
// e.g: "ssl:192.168.1.2:6641,ssl:192.168.1.2:6642"
Address string `gcfg:"address"`
PrivKey string `gcfg:"client-privkey"`
Cert string `gcfg:"client-cert"`
CACert string `gcfg:"client-cacert"`
CertCommonName string `gcfg:"cert-common-name"`
Scheme OvnDBScheme
ElectionTimer uint `gcfg:"election-timer"`
northbound bool
exec kexec.Interface
}
// MasterHAConfig holds configuration for master HA
// configuration.
type MasterHAConfig struct {
ElectionLeaseDuration int `gcfg:"election-lease-duration"`
ElectionRenewDeadline int `gcfg:"election-renew-deadline"`
ElectionRetryPeriod int `gcfg:"election-retry-period"`
}
// HybridOverlayConfig holds configuration for hybrid overlay
// configuration.
type HybridOverlayConfig struct {
// Enabled indicates whether hybrid overlay features are enabled or not.
Enabled bool `gcfg:"enabled"`
// RawClusterSubnets holds the unparsed hybrid overlay cluster subnets.
// Should only be used inside config module.
RawClusterSubnets string `gcfg:"cluster-subnets"`
// ClusterSubnets holds parsed hybrid overlay cluster subnet entries and
// may be used outside the config module.
ClusterSubnets []CIDRNetworkEntry
// VXLANPort holds the VXLAN tunnel UDP port number.
VXLANPort uint `gcfg:"hybrid-overlay-vxlan-port"`
}
// OvnKubeNodeConfig holds ovnkube-node configurations
type OvnKubeNodeConfig struct {
Mode string `gcfg:"mode"`
MgmtPortNetdev string `gcfg:"mgmt-port-netdev"`
DisableOVNIfaceIdVer bool `gcfg:"disable-ovn-iface-id-ver"`
}
// OvnDBScheme describes the OVN database connection transport method
type OvnDBScheme string
const (
// OvnDBSchemeSSL specifies SSL as the OVN database transport method
OvnDBSchemeSSL OvnDBScheme = "ssl"
// OvnDBSchemeTCP specifies TCP as the OVN database transport method
OvnDBSchemeTCP OvnDBScheme = "tcp"
// OvnDBSchemeUnix specifies Unix domains sockets as the OVN database transport method
OvnDBSchemeUnix OvnDBScheme = "unix"
)
// Config is used to read the structured config file and to cache config in testcases
type config struct {
Default DefaultConfig
Logging LoggingConfig
Monitoring MonitoringConfig
IPFIX IPFIXConfig
CNI CNIConfig
OVNKubernetesFeature OVNKubernetesFeatureConfig
Kubernetes KubernetesConfig
Metrics MetricsConfig
OvnNorth OvnAuthConfig
OvnSouth OvnAuthConfig
Gateway GatewayConfig
MasterHA MasterHAConfig
HybridOverlay HybridOverlayConfig
OvnKubeNode OvnKubeNodeConfig
}
var (
savedDefault DefaultConfig
savedLogging LoggingConfig
savedMonitoring MonitoringConfig
savedIPFIX IPFIXConfig
savedCNI CNIConfig
savedOVNKubernetesFeature OVNKubernetesFeatureConfig
savedKubernetes KubernetesConfig
savedMetrics MetricsConfig
savedOvnNorth OvnAuthConfig
savedOvnSouth OvnAuthConfig
savedGateway GatewayConfig
savedMasterHA MasterHAConfig
savedHybridOverlay HybridOverlayConfig
savedOvnKubeNode OvnKubeNodeConfig
// legacy service-cluster-ip-range CLI option
serviceClusterIPRange string
// legacy cluster-subnet CLI option
clusterSubnet string
// legacy init-gateways CLI option
initGateways bool
// legacy gateway-local CLI option
gatewayLocal bool
)
func init() {
// Cache original default config values
savedDefault = Default
savedLogging = Logging
savedMonitoring = Monitoring
savedIPFIX = IPFIX
savedCNI = CNI
savedOVNKubernetesFeature = OVNKubernetesFeature
savedKubernetes = Kubernetes
savedMetrics = Metrics
savedOvnNorth = OvnNorth
savedOvnSouth = OvnSouth
savedGateway = Gateway
savedMasterHA = MasterHA
savedHybridOverlay = HybridOverlay
savedOvnKubeNode = OvnKubeNode
cli.VersionPrinter = func(c *cli.Context) {
fmt.Printf("Version: %s\n", Version)
fmt.Printf("Git commit: %s\n", Commit)
fmt.Printf("Git branch: %s\n", Branch)
fmt.Printf("Go version: %s\n", GoVersion)
fmt.Printf("Build date: %s\n", BuildDate)
fmt.Printf("OS/Arch: %s\n", OSArch)
}
Flags = GetFlags([]cli.Flag{})
}
// PrepareTestConfig restores default config values. Used by testcases to
// provide a pristine environment between tests.
func PrepareTestConfig() error {
Default = savedDefault
Logging = savedLogging
Logging.Level = 5
Monitoring = savedMonitoring
IPFIX = savedIPFIX
CNI = savedCNI
OVNKubernetesFeature = savedOVNKubernetesFeature
Kubernetes = savedKubernetes
Metrics = savedMetrics
OvnNorth = savedOvnNorth
OvnSouth = savedOvnSouth
Gateway = savedGateway
MasterHA = savedMasterHA
HybridOverlay = savedHybridOverlay
OvnKubeNode = savedOvnKubeNode
if err := completeConfig(); err != nil {
return err
}
// Don't pick up defaults from the environment
os.Unsetenv("KUBECONFIG")
os.Unsetenv("K8S_CACERT")
os.Unsetenv("K8S_APISERVER")
os.Unsetenv("K8S_TOKEN")
os.Unsetenv("K8S_TOKEN_FILE")
return nil
}
// copy members of struct 'src' into the corresponding field in struct 'dst'
// if the field in 'src' is a non-zero int or a non-zero-length string and
// does not contain a default value. This function should be called with pointers to structs.
func overrideFields(dst, src, defaults interface{}) error {
dstStruct := reflect.ValueOf(dst).Elem()
srcStruct := reflect.ValueOf(src).Elem()
if dstStruct.Kind() != srcStruct.Kind() || dstStruct.Kind() != reflect.Struct {
return fmt.Errorf("mismatched value types")
}
if dstStruct.NumField() != srcStruct.NumField() {
return fmt.Errorf("mismatched struct types")
}
var defStruct reflect.Value
if defaults != nil {
defStruct = reflect.ValueOf(defaults).Elem()
}
// Iterate over each field in dst/src Type so we can get the tags,
// and use the field name to retrieve the field's actual value from
// the dst/src instance
var handled bool
dstType := reflect.TypeOf(dst).Elem()
for i := 0; i < dstType.NumField(); i++ {
structField := dstType.Field(i)
// Ignore private internal fields; we only care about overriding
// 'gcfg' tagged fields read from CLI or the config file
if _, ok := structField.Tag.Lookup("gcfg"); !ok {
continue
}
handled = true
dstField := dstStruct.FieldByName(structField.Name)
srcField := srcStruct.FieldByName(structField.Name)
var dv reflect.Value
if defStruct.IsValid() {
dv = defStruct.FieldByName(structField.Name)
}
if !dstField.IsValid() || !srcField.IsValid() {
return fmt.Errorf("invalid struct %q field %q", dstType.Name(), structField.Name)
}
if dstField.Kind() != srcField.Kind() {
return fmt.Errorf("mismatched struct %q fields %q", dstType.Name(), structField.Name)
}
if dv.IsValid() && reflect.DeepEqual(dv.Interface(), srcField.Interface()) {
continue
}
dstField.Set(srcField)
}
if !handled {
// No tags found in the struct so we don't know how to override
return fmt.Errorf("failed to find 'gcfg' tags in struct %q", dstType.Name())
}
return nil
}
var cliConfig config
//CommonFlags capture general options.
var CommonFlags = []cli.Flag{
// Mode flags
&cli.StringFlag{
Name: "init-master",
Usage: "initialize master, requires the hostname as argument",
},
&cli.StringFlag{
Name: "init-node",
Usage: "initialize node, requires the name that node is registered with in kubernetes cluster",
},
&cli.StringFlag{
Name: "cleanup-node",
Usage: "cleanup node, requires the name that node is registered with in kubernetes cluster",
},
&cli.StringFlag{
Name: "pidfile",
Usage: "Name of file that will hold the ovnkube pid (optional)",
},
&cli.StringFlag{
Name: "config-file",
Usage: "configuration file path (default: /etc/openvswitch/ovn_k8s.conf)",
//Value: "/etc/openvswitch/ovn_k8s.conf",
},
&cli.IntFlag{
Name: "mtu",
Usage: "MTU value used for the overlay networks (default: 1400)",
Destination: &cliConfig.Default.MTU,
Value: Default.MTU,
},
&cli.IntFlag{
Name: "routable-mtu",
Usage: "Maximum routable MTU between nodes, used to facilitate an MTU migration procedure where different nodes might be using different MTU values",
Destination: &cliConfig.Default.RoutableMTU,
},
&cli.IntFlag{
Name: "conntrack-zone",
Usage: "For gateway nodes, the conntrack zone used for conntrack flow rules (default: 64000)",
Destination: &cliConfig.Default.ConntrackZone,
Value: Default.ConntrackZone,
},
&cli.StringFlag{
Name: "encap-type",
Usage: "The encapsulation protocol to use to transmit packets between hypervisors (default: geneve)",
Destination: &cliConfig.Default.EncapType,
Value: Default.EncapType,
},
&cli.StringFlag{
Name: "encap-ip",
Usage: "The IP address of the encapsulation endpoint (default: Node IP address resolved from Node hostname)",
Destination: &cliConfig.Default.EncapIP,
},
&cli.UintFlag{
Name: "encap-port",
Usage: "The UDP port used by the encapsulation endpoint (default: 6081)",
Destination: &cliConfig.Default.EncapPort,
Value: Default.EncapPort,
},
&cli.IntFlag{
Name: "inactivity-probe",
Usage: "Maximum number of milliseconds of idle time on " +
"connection for ovn-controller before it sends a inactivity probe",
Destination: &cliConfig.Default.InactivityProbe,
Value: Default.InactivityProbe,
},
&cli.IntFlag{
Name: "openflow-probe",
Usage: "Maximum number of seconds of idle time on the openflow " +
"connection for ovn-controller before it sends a inactivity probe",
Destination: &cliConfig.Default.OpenFlowProbe,
Value: Default.OpenFlowProbe,
},
&cli.IntFlag{
Name: "ofctrl-wait-before-clear",
Usage: "Maximum number of milliseconds that ovn-controller waits before " +
"clearing existing flows during start up, to make sure the initial flow " +
"compute is complete and avoid data plane interruptions.",
Destination: &cliConfig.Default.OfctrlWaitBeforeClear,
Value: Default.OfctrlWaitBeforeClear,
},
&cli.BoolFlag{
Name: "monitor-all",
Usage: "Enable monitoring all data from SB DB instead of conditionally " +
"monitoring the data relevant to this node only. " +
"By default it is enabled.",
Destination: &cliConfig.Default.MonitorAll,
Value: Default.MonitorAll,
},
&cli.BoolFlag{
Name: "enable-lflow-cache",
Usage: "Enable the logical flow in-memory cache it uses " +
"when processing Southbound database logical flow changes. " +
"By default caching is enabled.",
Destination: &cliConfig.Default.LFlowCacheEnable,
Value: Default.LFlowCacheEnable,
},
&cli.UintFlag{
Name: "lflow-cache-limit",
Usage: "Maximum number of logical flow cache entries ovn-controller " +
"may create when the logical flow cache is enabled. By " +
"default the size of the cache is unlimited.",
Destination: &cliConfig.Default.LFlowCacheLimit,
Value: Default.LFlowCacheLimit,
},
&cli.UintFlag{
Name: "lflow-cache-limit-kb",
Usage: "Maximum size of the logical flow cache ovn-controller " +
"may create when the logical flow cache is enabled. By " +
"default the size of the cache is unlimited.",
Destination: &cliConfig.Default.LFlowCacheLimitKb,
Value: Default.LFlowCacheLimitKb,
},
&cli.StringFlag{
Name: "cluster-subnet",
Usage: "Deprecated alias for cluster-subnets.",
Destination: &clusterSubnet,
},
&cli.StringFlag{
Name: "cluster-subnets",
Value: Default.RawClusterSubnets,
Usage: "A comma separated set of IP subnets and the associated " +
"hostsubnet prefix lengths to use for the cluster (eg, \"10.128.0.0/14/23,10.0.0.0/14/23\"). " +
"Each entry is given in the form [IP address/prefix-length/hostsubnet-prefix-length] " +
"and cannot overlap with other entries. The hostsubnet-prefix-length " +
"defines how large a subnet is given to each node and may be different " +
"for each entry. For IPv6 subnets, it must be 64 (and does not need to " +
"be explicitly specified). For IPv4 subnets an explicit " +
"hostsubnet-prefix should be specified, but for backward compatibility " +
"it defaults to 24 if unspecified.",
Destination: &cliConfig.Default.RawClusterSubnets,
},
&cli.BoolFlag{
Name: "unprivileged-mode",
Usage: "Run ovnkube-node container in unprivileged mode. Valid only with --init-node option.",
Destination: &UnprivilegedMode,
},
&cli.BoolFlag{
Name: "enable-multicast",
Usage: "Adds multicast support. Valid only with --init-master option.",
Destination: &EnableMulticast,
},
// Logging options
&cli.IntFlag{
Name: "loglevel",
Usage: "log verbosity and level: info, warn, fatal, error are always printed no matter the log level. Use 5 for debug (default: 4)",
Destination: &cliConfig.Logging.Level,
Value: Logging.Level,
},
&cli.StringFlag{
Name: "logfile",
Usage: "path of a file to direct log output to",
Destination: &cliConfig.Logging.File,
},
&cli.StringFlag{
Name: "cnilogfile",
Usage: "path of a file to direct log from cni shim to output to (default: /var/log/ovn-kubernetes/ovn-k8s-cni-overlay.log)",
Destination: &cliConfig.Logging.CNIFile,
Value: "/var/log/ovn-kubernetes/ovn-k8s-cni-overlay.log",
},
// Logfile rotation parameters
&cli.IntFlag{
Name: "logfile-maxsize",
Usage: "Maximum size in bytes of the log file before it gets rolled",
Destination: &cliConfig.Logging.LogFileMaxSize,
Value: Logging.LogFileMaxSize,
},
&cli.IntFlag{
Name: "logfile-maxbackups",
Usage: "Maximum number of old log files to retain",
Destination: &cliConfig.Logging.LogFileMaxBackups,
Value: Logging.LogFileMaxBackups,
},
&cli.IntFlag{
Name: "logfile-maxage",
Usage: "Maximum number of days to retain old log files",
Destination: &cliConfig.Logging.LogFileMaxAge,
Value: Logging.LogFileMaxAge,
},
&cli.IntFlag{
Name: "acl-logging-rate-limit",
Usage: "The largest number of messages per second that gets logged before drop (default 20)",
Destination: &cliConfig.Logging.ACLLoggingRateLimit,
Value: 20,
},
}
// MonitoringFlags capture monitoring-related options
var MonitoringFlags = []cli.Flag{
// Monitoring options
&cli.StringFlag{
Name: "netflow-targets",
Value: Monitoring.RawNetFlowTargets,
Usage: "A comma separated set of NetFlow collectors to export flow data (eg, \"10.128.0.150:2056,10.0.0.151:2056\")." +
"Each entry is given in the form [IP address:port] or [:port]. If only port is provided, it uses the Node IP",
Destination: &cliConfig.Monitoring.RawNetFlowTargets,
},
&cli.StringFlag{
Name: "sflow-targets",
Value: Monitoring.RawSFlowTargets,
Usage: "A comma separated set of SFlow collectors to export flow data (eg, \"10.128.0.150:6343,10.0.0.151:6343\")." +
"Each entry is given in the form [IP address:port] or [:port]. If only port is provided, it uses the Node IP",
Destination: &cliConfig.Monitoring.RawSFlowTargets,
},
&cli.StringFlag{
Name: "ipfix-targets",
Value: Monitoring.RawIPFIXTargets,
Usage: "A comma separated set of IPFIX collectors to export flow data (eg, \"10.128.0.150:2055,10.0.0.151:2055\")." +
"Each entry is given in the form [IP address:port] or [:port]. If only port is provided, it uses the Node IP",
Destination: &cliConfig.Monitoring.RawIPFIXTargets,
},
}
// IPFIXFlags capture IPFIX-related options
var IPFIXFlags = []cli.Flag{
&cli.UintFlag{
Name: "ipfix-sampling",
Usage: "Rate at which packets should be sampled and sent to each target collector (default: 400)",
Destination: &cliConfig.IPFIX.Sampling,
Value: IPFIX.Sampling,
},
&cli.UintFlag{
Name: "ipfix-cache-max-flows",
Usage: "Maximum number of IPFIX flow records that can be cached at a time. If 0, caching is disabled (default: 0)",
Destination: &cliConfig.IPFIX.CacheMaxFlows,
Value: IPFIX.CacheMaxFlows,
}, &cli.UintFlag{
Name: "ipfix-cache-active-timeout",
Usage: "Maximum period in seconds for which an IPFIX flow record is cached and aggregated before being sent. If 0, caching is disabled (default: 60)",
Destination: &cliConfig.IPFIX.CacheActiveTimeout,
Value: IPFIX.CacheActiveTimeout,
},
}
// CNIFlags capture CNI-related options
var CNIFlags = []cli.Flag{
// CNI options
&cli.StringFlag{
Name: "cni-conf-dir",
Usage: "the CNI config directory in which to write the overlay CNI config file (default: /etc/cni/net.d)",
Destination: &cliConfig.CNI.ConfDir,
Value: CNI.ConfDir,
},
&cli.StringFlag{
Name: "cni-plugin",
Usage: "the name of the CNI plugin (default: ovn-k8s-cni-overlay)",
Destination: &cliConfig.CNI.Plugin,
Value: CNI.Plugin,
},
}
// OVNK8sFeatureFlags capture OVN-Kubernetes feature related options
var OVNK8sFeatureFlags = []cli.Flag{
&cli.BoolFlag{
Name: "enable-egress-ip",
Usage: "Configure to use EgressIP CRD feature with ovn-kubernetes.",
Destination: &cliConfig.OVNKubernetesFeature.EnableEgressIP,
Value: OVNKubernetesFeature.EnableEgressIP,
},
&cli.IntFlag{
Name: "egressip-reachability-total-timeout",
Usage: "EgressIP node reachability total timeout in seconds (default: 1)",
Destination: &cliConfig.OVNKubernetesFeature.EgressIPReachabiltyTotalTimeout,
Value: 1,
},
&cli.BoolFlag{
Name: "enable-egress-firewall",
Usage: "Configure to use EgressFirewall CRD feature with ovn-kubernetes.",
Destination: &cliConfig.OVNKubernetesFeature.EnableEgressFirewall,
Value: OVNKubernetesFeature.EnableEgressFirewall,
},
&cli.BoolFlag{
Name: "enable-egress-qos",
Usage: "Configure to use EgressQoS CRD feature with ovn-kubernetes.",
Destination: &cliConfig.OVNKubernetesFeature.EnableEgressQoS,
Value: OVNKubernetesFeature.EnableEgressQoS,
},
&cli.IntFlag{
Name: "egressip-node-healthcheck-port",
Usage: "Configure EgressIP node reachability using gRPC on this TCP port.",
Destination: &cliConfig.OVNKubernetesFeature.EgressIPNodeHealthCheckPort,
},
}
// K8sFlags capture Kubernetes-related options
var K8sFlags = []cli.Flag{
&cli.StringFlag{
Name: "service-cluster-ip-range",
Usage: "Deprecated alias for k8s-service-cidrs.",
Destination: &serviceClusterIPRange,
},
&cli.StringFlag{
Name: "k8s-service-cidr",
Usage: "Deprecated alias for k8s-service-cidrs.",
Destination: &cliConfig.Kubernetes.CompatServiceCIDR,
},
&cli.StringFlag{
Name: "k8s-service-cidrs",
Usage: "A comma-separated set of CIDR notation IP ranges from which k8s assigns " +
"service cluster IPs. This should be the same as the value " +
"provided for kube-apiserver \"--service-cluster-ip-range\" " +
"option. (default: 172.16.1.0/24)",
Destination: &cliConfig.Kubernetes.RawServiceCIDRs,
Value: Kubernetes.RawServiceCIDRs,
},
&cli.StringFlag{
Name: "k8s-kubeconfig",
Usage: "absolute path to the Kubernetes kubeconfig file (not required if the --k8s-apiserver, --k8s-ca-cert, and --k8s-token are given)",
Destination: &cliConfig.Kubernetes.Kubeconfig,
},
&cli.StringFlag{
Name: "k8s-apiserver",
Usage: "URL of the Kubernetes API server (not required if --k8s-kubeconfig is given) (default: http://localhost:8443)",
Destination: &cliConfig.Kubernetes.APIServer,
Value: Kubernetes.APIServer,
},
&cli.StringFlag{
Name: "k8s-cacert",
Usage: "the absolute path to the Kubernetes API CA certificate (not required if --k8s-kubeconfig is given)",
Destination: &cliConfig.Kubernetes.CACert,
},
&cli.StringFlag{
Name: "k8s-token",
Usage: "the Kubernetes API authentication token (not required if --k8s-kubeconfig is given)",
Destination: &cliConfig.Kubernetes.Token,
},
&cli.StringFlag{
Name: "k8s-token-file",
Usage: "the path to Kubernetes API token. If set, it is periodically read and takes precedence over k8s-token",
Destination: &cliConfig.Kubernetes.TokenFile,
},
&cli.StringFlag{
Name: "ovn-config-namespace",
Usage: "specify a namespace which will contain services to config the OVN databases",
Destination: &cliConfig.Kubernetes.OVNConfigNamespace,
Value: Kubernetes.OVNConfigNamespace,
},
&cli.BoolFlag{
Name: "ovn-empty-lb-events",
Usage: "If set, then load balancers do not get deleted when all backends are removed. " +
"Instead, ovn-kubernetes monitors the OVN southbound database for empty lb backends " +
"controller events. If one arrives, then a NeedPods event is sent so that Kubernetes " +
"will spin up pods for the load balancer to send traffic to.",
Destination: &cliConfig.Kubernetes.OVNEmptyLbEvents,
},
&cli.StringFlag{
Name: "pod-ip",
Usage: "UNUSED",
},
&cli.StringFlag{
Name: "no-hostsubnet-nodes",
Usage: "Specify a label for nodes that will manage their own hostsubnets",
Destination: &cliConfig.Kubernetes.RawNoHostSubnetNodes,
},
&cli.StringFlag{
Name: "host-network-namespace",
Usage: "specify a namespace which will be used to classify host network traffic for network policy",
Destination: &cliConfig.Kubernetes.HostNetworkNamespace,
Value: Kubernetes.HostNetworkNamespace,
},
&cli.StringFlag{
Name: "platform-type",
Usage: "The cloud provider platform type ovn-kubernetes is deployed on. " +
"Valid values can be found in: https://github.com/ovn-org/ovn-kubernetes/blob/master/go-controller/vendor/github.com/openshift/api/config/v1/types_infrastructure.go#L130-L172",
Destination: &cliConfig.Kubernetes.PlatformType,
Value: Kubernetes.PlatformType,
},
}
// MetricsFlags capture metrics-related options
var MetricsFlags = []cli.Flag{
&cli.StringFlag{
Name: "metrics-bind-address",
Usage: "The IP address and port for the OVN K8s metrics server to serve on (set to 0.0.0.0 for all IPv4 interfaces)",
Destination: &cliConfig.Metrics.BindAddress,
},
&cli.StringFlag{
Name: "ovn-metrics-bind-address",
Usage: "The IP address and port for the OVN metrics server to serve on (set to 0.0.0.0 for all IPv4 interfaces)",
Destination: &cliConfig.Metrics.OVNMetricsBindAddress,
},
&cli.BoolFlag{
Name: "export-ovs-metrics",
Usage: "When true exports OVS metrics from the OVN metrics server",
Destination: &cliConfig.Metrics.ExportOVSMetrics,
},
&cli.BoolFlag{
Name: "metrics-enable-pprof",
Usage: "If true, then also accept pprof requests on the metrics port.",
Destination: &cliConfig.Metrics.EnablePprof,
Value: Metrics.EnablePprof,
},
&cli.StringFlag{
Name: "node-server-privkey",
Usage: "Private key that the OVN node K8s metrics server uses to serve metrics over TLS.",
Destination: &cliConfig.Metrics.NodeServerPrivKey,
},
&cli.StringFlag{