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

Certificates and CA certificates: references #265

Merged
merged 10 commits into from
Jan 17, 2025

Conversation

lena-larionova
Copy link
Contributor

@lena-larionova lena-larionova commented Jan 16, 2025

Fixes #226
Fixes #238.

Created to-do task #278 to track how-to topics.

How-tos for service-level certs and ca certs and a reference doc for cert types in Gateway + fixes to cert and ca cert entities.

Need help figuring out how to properly test and validate. Creating the entities and applying them to Gateway works fine, the validation is difficult.

Few other things that need adjusting:

Screenshot 2025-01-15 at 11 55 37 PM

Preview Links

https://deploy-preview-265--kongdeveloper.netlify.app/gateway/entities/certificate/
https://deploy-preview-265--kongdeveloper.netlify.app/gateway/entities/ca-certificate/
https://deploy-preview-265--kongdeveloper.netlify.app/gateway/ssl-certificates/

Checklist

  • Every page is page one
  • Tested how-to docs. If not, note why here. - never really figured out how to test properly, so I don't know how to validate
  • All pages contain metadata
  • Updated sources.yaml. For more info review track docs changes
  • Any new docs link to existing docs.
  • All autogenereted instructions render correctly (API, decK, Konnect). - need to fix the way that keys display in decK format
  • Style guide (capital gateway entities, placeholder URLs) implemented correctly.

@lena-larionova lena-larionova added this to the Gateway entities milestone Jan 16, 2025
@lena-larionova lena-larionova requested a review from a team as a code owner January 16, 2025 07:57
Copy link

netlify bot commented Jan 16, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit a1882cb
🔍 Latest deploy log https://app.netlify.com/sites/kongdeveloper/deploys/678adaffce9e4d000863e5d2
😎 Deploy Preview https://deploy-preview-265--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lena-larionova lena-larionova force-pushed the feat/certificates-how-to branch from c60c663 to 8175348 Compare January 16, 2025 18:28
@lena-larionova lena-larionova changed the title Certificates and CA certificates: reference and how-to Certificates and CA certificates: references Jan 16, 2025
@cloudjumpercat cloudjumpercat self-requested a review January 16, 2025 21:07
Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

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

Changes needed:

  • A few grammatical fixes and a few entity references were missing an inline link to the entity page.
  • Two todo how tos are missing corresponding GH issues (or I couldn't find them).
  • Change "SSL Certificate reference" title to something that hints more at use cases and quickly seeing how to setup SSL certs
  • Descriptions from the "Configuring SSL connections through kong.conf" table should be moved to the kong.conf autogenerated source file. I'd prefer we link or use an autogenerated table instead of a manual table. This shouldn't hold up this PR though. We can note this to fix later and ship the table as-is.

Note: I also didn't test these code snippets since I read your note in the PR checklist about not knowing how to validate them.

app/_how-tos/ca-cert-for-server-on-service.md Outdated Show resolved Hide resolved
app/_how-tos/client-cert-for-service.md Outdated Show resolved Hide resolved
app/gateway/ssl-certificates.md Show resolved Hide resolved
app/gateway/ssl-certificates.md Outdated Show resolved Hide resolved
app/gateway/ssl-certificates.md Outdated Show resolved Hide resolved
app/gateway/ssl-certificates.md Outdated Show resolved Hide resolved
app/gateway/ssl-certificates.md Outdated Show resolved Hide resolved
app/_gateway_entities/certificate.md Outdated Show resolved Hide resolved
@lena-larionova lena-larionova merged commit 90a6750 into main Jan 17, 2025
10 checks passed
@lena-larionova lena-larionova deleted the feat/certificates-how-to branch January 17, 2025 22:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CA certificates references Certificates add information about certificate variables
3 participants