Skip to content

Add "Install NGINX Ingress Controller with AppProtect V5" to Installation section of docs #7416

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.

Sign up for GitHub

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

Jump to bottom
Closed
shaun-nx opened this issue Feb 27, 2025 · 1 comment · Fixed by #7688
Closed

Add "Install NGINX Ingress Controller with AppProtect V5" to Installation section of docs #7416

shaun-nx opened this issue Feb 27, 2025 · 1 comment · Fixed by #7688
Assignees
@javorszky
Labels
documentation Pull requests/issues for documentation proposal An issue that proposes a feature request
Milestone
v5.1.0

Comments

@shaun-nx
Copy link
Contributor

shaun-nx commented Feb 27, 2025 •
edited by vepatel
Loading

Overview

As a user who wants is interested in NGINX Ingress Controller with AppProtect
I want documentation with the easiest steps possible to install NGINX Ingress Controller with AppProtect
So that I don't need to jump between multiple documents to install NGINX Ingress Controller with AppProtect
And so that I can have NGINX Ingress Controller installed with AppProtect as fast as possible

Acceptance Criteria

  • Add documentation on how to install with both Helm and Manifest
  • Helm and Manifest install docs should be separate, the same as they are today in the current Install NGINX Ingress Controller docs
  • The document should not require the user to leave our docs. All steps should be contained within the one document
  • Before installing, users should be presented with an example "wafv5.json" policy and shown how to generate a bundle form that json.
  • Before installing, users should be guided to create their License Secret.
  • Before installing, users should be guided to create an imagePullSecret to pull image when installing
  • After installing, users should be guided on pushing their AppProtect policies to their Persistent Volume
  • After installing, users should be guided on configuring and deploying a WAF Policy resource
  • After installing, users should be guided on configuring and deploying a VirtualServer resource to reference the deployed WAF Policy
  • After installing, users should be guided on how to confirm that their application is protected

User Flow

  1. Create an AppProtect Policy
  2. Compile AppProtect Policy into an Policy Bundle
  3. Create licence secret for E&V
  4. Create imagePullSecret with JWT
  5. Run install command with required parameters
  6. User deploys a WAF Policy
  7. User deploys a VirtualServer to reference the WAF Policy
@shaun-nx shaun-nx added documentation Pull requests/issues for documentation proposal An issue that proposes a feature request labels Feb 27, 2025
@shaun-nx shaun-nx added this to the v4.1.0 milestone Feb 27, 2025
@github-actions GitHub Actions
Copy link

Hi @shaun-nx thanks for reporting!

Be sure to check out the docs and the Contributing Guidelines while you wait for a human to take a look at this 🙂

Cheers!

@shaun-nx shaun-nx modified the milestones: v4.1.0, v4.2.0 Feb 27, 2025
@shaun-nx shaun-nx moved this from Todo ☑ to Prioritized backlog in NGINX Ingress Controller Feb 27, 2025
@javorszky javorszky self-assigned this Mar 4, 2025
@danielnginx danielnginx changed the title Add "Install NGINX Ingress Controller with AppProtect" to Installation section of docs Add "Install NGINX Ingress Controller with AppProtect V5" to Installation section of docs Mar 5, 2025
@danielnginx danielnginx moved this from Prioritized backlog to Todo ☑ in NGINX Ingress Controller Mar 5, 2025
@danielnginx danielnginx moved this from Todo ☑ to In Progress 🛠 in NGINX Ingress Controller Mar 5, 2025
@shaun-nx shaun-nx modified the milestones: v4.2.0, v5.1.0 Apr 16, 2025
javorszky added a commit that referenced this issue Apr 22, 2025
@javorszky
docs: Adds installation guide for NIC and waf
1beca46 
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
@javorszky javorszky mentioned this issue Apr 22, 2025
Merged
6 tasks
@javorszky javorszky moved this from In Progress 🛠 to In Review 👀 in NGINX Ingress Controller Apr 22, 2025
javorszky added a commit that referenced this issue Apr 22, 2025
@javorszky
docs: Adds installation guide for NIC and waf
36b5247 
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
javorszky added a commit that referenced this issue Apr 22, 2025
@javorszky
docs: Adds installation guide for NIC and waf
7121668 
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
javorszky added a commit that referenced this issue Apr 23, 2025
@javorszky
docs: Adds installation guide for NIC and waf
a103d07 
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
@github-project-automation github-project-automation bot moved this from In Review 👀 to Done 🚀 in NGINX Ingress Controller Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@javorszky javorszky

Labels
documentation Pull requests/issues for documentation proposal An issue that proposes a feature request
Projects
NGINX Ingress Controller
Status: Done 🚀
Milestone
v5.1.0
Development

Successfully merging a pull request may close this issue.

docs: Adds installation guide for NIC and waf nginx/kubernetes-ingress
2 participants
@javorszky @shaun-nx