Repository navigation
Expand file tree
/
Copy pathconfig.go
More file actions
839 lines (796 loc) · 31.9 KB
/
Copy pathconfig.go
File metadata and controls
839 lines (796 loc) · 31.9 KB
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
package config
import (
"fmt"
"maps"
"math/rand"
"os"
"regexp"
"strconv"
"strings"
"sync"
"time"
"github.com/VictoriaMetrics/VictoriaMetrics/lib/buildinfo"
"github.com/caarlos0/env/v11"
"github.com/prometheus/client_golang/prometheus"
"k8s.io/apimachinery/pkg/api/resource"
"sigs.k8s.io/controller-runtime/pkg/metrics"
)
const (
UnlimitedQuantity = "unlimited"
)
func getVersion(defaultVersion string) string {
v := buildinfo.ShortVersion()
if len(v) == 0 {
return defaultVersion
}
return v
}
var (
opConf *BaseOperatorConf
initConf sync.Once
defaultEnvs = map[string]string{
"VM_METRICS_VERSION": "v1.136.0",
"VM_LOGS_VERSION": "v1.47.0",
"VM_ANOMALY_VERSION": "v1.28.5",
"VM_TRACES_VERSION": "v0.7.0",
"VM_OPERATOR_VERSION": getVersion("v0.68.3"),
}
)
func getEnvOpts() env.Options {
envOpts := env.Options{
DefaultValueTagName: "default",
PrefixTagName: "prefix",
UseFieldNameByDefault: true,
Environment: env.ToMap(os.Environ()),
}
for n, ov := range defaultEnvs {
if v, ok := envOpts.Environment[n]; !ok || v == "" {
envOpts.Environment[n] = ov
}
}
return envOpts
}
// Resource is useful for generic resource building
// uses the same memory layout as resources at config
type Resource struct {
Limit struct {
Mem string
Cpu string
EphemeralStorage string
}
Request struct {
Mem string
Cpu string
EphemeralStorage string
}
}
// ApplicationDefaults is useful for generic default building
// uses the same memory as application default at config
type ApplicationDefaults struct {
Image string
Version string
Port string
UseDefaultResources bool
Resource struct {
Limit struct {
Mem string
Cpu string
EphemeralStorage string
}
Request struct {
Mem string
Cpu string
EphemeralStorage string
}
}
TerminationGracePeriodSeconds int64
}
//genvars:true
type BaseOperatorConf struct {
MetricsVersion string `default:"${VM_METRICS_VERSION}" env:"VM_METRICS_VERSION,expand"`
LogsVersion string `default:"${VM_LOGS_VERSION}" env:"VM_LOGS_VERSION,expand"`
AnomalyVersion string `default:"${VM_ANOMALY_VERSION}" env:"VM_ANOMALY_VERSION,expand"`
TracesVertsion string `default:"${VM_TRACES_VERSION}" env:"VM_TRACES_VERSION,expand"`
OperatorVersion string `default:"${VM_OPERATOR_VERSION}" env:"VM_OPERATOR_VERSION,expand"`
GatewayAPIEnabled bool `default:"false" env:"VM_GATEWAY_API_ENABLED"`
VPAAPIEnabled bool `default:"false" env:"VM_VPA_API_ENABLED"`
// Defines a list of namespaces to be watched by operator.
// Operator don't perform any cluster wide API calls if namespaces not empty.
// In case of empty list it performs only clusterwide api calls.
WatchNamespaces []string `default:"" env:"WATCH_NAMESPACE"`
// container registry name prefix, e.g. docker.io
ContainerRegistry string `default:"" env:"VM_CONTAINERREGISTRY"`
// Deprecated: use VM_CONFIG_RELOADER_IMAGE instead
CustomConfigReloaderImage string `env:"VM_CUSTOMCONFIGRELOADERIMAGE"`
PSPAutoCreateEnabled bool `default:"false" env:"VM_PSPAUTOCREATEENABLED"`
EnableTCP6 bool `default:"false" env:"VM_ENABLETCP6"`
// Overrides default loopback interface that will be used for all VM components
Loopback string `env:"VM_LOOPBACK"`
// defines global config reloader parameters
ConfigReloader struct {
// default image for all config-reloader containers
Image string `default:"victoriametrics/operator:config-reloader-${VM_OPERATOR_VERSION}" env:",expand"`
Resource struct {
Limit struct {
// defines global resource.limits.memory for all config-reloader containers
Mem string `default:"unlimited" env:"MEMORY"`
// defines global resource.limits.cpu for all config-reloader containers
Cpu string `default:"unlimited"`
// defines global resource.limits.ephemeral-storage for all config-reloader containers
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
// defines global resource.requests.memory for all config-reloader containers
Mem string `default:"25Mi" env:"MEMORY"`
// defines global resource.requests.cpu for all config-reloader containers
Cpu string `default:"10m"`
// defines global resource.requests.ephemeral-storage for all config-reloader containers
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
}
} `prefix:"VM_CONFIG_RELOADER_"`
VLogs struct {
Image string `default:"victoriametrics/victoria-logs"`
Version string `env:",expand" default:"${VM_LOGS_VERSION}"`
Port string `default:"9428"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"1500Mi"`
Cpu string `default:"1200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"500Mi"`
Cpu string `default:"150m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VLOGSDEFAULT_"`
VLAgent struct {
Image string `default:"victoriametrics/vlagent"`
Version string `env:",expand" default:"${VM_LOGS_VERSION}"`
Port string `default:"9429"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"500Mi"`
Cpu string `default:"200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"200Mi"`
Cpu string `default:"50m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VLAGENTDEFAULT_"`
VLSingle struct {
Image string `default:"victoriametrics/victoria-logs"`
Version string `env:",expand" default:"${VM_LOGS_VERSION}"`
Port string `default:"9428"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"1500Mi"`
Cpu string `default:"1200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"500Mi"`
Cpu string `default:"150m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VLSINGLEDEFAULT_"`
VTSingle struct {
Image string `default:"victoriametrics/victoria-traces"`
Version string `env:",expand" default:"${VM_TRACES_VERSION}"`
Port string `default:"10428"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"1500Mi"`
Cpu string `default:"1200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"500Mi"`
Cpu string `default:"150m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VTSINGLEDEFAULT_"`
VMAlert struct {
Image string `default:"victoriametrics/vmalert"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}"`
Port string `default:"8080"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"500Mi"`
Cpu string `default:"200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"200Mi"`
Cpu string `default:"50m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VMALERTDEFAULT_"`
VMServiceScrape struct {
// Use endpointslices instead of endpoints as discovery role
// for vmservicescrape when generate scrape config for vmagent.
EnforceEndpointSlices bool `default:"false" env:"ENFORCEENDPOINTSLICES"`
} `prefix:"VM_VMSERVICESCRAPEDEFAULT_"`
VMAgent struct {
Image string `default:"victoriametrics/vmagent"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}"`
Port string `default:"8429"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"500Mi"`
Cpu string `default:"200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"200Mi"`
Cpu string `default:"50m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VMAGENTDEFAULT_"`
VMAnomaly struct {
Image string `default:"victoriametrics/vmanomaly"`
Version string `env:",expand" default:"${VM_ANOMALY_VERSION}"`
Port string `default:"8490"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"500Mi"`
Cpu string `default:"200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"200Mi"`
Cpu string `default:"50m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VMANOMALYDEFAULT_"`
VMSingle struct {
Image string `default:"victoriametrics/victoria-metrics"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}"`
Port string `default:"8429"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"1500Mi"`
Cpu string `default:"1200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"500Mi"`
Cpu string `default:"150m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VMSINGLEDEFAULT_"`
VMCluster struct {
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Select struct {
Image string `default:"victoriametrics/vmselect"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}-cluster"`
Port string `default:"8481"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VMCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"1000Mi"`
Cpu string `default:"500m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"500Mi"`
Cpu string `default:"100m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VMSELECTDEFAULT_"`
Storage struct {
VMInsertPort string `default:"8400" env:"VMINSERTPORT"`
VMSelectPort string `default:"8401" env:"VMSELECTPORT"`
Common struct {
Image string `default:"victoriametrics/vmstorage"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}-cluster"`
Port string `default:"8482"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VMCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"1500Mi"`
Cpu string `default:"1000m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"500Mi"`
Cpu string `default:"250m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
}
} `prefix:"VMSTORAGEDEFAULT_"`
Insert struct {
Image string `default:"victoriametrics/vminsert"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}-cluster"`
Port string `default:"8480"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VMCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"500Mi"`
Cpu string `default:"500m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"200Mi"`
Cpu string `default:"150m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VMINSERTDEFAULT_"`
} `prefix:"VM_VMCLUSTERDEFAULT_"`
VMAlertmanager struct {
Image string `default:"prom/alertmanager" env:"ALERTMANAGERDEFAULTBASEIMAGE"`
Version string `default:"v0.31.0" env:"ALERTMANAGERVERSION"`
Port string `default:"9093"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"256Mi"`
Cpu string `default:"100m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"56Mi"`
Cpu string `default:"30m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"120"`
} `prefix:"VM_VMALERTMANAGER_"`
DisableSelfServiceScrapeCreation bool `default:"false" env:"VM_DISABLESELFSERVICESCRAPECREATION"`
VMBackup struct {
Image string `default:"victoriametrics/vmbackupmanager"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}-enterprise"`
Port string `default:"8300"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"500Mi"`
Cpu string `default:"500m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"200Mi"`
Cpu string `default:"150m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VMBACKUP_"`
VMAuth struct {
Image string `default:"victoriametrics/vmauth"`
Version string `env:",expand" default:"${VM_METRICS_VERSION}"`
Port string `default:"8427"`
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Resource struct {
Limit struct {
Mem string `default:"300Mi"`
Cpu string `default:"200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"100Mi"`
Cpu string `default:"50m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VM_VMAUTHDEFAULT_"`
VLCluster struct {
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Select struct {
Image string `default:"victoriametrics/victoria-logs"`
Version string `env:",expand" default:"${VM_LOGS_VERSION}"`
Port string `default:"9471"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VLCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"1024Mi"`
Cpu string `default:"1000m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"256Mi"`
Cpu string `default:"100m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VLSELECTDEFAULT_"`
Storage struct {
Image string `default:"victoriametrics/victoria-logs"`
Version string `env:",expand" default:"${VM_LOGS_VERSION}"`
Port string `default:"9491"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VLCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"2048Mi"`
Cpu string `default:"1000m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"512Mi"`
Cpu string `default:"200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VLSTORAGEDEFAULT_"`
Insert struct {
Image string `default:"victoriametrics/victoria-logs"`
Version string `env:",expand" default:"${VM_LOGS_VERSION}"`
Port string `default:"9481"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VLCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"1024Mi"`
Cpu string `default:"1000m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"256Mi"`
Cpu string `default:"100m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"VLINSERTDEFAULT_"`
} `prefix:"VM_VLCLUSTERDEFAULT_"`
VTCluster struct {
UseDefaultResources bool `default:"true" env:"USEDEFAULTRESOURCES"`
Select struct {
Image string `default:"victoriametrics/victoria-traces"`
Version string `env:",expand" default:"${VM_TRACES_VERSION}"`
Port string `default:"10471"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VTCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"1024Mi"`
Cpu string `default:"1000m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"256Mi"`
Cpu string `default:"100m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"SELECT_"`
Storage struct {
Image string `default:"victoriametrics/victoria-traces"`
Version string `env:",expand" default:"${VM_TRACES_VERSION}"`
Port string `default:"10491"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VTCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"2048Mi"`
Cpu string `default:"1000m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"512Mi"`
Cpu string `default:"200m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"STORAGE_"`
Insert struct {
Image string `default:"victoriametrics/victoria-traces"`
Version string `env:",expand" default:"${VM_TRACES_VERSION}"`
Port string `default:"10481"`
UseDefaultResources bool `env:"USEDEFAULTRESOURCES,expand" default:"${VM_VTCLUSTERDEFAULT_USEDEFAULTRESOURCES}"`
Resource struct {
Limit struct {
Mem string `default:"1024Mi"`
Cpu string `default:"1000m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"LIMIT_"`
Request struct {
Mem string `default:"256Mi"`
Cpu string `default:"100m"`
EphemeralStorage string `default:"unlimited"`
} `prefix:"REQUEST_"`
} `prefix:"RESOURCE_"`
TerminationGracePeriodSeconds int64 `default:"30"`
} `prefix:"INSERT_"`
} `prefix:"VM_VTCLUSTERDEFAULT_"`
EnabledPrometheusConverter struct {
PodMonitor bool `default:"true" env:"PODMONITOR"`
ServiceScrape bool `default:"true" env:"SERVICESCRAPE"`
PrometheusRule bool `default:"true" env:"PROMETHEUSRULE"`
Probe bool `default:"true" env:"PROBE"`
AlertmanagerConfig bool `default:"true" env:"ALERTMANAGERCONFIG"`
ScrapeConfig bool `default:"true" env:"SCRAPECONFIG"`
} `prefix:"VM_ENABLEDPROMETHEUSCONVERTER_"`
// adds compare-options and sync-options for prometheus objects converted by operator.
// It helps to properly use converter with ArgoCD
PrometheusConverterAddArgoCDIgnoreAnnotations bool `default:"false" env:"VM_PROMETHEUSCONVERTERADDARGOCDIGNOREANNOTATIONS"`
EnabledPrometheusConverterOwnerReferences bool `default:"false" env:"VM_ENABLEDPROMETHEUSCONVERTEROWNERREFERENCES"`
// allows filtering for converted labels, labels with matched prefix will be ignored
FilterPrometheusConverterLabelPrefixes []string `default:"" env:"VM_FILTERPROMETHEUSCONVERTERLABELPREFIXES"`
// allows filtering for converted annotations, annotations with matched prefix will be ignored
FilterPrometheusConverterAnnotationPrefixes []string `default:"" env:"VM_FILTERPROMETHEUSCONVERTERANNOTATIONPREFIXES"`
// Defines domain name suffix for in-cluster addresses
// most known ClusterDomainName is .cluster.local
ClusterDomainName string `default:"" env:"VM_CLUSTERDOMAINNAME"`
// Defines deadline for deployment/statefulset
// to transit into ready state
// to wait for transition to ready state
AppWaitReadyTimeout time.Duration `default:"80s" env:"VM_APPREADYTIMEOUT"`
// Defines poll interval for pods ready check
// at statefulset rollout update
PodWaitReadyInterval time.Duration `default:"5s" env:"VM_PODWAITREADYINTERVALCHECK"`
// Defines single pod deadline
// to wait for transition to ready state
PodWaitReadyTimeout time.Duration `default:"80s" env:"VM_PODWAITREADYTIMEOUT"`
// Defines poll interval for PVC ready check
PVCWaitReadyInterval time.Duration `default:"5s" env:"VM_PVC_WAIT_READY_INTERVAL"`
// Defines poll timeout for PVC ready check
PVCWaitReadyTimeout time.Duration `default:"80s" env:"VM_PVC_WAIT_READY_TIMEOUT"`
// Defines poll interval for VM CRs
VMWaitReadyInterval time.Duration `default:"5s" env:"VM_WAIT_READY_INTERVAL"`
// configures force resync interval for VMAgent, VMAlert, VMAlertmanager and VMAuth.
ForceResyncInterval time.Duration `default:"60s" env:"VM_FORCERESYNCINTERVAL"`
// EnableStrictSecurity will add default `securityContext` to pods and containers created by operator
// Default PodSecurityContext include:
// 1. RunAsNonRoot: true
// 2. RunAsUser/RunAsGroup/FSGroup: 65534
// '65534' refers to 'nobody' in all the used default images like alpine, busybox.
// If you're using customize image, please make sure '65534' is a valid uid in there or specify SecurityContext.
// 3. FSGroupChangePolicy: &onRootMismatch
// If KubeVersion>=1.20, use `FSGroupChangePolicy="onRootMismatch"` to skip the recursive permission change
// when the root of the volume already has the correct permissions
// 4. SeccompProfile:
// type: RuntimeDefault
// Use `RuntimeDefault` seccomp profile by default, which is defined by the container runtime,
// instead of using the Unconfined (seccomp disabled) mode.
//
// Default container SecurityContext include:
// 1. AllowPrivilegeEscalation: false
// 2. ReadOnlyRootFilesystem: true
// 3. Capabilities:
// drop:
// - all
// turn off `EnableStrictSecurity` by default, see https://github.com/VictoriaMetrics/operator/issues/749 for details
EnableStrictSecurity bool `default:"false" env:"VM_ENABLESTRICTSECURITY"`
}
// ResyncAfterDuration returns requeue duration for object period reconcile
// adds 10% jitter
func (boc *BaseOperatorConf) ResyncAfterDuration() time.Duration {
if boc.ForceResyncInterval == 0 {
return 0
}
d := boc.ForceResyncInterval
dv := min(d/10, 10*time.Second)
p := float64(rand.Int31()) / (1 << 32)
return boc.ForceResyncInterval + time.Duration(p*float64(dv))
}
// Validate - validates config on best effort.
func (boc BaseOperatorConf) validate() error {
for _, ns := range boc.WatchNamespaces {
if !validNamespaceRegex.MatchString(ns) {
return fmt.Errorf("namespace=%q doesn't match regex=%q", ns, validNamespaceRegex.String())
}
}
validateResource := func(name string, res Resource) error {
if res.Request.Mem != UnlimitedQuantity {
if _, err := resource.ParseQuantity(res.Request.Mem); err != nil {
return fmt.Errorf("cannot parse resource request memory for %q: %w", name, err)
}
}
if res.Request.Cpu != UnlimitedQuantity {
if _, err := resource.ParseQuantity(res.Request.Cpu); err != nil {
return fmt.Errorf("cannot parse resource request cpu for %q: %w", name, err)
}
}
if res.Request.EphemeralStorage != UnlimitedQuantity {
if _, err := resource.ParseQuantity(res.Request.EphemeralStorage); err != nil {
return fmt.Errorf("cannot parse resource request ephemeral storage for %q: %w", name, err)
}
}
if res.Limit.Mem != UnlimitedQuantity {
if _, err := resource.ParseQuantity(res.Limit.Mem); err != nil {
return fmt.Errorf("cannot parse resource limit memory for %q: %w", name, err)
}
}
if res.Limit.Cpu != UnlimitedQuantity {
if _, err := resource.ParseQuantity(res.Limit.Cpu); err != nil {
return fmt.Errorf("cannot parse resource limit cpu for %q: %w", name, err)
}
}
if res.Limit.EphemeralStorage != UnlimitedQuantity {
if _, err := resource.ParseQuantity(res.Limit.EphemeralStorage); err != nil {
return fmt.Errorf("cannot parse resource limit ephemeral storage for %q: %w", name, err)
}
}
return nil
}
if err := validateResource("config-reloader", Resource(boc.ConfigReloader.Resource)); err != nil {
return err
}
if err := validateResource("vmagent", Resource(boc.VMAgent.Resource)); err != nil {
return err
}
if err := validateResource("vmalert", Resource(boc.VMAlert.Resource)); err != nil {
return err
}
if err := validateResource("vmalertmanager", Resource(boc.VMAlertmanager.Resource)); err != nil {
return err
}
if err := validateResource("vmselect", Resource(boc.VMCluster.Select.Resource)); err != nil {
return err
}
if err := validateResource("vminsert", Resource(boc.VMCluster.Insert.Resource)); err != nil {
return err
}
if err := validateResource("vmstorage", Resource(boc.VMCluster.Storage.Common.Resource)); err != nil {
return err
}
if err := validateResource("vmsingle", Resource(boc.VMSingle.Resource)); err != nil {
return err
}
if err := validateResource("vmbackup", Resource(boc.VMBackup.Resource)); err != nil {
return err
}
if err := validateResource("vlogs", Resource(boc.VLogs.Resource)); err != nil {
return err
}
if err := validateResource("vlagent", Resource(boc.VLAgent.Resource)); err != nil {
return err
}
if err := validateResource("vmanomaly", Resource(boc.VMAnomaly.Resource)); err != nil {
return err
}
if err := validateResource("vlsingle", Resource(boc.VLSingle.Resource)); err != nil {
return err
}
if err := validateResource("vlselect", Resource(boc.VLCluster.Select.Resource)); err != nil {
return err
}
if err := validateResource("vlinsert", Resource(boc.VLCluster.Insert.Resource)); err != nil {
return err
}
if err := validateResource("vlstorage", Resource(boc.VLCluster.Storage.Resource)); err != nil {
return err
}
if err := validateResource("vtsingle", Resource(boc.VTSingle.Resource)); err != nil {
return err
}
if err := validateResource("vtselect", Resource(boc.VTCluster.Select.Resource)); err != nil {
return err
}
if err := validateResource("vtinsert", Resource(boc.VTCluster.Insert.Resource)); err != nil {
return err
}
if err := validateResource("vtstorage", Resource(boc.VTCluster.Storage.Resource)); err != nil {
return err
}
return nil
}
// MustGetBaseConfig returns operator configuration with default values populated from env variables
func MustGetBaseConfig() *BaseOperatorConf {
initConf.Do(func() {
c, err := env.ParseAsWithOptions[BaseOperatorConf](getEnvOpts())
if err != nil {
panic(err)
}
if c.CustomConfigReloaderImage != "" {
c.ConfigReloader.Image = c.CustomConfigReloaderImage
}
if err := c.validate(); err != nil {
panic(err)
}
opConf = &c
})
return opConf
}
// GetLocalhost returns localhost value depending on global configuration
func GetLocalhost() string {
cfg := MustGetBaseConfig()
if len(cfg.Loopback) > 0 {
return cfg.Loopback
}
if cfg.EnableTCP6 {
return "localhost"
}
return "127.0.0.1"
}
var validNamespaceRegex = regexp.MustCompile(`[a-z0-9]([-a-z0-9]*[a-z0-9])?`)
// IsClusterWideAccessAllowed checks if cluster wide access for components is needed
func IsClusterWideAccessAllowed() bool {
cfg := MustGetBaseConfig()
return len(cfg.WatchNamespaces) == 0
}
type Labels struct {
LabelsString string
LabelsMap map[string]string
}
// Implement the flag.Value interface
func (labels *Labels) String() string {
return labels.LabelsString
}
// Merge labels create a new map with labels merged.
func (labels *Labels) Merge(otherLabels map[string]string) map[string]string {
mergedLabels := map[string]string{}
maps.Copy(mergedLabels, otherLabels)
maps.Copy(mergedLabels, labels.LabelsMap)
return mergedLabels
}
// Set implements the flag.Set interface.
func (labels *Labels) Set(value string) error {
m := map[string]string{}
if value != "" {
split := strings.Split(value, ",")
for _, pair := range split {
sp := strings.Split(pair, "=")
m[sp[0]] = sp[1]
}
}
labels.LabelsMap = m
labels.LabelsString = value
return nil
}
// ConfigAsMetrics exposes major configuration params as prometheus metrics
func ConfigAsMetrics(r metrics.RegistererGatherer, cfg *BaseOperatorConf) {
opts := getEnvOpts()
rawEnvVars := make(map[string]string)
var mapper func(v string) string
mapper = func(v string) string {
val := rawEnvVars[v]
if val == "" {
val = opts.Environment[v]
}
return os.Expand(val, mapper)
}
params, err := env.GetFieldParamsWithOptions(cfg, opts)
if err != nil {
panic(fmt.Sprintf("BUG: failed to get global variables: %s", err))
}
ms := prometheus.NewGaugeVec(prometheus.GaugeOpts{Name: "config parameter"}, []string{"name", "is_set", "value"})
for _, p := range params {
_, isSet := os.LookupEnv(p.Key)
value := p.DefaultValue
if v, ok := opts.Environment[p.Key]; ok {
value = v
} else if p.Expand {
value = os.Expand(value, mapper)
}
rawEnvVars[p.Key] = value
ms.WithLabelValues(p.Key, strconv.FormatBool(isSet), value).Set(1)
}
r.MustRegister(ms)
}