-
Notifications
You must be signed in to change notification settings - Fork 598
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
base: main
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for kongdocs failed.
|
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! |
There was a problem hiding this 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.
<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> |
There was a problem hiding this comment.
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):
- 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?
There was a problem hiding this comment.
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!
@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? |
@lmilan @cloudjumpercat not that it might be related, but can you add a closing |
the problem with the if they are inside a list, they should be indented |
@fabianrbz that worked, thank you! |
There was a problem hiding this 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!
45db8ca
to
312b5f5
Compare
Co-authored-by: Diana <[email protected]>
Co-authored-by: Ahmad Abedalqader <[email protected]>
Co-authored-by: lena-larionova <[email protected]>
@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. |
@cloudjumpercat we need to merge this one first. Or drop the submodule update from this one |
https://konghq.atlassian.net/browse/CSRE-2806
Description
Add docs page for privatelink.
Testing instructions
Preview link:
Checklist