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

Refactor AutoScaler: metricClient, context, reconcile #308

Merged
merged 3 commits into from
Oct 22, 2024

Conversation

kr11
Copy link
Collaborator

@kr11 kr11 commented Oct 21, 2024

Pull Request Description

Based on the suggestions in #119 comments, we continue refactoring of the autoscaling code structure, which have done:

  1. Removing the base client of Metriclient (i.e., PodMetricClient) to streamline the client implementation.
  2. Eliminating the base class of AutoScaler (i.e., BaseAutoscaler).
  3. Merging reconcileKPA and reconcileAPA into reconcileCustomPA, thereby sharing common stages and adapting different PA-specific components based on the pa.ScalingStrategy.

img_v3_02fs_8794b8d6-b5e2-47c1-9101-7d04ebbe7d6g

TBD 4. metricName -> metricKey

Currently, the metricName string is utilized in GetPodContainerMetric and GetMetricsFromPods. Both functions also include pods []corev1.Pod as parameters, which already encompass the metric_keys information. Should we continue to use metricName in this context?

TBD 5. ScalingContext - Change from Interface to Struct:

I have transferred some common attributes from KpaScalingContext to BaseScalingContext to make them concise.

I recommend retaining the ScalingContext interface, as the ScalingAlgorithm.ComputeTargetReplicas, a higher-level interface that operates above specific algorithms, requires ScalingContext as a parameter.

Related Issues

Resolves: #[119]

Related issue list in comments.

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [API]: Modifications to aibrix's API or interface
  • [CLI]: Changes or additions to the Command Line Interface
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

@kr11 kr11 changed the title Refactor AutoScaler: optimize metric client, context, and reconcile Refactor AutoScaler: metricClient, context, reconcile Oct 21, 2024
return &BaseScalingContext{
MaxScaleUpRate: 2, // Scale up rate of 200%, allowing rapid scaling
MaxScaleDownRate: 2, // Scale down rate of 50%, for more gradual reduction
ScalingMetric: "CPU", // Metric used for scaling, here set to CPU utilization
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be something has to be configured by user.

Copy link
Collaborator

Choose a reason for hiding this comment

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

this is OK at this moment, we should add some validation logic later

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Sure, we can allow user to config it by configmap or pa.yaml later.

@Jeffwan
Copy link
Collaborator

Jeffwan commented Oct 22, 2024

you can rebase the change and get #309 in your code. (CI fix)

@kr11 kr11 force-pushed the kangrong/features/autoscaling_refactor branch from 3592601 to 6621317 Compare October 22, 2024 05:25
@Jeffwan Jeffwan merged commit 77cfee2 into main Oct 22, 2024
9 checks passed
@Jeffwan Jeffwan deleted the kangrong/features/autoscaling_refactor branch October 22, 2024 05:46
Jeffwan added a commit that referenced this pull request Oct 22, 2024
* Update manifests version to v0.1.0-rc.3 (#287)

* [Misc] Add sync images step and scripts in release process (#283)

Add sync images step and scripts in release process

* [batch] E2E works with driver and request proxy  (#272)

* e2e driver and test

* comment functions

* check job status in test

* format update

* update copyright

* add examples with instructions and interfaces

* move batch tutorial

---------

Co-authored-by: xin.chen <[email protected]>

* Fix address already in use when AIRuntime start in pod (#289)

add uvicorn startup into file entrypoint

* Read model  name from request body (#290)

* Use model name from request body

* rename dummy to reserved router

* Fix redis bootstrap flaky connection issue (#293)

* skip docs CI if no changes in /docs dir (#294)

* skip docs CI if no changes in /docs dir

* test docs build

* Improve Rayclusterreplicaset Status (#295)

* improve rayclusterreplicaset status
* nit
* fix lint error
* improve isClusterActive logic
* fix lint error
* remove redundant isRayPodCreateOrDeleteFailed check
---------

Signed-off-by: Yicheng-Lu-llll <[email protected]>

* Add request trace for profiling (#291)

* Add request trace for profiling

* add to redis at 10 second interval

* nit

* round to nearest 10s interval

* round timestamp to nearest 10s interval and aggregate data by model

* add go routine to add request trace

* Update the crd definiton due to runtime upgrade (#298)

#295 introduce the latest kuberay api and the dependencies bumps sigs.k8s.io/controller-runtime from v0.17.3 to v0.17.5. Due to that change, make manifest update the CRD definitions

* Push images to Github registry in release pipeline (#301)

* Disable docker build github workflow to cut CI cost

* Push images to Github registry in release pipeline

* Build autoscaler abstractions like fetcher, client and scaler (#300)

* minor clean up on the autoscaler controller

* Extract the algorithm package

algorithm is extracted to distinguish with the scaler.

* Refactor scaler interface

1. Split the Scaler interface and BaseAutoscaler implementation
2. Create APA/KPA scaler separately and adopt the corresponding algorithms

* Introduce the scalingContext in algorithm

* Introduce k8s.io/metrics for resource & custom metrics fetching

* Extract metric fetcher to cover the fetching logic

* Optimize the scaler workflow to adopt fetch and client interface

* Further refactor the code structure

* Support pod autoscaler periodically check (#306)

* Support pod autoscaler periodically check

* Fix the error case

* Add timeout in nc check for redis bootstrap (#309)

* Refactor AutoScaler: metricClient, context, reconcile (#308)

* Refactor AutoScaler: optimize metric client, context, and reconcile processes.

* fix make lint-all

* fix typos

---------

Signed-off-by: Yicheng-Lu-llll <[email protected]>
Co-authored-by: xinchen384 <[email protected]>
Co-authored-by: xin.chen <[email protected]>
Co-authored-by: brosoul <[email protected]>
Co-authored-by: Varun Gupta <[email protected]>
Co-authored-by: Yicheng-Lu-llll <[email protected]>
Co-authored-by: Rong-Kang <[email protected]>
gangmuk pushed a commit that referenced this pull request Jan 25, 2025
* Refactor AutoScaler: optimize metric client, context, and reconcile processes.

* fix make lint-all

* fix typos
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.

2 participants