-
Notifications
You must be signed in to change notification settings - Fork 603
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: serverless custom domains docs (#8213)
* feat: serverless custom domains docs --------- Signed-off-by: John Harris <[email protected]>
- Loading branch information
1 parent
3f8b4ae
commit 05d54c3
Showing
8 changed files
with
94 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
39 changes: 39 additions & 0 deletions
39
app/konnect/gateway-manager/dedicated-cloud-gateways/custom-dns.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: Custom Domains for Dedicated Cloud Gateways | ||
| --- | ||
|
|
||
| {{site.konnect_short_name}} integrates domain name management and configuration with [managed data planes](/konnect/gateway-manager/dedicated-cloud-gateways/). | ||
|
|
||
|
|
||
| ## {{site.konnect_short_name}} configuration | ||
|
|
||
| 1. Open {% konnect_icon runtimes %} **Gateway Manager**, choose a control plane to open the **Overview** dashboard, then click **Connect**. | ||
|
|
||
| The **Connect** menu will open and display the URL for the **Public Edge DNS**. Save this URL. | ||
|
|
||
| 2. Select **Custom Domains** from the side navigation, then **New Custom Domain**, and enter your domain name. | ||
|
|
||
| Save the values that appear under **CNAME** and **Content**. | ||
|
|
||
|
|
||
| ## Domain registrar configuration | ||
|
|
||
| 3. Log in to your domain registrar's dashboard. | ||
| 4. Navigate to the DNS settings section. This area might be labeled differently depending on your registrar. | ||
| 5. Locate the option to add a new CNAME record and create the following records using the values saved in the [{{site.konnect_short_name}} configuration](#konnect-configuration) section. For example, in AWS Route 53, it would look like this: | ||
|
|
||
| | Host Name | Record Type | Routing Policy | Alias | Evaluate Target Health | Value | TTL | | ||
| |---------------------------------|-------------|----------------|-------|------------------------|------------------------------------------------------|-----| | ||
| | `_acme-challenge.example.com` | CNAME | Simple | No | No | `_acme-challenge.9e454bcfec.acme.gateways.konghq.com`| 300 | | ||
| | `example.com` | CNAME | Simple | No | No | `9e454bcfec.gateways.konghq.com` | 300 | | ||
|
|
||
|
|
||
| {:.note} | ||
| > **Note:** DNS validation statuses for Dedicated Cloud Gateways are refreshed every 5 minutes. | ||
|
|
||
| ## Delete a custom domain {#delete-url} | ||
|
|
||
| 1. In {{site.konnect_short_name}}, open {% konnect_icon runtimes %} **Gateway Manager**, choose a control plane to open the **Overview** dashboard, then click **Custom Domains**. | ||
|
|
||
| 2. Click the action menu on the end of the row you want to delete and click **Delete**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
app/konnect/gateway-manager/serverless-gateways/custom-dns.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: Custom Domains for Serverless Gateways | ||
| --- | ||
|
|
||
| {{site.konnect_short_name}} integrates domain name management and configuration with [Serverless](/konnect/gateway-manager/serverless-gateways/) gateways. | ||
|
|
||
|
|
||
| ## {{site.konnect_short_name}} configuration | ||
|
|
||
| 1. Open {% konnect_icon runtimes %} **Gateway Manager**, choose a control plane to open the **Overview** dashboard, then click **Connect**. | ||
|
|
||
| The **Connect** menu will open and display the URL for the **Public Edge DNS**. Save this URL. | ||
|
|
||
| 1. Select **Custom Domains** from the side navigation, then **New Custom Domain**, and enter your domain name. | ||
|
|
||
| Save the value that appears under **CNAME**. | ||
|
|
||
|
|
||
| ## Domain registrar configuration | ||
|
|
||
| 1. Log in to your domain registrar's dashboard. | ||
| 1. Navigate to the DNS settings section. This area might be labeled differently depending on your registrar. | ||
| 1. Locate the option to add a new CNAME record and create the following record using the value saved in the [{{site.konnect_short_name}} configuration](#konnect-configuration) section. For example, in AWS Route 53, it would look like this: | ||
|
|
||
| | Host Name | Record Type | Routing Policy | Alias | Evaluate Target Health | Value | TTL | | ||
| |---------------------------------|-------------|----------------|-------|------------------------|------------------------------------------------------|-----| | ||
| | `my.example.com` | CNAME | Simple | No | No | `9e454bcfec.kongcloud.dev` | 300 | | ||
|
|
||
|
|
||
| {:.note} | ||
| > **Note:** Once a Serverless Gateway custom DNS record has been validated, it will _not_ be refreshed or re-validated. Remove and re-add the custom domain in {{site.konnect_short_name}} to force a re-validation. | ||
|
|
||
| ## Delete a custom domain {#delete-url} | ||
|
|
||
| 1. In {{site.konnect_short_name}}, open {% konnect_icon runtimes %} **Gateway Manager**, choose a control plane to open the **Overview** dashboard, then click **Custom Domains**. | ||
|
|
||
| 2. Click the action menu on the end of the row you want to delete and click **Delete**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters