Updated guide to use NGINX/NGINX Plus as the Ingress Controller in EKS

[madebydna]

Proposed changes

Problem: The original version of the NGINX Ingress Controller on AWS EKS guide had many outdated links, some confusing instructions, and a readability score of 9 in the Hemingway editor.

Solution: I followed the instructions on this and various linked pages to set up an open source NGINX Ingress Controller in an AWS EKS cluster. I fixed outdated links along the way. I also tried to improve the flow of the guide by reorganizing some of the instructions on the page as they relate to references on linked pages. This was necessary to avoid confusion as the guide sometimes referenced older versions of linked pages.

I also improved the wording and readability according to the Hemingway editor from a 9 to a 7 (note that I removed code snippets and file paths):

Testing: I tested the instructions several times by setting up an AWS EKS cluster with the NGINX Ingress Controller, and deploying the Cafe sample application for testing functionality.

Please focus on: One part I couldn't get to work properly was to remove the use of the PROXY Protocol as described in the Appendix. Even after I added the (necessary) step of removing the Proxy protocol setting from the AWS target groups, the client IP was still logged in the Kubernetes logs of the NGINX Ingress Controller. This is an indication that client connection information is still being forwarded from the load balancer to the proxy.

Closes #98

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 ensured that documentation content adheres to the style guide
• If the change involves potentially sensitive changes, I have assessed the possible impact
• If applicable, I have added tests that prove my fix is effective or that my feature works
• If applicable, I have checked that any relevant tests pass after adding my changes
• I have updated any relevant documentation (README.md and CHANGELOG.md)
• 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

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.

[github-actions]

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

[madebydna]

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

[mjang]

Hi @madebydna , you've done a great amount of work on this. I look forward to reviewing it, hopefully in the next couple of days (or at least by the end of the week).

[madebydna]

Thanks @mjang! It was a fun challenge. 😄

[ADubhlaoich]

Hi @madebydna! I'm the assigned TW for Kubernetes stuff: I'm happy to approve and merge this in.

I have made a bunch of edit suggestions. They're things you would have had no chance to know since this document is consistent within itself, but not up to contemporary standards. I have added context to the first instance of each type of suggestion.

Thanks for contributing!

[madebydna]

@ADubhlaoich, thanks for the review including the detailed explanations! I committed the suggested changes.

I found the Contributing Docs only after I submitted the PR, unfortunately. Otherwise I would have learned about Hugo shortcodes and avoiding HTML spans, etc. I will also reference the style guide more before submitting my next PR. 🙂

[madebydna]

@y82, @ADubhlaoich, the note about not uploading NGINX Plus images doesn't exist as an include yet.

On the content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md page it occurs twice (here and here). There is an include at content/includes/nap-waf/build-nginx-image-cmd.md that contains a similar phrase but it's specific to NGINX App Protect WAF v5 and also has additional content (see here).

I could take a stab at refactoring but I'm wondering if that should be a separate ticket since it would go beyond the scope of this one.

[mjang]

I could take a stab at refactoring but I'm wondering if that should be a separate ticket since it would go beyond the scope of this one.

@madebydna thank you, I think you're correct. IMO, you've gone "above and beyond" with your answer. Since you now have two approvals, I'm going to proceed with merge, and congratulate you on making your first contribution!