Skip to content

NGF: Document patching dataplane Service, Deployment, DaemonSet #862

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

Merged
merged 1 commit into from
Jul 22, 2025

Conversation

ciarams87
Copy link

Proposed changes

Problem: NGF is adding a way to submit custom patches to unblock users who need to set fields that are not yet exposed in the NginxProxy CRD. This needs to be documented for users.

Solution: Extend the data plane configuration document to cover this functionality.

Partially addresses nginx/nginx-gateway-fabric#3568

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • [] If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@ciarams87 ciarams87 requested a review from a team as a code owner July 21, 2025 15:47
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Jul 21, 2025
@ciarams87 ciarams87 requested a review from a team July 21, 2025 15:48
Copy link
Contributor

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

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

Nice!

Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

LGTM: please ensure the merge commit for this PR adheres to Conventional Commits, per our Commit messages conventions.

@ciarams87 ciarams87 merged commit 200774b into nginx:ngf-release-2.1 Jul 22, 2025
7 checks passed
@ciarams87 ciarams87 deleted the ngf/nginx-proxy-patch branch July 22, 2025 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants