Skip to content

Conversation

@yugannkt
Copy link

@yugannkt yugannkt commented Dec 10, 2025

Description

Adds support for exposing the control plane readiness probe endpoint (/readyz) to enable external load balancers like Azure Application Gateway to perform health checks.

Fixes #4400

Changes

  • Added nginxGateway.service.exposeHealthPort Helm value (default: false)
  • Updated control plane Service template to conditionally expose health port
  • Generated Helm schema and documentation
  • Added CHANGELOG entry

Usage

nginxGateway:
  service:
    exposeHealthPort: true

This exposes /readyz on port 8081 (or configured readinessProbe.port) for external load balancer health checks.

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

Add support for exposing control plane readiness probe endpoint for external load balancer health checks.

Expose the control plane readiness probe endpoint (/readyz) on the
Service to enable external load balancers like Azure Application Gateway
to perform health checks.

This adds a new Helm value 'nginxGateway.service.exposeHealthPort'
(default: false) that conditionally exposes the readiness probe port
on the control plane ClusterIP Service. This is secure by default and
requires explicit opt-in.

When enabled with readinessProbe also enabled, the /readyz endpoint
becomes accessible to external load balancers within the cluster network.

Fixes nginx#4400

Signed-off-by: Yugan <yugannkt@gmail.com>
@nginx-bot
Copy link

nginx-bot bot commented Dec 10, 2025

Hi @yugannkt! 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
Copy link
Contributor

github-actions bot commented Dec 10, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@github-actions github-actions bot added documentation Improvements or additions to documentation helm-chart Relates to helm chart labels Dec 10, 2025
@yugannkt
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community documentation Improvements or additions to documentation helm-chart Relates to helm chart release-notes

Projects

Status: 🆕 New

Development

Successfully merging this pull request may close these issues.

Cannot expose NGF readiness probe (/readyz on 8081) through Gateway Service for Azure Application Gateway health checks.

1 participant