Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: New ScalingSet CRD to deploy isolated interceptors+scalers #1014

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

JorTurFer
Copy link
Member

Provide a description of what has been changed

Checklist

Fixes #241

@JorTurFer JorTurFer requested a review from a team as a code owner May 5, 2024 00:27
@JorTurFer JorTurFer force-pushed the isolated-components branch 2 times, most recently from 4e793d6 to 6e1700a Compare May 12, 2024 19:53
Copy link
Member

@wozniakjan wozniakjan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this approach very much, here is a couple of minor nitpicks from the first pass, I will take a deeper look later today

operator/apis/http/v1alpha1/httpscalingset_types.go Outdated Show resolved Hide resolved
operator/apis/http/v1alpha1/httpscalingset_types.go Outdated Show resolved Hide resolved
operator/apis/http/v1alpha1/httpscalingset_types.go Outdated Show resolved Hide resolved
operator/apis/http/v1alpha1/httpscalingset_types.go Outdated Show resolved Hide resolved
operator/apis/http/v1alpha1/httpscalingset_types.go Outdated Show resolved Hide resolved
}

// HTTPScalingSetStatus defines the observed state of HTTPScalingSet
type HTTPScalingSetStatus struct{}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am sure this is empty only because the PR is still WIP but for discussion sake mentioning controller may want to capture some conditions here, such as:

  • unable to create interceptor/scaler
    • kube-api rejects some resource creation
    • failure to form the externalScalerURI
  • interceptor/scaler are not running with desired replica count and/or are unhealthy
  • possibly getting some basic stats from interceptor admin endpoint?

Copy link
Member

@zroubalik zroubalik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First pass of review

}

// HTTPScalingSetStatus defines the observed state of HTTPScalingSet
type HTTPScalingSetStatus struct{}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should provide some status about the resource, at least Ready condition

ctx context.Context,
logger logr.Logger,
cl client.Client,
httpss metav1.Object,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should consider using duck types instead of metav1.Object here, to add some type safety.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wozniakjan has also an idea on this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYM? We do almost the same in KEDA with ScaledObjects and ScaledJobs. Would be enough if I validate the type and return an error if the type isn't correct?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mentioned to @zroubalik earlier that maybe we could explore type aliasing or trivial type definitions. In this case, both ScalingSets as well as ClusterScalingSets seem to have exactly matching structure so maybe we could do something along the lines of either

type ClusterScalingSet ScalingSet

or

type ClusterScalingSet = ScalingSet

I had used the first one with controller-runtime v1 some eons ago successfully and haven't tried it ever since, but could be a good fit for this usecase unless controller-runtime became more strict regarding types.

The implementation went something like this: https://go.dev/play/p/sxZiO_BDw4z

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't know that this works with kubebuilder but I can give a try because yes. both types are exactly the same, just cluster scoped or namespaced

pkg/util/scalingset_validatior.go Outdated Show resolved Hide resolved
@JorTurFer
Copy link
Member Author

I appreciate your feedback, I'll review it, but don't worry about reviewing the PR for the moment as it's still a WIP and there are a couple of pending stuff, like propagating the status info the the CRD, documentation, more test coverage , etc

You can review it if you want, but there can be multiple changes until the final version :)

@JorTurFer JorTurFer marked this pull request as draft May 16, 2024 09:05
@JorTurFer
Copy link
Member Author

I'm removing the changes applied to my local branch

Signed-off-by: Jorge Turrado <[email protected]>
Signed-off-by: Jorge Turrado <[email protected]>
Signed-off-by: Jorge Turrado <[email protected]>
Signed-off-by: Jorge Turrado <[email protected]>
@JorTurFer JorTurFer marked this pull request as ready for review June 24, 2024 18:23
@JorTurFer JorTurFer changed the title WIP - feat: New ScalingSet CRD to deploy isolated interceptors+scalers feat: New ScalingSet CRD to deploy isolated interceptors+scalers Jun 24, 2024
Signed-off-by: Jorge Turrado <[email protected]>
@JorTurFer
Copy link
Member Author

I've been talking about this with @zroubalik and to not lock you with the code refactor, we will agreed with merging this PR as it is (it works actually) and I'll open a followup PR in a few days/weeks (before the release for sure) adding the pending stuff to complete this PR (such as but not exclusive):

  • Documentation
  • CRD Status propagation
  • Autoscaling
  • Support for global configurations (timeouts, TLS, watched namespaces, etc...)

@kahirokunn
Copy link
Contributor

This feature is great!
I can't wait to start using it!

@kahirokunn
Copy link
Contributor

@wozniakjan Hello!
Is there anything else you need to do to merge this PR?
If you need help, I'd be happy to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable dedicated interceptor/scalers with the same operator
4 participants