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

Feat/add privatelink docs #7771

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Feat/add privatelink docs #7771

wants to merge 9 commits into from

Conversation

healthy-pod
Copy link

@healthy-pod healthy-pod commented Aug 20, 2024

https://konghq.atlassian.net/browse/CSRE-2806

Description

Add docs page for privatelink.

Testing instructions

Preview link:

Checklist

@healthy-pod healthy-pod requested a review from a team as a code owner August 20, 2024 00:19
Copy link

netlify bot commented Aug 20, 2024

Deploy Preview for kongdocs failed.

Name Link
🔨 Latest commit 2d8d157
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/672e79bb6503c700080cb9f3

@healthy-pod healthy-pod added review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:sme Request for SME review, external to the docs team. labels Aug 20, 2024
@lmilan lmilan self-assigned this Sep 9, 2024
@lmilan
Copy link
Contributor

lmilan commented Sep 9, 2024

Hi @healthy-pod, I've moved the section and made some structure/wording changes, can you take a look?

My understanding from the product brief is that it will eventually be possible to create private connections to other cloud providers, so it made sense to me to create a section for that and put the privatelink docs under it. Let me know what you think. Thanks!

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.

@lmilan Left some comments! I like where you put the doc in the nav and I think making that new Private connections section makes sense to me. I changed the HTML to markdown as well in my suggestions.

app/konnect/private-connections/aws-privatelink.md Outdated Show resolved Hide resolved
app/konnect/private-connections/aws-privatelink.md Outdated Show resolved Hide resolved
app/konnect/private-connections/aws-privatelink.md Outdated Show resolved Hide resolved
Comment on lines 72 to 78
<li>Update your data plane configuration to connect to the control plane through the private connection. Use the private DNS name that matches your control plane geo in the tables above. For the US {{site.konnect_short_name}} geo, the updated Kong data plane configuration looks like this:
<pre>
cluster_control_plane = us.svc.konghq.com/cp/{cluster_prefix}
cluster_server_name = us.svc.konghq.com
</pre>
</li>
</ol>
Copy link
Contributor

Choose a reason for hiding this comment

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

Here's my suggested edits (the code block will break the GH suggestion thingy, so I'll just post it here):

  1. Update your data plane configuration to connect to the control plane through the private connection. Use the private DNS name that matches your control plane geo in the tables above. For the US {{site.konnect_short_name}} geo, the updated Kong data plane configuration looks like this:
cluster_control_plane = us.svc.konghq.com/cp/{cluster_prefix}
cluster_server_name = us.svc.konghq.com

Also, I'm not exactly sure where I'd put this config for Konnect. Is there a doc we could link or maybe someplace we could reference in the UI or a file?

Copy link
Contributor

Choose a reason for hiding this comment

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

I missed that, it's in kong.conf, I added it. Thanks!

@lmilan
Copy link
Contributor

lmilan commented Sep 10, 2024

@cloudjumpercat Thanks for your comments! When I started reviewing I also changed the HTML to markdown, but then I realized that it caused issues with the navtabs inside a step, so I put the HTML back 😄 do you know if there a better way to do this?

@cloudjumpercat
Copy link
Contributor

@cloudjumpercat Thanks for your comments! When I started reviewing I also changed the HTML to markdown, but then I realized that it caused issues with the navtabs inside a step, so I put the HTML back 😄 do you know if there a better way to do this?

@lmilan Good catch! I'm not sure why the tabs would be doing that, @lena-larionova or @fabianrbz, do you know why the markdown is causing problems with the tabs?

@fabianrbz
Copy link
Contributor

@lmilan @cloudjumpercat not that it might be related, but can you add a closing | to the tables?

@fabianrbz
Copy link
Contributor

the problem with the navtabs is probably the indentation.

if they are inside a list, they should be indented

@lmilan
Copy link
Contributor

lmilan commented Sep 10, 2024

if they are inside a list, they should be indented

@fabianrbz that worked, thank you!
@cloudjumpercat I applied your suggestions, thanks!

Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

A couple of minor comments, otherwise LGTM!

app/konnect/private-connections/aws-privatelink.md Outdated Show resolved Hide resolved
app/konnect/private-connections/aws-privatelink.md Outdated Show resolved Hide resolved
app/konnect/private-connections/aws-privatelink.md Outdated Show resolved Hide resolved
@cloudjumpercat
Copy link
Contributor

@fabianrbz Could you help fix the failing smoke test? I updated the branch since I thought it might be an issue with the Kong Mesh 2.9 nav file, but that didn't fix it and I couldn't figure out what went wrong.

@fabianrbz
Copy link
Contributor

@cloudjumpercat we need to merge this one first. Or drop the submodule update from this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:general Review for general accuracy and presentation. Does the doc work? Does it output correctly? review:sme Request for SME review, external to the docs team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants