Skip to content
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

NGINX Ingress Controller Configuration guide update #2864

Merged
merged 52 commits into from Aug 22, 2022
Merged

NGINX Ingress Controller Configuration guide update #2864

merged 52 commits into from Aug 22, 2022

Conversation

rranghar
Copy link
Contributor

@rranghar rranghar commented Jul 18, 2022 •
edited by ciarams87

Proposed changes

Update the documentation with NAP configuration guidelines and examples.

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

@rranghar rranghar marked this pull request as ready for review July 18, 2022 13:44
@rranghar rranghar changed the base branch from main to staging July 18, 2022 14:16
@rranghar rranghar changed the base branch from staging to main July 18, 2022 14:36
Jcahilltorre
Jcahilltorre approved these changes Jul 18, 2022
View reviewed changes
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
liorm39
liorm39 suggested changes Jul 18, 2022
View reviewed changes
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
docs/content/app-protect/configuration.md Show resolved Hide resolved
docs/content/app-protect/configuration.md Show resolved Hide resolved
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
aknot242
aknot242 suggested changes Jul 20, 2022
View reviewed changes
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
docs/content/app-protect/configuration.md Show resolved Hide resolved
brianehlert
brianehlert requested changes Jul 20, 2022
View reviewed changes
Copy link
Collaborator

@brianehlert brianehlert left a comment

Choose a reason for hiding this comment

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

The header "## Enable App Protect for an Ingress Resource" leaves the reader with the impression that App Protect can only be configured using the Ingress resource.
This impression needs to be altered and the reader should walk away with the understanding that they can use either the Custom Resources (VirtualServer, VirtualServerRoute) or the Ingress resource.
Both should be equally represented or the preference should lean to the Custom Resources.

@brianehlert brianehlert requested a review from a team July 22, 2022 17:50
@lucacome
Copy link
Member

lucacome commented Aug 3, 2022

@brianehlert @aknot242 are you happy with the changes or does this PR need more work?

aknot242
aknot242 suggested changes Aug 4, 2022
View reviewed changes
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
docs/content/app-protect/configuration.md Outdated Show resolved Hide resolved
@rranghar rranghar force-pushed the Missing_Documentation_for_Use_Cases_for_NAP_within_NIC branch from 1df1e4d to 6669053 Compare August 22, 2022 08:56
@rranghar rranghar changed the title Missing_Documentation_for_Use_Cases_for_NAP_within_NIC NGINX Ingress Controller Configuration guide update Aug 22, 2022
@ciarams87 ciarams87 merged commit 8d141fd into nginxinc:main Aug 22, 2022
ciarams87 pushed a commit that referenced this pull request Aug 22, 2022
@rranghar @ciarams87
NGINX Ingress Controller Configuration guide update (#2864)
fde2ede 
* Missing_Documentation_for_Use_Cases_for_NAP_within_NIC
@ciarams87 ciarams87 mentioned this pull request Aug 22, 2022
Merged
6 tasks
ciarams87 added a commit that referenced this pull request Aug 22, 2022
@ciarams87 @rranghar
NGINX Ingress Controller Configuration guide update (#2864) (#2950)
91cb1d9 
* NGINX Ingress Controller Configuration guide update (#2864)

* Missing_Documentation_for_Use_Cases_for_NAP_within_NIC

* Fix formatting

Co-authored-by: rranghar <79910395+rranghar@users.noreply.github.com>
@ciarams87 ciarams87 added the documentation Pull requests/issues for documentation label Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ciarams87 ciarams87 ciarams87 left review comments

@brianehlert brianehlert brianehlert approved these changes

@aknot242 aknot242 aknot242 approved these changes

@liorm39 liorm39 liorm39 approved these changes

@Jcahilltorre Jcahilltorre Jcahilltorre approved these changes

Assignees
No one assigned
Labels
documentation Pull requests/issues for documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@rranghar @lucacome @brianehlert @aknot242 @ciarams87 @liorm39 @Jcahilltorre