Add Recommendation API #4
Conversation
recommendation/v1alpha1/types.go
Outdated
|
|
||
| // RecommendationSpec describes the recommendation type and what the recommendation is for. | ||
| type RecommendationSpec struct { | ||
| TargetRef autoscalingv2.CrossVersionObjectReference `json:"targetRef"` |
There was a problem hiding this comment.
this is a mandatory field
recommendation/v1alpha1/types.go
Outdated
| // RecommendationSpec describes the recommendation type and what the recommendation is for. | ||
| type RecommendationSpec struct { | ||
| TargetRef autoscalingv2.CrossVersionObjectReference `json:"targetRef"` | ||
| Namespace string `json:"namespace"` |
There was a problem hiding this comment.
do we want to have cross namespace support for this?
There was a problem hiding this comment.
No.
RecommendationSpec should refer to a specific workload, which is uniquely identified by 'namespace/apiversion/kind/name'
recommendation/v1alpha1/types.go
Outdated
|
|
||
| type AdvancedHorizontalPodAutoscalerRecommendation struct { | ||
| // optional | ||
| MinReplicas *int32 |
There was a problem hiding this comment.
what about other properties in AHPA?
There was a problem hiding this comment.
Currently this is a place holder, and @qmhu can provide more in future:)
There was a problem hiding this comment.
yeah, i will finish the recommendation for AHPA sooner
recommendation/v1alpha1/types.go
Outdated
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
|
|
||
| // Analytics represents the configuration of an analytics. | ||
| type Analytics struct { |
There was a problem hiding this comment.
should this be singlary format?
There was a problem hiding this comment.
analytics is uncountable noun
There was a problem hiding this comment.
but kubernetes api need singular and plural format, then it is Analytics and Analytics, I am not sure if crdgen can handle such case, it might become Analytics and Analyticss
recommendation/v1alpha1/types.go
Outdated
|
|
||
| // +genclient | ||
| // +genclient:nonNamespaced | ||
| // +kubebuilder:resource:scope=Cluster |
There was a problem hiding this comment.
if we define this object scope as Cluster, it means generally only admin can scan the app, but should we also consider app owner?
maybe:
set this object as namespaced, and if use create the object in crane-root, then it applies everywhere.
There was a problem hiding this comment.
the same comment to analytics
There was a problem hiding this comment.
I think this is SRE or admin's job to perform any resource optimization action,s and app owner should only care the APM rather than the underlying resource consumption.
recommendation/v1alpha1/types.go
Outdated
| } | ||
|
|
||
| // AnalyticsSpec describes the analytics type and what the analysis is for. | ||
| type AnalyticsSpec struct { |
There was a problem hiding this comment.
what's the relation of analytics and recommendation?
users define analytics and analytics controller creates recommendation?
There was a problem hiding this comment.
I addition, is recommendation and analytic is very generic words, should we consider if the reflected the real intension?
There was a problem hiding this comment.
Analytics "generates" and "updates" Recommendations, which is similar to the relationship between CronJob and Job.
There was a problem hiding this comment.
How about ResourceRecommendation & ResourceAnalytics?
|
|
||
| go run ${KUBE_OPENAPI_PKG}/cmd/openapi-gen/openapi-gen.go --logtostderr \ |
There was a problem hiding this comment.
openapi-gen and zz_generated.openapi is used now in metric-adapter, please keep it
recommendation/v1alpha1/register.go
Outdated
| package v1alpha1 | ||
|
|
||
| import ( | ||
| "github.com/gocrane/api/recommendation" |
recommendation/v1alpha1/types.go
Outdated
|
|
||
| // Recommendation represents the configuration of a single recommendation. | ||
| type Recommendation struct { | ||
| metav1.TypeMeta `json:",inline"` |
There was a problem hiding this comment.
It is nicer to add blank lines here for spec and status.
recommendation/v1alpha1/types.go
Outdated
|
|
||
| type AdvancedHorizontalPodAutoscalerRecommendation struct { | ||
| // optional | ||
| MinReplicas *int32 |
There was a problem hiding this comment.
yeah, i will finish the recommendation for AHPA sooner
recommendation/v1alpha1/types.go
Outdated
| // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object | ||
|
|
||
| // Analytics represents the configuration of an analytics. | ||
| type Analytics struct { |
recommendation/v1alpha1/types.go
Outdated
| // Recommendations is a list of pointers to recommendations that are updated by this analytics. | ||
| // +optional | ||
| // +listType=atomic | ||
| Recommendations []corev1.ObjectReference `json:"active,omitempty"` |
There was a problem hiding this comment.
Analystics n <-> n Recommendation
Seems no need to add owner reference between them
There was a problem hiding this comment.
We can just select them from label selector.
recommendation/v1alpha1/types.go
Outdated
|
|
||
| type AnalyticsType string | ||
|
|
||
| const ( |
There was a problem hiding this comment.
how about combine AnalyticsType and RecommendationType
…e.io" 2. Make Recommendation and Analytics namespace scoped. 3. Generate crd schemas for analysis.
analysis/v1alpha1/types.go
Outdated
|
|
||
| const ( | ||
| AnalyticsTypeAdvancedHPA AnalyticsType = "HPA" | ||
| AnalyticsTypeResource AnalyticsType = "Resource" |
|
/LGTM |
No description provided.