Skip to content
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

Add possibility to provide custom pod annotations #2250

Merged

Conversation

Robsta86
Copy link
Contributor

@Robsta86 Robsta86 commented Jul 16, 2024

Proposed changes

Problem: Currently the helm chart does not provide an option to configure custom annotations for the nginx-gateway-fabric pod(s). In our scenario this is inconvenient because the pre-configured annotations Prometheus specific, but we are using Grafana Alloy to scrape metrics and Alloy is expecting different annotations. Of course there are also other scenarios where custom annotations can be useful, for instance to configure exceptions for Gatekeeper policies.

Solution: This Pull Request adds the possibility to configure your own custom annotations which will be added to the nginx-gateway-fabric pods.

Testing: Tested by installing the helm chart with the default values, and after that installing the helm chart with custom annotations configured.

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 capability to configure custom annotations for the nginx-gateway-fabric pod(s)

@Robsta86 Robsta86 requested a review from a team as a code owner July 16, 2024 11:55
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request helm-chart Relates to helm chart labels Jul 16, 2024
Copy link

nginx-bot bot commented Jul 16, 2024

Hi @Robsta86! 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.

Please make sure to include the issue number in the PR description to automatically close the issue when the PR is merged.
See Linking a pull request to an issue and our Pull Request Guidelines for more information.

@nginx-bot nginx-bot bot added the community label Jul 16, 2024
@kate-osborn kate-osborn self-requested a review July 16, 2024 18:49
@kate-osborn
Copy link
Contributor

@Robsta86 thanks for the contribution!

Can you run make generate-all and commit/push the changes? That should resolve the pipeline issue. Thanks!

Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.62%. Comparing base (365a683) to head (46fd4eb).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2250   +/-   ##
=======================================
  Coverage   87.62%   87.62%           
=======================================
  Files          96       96           
  Lines        6715     6715           
  Branches       50       50           
=======================================
  Hits         5884     5884           
  Misses        774      774           
  Partials       57       57           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sjberman sjberman requested a review from kate-osborn July 17, 2024 14:05
@kate-osborn kate-osborn merged commit 550c8f6 into nginxinc:main Jul 17, 2024
43 checks passed
@Robsta86 Robsta86 deleted the feature/allow-custom-pod-annotations branch October 19, 2024 20:31
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 enhancement New feature or request helm-chart Relates to helm chart release-notes
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants