NLB-6577 Added NGINXaaS troubleshooting guide #534
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
✅ Deploy Preview will be available once build job completes!
|
A potential customer has requested that we draw our most commonly given troubleshooting advice into a single location within our docs to help users get started with the service and monitor their deployments' performance.
arussellf5
force-pushed
the
nlb-6577-troubleshooting-guide
branch
from
c5f539c to
079a531
Compare
russokj
reviewed
May 15, 2025
|
|
||
| ## Certificate health ## | ||
|
|
||
| Certificates are a common source of confusion and errors. It is important to understand that certificates are integral to your deployment's health. Once you have added a certificate as a resource to your deployment, our service will always attempt to fetch that certificate when applying your NGINX configuration. It doesn't matter whether the certificate is referenced by the NGINX configuration or not: we will always try to fetch it as long as it is added to the deployment. |
There was a problem hiding this comment.
This seems specific to certs stored in AKV and not those directly uploaded as part of the NGINX configuration.
russokj
reviewed
May 15, 2025
| Certificates are a common source of confusion and errors. It is important to understand that certificates are integral to your deployment's health. Once you have added a certificate as a resource to your deployment, our service will always attempt to fetch that certificate when applying your NGINX configuration. It doesn't matter whether the certificate is referenced by the NGINX configuration or not: we will always try to fetch it as long as it is added to the deployment. | ||
|
|
||
| - Ensure that all certificate resources are needed by the deployment and that they are not about to expire. | ||
| - If a certificate on the deployment expires in your Azure Key Vault, we will not be able to fetch it and your deployment will enter a degraded state. Our service will then be unable to apply the latest software updates to your dataplane. |
There was a problem hiding this comment.
based on our last customer interaction, maybe change this to:
... enter a degraded state and may not be able to serve traffic.
russokj
reviewed
May 15, 2025
|
|
||
| ## System load ## | ||
|
|
||
| The `nginxaas.capacity.percentage` metric indicates how much capacity your deployment is consuming (expressed as a percentage of the total). We recommend [configuring an alert](https://docs.nginx.com/nginxaas/azure/monitoring/configure-alerts/) on this metric, so that if it exceeds a certain threshold, you manually scale out your deployment. If you have [autoscaling](https://docs.nginx.com/nginxaas/azure/quickstart/scaling/#autoscaling) enabled, our service will scale your deployment automatically. |
There was a problem hiding this comment.
... you can manually scale ... ?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A potential customer has requested that we draw our most commonly given troubleshooting advice into a single location within our docs to help users get started with the service and monitor their deployments' performance.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.mdandCHANGELOG.mdFootnotes
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. ↩