Skip to content

Commit

Permalink
Feat/add privatelink docs (#7771)
Browse files Browse the repository at this point in the history
* Feat/add edge gateway docs

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

* update privatelink docs

* remove original files

* Update aws-privatelink.md

* Apply suggestions from code review

Co-authored-by: Diana <[email protected]>

* fixed navtabs issue

* Update app/konnect/private-connections/aws-privatelink.md

Co-authored-by: Ahmad Abedalqader <[email protected]>

* Apply suggestions from code review

Co-authored-by: lena-larionova <[email protected]>

* Feat/add edge gateway docs

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

* remove original files

* Apply suggestions from code review

Co-authored-by: lena-larionova <[email protected]>

* Update dictionary.txt

* Feat/add edge gateway docs

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

* update privatelink docs

* remove original files

* Revert "Feat/add edge gateway docs"

This reverts commit 0c069b9.

* Update aws-privatelink.md

---------

Co-authored-by: Lucie Milan <[email protected]>
Co-authored-by: Lucie Milan <[email protected]>
Co-authored-by: Diana <[email protected]>
Co-authored-by: lena-larionova <[email protected]>
  • Loading branch information
5 people authored Nov 19, 2024
1 parent 6077ec9 commit e77efe4
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/styles/kong/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@ grpcs
grpcurl
gui
guis
GWLBs
gzip
gzipped
hackathon
Expand Down Expand Up @@ -399,6 +400,7 @@ nginx
Nginx's
ngrok
ngx_wasm_module
NLBs
Node.js
Noname
nopp
Expand Down Expand Up @@ -528,6 +530,7 @@ subcomponents
submodule
submodule's
subnet
subnets
substring
subtable
subtables
Expand Down
5 changes: 5 additions & 0 deletions app/_data/docs_nav_konnect.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
url: /network-resiliency/
- text: Port and Network Requirements
url: /network/
- text: Private Connections to Other Cloud Providers
items:
- text: Create a private connection with AWS PrivateLink
url: /private-connections/aws-privatelink/
- text: Geographic Regions
url: /geo/
- text: Compatibility
Expand Down Expand Up @@ -245,6 +249,7 @@
url: /analytics/use-cases/
- text: Requests
url: /analytics/api-requests/

- title: Org Management
icon: /assets/images/icons/konnect/icn-organizations-nav.svg
items:
Expand Down
75 changes: 75 additions & 0 deletions app/konnect/private-connections/aws-privatelink.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Create a private connection with AWS PrivateLink
subtitle: Connect your data plane to your Konnect control plane with a private connection to stay compliant and save data transfer costs
content-type: reference
---

You can establish a private connection to ensure that the data transmitted between {{site.konnect_short_name}} and your AWS environment is secure. This private connection uses AWS PrivateLink and is available for the following AWS regions:
- eu-central-1
- us-east-2
- eu-west-1

If you want to create a connection with a different AWS region, contact [Kong Support](https://support.konghq.com/support/s/).

## Prerequisites

Create a VPC, subnets, and a security group in AWS. For more information, see the [AWS documentation](https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html).

## Steps

1. In the AWS Console, connect to your data plane region, open the Endpoints section of the VPC dashboard and [create a new endpoint](https://docs.aws.amazon.com/vpc/latest/privatelink/create-interface-endpoint.html#create-interface-endpoint-aws).

1. Enter a name tag for the endpoint that includes the {{site.konnect_short_name}} control plane geo that you want to connect to. For example: `konnect-us-geo`.

1. Select the **Endpoint services that use NLBs and GWLBs** service category.

1. Find the correct service name for your region in the tables below. Open the tab that matches your AWS region and use the PrivateLink service name for your {{site.konnect_short_name}} geo. For example, `com.amazonaws.vpce.us-east-2.vpce-svc-096fe7ba54ebc32db` for the us-east-2 AWS region and US {{site.konnect_short_name}} geo.

{% capture tabs %}
{% navtabs %}

{% navtab eu-central-1 %}
| {{site.konnect_short_name}} Geographical Region | PrivateLink service name | Private DNS name |
| ------ | ------------ |
| AP | com.amazonaws.vpce.eu-central-1.vpce-svc-0c3f0574080bdd859 | ap.svc.konghq.com |
| EU | com.amazonaws.vpce.eu-central-1.vpce-svc-05e6822fbce58e1a0 | eu.svc.konghq.com |
| ME | com.amazonaws.vpce.eu-central-1.vpce-svc-0e6497e6df9928a80 | me.svc.konghq.com |
| US | com.amazonaws.vpce.eu-central-1.vpce-svc-01d3dd232e277feeb | us.svc.konghq.com |
{% endnavtab %}

{% navtab us-east-2 %}
| {{site.konnect_short_name}} Geographical Region | PrivateLink service name | Private DNS name |
| ------ | ------------ |
| AP | com.amazonaws.vpce.us-east-2.vpce-svc-03da89378358921bc | ap.svc.konghq.com |
| EU | com.amazonaws.vpce.us-east-2.vpce-svc-0cb28c923823735ac | eu.svc.konghq.com |
| ME | com.amazonaws.vpce.us-east-2.vpce-svc-0f1c86fb6399d4fe5 | me.svc.konghq.com |
| US | com.amazonaws.vpce.us-east-2.vpce-svc-096fe7ba54ebc32db | us.svc.konghq.com |
{% endnavtab %}

{% navtab eu-west-1 %}
| {{site.konnect_short_name}} Geographical Region | PrivateLink service name | Private DNS name |
| ------ | ------------ |
| AP | com.amazonaws.vpce.eu-west-1.vpce-svc-08edf59f8bc1d2262 | ap.svc.konghq.com |
| EU | com.amazonaws.vpce.eu-west-1.vpce-svc-037bd988d9a9d4e3a | eu.svc.konghq.com |
| ME | com.amazonaws.vpce.eu-west-1.vpce-svc-0978fbaf50bfc67d9 | me.svc.konghq.com |
| US | com.amazonaws.vpce.eu-west-1.vpce-svc-01070d7c2137e0ee1 | us.svc.konghq.com |
{% endnavtab %}
{% endnavtabs %}
{% endcapture %}
{{ tabs | indent }}

1. Verify the service. If the service name can't be verified, contact [Kong Support](https://support.konghq.com/support/s/).

1. Once the service name is verified, select the VPC, subnets, and security groups to associate with this endpoint. Make sure that:
* The security group accepts inbound traffic on TCP port 443.
* The DNS name parameter in the additional settings is enabled.

1. Create the VPC endpoint and wait for its status to change to available. We recommend waiting for 10 minutes before using it.

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 in `kong.conf` looks like this:
```sh
cluster_control_plane = us.svc.konghq.com/cp/{cluster_prefix}
cluster_server_name = us.svc.konghq.com
cluster_telemetry_endpoint = us.svc.konghq.com:443/tp/{cluster_prefix}
cluster_telemetry_server_name = us.svc.konghq.com
```

0 comments on commit e77efe4

Please sign in to comment.