Skip to content

NGINXaaS Custom Security Policies #397

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

Conversation

edarzins
Copy link
Contributor

Updated doc to support the use of NGINX App Protect custom security policies.

Proposed changes

Update NGINXaaS for Azure doc to support NGINX App Protect custom policies

Problem: Document new feature for NGINXaaS for Azure

Solution: N/A

Testing: N/A

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:

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.

@edarzins edarzins requested a review from a team as a code owner April 11, 2025 17:57
Copy link

github-actions bot commented Apr 11, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/nginxaas NGINX as a Service for Azure labels Apr 11, 2025
@edarzins
Copy link
Contributor Author

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

@russokj
Copy link

russokj commented Apr 11, 2025

Did a quick grep on where we refer to NAP as being in preview. Please change the following:

@russokj
Copy link

russokj commented Apr 11, 2025

Don't forget to call out anything in the official docs that cannot be done with the Saas version (a few general exceptions are mentioned in the NLB-5567 ticket).

@russokj
Copy link

russokj commented Apr 11, 2025

They might not be available yet, but should we have a section for the CLI tool, as well as Terraform?

@amudukutore
Copy link

@edarzins - thanks for making these changes. I'll echo Ken's comment about removing any references to preview associated with the NAP feature. Also, we should add a note of this in the Changelog along with calling out that NAP capability is now generally available and no longer considered preview.

@edarzins edarzins requested a review from a team as a code owner April 14, 2025 03:42
@russokj
Copy link

russokj commented Apr 14, 2025

Another thought I had given the current incident reported by Liftr is that we should highly suggest they enable NGINX Security Logs (in the Diagnostic settings for Portal users).

@russokj
Copy link

russokj commented Apr 15, 2025

Still missing a Troubleshooting section for NAP


{{< img src="nginxaas-azure/custom-policy-editor.png" alt="NGINXaaS Custom Policy Editor." >}}

After your policy has been saved, you can then reference it in your NGINX configuration the same as you did for precompiled policies.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After your policy has been saved, you can then reference it in your NGINX configuration the same as you did for precompiled policies.
After your policy has been saved, you can then reference it in your NGINX configuration as you did before for precompiled policies.

Copy link

Choose a reason for hiding this comment

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

This assumes the customer used precompiled policies previously. We shouldn't make this assumption.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed mention of precompiled polcies.

Updated doc to support the use of NGINX App Protect custom
security policies.
@JTorreG
Copy link
Contributor

JTorreG commented Apr 16, 2025

@edarzins please review the conflicts with the target branch (another PR updated the changelog too)

@russokj
Copy link

russokj commented Apr 16, 2025

@JTorreG - please approve this MR if there are no specific changes needed besides rebasing. The pipeline will automatically block the merge until the conflicts are resolved and there will probably be multiple rebases needed. We want to be in a position that when the production code is live we can push the docs too.

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.

4 participants