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

Add guide for TLS Route in site #2363

Merged
merged 10 commits into from
Aug 16, 2024
Merged

Add guide for TLS Route in site #2363

merged 10 commits into from
Aug 16, 2024

Conversation

sarthyparty
Copy link
Contributor

@sarthyparty sarthyparty commented Aug 9, 2024 •
edited by kate-osborn
Loading

Proposed changes

Problem: No user-facing documentation for configuring TLS Passthrough

Solution: Add a how-to guide for TLS Passthrough and update Gateway API compatibility doc

Closes #2285

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

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

Add how-to user guide for configuring TLS Passthrough load-balancing

@sarthyparty sarthyparty requested review from a team as code owners August 9, 2024 20:59
@github-actions github-actions bot added documentation Improvements or additions to documentation chore Pull requests for routine tasks labels Aug 9, 2024
@sarthyparty sarthyparty marked this pull request as draft August 9, 2024 20:59
@codecov Codecov
Copy link

codecov bot commented Aug 9, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.81%. Comparing base (16a9522) to head (3ac39b2).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2363      +/-   ##
==========================================
- Coverage   88.84%   88.81%   -0.03%     
==========================================
  Files         100      100              
  Lines        7527     7527              
  Branches       50       50              
==========================================
- Hits         6687     6685       -2     
- Misses        784      785       +1     
- Partials       56       57       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@sjberman
Copy link
Contributor

We should include something more here to indicate that it's actually working if possible, other than just a response.

ADubhlaoich
ADubhlaoich approved these changes Aug 13, 2024
View reviewed changes
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.

LGTM, generally. See Saylor's feedback about the DOCS code.

My edit suggestions are largely to remove possessive language, which we avoid for tone.

site/content/how-to/traffic-management/tls-passthrough-routing.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough-routing.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough-routing.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough-routing.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough-routing.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough-routing.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn removed the chore Pull requests for routine tasks label Aug 13, 2024
@kate-osborn kate-osborn force-pushed the chore/update-site-for-tls-route branch from cf570eb to 7875ca5 Compare August 15, 2024 17:09
@github-actions github-actions bot added the chore Pull requests for routine tasks label Aug 15, 2024
@kate-osborn kate-osborn removed the chore Pull requests for routine tasks label Aug 15, 2024
@kate-osborn kate-osborn marked this pull request as ready for review August 15, 2024 17:10
@nginx-bot nginx-bot
Copy link

nginx-bot bot commented Aug 15, 2024

Hi @sarthyparty!

Thanks for opening this pull request!
Be sure to check out our Contributing Guidelines while you wait for someone on the team to review this.

salonichf5
salonichf5 reviewed Aug 15, 2024
View reviewed changes
site/content/how-to/traffic-management/tls-passthrough.md Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough.md Outdated Show resolved Hide resolved
site/content/how-to/traffic-management/tls-passthrough.md Outdated Show resolved Hide resolved
@kate-osborn kate-osborn force-pushed the chore/update-site-for-tls-route branch from 7875ca5 to b4689f8 Compare August 15, 2024 19:06
@github-actions github-actions bot added the chore Pull requests for routine tasks label Aug 15, 2024
kate-osborn and others added 2 commits August 15, 2024 13:59
@kate-osborn @sjberman
Update site/content/how-to/traffic-management/tls-passthrough.md
12d01d1 
Co-authored-by: Saylor Berman <s.berman@f5.com>
@kate-osborn @sjberman
Update site/content/how-to/traffic-management/tls-passthrough.md
e80d292 
Co-authored-by: Saylor Berman <s.berman@f5.com>
@kate-osborn kate-osborn removed chore Pull requests for routine tasks community labels Aug 15, 2024
@github-actions github-actions bot added the chore Pull requests for routine tasks label Aug 16, 2024
@kate-osborn kate-osborn merged commit 0e90229 into nginxinc:main Aug 16, 2024
39 checks passed
kate-osborn added a commit that referenced this pull request Aug 16, 2024
@kate-osborn @sarthyparty
Add guide for TLS Route in site (#2363) (#2412)
b58c306 
Problem: No user-facing documentation for configuring TLS Passthrough
Solution: Add a how-to guide for TLS Passthrough and update Gateway API compatibility doc

Co-authored-by: Sarthak Agrawal <68310924+sarthyparty@users.noreply.github.com>
lucacome pushed a commit to lucacome/nginx-kubernetes-gateway that referenced this pull request Aug 20, 2024
@sarthyparty @kate-osborn @lucacome
Add guide for TLS Route in site (nginxinc#2363)
87e2de3 
Problem: No user-facing documentation for configuring TLS Passthrough
Solution: Add a how-to guide for TLS Passthrough and update Gateway API compatibility doc

Co-authored-by: Kate Osborn <k.osborn@f5.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kate-osborn kate-osborn kate-osborn left review comments

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@sjberman sjberman sjberman approved these changes

@bjee19 bjee19 bjee19 approved these changes

@salonichf5 salonichf5 Awaiting requested review from salonichf5

Assignees

@lucacome lucacome

Labels
chore Pull requests for routine tasks documentation Improvements or additions to documentation release-notes
Projects
NGINX Gateway Fabric
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation: Write TLS Passthrough how-to
7 participants
@sarthyparty @sjberman @ADubhlaoich @kate-osborn @bjee19 @salonichf5 @lucacome