Skip to content

docs: Adds installation guide for NIC and waf #7688

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

Merged
merged 14 commits into from
Apr 24, 2025

Conversation

javorszky
Copy link
Contributor

Closes #7416

  • Adds installation guide for NIC and waf
  • users don't need to leave the document
  • uses the wafv5 json from the examples directory
  • users are guided to download their key, certificate, and jwt files, and set up license secrets and image pull secrets
  • users are guided on copying their compiled policy bundle onto the deployment
  • users are shown how to compile a json into a policy bundle
  • example applications are deployed and waf is used in those
  • there are examples of successful and expectedly failed requests

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

@javorszky javorszky requested review from a team as code owners April 22, 2025 08:24
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Apr 22, 2025
Copy link

Deploy Preview will be available once build job completes!

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

@javorszky javorszky force-pushed the gabor/issue-7416-nic-appprotectv5 branch from 1beca46 to 36b5247 Compare April 22, 2025 08:47
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

Generally LGTM.

I've given feedback on a bunch of different things: some of them are just the first instance of something on the basis that the guidance on the rule/style is enough to address other instances.

Please hit the re-request button when you've taken another pass.

@javorszky javorszky force-pushed the gabor/issue-7416-nic-appprotectv5 branch from 2a8c1c0 to a2c37bf Compare April 22, 2025 13:34
@javorszky javorszky requested a review from ADubhlaoich April 22, 2025 13:34
javorszky and others added 9 commits April 23, 2025 12:15
Closes #7416

* Adds installation guide for NIC and waf
* users don't need to leave the document
* uses the wafv5 json from the examples directory
* users are guided to download their key, certificate, and jwt files, and set up license secrets and image pull secrets
* users are guided on copying their compiled policy bundle onto the deployment
* users are shown how to compile a json into a policy bundle
* example applications are deployed and waf is used in those
* there are examples of successful and expectedly failed requests
…-helm.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Gabor Javorszky <[email protected]>
…-helm.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Gabor Javorszky <[email protected]>
…-helm.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Gabor Javorszky <[email protected]>
…-helm.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Gabor Javorszky <[email protected]>
…-helm.md

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Gabor Javorszky <[email protected]>
@javorszky javorszky force-pushed the gabor/issue-7416-nic-appprotectv5 branch from da9025b to 42b00c2 Compare April 23, 2025 11:15
ADubhlaoich
ADubhlaoich previously approved these changes Apr 23, 2025
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

Generally LGTM. Good to ship, but I have some small pedantic details as edit suggestions.

Adding tiny nits and wording suggestions

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Gabor Javorszky <[email protected]>
@javorszky javorszky requested a review from ADubhlaoich April 23, 2025 15:58
AlexFenlon
AlexFenlon previously approved these changes Apr 24, 2025
ADubhlaoich
ADubhlaoich previously approved these changes Apr 24, 2025
@javorszky javorszky merged commit a0e11a8 into main Apr 24, 2025
30 checks passed
@javorszky javorszky deleted the gabor/issue-7416-nic-appprotectv5 branch April 24, 2025 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add "Install NGINX Ingress Controller with AppProtect V5" to Installation section of docs
3 participants