Skip to content

Update faq.md #533

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update faq.md #533

wants to merge 1 commit into from

Conversation

brianehlert
Copy link

Proposed changes

Write a clear and concise description that helps reviewers understand the purpose and impact of your changes. Use the
following format:

Problem: Give a brief overview of the problem or feature being addressed.

Solution: Explain the approach you took to implement the solution, highlighting any significant design decisions or
considerations.

Testing: Describe any testing that you did.

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.

If this PR addresses an issue on GitHub, ensure that you link to it here:

Closes #ISSUE

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 and CHANGELOG.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.

@brianehlert brianehlert requested a review from a team as a code owner May 7, 2025 16:24
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginxaas NGINX as a Service for Azure labels May 7, 2025
Copy link

github-actions bot commented May 7, 2025

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:


I have hereby read the F5 CLA and agree to its terms


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

Copy link

github-actions bot commented May 7, 2025

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/533/

@@ -17,10 +17,10 @@ Common questions about F5 NGINX as a Service for Azure (NGINXaaS).
- The usage data is reported to NGINXaaS.

### Is NGINXaaS available in my subscription or in F5 subscription?
- Your NGINXaaS deployment resource is visible to you under your subscription. The underlying compute resources of your deployment, which are managed by NGINX on your behalf, are not visible in your subscription.
- Your NGINXaaS deployment resource is visible to you under your Azure subscription. The underlying resources of any NaaS deployment, which are managed by NGINX on your behalf, are not visible in your subscription.

Choose a reason for hiding this comment

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

We have only referred to our service as NGINXaaS in these docs and have not used NaaS - perhaps we can maintain that convention here as well.

@@ -39,7 +39,7 @@ Common questions about F5 NGINX as a Service for Azure (NGINXaaS).
### I am an NGINX Plus customer; how can I switch to NGINXaaS?
- In NGINX Plus, customers SSH into the NGINX Plus system, store their certificates in some kind of storage and configure the network and subnet to connect to NGINX Plus.

- For NGINXaaS, customers store their certificates in the Azure key vault and configure NGINXaaS in the same VNet or peer to the VNet in which NGINXaaS is deployed.
- For NGINXaaS, customers store their certificates in the Azure key vault and configure NGINXaaS in the same VNet or peer to the VNet in which NGINXaaS is deployed. There is a Portal option to upload your existing configuration as a single archive.

Choose a reason for hiding this comment

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

Good call out. I believe this option (to upload existing NGINX configuration along with aux files, certificates, etc as an archive) is also available through other clients and is not specific just to the portal.

@@ -79,7 +79,7 @@ Common questions about F5 NGINX as a Service for Azure (NGINXaaS).

### Does NGINXaaS support multiple public IPs, a mix of public and private IPs?

- NGINXaaS supports one public or private IP per deployment. NGINXaaS doesn't support a mix of public and private IPs at this time.
- NGINXaaS supports one public or private IP per deployment. A single NGINXaaS deployment doesn't support a mix of public and private IPs. We recommend defining separate deployments.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: recommendation may not be what you want here. Given that the mixed IP scenario does not work, we may just want to say If you want a mix of public and private IP deployments, consider creating one per IP visibility type. Us recommending something might make the user think that going the other way is an option, which is not going to work here.

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/nginxaas NGINX as a Service for Azure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants