-
Notifications
You must be signed in to change notification settings - Fork 0
/
prometheus-operator-crd.jsonschema
2774 lines (2774 loc) · 148 KB
/
prometheus-operator-crd.jsonschema
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
{
"swagger": "2.0",
"info": {
"title": "Prometheus Operator CRD OpenAPI",
"version": "v1"
},
"paths": {},
"definitions": {
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.APIServerConfig": {
"description": "APIServerConfig defines a host and auth methods to access apiserver. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config",
"type": "object",
"required": [
"host"
],
"properties": {
"basicAuth": {
"description": "BasicAuth allow an endpoint to authenticate over basic authentication",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.BasicAuth"
},
"bearerToken": {
"description": "Bearer token for accessing apiserver.",
"type": "string"
},
"bearerTokenFile": {
"description": "File to read bearer token for accessing apiserver.",
"type": "string"
},
"host": {
"description": "Host of apiserver. A valid string consisting of a hostname or IP followed by an optional port number",
"type": "string"
},
"tlsConfig": {
"description": "TLS Config to use for accessing apiserver.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.TLSConfig"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertingSpec": {
"description": "AlertingSpec defines parameters for alerting configuration of Prometheus servers.",
"type": "object",
"required": [
"alertmanagers"
],
"properties": {
"alertmanagers": {
"description": "AlertmanagerEndpoints Prometheus should fire alerts against.",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertmanagerEndpoints"
}
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.Alertmanager": {
"description": "Alertmanager describes an Alertmanager cluster.",
"type": "object",
"required": [
"spec"
],
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"spec": {
"description": "Specification of the desired behavior of the Alertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertmanagerSpec"
},
"status": {
"description": "Most recent observed status of the Alertmanager cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertmanagerStatus"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertmanagerEndpoints": {
"description": "AlertmanagerEndpoints defines a selection of a single Endpoints object containing alertmanager IPs to fire alerts against.",
"type": "object",
"required": [
"namespace",
"name",
"port"
],
"properties": {
"bearerTokenFile": {
"description": "BearerTokenFile to read from filesystem to use when authenticating to Alertmanager.",
"type": "string"
},
"name": {
"description": "Name of Endpoints object in Namespace.",
"type": "string"
},
"namespace": {
"description": "Namespace of Endpoints object.",
"type": "string"
},
"pathPrefix": {
"description": "Prefix for the HTTP path alerts are pushed to.",
"type": "string"
},
"port": {
"description": "Port the Alertmanager API is exposed on.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
},
"scheme": {
"description": "Scheme to use when firing alerts.",
"type": "string"
},
"tlsConfig": {
"description": "TLS Config to use for alertmanager connection.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.TLSConfig"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertmanagerSpec": {
"description": "AlertmanagerSpec is a specification of the desired behavior of the Alertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"type": "object",
"properties": {
"additionalPeers": {
"description": "AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster.",
"type": "array",
"items": {
"type": "string"
}
},
"affinity": {
"description": "If specified, the pod's scheduling constraints.",
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity"
},
"baseImage": {
"description": "Base image that is used to deploy pods, without tag.",
"type": "string"
},
"configMaps": {
"description": "ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. The ConfigMaps are mounted into /etc/alertmanager/configmaps/<configmap-name>.",
"type": "array",
"items": {
"type": "string"
}
},
"containers": {
"description": "Containers allows injecting additional containers. This is meant to allow adding an authentication proxy to an Alertmanager pod.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
}
},
"externalUrl": {
"description": "The external URL the Alertmanager instances will be available under. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name.",
"type": "string"
},
"image": {
"description": "Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Alertmanager is being configured.",
"type": "string"
},
"imagePullSecrets": {
"description": "An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
}
},
"listenLocal": {
"description": "ListenLocal makes the Alertmanager server listen on loopback, so that it does not bind against the Pod IP. Note this is only for the Alertmanager UI, not the gossip communication.",
"type": "boolean"
},
"logFormat": {
"description": "Log format for Alertmanager to be configured with.",
"type": "string"
},
"logLevel": {
"description": "Log level for Alertmanager to be configured with.",
"type": "string"
},
"nodeSelector": {
"description": "Define which Nodes the Pods are scheduled on.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paused": {
"description": "If set to true all actions on the underlaying managed objects are not goint to be performed, except for delete actions.",
"type": "boolean"
},
"podMetadata": {
"description": "Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata Metadata Labels and Annotations gets propagated to the prometheus pods.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"priorityClassName": {
"description": "Priority class assigned to the Pods",
"type": "string"
},
"replicas": {
"description": "Size is the expected size of the alertmanager cluster. The controller will eventually make the size of the running cluster equal to the expected size.",
"type": "integer",
"format": "int32"
},
"resources": {
"description": "Define resources requests and limits for single Pods.",
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
},
"retention": {
"description": "Time duration Alertmanager shall retain data for. Default is '120h', and must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours).",
"type": "string"
},
"routePrefix": {
"description": "The route prefix Alertmanager registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`.",
"type": "string"
},
"secrets": {
"description": "Secrets is a list of Secrets in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. The Secrets are mounted into /etc/alertmanager/secrets/<secret-name>.",
"type": "array",
"items": {
"type": "string"
}
},
"securityContext": {
"description": "SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.",
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext"
},
"serviceAccountName": {
"description": "ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.",
"type": "string"
},
"sha": {
"description": "SHA of Alertmanager container image to be deployed. Defaults to the value of `version`. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set.",
"type": "string"
},
"storage": {
"description": "Storage is the definition of how storage will be used by the Alertmanager instances.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.StorageSpec"
},
"tag": {
"description": "Tag of Alertmanager container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set.",
"type": "string"
},
"tolerations": {
"description": "If specified, the pod's tolerations.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
}
},
"version": {
"description": "Version the cluster should be on.",
"type": "string"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertmanagerStatus": {
"description": "AlertmanagerStatus is the most recent observed status of the Alertmanager cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"type": "object",
"required": [
"paused",
"replicas",
"updatedReplicas",
"availableReplicas",
"unavailableReplicas"
],
"properties": {
"availableReplicas": {
"description": "Total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster.",
"type": "integer",
"format": "int32"
},
"paused": {
"description": "Represents whether any actions on the underlaying managed objects are being performed. Only delete actions will be performed.",
"type": "boolean"
},
"replicas": {
"description": "Total number of non-terminated pods targeted by this Alertmanager cluster (their labels match the selector).",
"type": "integer",
"format": "int32"
},
"unavailableReplicas": {
"description": "Total number of unavailable pods targeted by this Alertmanager cluster.",
"type": "integer",
"format": "int32"
},
"updatedReplicas": {
"description": "Total number of non-terminated pods targeted by this Alertmanager cluster that have the desired version spec.",
"type": "integer",
"format": "int32"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.BasicAuth": {
"description": "BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints",
"type": "object",
"properties": {
"password": {
"description": "The secret that contains the password for authenticate",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"username": {
"description": "The secret that contains the username for authenticate",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.Endpoint": {
"description": "Endpoint defines a scrapeable endpoint serving Prometheus metrics.",
"type": "object",
"properties": {
"basicAuth": {
"description": "BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.BasicAuth"
},
"bearerTokenFile": {
"description": "File to read bearer token for scraping targets.",
"type": "string"
},
"honorLabels": {
"description": "HonorLabels chooses the metric's labels on collisions with target labels.",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"metricRelabelings": {
"description": "MetricRelabelConfigs to apply to samples before ingestion.",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RelabelConfig"
}
},
"params": {
"description": "Optional HTTP URL parameters",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"path": {
"description": "HTTP path to scrape for metrics.",
"type": "string"
},
"port": {
"description": "Name of the service port this endpoint refers to. Mutually exclusive with targetPort.",
"type": "string"
},
"proxyUrl": {
"description": "ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.",
"type": "string"
},
"relabelings": {
"description": "RelabelConfigs to apply to samples before scraping. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RelabelConfig"
}
},
"scheme": {
"description": "HTTP scheme to use for scraping.",
"type": "string"
},
"scrapeTimeout": {
"description": "Timeout after which the scrape is ended",
"type": "string"
},
"targetPort": {
"description": "Name or number of the target port of the endpoint. Mutually exclusive with port.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
},
"tlsConfig": {
"description": "TLS configuration to use when scraping the endpoint",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.TLSConfig"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.NamespaceSelector": {
"description": "NamespaceSelector is a selector for selecting either all namespaces or a list of namespaces.",
"type": "object",
"properties": {
"any": {
"description": "Boolean describing whether all namespaces are selected in contrast to a list restricting them.",
"type": "boolean"
},
"matchNames": {
"description": "List of namespace names.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PodMetricsEndpoint": {
"description": "PodMetricsEndpoint defines a scrapeable endpoint of a Kubernetes Pod serving Prometheus metrics.",
"type": "object",
"properties": {
"honorLabels": {
"description": "HonorLabels chooses the metric's labels on collisions with target labels.",
"type": "boolean"
},
"interval": {
"description": "Interval at which metrics should be scraped",
"type": "string"
},
"metricRelabelings": {
"description": "MetricRelabelConfigs to apply to samples before ingestion.",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RelabelConfig"
}
},
"params": {
"description": "Optional HTTP URL parameters",
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"path": {
"description": "HTTP path to scrape for metrics.",
"type": "string"
},
"port": {
"description": "Name of the port this endpoint refers to. Mutually exclusive with targetPort.",
"type": "string"
},
"proxyUrl": {
"description": "ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.",
"type": "string"
},
"relabelings": {
"description": "RelabelConfigs to apply to samples before ingestion. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RelabelConfig"
}
},
"scheme": {
"description": "HTTP scheme to use for scraping.",
"type": "string"
},
"scrapeTimeout": {
"description": "Timeout after which the scrape is ended",
"type": "string"
},
"targetPort": {
"description": "Name or number of the target port of the endpoint. Mutually exclusive with port.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PodMonitor": {
"description": "PodMonitor defines monitoring for a set of pods.",
"type": "object",
"required": [
"spec"
],
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"spec": {
"description": "Specification of desired Pod selection for target discovery by Prometheus.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PodMonitorSpec"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PodMonitorSpec": {
"description": "PodMonitorSpec contains specification parameters for a PodMonitor.",
"type": "object",
"required": [
"podMetricsEndpoints",
"selector"
],
"properties": {
"jobLabel": {
"description": "The label to use to retrieve the job name from.",
"type": "string"
},
"namespaceSelector": {
"description": "Selector to select which namespaces the Endpoints objects are discovered from.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.NamespaceSelector"
},
"podMetricsEndpoints": {
"description": "A list of endpoints allowed as part of this PodMonitor.",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PodMetricsEndpoint"
}
},
"podTargetLabels": {
"description": "PodTargetLabels transfers labels on the Kubernetes Pod onto the target.",
"type": "array",
"items": {
"type": "string"
}
},
"sampleLimit": {
"description": "SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.",
"type": "integer",
"format": "int64"
},
"selector": {
"description": "Selector to select Pod objects.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.Prometheus": {
"description": "Prometheus defines a Prometheus deployment.",
"type": "object",
"required": [
"spec"
],
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"spec": {
"description": "Specification of the desired behavior of the Prometheus cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PrometheusSpec"
},
"status": {
"description": "Most recent observed status of the Prometheus cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PrometheusStatus"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PrometheusRule": {
"description": "PrometheusRule defines alerting rules for a Prometheus instance",
"type": "object",
"required": [
"spec"
],
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"description": "Standard object’s metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"spec": {
"description": "Specification of desired alerting rule definitions for Prometheus.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PrometheusRuleSpec"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PrometheusRuleSpec": {
"description": "PrometheusRuleSpec contains specification parameters for a Rule.",
"type": "object",
"properties": {
"groups": {
"description": "Content of Prometheus rule file",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RuleGroup"
}
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PrometheusSpec": {
"description": "PrometheusSpec is a specification of the desired behavior of the Prometheus cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"type": "object",
"properties": {
"additionalAlertManagerConfigs": {
"description": "AdditionalAlertManagerConfigs allows specifying a key of a Secret containing additional Prometheus AlertManager configurations. AlertManager configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config. As AlertManager configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible AlertManager configs are going to break Prometheus after the upgrade.",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"additionalAlertRelabelConfigs": {
"description": "AdditionalAlertRelabelConfigs allows specifying a key of a Secret containing additional Prometheus alert relabel configurations. Alert relabel configurations specified are appended to the configurations generated by the Prometheus Operator. Alert relabel configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs. As alert relabel configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible alert relabel configs are going to break Prometheus after the upgrade.",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"additionalScrapeConfigs": {
"description": "AdditionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified in the official Prometheus documentation: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config. As scrape configs are appended, the user is responsible to make sure it is valid. Note that using this feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release notes to ensure that no incompatible scrape configs are going to break Prometheus after the upgrade.",
"$ref": "#/definitions/io.k8s.api.core.v1.SecretKeySelector"
},
"affinity": {
"description": "If specified, the pod's scheduling constraints.",
"$ref": "#/definitions/io.k8s.api.core.v1.Affinity"
},
"alerting": {
"description": "Define details regarding alerting.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.AlertingSpec"
},
"apiserverConfig": {
"description": "APIServerConfig allows specifying a host and auth methods to access apiserver. If left empty, Prometheus is assumed to run inside of the cluster and will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.APIServerConfig"
},
"baseImage": {
"description": "Base image to use for a Prometheus deployment.",
"type": "string"
},
"configMaps": {
"description": "ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The ConfigMaps are mounted into /etc/prometheus/configmaps/<configmap-name>.",
"type": "array",
"items": {
"type": "string"
}
},
"containers": {
"description": "Containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a Prometheus pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge patch. The current container names are: `prometheus`, `prometheus-config-reloader`, `rules-configmap-reloader`, and `thanos-sidecar`. Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Container"
}
},
"enableAdminAPI": {
"description": "Enable access to prometheus web admin API. Defaults to the value of `false`. WARNING: Enabling the admin APIs enables mutating endpoints, to delete data, shutdown Prometheus, and more. Enabling this should be done with care and the user is advised to add additional authentication authorization via a proxy to ensure only clients authorized to perform these actions can do so. For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis",
"type": "boolean"
},
"evaluationInterval": {
"description": "Interval between consecutive evaluations.",
"type": "string"
},
"externalLabels": {
"description": "The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager).",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"externalUrl": {
"description": "The external URL the Prometheus instances will be available under. This is necessary to generate correct URLs. This is necessary if Prometheus is not served from root of a DNS name.",
"type": "string"
},
"image": {
"description": "Image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Prometheus is being configured.",
"type": "string"
},
"imagePullSecrets": {
"description": "An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
}
},
"listenLocal": {
"description": "ListenLocal makes the Prometheus server listen on loopback, so that it does not bind against the Pod IP.",
"type": "boolean"
},
"logFormat": {
"description": "Log format for Prometheus to be configured with.",
"type": "string"
},
"logLevel": {
"description": "Log level for Prometheus to be configured with.",
"type": "string"
},
"nodeSelector": {
"description": "Define which Nodes the Pods are scheduled on.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"paused": {
"description": "When a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects.",
"type": "boolean"
},
"podMetadata": {
"description": "Standard object’s metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#metadata Metadata Labels and Annotations gets propagated to the prometheus pods.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
},
"podMonitorNamespaceSelector": {
"description": "Namespaces to be selected for PodMonitor discovery. If nil, only check own namespace.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
"podMonitorSelector": {
"description": "*Experimental* PodMonitors to be selected for target discovery.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
"priorityClassName": {
"description": "Priority class assigned to the Pods",
"type": "string"
},
"prometheusExternalLabelName": {
"description": "Name of Prometheus external label used to denote Prometheus instance name. Defaults to the value of `prometheus`. External label will _not_ be added when value is set to empty string (`\"\"`).",
"type": "string"
},
"query": {
"description": "QuerySpec defines the query command line flags when starting Prometheus.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.QuerySpec"
},
"remoteRead": {
"description": "If specified, the remote_read spec. This is an experimental feature, it may change in any upcoming release in a breaking way.",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RemoteReadSpec"
}
},
"remoteWrite": {
"description": "If specified, the remote_write spec. This is an experimental feature, it may change in any upcoming release in a breaking way.",
"type": "array",
"items": {
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RemoteWriteSpec"
}
},
"replicaExternalLabelName": {
"description": "Name of Prometheus external label used to denote replica name. Defaults to the value of `prometheus_replica`. External label will _not_ be added when value is set to empty string (`\"\"`).",
"type": "string"
},
"replicas": {
"description": "Number of instances to deploy for a Prometheus deployment.",
"type": "integer",
"format": "int32"
},
"resources": {
"description": "Define resources requests and limits for single Pods.",
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
},
"retention": {
"description": "Time duration Prometheus shall retain data for. Default is '24h', and must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes hours days weeks years).",
"type": "string"
},
"retentionSize": {
"description": "Maximum amount of disk space used by blocks.",
"type": "string"
},
"routePrefix": {
"description": "The route prefix Prometheus registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`.",
"type": "string"
},
"ruleNamespaceSelector": {
"description": "Namespaces to be selected for PrometheusRules discovery. If unspecified, only the same namespace as the Prometheus object is in is used.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
"ruleSelector": {
"description": "A selector to select which PrometheusRules to mount for loading alerting rules from. Until (excluding) Prometheus Operator v0.24.0 Prometheus Operator will migrate any legacy rule ConfigMaps to PrometheusRule custom resources selected by RuleSelector. Make sure it does not match any config maps that you do not want to be migrated.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
"rules": {
"description": "/--rules.*/ command-line arguments.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.Rules"
},
"scrapeInterval": {
"description": "Interval between consecutive scrapes.",
"type": "string"
},
"secrets": {
"description": "Secrets is a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. The Secrets are mounted into /etc/prometheus/secrets/<secret-name>.",
"type": "array",
"items": {
"type": "string"
}
},
"securityContext": {
"description": "SecurityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext.",
"$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext"
},
"serviceAccountName": {
"description": "ServiceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods.",
"type": "string"
},
"serviceMonitorNamespaceSelector": {
"description": "Namespaces to be selected for ServiceMonitor discovery. If nil, only check own namespace.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
"serviceMonitorSelector": {
"description": "ServiceMonitors to be selected for target discovery.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
"sha": {
"description": "SHA of Prometheus container image to be deployed. Defaults to the value of `version`. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set.",
"type": "string"
},
"storage": {
"description": "Storage spec to specify how storage shall be used.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.StorageSpec"
},
"tag": {
"description": "Tag of Prometheus container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set.",
"type": "string"
},
"thanos": {
"description": "Thanos configuration allows configuring various aspects of a Prometheus server in a Thanos environment.\n\nThis section is experimental, it may change significantly without deprecation notice in any release.\n\nThis is experimental and may change significantly without backward compatibility in any release.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.ThanosSpec"
},
"tolerations": {
"description": "If specified, the pod's tolerations.",
"type": "array",
"items": {
"$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
}
},
"version": {
"description": "Version of Prometheus to be deployed.",
"type": "string"
},
"walCompression": {
"description": "Enable compression of the write-ahead log using Snappy. This flag is only available in versions of Prometheus >= 2.11.0.",
"type": "boolean"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.PrometheusStatus": {
"description": "PrometheusStatus is the most recent observed status of the Prometheus cluster. Read-only. Not included when requesting from the apiserver, only from the Prometheus Operator API itself. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#spec-and-status",
"type": "object",
"required": [
"paused",
"replicas",
"updatedReplicas",
"availableReplicas",
"unavailableReplicas"
],
"properties": {
"availableReplicas": {
"description": "Total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment.",
"type": "integer",
"format": "int32"
},
"paused": {
"description": "Represents whether any actions on the underlaying managed objects are being performed. Only delete actions will be performed.",
"type": "boolean"
},
"replicas": {
"description": "Total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector).",
"type": "integer",
"format": "int32"
},
"unavailableReplicas": {
"description": "Total number of unavailable pods targeted by this Prometheus deployment.",
"type": "integer",
"format": "int32"
},
"updatedReplicas": {
"description": "Total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec.",
"type": "integer",
"format": "int32"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.QuerySpec": {
"description": "QuerySpec defines the query command line flags when starting Prometheus.",
"type": "object",
"properties": {
"lookbackDelta": {
"description": "The delta difference allowed for retrieving metrics during expression evaluations.",
"type": "string"
},
"maxConcurrency": {
"description": "Number of concurrent queries that can be run at once.",
"type": "integer",
"format": "int32"
},
"maxSamples": {
"description": "Maximum number of samples a single query can load into memory. Note that queries will fail if they would load more samples than this into memory, so this also limits the number of samples a query can return.",
"type": "integer",
"format": "int32"
},
"timeout": {
"description": "Maximum time a query may take before being aborted.",
"type": "string"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.QueueConfig": {
"description": "QueueConfig allows the tuning of remote_write queue_config parameters. This object is referenced in the RemoteWriteSpec object.",
"type": "object",
"properties": {
"batchSendDeadline": {
"description": "BatchSendDeadline is the maximum time a sample will wait in buffer.",
"type": "string"
},
"capacity": {
"description": "Capacity is the number of samples to buffer per shard before we start dropping them.",
"type": "integer",
"format": "int32"
},
"maxBackoff": {
"description": "MaxBackoff is the maximum retry delay.",
"type": "string"
},
"maxRetries": {
"description": "MaxRetries is the maximum number of times to retry a batch on recoverable errors.",
"type": "integer",
"format": "int32"
},
"maxSamplesPerSend": {
"description": "MaxSamplesPerSend is the maximum number of samples per send.",
"type": "integer",
"format": "int32"
},
"maxShards": {
"description": "MaxShards is the maximum number of shards, i.e. amount of concurrency.",
"type": "integer",
"format": "int32"
},
"minBackoff": {
"description": "MinBackoff is the initial retry delay. Gets doubled for every retry.",
"type": "string"
},
"minShards": {
"description": "MinShards is the minimum number of shards, i.e. amount of concurrency.",
"type": "integer",
"format": "int32"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RelabelConfig": {
"description": "RelabelConfig allows dynamic rewriting of the label set, being applied to samples before ingestion. It defines `<metric_relabel_configs>`-section of Prometheus configuration. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs",
"type": "object",
"properties": {
"action": {
"description": "Action to perform based on regex matching. Default is 'replace'",
"type": "string"
},
"modulus": {
"description": "Modulus to take of the hash of the source label values.",
"type": "integer",
"format": "int64"
},
"regex": {
"description": "Regular expression against which the extracted value is matched. defailt is '(.*)'",
"type": "string"
},
"replacement": {
"description": "Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is '$1'",
"type": "string"
},
"separator": {
"description": "Separator placed between concatenated source label values. default is ';'.",
"type": "string"
},
"sourceLabels": {
"description": "The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.",
"type": "array",
"items": {
"type": "string"
}
},
"targetLabel": {
"description": "Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.",
"type": "string"
}
}
},
"com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.RemoteReadSpec": {
"description": "RemoteReadSpec defines the remote_read configuration for prometheus.",
"type": "object",
"required": [
"url"
],
"properties": {
"basicAuth": {
"description": "BasicAuth for the URL.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.BasicAuth"
},
"bearerToken": {
"description": "bearer token for remote read.",
"type": "string"
},
"bearerTokenFile": {
"description": "File to read bearer token for remote read.",
"type": "string"
},
"proxyUrl": {
"description": "Optional ProxyURL",
"type": "string"
},
"readRecent": {
"description": "Whether reads should be made for queries for time ranges that the local storage should have complete data for.",
"type": "boolean"
},
"remoteTimeout": {
"description": "Timeout for requests to the remote read endpoint.",
"type": "string"
},
"requiredMatchers": {
"description": "An optional list of equality matchers which have to be present in a selector to query the remote read endpoint.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"tlsConfig": {
"description": "TLS Config to use for remote read.",
"$ref": "#/definitions/com.github.coreos.prometheus-operator.pkg.apis.monitoring.v1.TLSConfig"
},