feat: NGINXaaS - Certificate Fetch via Private Endpoint support #1137
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
mjang
reviewed
Sep 18, 2025
| - Access to AKV through a public or private endpoint. If public access to AKV needs to be restricted, | ||
| either [configure Network Security Perimeter]({{< ref "/nginxaas-azure/quickstart/security-controls/certificates.md#configure-network-security-perimeter-nsp" >}}) or [integrate with a private endpoint]({{< ref "/nginxaas-azure/quickstart/security-controls/certificates.md#integrate-with-private-endpoint" >}}) | ||
|
|
||
| {{< call-out "important" >}}**Known Issue:** Updating managed identity on NGINXaaS deployment after creation may result in the managed identity not being correctly delegated to the dataplane, which can cause certificate fetch failures when public access is disabled. To avoid this issue, ensure that the managed identity that has access to AKV is assigned during NGINXaaS deployment creation. {{< /call-out >}} |
There was a problem hiding this comment.
This is difficult to read. I might say:
Suggested change
| {{< call-out "important" >}}**Known Issue:** Updating managed identity on NGINXaaS deployment after creation may result in the managed identity not being correctly delegated to the dataplane, which can cause certificate fetch failures when public access is disabled. To avoid this issue, ensure that the managed identity that has access to AKV is assigned during NGINXaaS deployment creation. {{< /call-out >}} | |
| {{< call-out "important" >}}**Known Issue:** When public access is disabled, you may see certificate fetch failures. This can happen when you update managed identity on NGINXaaS deployment after creation. This may result in the managed identity not being correctly delegated to the dataplane. | |
| To avoid this issue, when you create an NGINXaaS deployment, make sure that the managed identity that has access to AKV is assigned. {{< /call-out >}} |
There was a problem hiding this comment.
Alternative: if this is an edge case, set this up as a KB article.
There was a problem hiding this comment.
You are right perhaps the prerequisites page is not the best place to add this info. Move this to the known-issues page.
| 1. Get the resource ID of the key vault. | ||
| Please ensure the following environment variables are set before copying the below Azure CLI command. |
There was a problem hiding this comment.
Our style guide suggests that you shouldn't use please (unless the problem is "our fault"). And I think you can be more direct:
Suggested change
| Please ensure the following environment variables are set before copying the below Azure CLI command. | |
| Set the following environment variables before copying the following Azure CLI command. |
There was a problem hiding this comment.
Similar comment, several places
There was a problem hiding this comment.
The existing page used "please" in a bunch of places which is why I followed the same style. Modified everywhere to remove it.
|
|
||
| To review older entries, visit the [Changelog archive]({{< ref "/nginxaas-azure/changelog-archive" >}}) section. | ||
|
|
||
| ## TODO, 2025 |
There was a problem hiding this comment.
Will you resolve this issue before marking this PR as "Ready to Review?"
This commit updates the NGINXaaS documentation to add instructions for fetching certificates via private endpoints.
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.
This commit updates the NGINXaaS documentation to add instructions for fetching certificates via private endpoints.
Proposed changes
Checklist
Before sharing this pull request, I completed the following checklist:
Footnotes
Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content. ↩