cleanup FederatedHPA API

Signed-off-by: RainbowMango <qdurenhongcai@gmail.com>
This commit is contained in:
RainbowMango 2023-06-26 19:28:53 +08:00
parent fb317bd905
commit 658eec642e
3 changed files with 15 additions and 19 deletions

View File

@ -61,7 +61,7 @@ spec:
metadata:
type: object
spec:
description: Spec is the specification of the FederatedHPASpec.
description: Spec is the specification of the FederatedHPA.
properties:
behavior:
description: Behavior configures the scaling behavior of the target
@ -179,7 +179,7 @@ spec:
type: object
type: object
maxReplicas:
description: maxReplicas is the upper limit for the number of replicas
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
@ -657,11 +657,8 @@ spec:
type: object
type: array
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.
description: MinReplicas is the lower limit for the number of replicas
to which the autoscaler can scale down. It defaults to 1 pod.
format: int32
type: integer
scaleTargetRef:

View File

@ -24,7 +24,7 @@ type FederatedHPA struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec is the specification of the FederatedHPASpec.
// Spec is the specification of the FederatedHPA.
// +required
Spec FederatedHPASpec `json:"spec"`
@ -41,17 +41,16 @@ type FederatedHPASpec struct {
// +required
ScaleTargetRef autoscalingv2.CrossVersionObjectReference `json:"scaleTargetRef"`
// 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.
// MinReplicas is the lower limit for the number of replicas to which the
// autoscaler can scale down.
// It defaults to 1 pod.
// +optional
MinReplicas *int32 `json:"minReplicas,omitempty" protobuf:"varint,2,opt,name=minReplicas"`
MinReplicas *int32 `json:"minReplicas,omitempty"`
// maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up.
// MaxReplicas is the upper limit for the number of replicas to which the
// autoscaler can scale up.
// It cannot be less that minReplicas.
MaxReplicas int32 `json:"maxReplicas" protobuf:"varint,3,opt,name=maxReplicas"`
MaxReplicas int32 `json:"maxReplicas"`
// Metrics contains the specifications for which to use to calculate the
// desired replica count (the maximum replica count across all metrics will

View File

@ -856,7 +856,7 @@ func schema_pkg_apis_autoscaling_v1alpha1_FederatedHPA(ref common.ReferenceCallb
},
"spec": {
SchemaProps: spec.SchemaProps{
Description: "Spec is the specification of the FederatedHPASpec.",
Description: "Spec is the specification of the FederatedHPA.",
Default: map[string]interface{}{},
Ref: ref("github.com/karmada-io/karmada/pkg/apis/autoscaling/v1alpha1.FederatedHPASpec"),
},
@ -942,14 +942,14 @@ func schema_pkg_apis_autoscaling_v1alpha1_FederatedHPASpec(ref common.ReferenceC
},
"minReplicas": {
SchemaProps: spec.SchemaProps{
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.",
Description: "MinReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod.",
Type: []string{"integer"},
Format: "int32",
},
},
"maxReplicas": {
SchemaProps: spec.SchemaProps{
Description: "maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.",
Description: "MaxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.",
Default: 0,
Type: []string{"integer"},
Format: "int32",