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 NGINX plus Dockerfile, add make command, add metrics #1394

Merged
merged 3 commits into from
Dec 19, 2023

Conversation

ciarams87
Copy link
Member

@ciarams87 ciarams87 commented Dec 15, 2023

Proposed changes

Problem: To enable support for NGINX Plus we need a way to build NGINX Plus images using a provided license. Additionally, if we are using an NGINX Plus image, we need to update the Prometheus exporter to use the NGINX Plus API instead of the stub_status so we do not get errors when metrics are enabled.

Solution:

  • Create an NGINX Plus Dockerfile and conf file
  • Create a Make target to build the NGINX Plus image
  • Add a build agent arg to the nginx images to indicate if the image was built locally or from the pipeline
  • Update the metrics code to use the Plus API instead of the stub status when NGINX Plus is enabled
  • Add a new cli flag to indicate that NGINX Plus support should be enabled and add a corresponding entry to the helm templates
  • Add documentation.

Testing: Built and deployed the NGINX Plus image as part of my NGF deployment locally and ran the examples

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

Closes #1327
Closes #1330

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

@ciarams87 ciarams87 requested review from a team as code owners December 15, 2023 16:53
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New feature or request dependencies Pull requests that update a dependency file helm-chart Relates to helm chart labels Dec 15, 2023
docs/developer/quickstart.md Outdated Show resolved Hide resolved
internal/mode/static/manager.go Outdated Show resolved Hide resolved
internal/mode/static/metrics/collectors/nginx.go Outdated Show resolved Hide resolved
internal/mode/static/metrics/collectors/nginx.go Outdated Show resolved Hide resolved
deploy/helm-chart/values.yaml Outdated Show resolved Hide resolved
build/Dockerfile.nginxplus Show resolved Hide resolved
site/content/how-to/monitoring/monitoring.md Outdated Show resolved Hide resolved
site/content/how-to/monitoring/monitoring.md Outdated Show resolved Hide resolved
internal/mode/static/config/config.go Outdated Show resolved Hide resolved
docs/developer/quickstart.md Show resolved Hide resolved
internal/mode/static/metrics/collectors/nginx.go Outdated Show resolved Hide resolved
deploy/helm-chart/values.yaml Outdated Show resolved Hide resolved
deploy/helm-chart/README.md Outdated Show resolved Hide resolved
internal/mode/static/metrics/collectors/nginx.go Outdated Show resolved Hide resolved
docs/developer/quickstart.md Outdated Show resolved Hide resolved
internal/mode/static/metrics/collectors/nginx.go Outdated Show resolved Hide resolved
Copy link
Contributor

@kate-osborn kate-osborn left a comment

Choose a reason for hiding this comment

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

👍

@ciarams87 ciarams87 enabled auto-merge (squash) December 19, 2023 17:05
@ciarams87 ciarams87 merged commit c02f0e8 into nginxinc:main Dec 19, 2023
23 checks passed
@ciarams87 ciarams87 deleted the feat/support-nginx-plus branch December 20, 2023 09:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation enhancement New feature or request helm-chart Relates to helm chart
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

NGINX+ Prometheus Metrics NGINX+ NGF Dev Image
5 participants