-
Notifications
You must be signed in to change notification settings - Fork 38.7k
/
apis__autoscaling__v2_openapi.json
3715 lines (3715 loc) · 175 KB
/
apis__autoscaling__v2_openapi.json
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
{
"components": {
"schemas": {
"io.k8s.api.autoscaling.v2.ContainerResourceMetricSource": {
"description": "ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source. Only one \"target\" type should be set.",
"properties": {
"container": {
"default": "",
"description": "container is the name of the container in the pods of the scaling target",
"type": "string"
},
"name": {
"default": "",
"description": "name is the name of the resource in question.",
"type": "string"
},
"target": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricTarget"
}
],
"default": {},
"description": "target specifies the target value for the given metric"
}
},
"required": [
"name",
"target",
"container"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.ContainerResourceMetricStatus": {
"description": "ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source.",
"properties": {
"container": {
"default": "",
"description": "Container is the name of the container in the pods of the scaling target",
"type": "string"
},
"current": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricValueStatus"
}
],
"default": {},
"description": "current contains the current value for the given metric"
},
"name": {
"default": "",
"description": "Name is the name of the resource in question.",
"type": "string"
}
},
"required": [
"name",
"current",
"container"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.CrossVersionObjectReference": {
"description": "CrossVersionObjectReference contains enough information to let you identify the referred resource.",
"properties": {
"apiVersion": {
"description": "API version of the referent",
"type": "string"
},
"kind": {
"default": "",
"description": "Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\"",
"type": "string"
},
"name": {
"default": "",
"description": "Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.ExternalMetricSource": {
"description": "ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).",
"properties": {
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricIdentifier"
}
],
"default": {},
"description": "metric identifies the target metric by name and selector"
},
"target": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricTarget"
}
],
"default": {},
"description": "target specifies the target value for the given metric"
}
},
"required": [
"metric",
"target"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.ExternalMetricStatus": {
"description": "ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.",
"properties": {
"current": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricValueStatus"
}
],
"default": {},
"description": "current contains the current value for the given metric"
},
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricIdentifier"
}
],
"default": {},
"description": "metric identifies the target metric by name and selector"
}
},
"required": [
"metric",
"current"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.HPAScalingPolicy": {
"description": "HPAScalingPolicy is a single policy which must hold true for a specified past interval.",
"properties": {
"periodSeconds": {
"default": 0,
"description": "PeriodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).",
"format": "int32",
"type": "integer"
},
"type": {
"default": "",
"description": "Type is used to specify the scaling policy.",
"type": "string"
},
"value": {
"default": 0,
"description": "Value contains the amount of change which is permitted by the policy. It must be greater than zero",
"format": "int32",
"type": "integer"
}
},
"required": [
"type",
"value",
"periodSeconds"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.HPAScalingRules": {
"description": "HPAScalingRules configures the scaling behavior for one direction. These Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen.",
"properties": {
"policies": {
"description": "policies is a list of potential scaling polices which can be used during scaling. At least one policy must be specified, otherwise the HPAScalingRules will be discarded as invalid",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HPAScalingPolicy"
}
],
"default": {}
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"selectPolicy": {
"description": "selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.",
"type": "string"
},
"stabilizationWindowSeconds": {
"description": "StabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to zero and less than or equal to 3600 (one hour). If not set, use the default values: - For scale up: 0 (i.e. no stabilization is done). - For scale down: 300 (i.e. the stabilization window is 300 seconds long).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler": {
"description": "HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.",
"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/sig-architecture/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/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
}
],
"default": {},
"description": "metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata"
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerSpec"
}
],
"default": {},
"description": "spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status."
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerStatus"
}
],
"default": {},
"description": "status is the current information about the autoscaler."
}
},
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "autoscaling",
"kind": "HorizontalPodAutoscaler",
"version": "v2"
}
]
},
"io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerBehavior": {
"description": "HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).",
"properties": {
"scaleDown": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HPAScalingRules"
}
],
"description": "scaleDown is scaling policy for scaling Down. If not set, the default value is to allow to scale down to minReplicas pods, with a 300 second stabilization window (i.e., the highest recommendation for the last 300sec is used)."
},
"scaleUp": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HPAScalingRules"
}
],
"description": "scaleUp is scaling policy for scaling Up. If not set, the default value is the higher of:\n * increase no more than 4 pods per 60 seconds\n * double the number of pods per 60 seconds\nNo stabilization is used."
}
},
"type": "object"
},
"io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerCondition": {
"description": "HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.",
"properties": {
"lastTransitionTime": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}
],
"default": {},
"description": "lastTransitionTime is the last time the condition transitioned from one status to another"
},
"message": {
"description": "message is a human-readable explanation containing details about the transition",
"type": "string"
},
"reason": {
"description": "reason is the reason for the condition's last transition.",
"type": "string"
},
"status": {
"default": "",
"description": "status is the status of the condition (True, False, Unknown)",
"type": "string"
},
"type": {
"default": "",
"description": "type describes the current condition",
"type": "string"
}
},
"required": [
"type",
"status"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerList": {
"description": "HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.",
"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/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"items": {
"description": "items is the list of horizontal pod autoscaler objects.",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HorizontalPodAutoscaler"
}
],
"default": {}
},
"type": "array"
},
"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/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
}
],
"default": {},
"description": "metadata is the standard list metadata."
}
},
"required": [
"items"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "autoscaling",
"kind": "HorizontalPodAutoscalerList",
"version": "v2"
}
]
},
"io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerSpec": {
"description": "HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.",
"properties": {
"behavior": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerBehavior"
}
],
"description": "behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used."
},
"maxReplicas": {
"default": 0,
"description": "maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.",
"format": "int32",
"type": "integer"
},
"metrics": {
"description": "metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization.",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricSpec"
}
],
"default": {}
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"minReplicas": {
"description": "minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.",
"format": "int32",
"type": "integer"
},
"scaleTargetRef": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.CrossVersionObjectReference"
}
],
"default": {},
"description": "scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count."
}
},
"required": [
"scaleTargetRef",
"maxReplicas"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerStatus": {
"description": "HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.",
"properties": {
"conditions": {
"description": "conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.HorizontalPodAutoscalerCondition"
}
],
"default": {}
},
"type": "array",
"x-kubernetes-list-map-keys": [
"type"
],
"x-kubernetes-list-type": "map",
"x-kubernetes-patch-merge-key": "type",
"x-kubernetes-patch-strategy": "merge"
},
"currentMetrics": {
"description": "currentMetrics is the last read state of the metrics used by this autoscaler.",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricStatus"
}
],
"default": {}
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"currentReplicas": {
"description": "currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.",
"format": "int32",
"type": "integer"
},
"desiredReplicas": {
"default": 0,
"description": "desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.",
"format": "int32",
"type": "integer"
},
"lastScaleTime": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
}
],
"description": "lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed."
},
"observedGeneration": {
"description": "observedGeneration is the most recent generation observed by this autoscaler.",
"format": "int64",
"type": "integer"
}
},
"required": [
"desiredReplicas"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.MetricIdentifier": {
"description": "MetricIdentifier defines the name and optionally selector for a metric",
"properties": {
"name": {
"default": "",
"description": "name is the name of the given metric",
"type": "string"
},
"selector": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
}
],
"description": "selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics."
}
},
"required": [
"name"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.MetricSpec": {
"description": "MetricSpec specifies how to scale based on a single metric (only `type` and one other matching field should be set at once).",
"properties": {
"containerResource": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ContainerResourceMetricSource"
}
],
"description": "containerResource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag."
},
"external": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ExternalMetricSource"
}
],
"description": "external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster)."
},
"object": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ObjectMetricSource"
}
],
"description": "object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object)."
},
"pods": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.PodsMetricSource"
}
],
"description": "pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value."
},
"resource": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ResourceMetricSource"
}
],
"description": "resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source."
},
"type": {
"default": "",
"description": "type is the type of metric source. It should be one of \"ContainerResource\", \"External\", \"Object\", \"Pods\" or \"Resource\", each mapping to a matching field in the object. Note: \"ContainerResource\" type is available on when the feature-gate HPAContainerMetrics is enabled",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.MetricStatus": {
"description": "MetricStatus describes the last-read state of a single metric.",
"properties": {
"containerResource": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ContainerResourceMetricStatus"
}
],
"description": "container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source."
},
"external": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ExternalMetricStatus"
}
],
"description": "external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster)."
},
"object": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ObjectMetricStatus"
}
],
"description": "object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object)."
},
"pods": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.PodsMetricStatus"
}
],
"description": "pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value."
},
"resource": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.ResourceMetricStatus"
}
],
"description": "resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source."
},
"type": {
"default": "",
"description": "type is the type of metric source. It will be one of \"ContainerResource\", \"External\", \"Object\", \"Pods\" or \"Resource\", each corresponds to a matching field in the object. Note: \"ContainerResource\" type is available on when the feature-gate HPAContainerMetrics is enabled",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.MetricTarget": {
"description": "MetricTarget defines the target value, average value, or average utilization of a specific metric",
"properties": {
"averageUtilization": {
"description": "averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only valid for Resource metric source type",
"format": "int32",
"type": "integer"
},
"averageValue": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.api.resource.Quantity"
}
],
"description": "averageValue is the target value of the average of the metric across all relevant pods (as a quantity)"
},
"type": {
"default": "",
"description": "type represents whether the metric type is Utilization, Value, or AverageValue",
"type": "string"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.api.resource.Quantity"
}
],
"description": "value is the target value of the metric (as a quantity)."
}
},
"required": [
"type"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.MetricValueStatus": {
"description": "MetricValueStatus holds the current value for a metric",
"properties": {
"averageUtilization": {
"description": "currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.",
"format": "int32",
"type": "integer"
},
"averageValue": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.api.resource.Quantity"
}
],
"description": "averageValue is the current value of the average of the metric across all relevant pods (as a quantity)"
},
"value": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.api.resource.Quantity"
}
],
"description": "value is the current value of the metric (as a quantity)."
}
},
"type": "object"
},
"io.k8s.api.autoscaling.v2.ObjectMetricSource": {
"description": "ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).",
"properties": {
"describedObject": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.CrossVersionObjectReference"
}
],
"default": {},
"description": "describedObject specifies the descriptions of a object,such as kind,name apiVersion"
},
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricIdentifier"
}
],
"default": {},
"description": "metric identifies the target metric by name and selector"
},
"target": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricTarget"
}
],
"default": {},
"description": "target specifies the target value for the given metric"
}
},
"required": [
"describedObject",
"target",
"metric"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.ObjectMetricStatus": {
"description": "ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).",
"properties": {
"current": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricValueStatus"
}
],
"default": {},
"description": "current contains the current value for the given metric"
},
"describedObject": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.CrossVersionObjectReference"
}
],
"default": {},
"description": "DescribedObject specifies the descriptions of a object,such as kind,name apiVersion"
},
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricIdentifier"
}
],
"default": {},
"description": "metric identifies the target metric by name and selector"
}
},
"required": [
"metric",
"current",
"describedObject"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.PodsMetricSource": {
"description": "PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.",
"properties": {
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricIdentifier"
}
],
"default": {},
"description": "metric identifies the target metric by name and selector"
},
"target": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricTarget"
}
],
"default": {},
"description": "target specifies the target value for the given metric"
}
},
"required": [
"metric",
"target"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.PodsMetricStatus": {
"description": "PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).",
"properties": {
"current": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricValueStatus"
}
],
"default": {},
"description": "current contains the current value for the given metric"
},
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricIdentifier"
}
],
"default": {},
"description": "metric identifies the target metric by name and selector"
}
},
"required": [
"metric",
"current"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.ResourceMetricSource": {
"description": "ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source. Only one \"target\" type should be set.",
"properties": {
"name": {
"default": "",
"description": "name is the name of the resource in question.",
"type": "string"
},
"target": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricTarget"
}
],
"default": {},
"description": "target specifies the target value for the given metric"
}
},
"required": [
"name",
"target"
],
"type": "object"
},
"io.k8s.api.autoscaling.v2.ResourceMetricStatus": {
"description": "ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the \"pods\" source.",
"properties": {
"current": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.api.autoscaling.v2.MetricValueStatus"
}
],
"default": {},
"description": "current contains the current value for the given metric"
},
"name": {
"default": "",
"description": "Name is the name of the resource in question.",
"type": "string"
}
},
"required": [
"name",
"current"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.api.resource.Quantity": {
"description": "Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors.\n\nThe serialization format is:\n\n<quantity> ::= <signedNumber><suffix>\n (Note that <suffix> may be empty, from the \"\" case in <decimalSI>.)\n<digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= \"+\" | \"-\" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei\n (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html)\n<decimalSI> ::= m | \"\" | k | M | G | T | P | E\n (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.)\n<decimalExponent> ::= \"e\" <signedNumber> | \"E\" <signedNumber>\n\nNo matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities.\n\nWhen a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized.\n\nBefore serializing, Quantity will be put in \"canonical form\". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that:\n a. No precision is lost\n b. No fractional digits will be emitted\n c. The exponent (or suffix) is as large as possible.\nThe sign will be omitted unless the number is negative.\n\nExamples:\n 1.5 will be serialized as \"1500m\"\n 1.5Gi will be serialized as \"1536Mi\"\n\nNote that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise.\n\nNon-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.)\n\nThis format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation.",
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.APIResource": {
"description": "APIResource specifies the name of a resource and whether it is namespaced.",
"properties": {
"categories": {
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"group": {
"description": "group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\".",
"type": "string"
},
"kind": {
"default": "",
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
"type": "string"
},
"name": {
"default": "",
"description": "name is the plural name of the resource.",
"type": "string"
},
"namespaced": {
"default": false,
"description": "namespaced indicates if a resource is namespaced or not.",
"type": "boolean"
},
"shortNames": {
"description": "shortNames is a list of suggested short names of the resource.",
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"singularName": {
"default": "",
"description": "singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.",
"type": "string"
},
"storageVersionHash": {
"description": "The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.",
"type": "string"
},
"verbs": {
"description": "verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)",
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"version": {
"description": "version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)\".",
"type": "string"
}
},
"required": [
"name",
"singularName",
"namespaced",
"kind",
"verbs"
],
"type": "object"
},
"io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList": {
"description": "APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.",
"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/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"groupVersion": {
"default": "",
"description": "groupVersion is the group and version this APIResourceList is for.",
"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/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"resources": {
"description": "resources contains the name of the resources and if they are namespaced.",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.APIResource"
}
],
"default": {}
},
"type": "array"
}
},
"required": [
"groupVersion",
"resources"
],
"type": "object",
"x-kubernetes-group-version-kind": [
{
"group": "",
"kind": "APIResourceList",
"version": "v1"
}
]
},
"io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions": {
"description": "DeleteOptions may be provided when deleting an API object.",
"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/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"dryRun": {
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
"items": {
"default": "",
"type": "string"
},
"type": "array"
},
"gracePeriodSeconds": {
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
"format": "int64",
"type": "integer"
},
"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/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"orphanDependents": {
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
"type": "boolean"
},
"preconditions": {
"allOf": [
{
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions"
}
],
"description": "Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned."
},
"propagationPolicy": {
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
"type": "string"
}