Hpa #3492

nowjean · 2025-06-11T09:23:25Z

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: I want NGF to work with a HorizontalPodAutoscaler

Solution: Add HPA for deployement

Testing: Describe any testing that you did.
I've deployed my AKS cluster and checked hpa working correctly.

Closes #3447

Checklist

Before creating a PR, run through this checklist and mark each as complete.

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have checked that all unit tests pass after adding my changes
I have updated necessary documentation
I have rebased my branch onto main
I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

add: resources for nginx

nginx-bot · 2025-06-11T09:23:29Z

Hi @nowjean! Welcome to the project! 🎉

Thanks for opening this pull request!
Be sure to check out our Contributing Guidelines while you wait for someone on the team to review this.

github-actions · 2025-06-11T09:23:34Z

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:

I have hereby read the F5 CLA and agree to its terms

1 out of 2 committers have signed the CLA.
✅ (nowjean)[https://github.com/nowjean]
❌ @nowjean
Nowjean seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You can retrigger this bot by commenting recheck in this Pull Request.}_{Posted by the CLA Assistant Lite bot.}

nowjean · 2025-06-11T09:27:08Z

I have hereby read the F5 CLA and agree to its terms

salonichf5 · 2025-06-13T22:08:31Z

Thank you for you contribution to the project. Please run make generate-all from root directory to auto generate schema files.

salonichf5 · 2025-06-13T22:14:41Z

charts/nginx-gateway-fabric/values.yaml

+  autoscaling:
+    enabled: false
+    annotations: {}
+    minReplicas: 1
+    maxReplicas: 11
+    targetCPUUtilizationPercentage: 50
+    targetMemoryUtilizationPercentage: 50
+    behavior: {}
+    # scaleDown:
+    #   stabilizationWindowSeconds: 300
+    #   policies:
+    #   - type: Pods
+    #     value: 1
+    #     periodSeconds: 180
+    # scaleUp:
+    #   stabilizationWindowSeconds: 300
+    #   policies:
+    #   - type: Pods
+    #     value: 2
+    #     periodSeconds: 60
+  autoscalingTemplate: []
+  # Custom or additional autoscaling metrics
+  # ref: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/#support-for-custom-metrics
+  # - type: Pods
+  #   pods:
+  #     metric:
+  #       name: nginx_gateway_fabric_nginx_process_requests_total
+  #     target:
+  #       type: AverageValue
+  #       averageValue: 10000m
+


nit: add one-line descriptions for these fields, similar to how it's done for the others, to improve readability for users.

I've added comments!

nowjean · 2025-06-14T01:36:30Z

Thank you for you contribution to the project. Please run make generate-all from root directory to auto generate schema files.

I’ve completed 'make generate-all'. Could you please review my PR?

sjberman · 2025-06-17T14:54:05Z

So this only affects the control plane, correct? We probably want to support this for the nginx data plane as well (seems like that would be the more beneficial use case).

In order to configure deployment options for the data plane, it requires a bit more work, specifically in our APIs and the code itself. The NginxProxy CRD holds the deployment configuration for the nginx data plane, which the control plane uses to configure the data plane when deploying it.

Here is a simple example of how we add a new field to the API to allow for configuring these types of deployment fields: #3319.

sjberman · 2025-06-17T15:07:25Z

I'd also love a more descriptive PR title, as well as a release note in the description so we can include this feature in our release notes :)

nowjean · 2025-06-17T15:33:45Z

@sjberman Yes, this PR only affects the control plane. Can we also implement HPA for the data plane?

AFAIK, the data plane Deployment is created by the NginxProxy CRD, and its name depends on the Gateway's name parameter. This means we can't assume a fixed name in values.yaml.

HPA only applies to Deployments with a fixed name, like:

scaleTargetRef:
  apiVersion: apps/v1
  kind: Deployment
  name: my-app

So, I think we can't implement HPA via the Helm chart, especially since data plane and control plane pods are now separated in 2.0.
Do you have any suggestions or recommended approaches for enabling HPA on the data plane?

sjberman · 2025-06-17T15:35:19Z

@nowjean I updated my comment with a description on how it can be implemented on the data plane side. Glad we're on the same page :)

salonichf5 · 2025-06-18T03:50:29Z

Thank you for you contribution to the project. Please run make generate-all from root directory to auto generate schema files.

I’ve completed 'make generate-all'. Could you please review my PR?

Will manual test this PR for both control plane and data plane when we have all the changes :)

nowjean · 2025-06-20T07:56:19Z

@sjberman @salonichf5 I've pushed my changes to this PR.
This is my first time working with Golang and creating CRDs, so I’d appreciate your review.

From my testing, the code correctly applies HPA to both the control plane and data plane.
To enable this, please set nginx.autoscaling.enabled: true and configure nginx.container.resources accordingly.

nowjean added 2 commits June 11, 2025 18:18

Create hpa.yaml

e1f0293

Update values.yaml

13f67c4

add: resources for nginx

nowjean requested a review from a team as a code owner June 11, 2025 09:23

github-project-automation bot added this to NGINX Gateway Fabric Jun 11, 2025

github-project-automation bot moved this to 🆕 New in NGINX Gateway Fabric Jun 11, 2025

nginx-bot bot added the community label Jun 11, 2025

github-actions bot added the helm-chart Relates to helm chart label Jun 11, 2025

nowjean added 2 commits June 11, 2025 22:29

Merge branch 'main' into hpa

fb89c5e

Merge branch 'main' into hpa

8075053

sjberman moved this from 🆕 New to External Pull Requests in NGINX Gateway Fabric Jun 12, 2025

salonichf5 reviewed Jun 13, 2025

View reviewed changes

nowjean added 3 commits June 14, 2025 08:57

Merge remote-tracking branch 'upstream/main' into hpa

7c87b0b

add: nginxGateway HPA

886430d

add: nginxGateway HPA

d081d68

nowjean force-pushed the hpa branch from 8075053 to 365bcb7 Compare June 14, 2025 01:31

nowjean requested a review from a team as a code owner June 14, 2025 01:31

github-actions bot added the documentation Improvements or additions to documentation label Jun 14, 2025

nowjean force-pushed the hpa branch 2 times, most recently from 172c009 to d081d68 Compare June 14, 2025 07:20

Merge branch 'main' into hpa

f8cb1fa

sjberman added the enhancement New feature or request label Jun 17, 2025

HPA for data plane

61e320d

github-actions bot removed the enhancement New feature or request label Jun 20, 2025

Merge branch 'main' into hpa

8f82fbe

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Hpa #3492

Hpa #3492

Uh oh!

nowjean commented Jun 11, 2025

Uh oh!

nginx-bot bot commented Jun 11, 2025

Uh oh!

github-actions bot commented Jun 11, 2025 •

edited

Loading

Uh oh!

nowjean commented Jun 11, 2025

Uh oh!

salonichf5 commented Jun 13, 2025

Uh oh!

salonichf5 Jun 13, 2025

Uh oh!

nowjean Jun 14, 2025

Uh oh!

nowjean commented Jun 14, 2025 •

edited

Loading

Uh oh!

sjberman commented Jun 17, 2025 •

edited

Loading

Uh oh!

sjberman commented Jun 17, 2025

Uh oh!

nowjean commented Jun 17, 2025 •

edited

Loading

Uh oh!

sjberman commented Jun 17, 2025

Uh oh!

salonichf5 commented Jun 18, 2025

Uh oh!

nowjean commented Jun 20, 2025

Uh oh!

Uh oh!

Hpa #3492

Are you sure you want to change the base?

Hpa #3492

Uh oh!

Conversation

nowjean commented Jun 11, 2025

Proposed changes

Checklist

Release notes

Uh oh!

nginx-bot bot commented Jun 11, 2025

Uh oh!

github-actions bot commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nowjean commented Jun 11, 2025

Uh oh!

salonichf5 commented Jun 13, 2025

Uh oh!

salonichf5 Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

nowjean Jun 14, 2025

Choose a reason for hiding this comment

Uh oh!

nowjean commented Jun 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sjberman commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sjberman commented Jun 17, 2025

Uh oh!

nowjean commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sjberman commented Jun 17, 2025

Uh oh!

salonichf5 commented Jun 18, 2025

Uh oh!

nowjean commented Jun 20, 2025

Uh oh!

Uh oh!

github-actions bot commented Jun 11, 2025 •

edited

Loading

nowjean commented Jun 14, 2025 •

edited

Loading

sjberman commented Jun 17, 2025 •

edited

Loading

nowjean commented Jun 17, 2025 •

edited

Loading