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.

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

Add a cert-manager integration guide #957

Merged
merged 5 commits into from
Aug 18, 2023

Conversation

ciarams87
Copy link
Member

@ciarams87 ciarams87 commented Aug 11, 2023

Proposed changes

Problem: As a potential user of NKG
I want a guide on how to integrate cert-manager in my NKG deployment
So that I can feel confident using NKG knowing I can rely on cert-manager to manage my certificates for me
And so that I can easily integrate it within my environment.

Solution: Add a guide detailing how to configure HTTPS for an application using Gateway resources managed by NGINX
Kubernetes Gateway (NKG); Let’s Encrypt as the Certificate Authority (CA) issuing the certificates
used in securing these resources; and cert-manager to automate the provisioning and management of these certificates.

Closes #868

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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 11, 2023
@ciarams87 ciarams87 force-pushed the docs/cert-manager-guide branch 2 times, most recently from 6afbf31 to 5902fc5 Compare August 11, 2023 11:39
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

great guide! please find some comments and suggestions

docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Show resolved Hide resolved
@ciarams87 ciarams87 force-pushed the docs/cert-manager-guide branch 2 times, most recently from c143209 to f98c700 Compare August 15, 2023 15:30
@ciarams87 ciarams87 requested a review from pleshakov August 15, 2023 15:31
Copy link
Contributor

@pleshakov pleshakov left a comment

Choose a reason for hiding this comment

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

👍

@ciarams87 ciarams87 marked this pull request as ready for review August 15, 2023 15:35
@ciarams87 ciarams87 requested a review from a team as a code owner August 15, 2023 15:35
@ciarams87 ciarams87 requested a review from ADubhlaoich August 15, 2023 15:36
Copy link
Contributor

@sjberman sjberman left a comment

Choose a reason for hiding this comment

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

@ADubhlaoich for doc review

docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Show resolved Hide resolved
@ciarams87 ciarams87 force-pushed the docs/cert-manager-guide branch 2 times, most recently from e0b005f to 96b0f43 Compare August 16, 2023 13:30
@ADubhlaoich
Copy link
Contributor

I will review this tomorrow morning (9am IST): just noticed I was tagged, my apologies!

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! Had a few minor corrections and suggestions, but otherwise this could fire immediately from a docs perspective.

docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
@ciarams87 ciarams87 force-pushed the docs/cert-manager-guide branch from 96b0f43 to 4ca1498 Compare August 18, 2023 14:29
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
docs/guides/integrating-cert-manager.md Outdated Show resolved Hide resolved
@ciarams87 ciarams87 force-pushed the docs/cert-manager-guide branch from b081dd2 to c97be3d Compare August 18, 2023 15:22
@ciarams87 ciarams87 requested a review from sjberman August 18, 2023 15:23
@ciarams87 ciarams87 merged commit aa973b2 into nginxinc:main Aug 18, 2023
@ciarams87 ciarams87 deleted the docs/cert-manager-guide branch August 18, 2023 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

How to Integrate Cert-Manager
4 participants