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 documentation for TLS configuration of NLK #115

Closed
wants to merge 2 commits into from
Closed

Add documentation for TLS configuration of NLK #115

wants to merge 2 commits into from

Conversation

ciroque
Copy link
Collaborator

@ciroque ciroque commented Sep 13, 2023

Proposed changes

Provide documentation for configuring NLK to use TLS for communications with NGINX Plus.

This is just the documentation, the implementation will come along later.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • 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)

@ciroque ciroque requested a review from chrisakker as a code owner September 13, 2023 18:30
@ciroque ciroque requested review from 4141done and brianehlert and removed request for chrisakker September 13, 2023 18:31
@ciroque ciroque force-pushed the use-tls-for-nginx-connection branch 8 times, most recently from 6664e7f to 02b247e Compare September 13, 2023 21:19
4141done
4141done approved these changes Sep 14, 2023
View reviewed changes
Copy link
Collaborator

@4141done 4141done left a comment

Choose a reason for hiding this comment

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

A few small notes but I suspect some things will change with implementation. Further improvements can come from user feedback. Might want to consider not merging this until implementation is complete but you've also provided ample warning so up to you.

docs/tls/README.md Outdated Show resolved Hide resolved
docs/tls/KUBERNETES-SECRETS.md Outdated Show resolved Hide resolved
docs/tls/KUBERNETES-SECRETS.md Outdated Show resolved Hide resolved
docs/tls/KUBERNETES-SECRETS.md Outdated Show resolved Hide resolved
@ciroque ciroque force-pushed the use-tls-for-nginx-connection branch from 02b247e to a0b4fa6 Compare September 21, 2023 20:29
@ciroque
Add documentation for TLS configuration of NLK- better titles
c484f1a 
- tweaks
- Add Under Development notice
- prefer References section over inline links to external documentation
- address PR feedback

- correct use of [!WARNING]
@ciroque ciroque force-pushed the use-tls-for-nginx-connection branch from a0b4fa6 to c484f1a Compare September 21, 2023 20:43
@ciroque
Copy link
Collaborator Author

ciroque commented Oct 24, 2023

Decided it would be worse to throw this in with the implementation PR. Happy hunting.

@ciroque ciroque closed this Oct 24, 2023
@ciroque ciroque mentioned this pull request Oct 24, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@4141done 4141done 4141done approved these changes

@brianehlert brianehlert Awaiting requested review from brianehlert

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ciroque @4141done