Skip to content

Cherry pick wafv5 install doc(#7416) #7715

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 1 commit into from
Apr 29, 2025

Conversation

AlexFenlon
Copy link
Contributor

  • docs: Adds installation guide for NIC and waf

Closes #7416


Proposed changes

Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to
that issue here in this description (not in the title of the PR).

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

* docs: Adds installation guide for NIC and waf

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

* Update site/content/installation/installing-nic/deploy-with-nap-using-helm.md

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

* Update site/content/installation/installing-nic/deploy-with-nap-using-helm.md

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

* Update site/content/installation/installing-nic/deploy-with-nap-using-helm.md

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

* Update site/content/installation/installing-nic/deploy-with-nap-using-helm.md

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

* Update site/content/installation/installing-nic/deploy-with-nap-using-helm.md

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

* Replace bash code type with shell

* Rework creating license secrets section

* Remove Step X from headings

* Fix a yml/yaml inconsistency

* Fix helm command and add instruction to install manifest

* Apply suggestions from code review

Adding tiny nits and wording suggestions

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

* Specify that we're using WAF v5

* Remove the DOCS code from the frontmatter

---------

Signed-off-by: Gabor Javorszky <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
@AlexFenlon AlexFenlon requested review from a team as code owners April 29, 2025 09:05
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Apr 29, 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/7715/

@AlexFenlon AlexFenlon merged commit 6a450b2 into release-5.0 Apr 29, 2025
23 checks passed
@AlexFenlon AlexFenlon deleted the cherry-pick-wafv5-install-doc branch April 29, 2025 09:18
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.

3 participants