initial draft for review before generating code #1015
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
roypaulin
reviewed
Jan 2, 2025
| @@ -18,6 +18,7 @@ limitations under the License. | |||
| package v1beta1 | |||
|
|
|||
| import ( | |||
| v2 "k8s.io/api/autoscaling/v2" | |||
There was a problem hiding this comment.
Suggested change
| v2 "k8s.io/api/autoscaling/v2" | |
| autoscalingv2 "k8s.io/api/autoscaling/v2" |
| // This struct allows customization of autoscaling. A custom metric can be used instead of the memory and cpu metrics. | ||
| // The scaling behavior can also be customized to meet different performance requirements. The maximum and mininum of | ||
| // sizes of the replica sets can be specified to limit the use of resources. | ||
| Custom Custom `json:"custom,omitempty"` |
| } | ||
|
|
||
| // Custom customizes VerticaAutoscaler | ||
| type Custom struct { |
There was a problem hiding this comment.
Let's use a better name. Maybe CustomAutoscalerSpec?
Comment on lines
92
to
93
| // +kubebuilder:default:=3 | ||
| // +kubebuilder:Minimum:=3 |
There was a problem hiding this comment.
Suggested change
| // +kubebuilder:default:=3 | |
| // +kubebuilder:Minimum:=3 | |
| // +kubebuilder:Minimum:=0 |
| // the mininum size of replica set | ||
| MinReplicas int32 `json:"minReplicas"` | ||
|
|
||
| // +kubebuilder:validation:Optional |
There was a problem hiding this comment.
Suggested change
| // +kubebuilder:validation:Optional | |
| // +kubebuilder:Minimum:=0 |
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the mininum size of replica set | ||
| MinReplicas int32 `json:"minReplicas"` |
There was a problem hiding this comment.
This is an integer. Using a pointer will not reduce memory footprint. Do you really want to use a pointer?
There was a problem hiding this comment.
Yes, will avoid a conversion later as the hpa expects a pointer.
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the custom metric to be used for autocaling | ||
| Metrics v2.MetricSpec `json:"metrics"` |
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // define how the autocaler handles the scaleup and scaledown | ||
| Behavior v2.HorizontalPodAutoscalerBehavior `json:"behavior,omitempty"` |
roypaulin
reviewed
Jan 3, 2025
|
|
||
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the value used to increase the threshold after after a scale up or a scale down |
There was a problem hiding this comment.
Suggested change
| // the value used to increase the threshold after after a scale up or a scale down | |
| // The value used to increase the threshold after a scale up or a scale down. |
Comment on lines
101
to
103
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the maximum size of replica set | ||
| MaxReplicas *int32 `json:"maxReplicas"` |
There was a problem hiding this comment.
Suggested change
| // +operator-sdk:csv:customresourcedefinitions:type=spec | |
| // the maximum size of replica set | |
| MaxReplicas *int32 `json:"maxReplicas"` | |
| // +operator-sdk:csv:customresourcedefinitions:type=spec | |
| // The maximum number of pods when scaling. | |
| MaxReplicas int32 `json:"maxReplicas"` |
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the value used to increase the threshold after after a scale up or a scale down | ||
| Increment *int32 `json:"increment"` |
There was a problem hiding this comment.
Suggested change
| Increment *int32 `json:"increment"` | |
| ThresholdAdjustmentValue int32 `json:"thresholdAdjustmentValue,omitempty"` |
I changed this field's name after your comment, it is always positive
| // MetricDefinition defines increment and metric to be used for autoscaling | ||
| type MetricDefinition struct { | ||
|
|
||
| // +kubebuilder:validation:Optional |
There was a problem hiding this comment.
Suggested change
| // +kubebuilder:validation:Optional | |
| // +kubebuilder:validation:Optional | |
| // +kubebuilder:Minimum:=0 |
There was a problem hiding this comment.
If the increment can only be positive, we can only increase threshold and cannot decrease it. That will work for scale up but not scale down.
There was a problem hiding this comment.
It is no longer an increment but a value. For scale up it will be used to decrease.
|
|
||
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the custom metric to be used for autocaling |
There was a problem hiding this comment.
Suggested change
| // the custom metric to be used for autocaling | |
| // The custom metric to be used for autocaling. |
|
|
||
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // define how the autocaler handles the scaleup and scaledown |
There was a problem hiding this comment.
Suggested change
| // define how the autocaler handles the scaleup and scaledown | |
| // Specifies the scaling behavior for both scale up and down. |
| // +kubebuilder:Minimum:=0 | ||
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the mininum size of replica set |
There was a problem hiding this comment.
Suggested change
| // the mininum size of replica set | |
| // The miminum number of pods when scaling. |
roypaulin
reviewed
Jan 3, 2025
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the mininum size of replica set | ||
| MinReplicas *int32 `json:"minReplicas"` |
There was a problem hiding this comment.
Suggested change
| MinReplicas *int32 `json:"minReplicas"` | |
| MinReplicas *int32 `json:"minReplicas,omitempty"` |
roypaulin
reviewed
Jan 3, 2025
| // +kubebuilder:Minimum:=0 | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the maximum size of replica set | ||
| MaxReplicas *int32 `json:"maxReplicas"` |
There was a problem hiding this comment.
Suggested change
| MaxReplicas *int32 `json:"maxReplicas"` | |
| MaxReplicas *int32 `json:"maxReplicas,omitempty"` |
roypaulin
reviewed
Jan 3, 2025
Comment on lines
107
to
108
| // the custom metric and increment to be used for autocaling | ||
| Metrics []MetricDefinition `json:"metrics"` |
There was a problem hiding this comment.
Suggested change
| // the custom metric and increment to be used for autocaling | |
| Metrics []MetricDefinition `json:"metrics"` | |
| // The custom metric to be used for autocaling. | |
| Metrics []MetricDefinition `json:"metrics,omitempty"` |
roypaulin
reviewed
Jan 3, 2025
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // the custom metric to be used for autocaling | ||
| Metric autoscalingv2.MetricSpec `json:"metric"` |
There was a problem hiding this comment.
Suggested change
| Metric autoscalingv2.MetricSpec `json:"metric"` | |
| Metric autoscalingv2.MetricSpec `json:"metric,omitempty"` |
LiboYu2
requested review from
cchen-vertica,
fenic-fawkes,
HaoYang0000 and
qindotguan
as code owners
roypaulin
reviewed
Jan 5, 2025
| // The miminum number of pods when scaling. | ||
| MinReplicas *int32 `json:"minReplicas,omitempty"` | ||
|
|
||
| // +kubebuilder:validation:Optional |
There was a problem hiding this comment.
Suggested change
| // +kubebuilder:validation:Optional |
| // +kubebuilder:Minimum:=0 | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // The maximum number of pods when scaling. | ||
| MaxReplicas *int32 `json:"maxReplicas,omitempty"` |
There was a problem hiding this comment.
Suggested change
| MaxReplicas *int32 `json:"maxReplicas,omitempty"` | |
| MaxReplicas int32 `json:"maxReplicas,omitempty"` |
| // This struct allows customization of autoscaling. Custom metrics can be used instead of the memory and cpu metrics. | ||
| // The scaling behavior can also be customized to meet different performance requirements. The maximum and mininum of | ||
| // sizes of the replica sets can be specified to limit the use of resources. | ||
| CustomAutoscalerSpec *CustomAutoscalerSpec `json:"customAutoscalerSpec,omitempty"` |
There was a problem hiding this comment.
Suggested change
| CustomAutoscalerSpec *CustomAutoscalerSpec `json:"customAutoscalerSpec,omitempty"` | |
| CustomAutoscaler *CustomAutoscalerSpec `json:"customAutoscalerSpec,omitempty"` |
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // +kubebuilder:Minimum:=0 | ||
| // The value used to increase the threshold after after a scale up or a scale down. | ||
| ThresholdAdjustmentValue *int32 `json:"thresholdAdjustmentValue,omitempty"` |
There was a problem hiding this comment.
Suggested change
| ThresholdAdjustmentValue *int32 `json:"thresholdAdjustmentValue,omitempty"` | |
| ThresholdAdjustmentValue int `json:"thresholdAdjustmentValue,omitempty"` |
|
|
||
| // +kubebuilder:validation:Optional | ||
| // +operator-sdk:csv:customresourcedefinitions:type=spec | ||
| // The custom metric and increment to be used for autocaling. |
There was a problem hiding this comment.
Suggested change
| // The custom metric and increment to be used for autocaling. | |
| // The custom metric definition to be used for autocaling. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I would like to get some feedback before generating code for new those fields.