Skip to content

Add Horizontal Pod Autoscaler (HPA) Support for Airflow API Server #52392

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

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

Conversation

HsiuChuanHsu
Copy link

Description:

This pull request introduces Horizontal Pod Autoscaler (HPA) support for the Airflow API server in the Helm chart, enabling automatic scaling of API server pods based on resource utilization or custom metrics. The changes enhance the chart's flexibility and scalability, allowing users to configure autoscaling for the API server to handle varying workloads efficiently.

Changes:

  1. Added HPA Configuration Template
    Created chart/templates/api-server/api-server-hpa.yaml to define the HPA resource for the API server.
  2. Updated Values Schema
    Modified chart/values.schema.json to include a new hpa section under apiServer.
  3. Updated Default Values
    Added HPA configuration in chart/values.yaml under apiServer.hpa with sensible defaults
  4. Added Unit Tests:
    Introduced helm-tests/tests/helm_tests/apiserver/test_hpa_apiserver.py to validate HPA behavior

How to Test:

  1. Enable HPA with apiServer.hpa.enabled=true and verify the HPA resource is created with default settings.
  2. Override minReplicaCount, maxReplicaCount, metrics, or behavior in values.yaml and confirm the HPA resource reflects the changes.
  3. Run unit tests with pytest helm-tests/tests/helm_tests/apiserver/test_hpa_apiserver.py to validate logic.

Additional Notes:

Screenshot 2025-06-28 at 3 15 04 PM
Included deployment and HPA status screenshot from kubectl displaying an Airflow API server deployment with 4 pods running.

Related Issues:

#51935


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

Copy link

boring-cyborg bot commented Jun 28, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:helm-chart Airflow Helm Chart
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant