You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "JoaVirtudes19 (via GitHub)" <gi...@apache.org> on 2024/09/02 12:33:25 UTC
[PR] Enable HPA for Airflow Webserver [airflow]
JoaVirtudes19 opened a new pull request, #41955:
URL: https://github.com/apache/airflow/pull/41955
closes [#41876](https://github.com/apache/airflow/issues/41876)
Add a Horizontal Pod Autoscaler (HPA) to the webserver for hight loads of users.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "JoaVirtudes19 (via GitHub)" <gi...@apache.org>.
JoaVirtudes19 commented on code in PR #41955:
URL: https://github.com/apache/airflow/pull/41955#discussion_r1762454321
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ "labels": {"test_label": "test_label_value"},
+ },
+ },
+ show_only=["templates/webserver/webserver-hpa.yaml"],
+ )
+
+ assert "test_label" in jmespath.search("metadata.labels", docs[0])
+ assert jmespath.search("metadata.labels", docs[0])["test_label"] == "test_label_value"
+
+ def test_should_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" not in jmespath.search("spec", docs[0])
+
+ def test_should_not_remove_replicas_field(self):
Review Comment:
I didn't realice, but seems to be a better place for these tests actually!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "JoaVirtudes19 (via GitHub)" <gi...@apache.org>.
JoaVirtudes19 commented on code in PR #41955:
URL: https://github.com/apache/airflow/pull/41955#discussion_r1762454321
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ "labels": {"test_label": "test_label_value"},
+ },
+ },
+ show_only=["templates/webserver/webserver-hpa.yaml"],
+ )
+
+ assert "test_label" in jmespath.search("metadata.labels", docs[0])
+ assert jmespath.search("metadata.labels", docs[0])["test_label"] == "test_label_value"
+
+ def test_should_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" not in jmespath.search("spec", docs[0])
+
+ def test_should_not_remove_replicas_field(self):
Review Comment:
I didn't realize, but seems to be a better place for these tests actually!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "JoaVirtudes19 (via GitHub)" <gi...@apache.org>.
JoaVirtudes19 commented on code in PR #41955:
URL: https://github.com/apache/airflow/pull/41955#discussion_r1762457441
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ "labels": {"test_label": "test_label_value"},
+ },
+ },
+ show_only=["templates/webserver/webserver-hpa.yaml"],
+ )
+
+ assert "test_label" in jmespath.search("metadata.labels", docs[0])
+ assert jmespath.search("metadata.labels", docs[0])["test_label"] == "test_label_value"
+
+ def test_should_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" not in jmespath.search("spec", docs[0])
+
+ def test_should_not_remove_replicas_field(self):
Review Comment:
Done!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "JoaVirtudes19 (via GitHub)" <gi...@apache.org>.
JoaVirtudes19 commented on PR #41955:
URL: https://github.com/apache/airflow/pull/41955#issuecomment-2337456377
@jedcunningham
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham merged PR #41955:
URL: https://github.com/apache/airflow/pull/41955
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #41955:
URL: https://github.com/apache/airflow/pull/41955#issuecomment-2358614557
Awesome work, congrats on your first merged pull request! You are invited to check our [Issue Tracker](https://github.com/apache/airflow/issues) for additional contributions.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on PR #41955:
URL: https://github.com/apache/airflow/pull/41955#issuecomment-2358619235
Thanks @JoaVirtudes19! Congrats on yours first PR 🎉
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #41955:
URL: https://github.com/apache/airflow/pull/41955#issuecomment-2324653419
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]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-pre-commit-hooks) 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](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/dev/breeze/doc/README.rst) 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](https://www.apache.org/foundation/policies/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]( https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#coding-style-and-best-practices).
- 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: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on code in PR #41955:
URL: https://github.com/apache/airflow/pull/41955#discussion_r1762243285
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ "labels": {"test_label": "test_label_value"},
+ },
+ },
+ show_only=["templates/webserver/webserver-hpa.yaml"],
+ )
+
+ assert "test_label" in jmespath.search("metadata.labels", docs[0])
+ assert jmespath.search("metadata.labels", docs[0])["test_label"] == "test_label_value"
+
+ def test_should_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" not in jmespath.search("spec", docs[0])
+
+ def test_should_not_remove_replicas_field(self):
Review Comment:
This is probably better done by adding test coverage that `webserver.replicas` works. Can you remove this test and add coverage for that instead in `TestWebserverDeployment`?
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ "labels": {"test_label": "test_label_value"},
+ },
+ },
+ show_only=["templates/webserver/webserver-hpa.yaml"],
+ )
+
+ assert "test_label" in jmespath.search("metadata.labels", docs[0])
+ assert jmespath.search("metadata.labels", docs[0])["test_label"] == "test_label_value"
+
+ def test_should_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" not in jmespath.search("spec", docs[0])
+
+ def test_should_not_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": False},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" in jmespath.search("spec", docs[0])
+
+ @pytest.mark.parametrize(
+ "metrics, expected_metrics",
+ [
+ # default metrics
+ (
+ None,
+ {
+ "type": "Resource",
+ "resource": {"name": "cpu", "target": {"type": "Utilization", "averageUtilization": 80}},
+ },
+ ),
+ # custom metric
+ (
+ [
+ {
+ "type": "Pods",
+ "pods": {
+ "metric": {"name": "custom"},
+ "target": {"type": "Utilization", "averageUtilization": 80},
+ },
+ }
+ ],
+ {
+ "type": "Pods",
+ "pods": {
+ "metric": {"name": "custom"},
+ "target": {"type": "Utilization", "averageUtilization": 80},
+ },
+ },
+ ),
+ ],
+ )
+ def test_should_use_hpa_metrics(self, metrics, expected_metrics):
Review Comment:
Same with this one?
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
Review Comment:
Can you move this to `test_hpa_webserver`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Enable HPA for Airflow Webserver [airflow]
Posted by "JoaVirtudes19 (via GitHub)" <gi...@apache.org>.
JoaVirtudes19 commented on code in PR #41955:
URL: https://github.com/apache/airflow/pull/41955#discussion_r1762449415
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
Review Comment:
Sure!
##########
helm_tests/webserver/test_webserver.py:
##########
@@ -1154,3 +1154,86 @@ def test_overridden_automount_service_account_token(self):
show_only=["templates/webserver/webserver-serviceaccount.yaml"],
)
assert jmespath.search("automountServiceAccountToken", docs[0]) is False
+
+
+class TestWebserverHPAAutoScaler:
+ """Tests webserver HPA auto scaler."""
+
+ def test_should_add_component_specific_labels(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ "labels": {"test_label": "test_label_value"},
+ },
+ },
+ show_only=["templates/webserver/webserver-hpa.yaml"],
+ )
+
+ assert "test_label" in jmespath.search("metadata.labels", docs[0])
+ assert jmespath.search("metadata.labels", docs[0])["test_label"] == "test_label_value"
+
+ def test_should_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": True},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" not in jmespath.search("spec", docs[0])
+
+ def test_should_not_remove_replicas_field(self):
+ docs = render_chart(
+ values={
+ "webserver": {
+ "hpa": {"enabled": False},
+ },
+ },
+ show_only=["templates/webserver/webserver-deployment.yaml"],
+ )
+ assert "replicas" in jmespath.search("spec", docs[0])
+
+ @pytest.mark.parametrize(
+ "metrics, expected_metrics",
+ [
+ # default metrics
+ (
+ None,
+ {
+ "type": "Resource",
+ "resource": {"name": "cpu", "target": {"type": "Utilization", "averageUtilization": 80}},
+ },
+ ),
+ # custom metric
+ (
+ [
+ {
+ "type": "Pods",
+ "pods": {
+ "metric": {"name": "custom"},
+ "target": {"type": "Utilization", "averageUtilization": 80},
+ },
+ }
+ ],
+ {
+ "type": "Pods",
+ "pods": {
+ "metric": {"name": "custom"},
+ "target": {"type": "Utilization", "averageUtilization": 80},
+ },
+ },
+ ),
+ ],
+ )
+ def test_should_use_hpa_metrics(self, metrics, expected_metrics):
Review Comment:
Done!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org