diff --git a/app/_data/docs_nav_konnect.yml b/app/_data/docs_nav_konnect.yml index 07a9b8e0e146..5ea27ec76e96 100644 --- a/app/_data/docs_nav_konnect.yml +++ b/app/_data/docs_nav_konnect.yml @@ -54,6 +54,8 @@ url: /gateway-manager/dedicated-cloud-gateways/transit-gateways - text: Azure VNET Peering url: /gateway-manager/dedicated-cloud-gateways/azure-peering + - text: Custom Domains + url: /gateway-manager/dedicated-cloud-gateways/custom-dns/ - text: Serverless Gateways items: - text: Overview @@ -62,6 +64,8 @@ url: /gateway-manager/serverless-gateways/provision-serverless-gateway/ - text: Securing Backend Traffic url: /gateway-manager/serverless-gateways/securing-backend-traffic/ + - text: Custom Domains + url: /gateway-manager/serverless-gateways/custom-dns/ - text: Data Plane Nodes items: - text: Installation Options @@ -232,6 +236,8 @@ url: /dev-portal/customization/self-hosted-portal/ - text: Host your Dev Portal with Netlify url: /dev-portal/customization/netlify/ + - text: Custom Domains + url: /dev-portal/customization/custom-dns/ - text: Dev Portal SDK url: https://www.npmjs.com/package/@kong/sdk-portal-js absolute_url: true @@ -424,8 +430,6 @@ url: /reference/labels/ - text: Plugin Ordering Reference url: /reference/plugins/ - - text: Custom Domains - url: /reference/custom-dns/ - text: Konnect Search url: /reference/search/ - text: Terraform Provider diff --git a/app/_redirects b/app/_redirects index 1a90ae2a1fc9..e182afee0d1c 100644 --- a/app/_redirects +++ b/app/_redirects @@ -25,11 +25,12 @@ ## DCG seperate section - /konnect/gateway-manager/data-plane-nodes/azure-peering/ /konnect/gateway-manager/dedicated-cloud-gateways/azure-peering/ /konnect/gateway-manager/data-plane-nodes/transit-gateways/ /konnect/gateway-manager/dedicated-cloud-gateways/transit-gateways/ /konnect/gateway-manager/provision-cloud-gateway/ /konnect/gateway-manager/dedicated-cloud-gateways/provision-cloud-gateway/ /konnect/gateway-manager/dedicated-cloud-gateways/ /konnect/gateway-manager/dedicated-cloud-gateways/ +/konnect/reference/custom-dns/ /konnect/dev-portal/customization/custom-dns/ + ## Saml SSO /konnect/org-management/oidc-idp/ /konnect/org-management/sso/ diff --git a/app/konnect/reference/custom-dns.md b/app/konnect/dev-portal/customization/custom-dns.md similarity index 70% rename from app/konnect/reference/custom-dns.md rename to app/konnect/dev-portal/customization/custom-dns.md index a8b16f2acffd..73e940f6caab 100644 --- a/app/konnect/reference/custom-dns.md +++ b/app/konnect/dev-portal/customization/custom-dns.md @@ -1,33 +1,8 @@ --- -title: Custom Domains +title: Custom Domains for Dev Portal --- -{{site.konnect_short_name}} integrates domain name management and configuration in the Dev Portal and with [managed data planes](/konnect/gateway-manager/dedicated-cloud-gateways/). - - -## Managed data planes -### {{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 values that appear under **CNAME** and **Content**. - - -### 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 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 | +{{site.konnect_short_name}} integrates domain name management and configuration in the [Dev Portal](/konnect/dev-portal/). ## Dev Portal @@ -42,7 +17,7 @@ To add a custom URL to Dev Portal, you need: You can also choose to [self-host the Dev Portal with Netlify](/konnect/dev-portal/customization/netlify/) or any other static hosting service that supports single page applications. -### Configure DNS +## Configure DNS In your DNS configuration, create a CNAME record for the domain you want to use using the automatically generated Dev Portal URL. The record will look like this: @@ -53,7 +28,7 @@ The record will look like this: If your domain has specific CAA DNS records that list authorized certificate authorities/issuers, you'll also need to create a new CAA DNS record to permit [Google Trust Services](https://pki.goog/faq/#caa) as an issuer. If your domain doesn't currently have any CAA DNS records, it means all issuers are implicitly allowed, and there's no need for a new CAA DNS record in that case. -### Update Dev Portal URL settings {#update-portal} +## Update Dev Portal URL settings {#update-portal} To add a custom URL to Dev Portal, open {% konnect_icon dev-portal %} **Dev Portal**, click **Settings**, then follow these steps: @@ -66,7 +41,7 @@ To add a custom URL to Dev Portal, open {% konnect_icon dev-portal %} **Dev Port 5. Click **Confirm** to begin the domain verification process. -### Domain name restrictions +## Domain name restrictions Because of SSL certificate authority restrictions, {{site.konnect_short_name}} can't generate SSL certificates for the following domains: @@ -90,7 +65,7 @@ for the following domains: If you have any questions, [contact Support](https://support.konghq.com). -### Delete a custom URL {#delete-url} +## Delete a custom URL {#delete-url} Delete a custom Dev Portal URL through your organization's {{site.konnect_short_name}} admin UI. diff --git a/app/konnect/dev-portal/customization/index.md b/app/konnect/dev-portal/customization/index.md index 9d934d1a9ce6..19426a44f293 100644 --- a/app/konnect/dev-portal/customization/index.md +++ b/app/konnect/dev-portal/customization/index.md @@ -49,7 +49,7 @@ To add a custom URL to Dev Portal, you need: You can also choose to [self-host the Dev Portal with Netlify](/konnect/dev-portal/customization/netlify/) or any other static hosting service that supports single page applications. -[Configure DNS →](/konnect/reference/custom-dns) +[Configure DNS →](/konnect/dev-portal/customization/custom-dns) ## Single sign-on {:.badge .enterprise} diff --git a/app/konnect/gateway-manager/dedicated-cloud-gateways/custom-dns.md b/app/konnect/gateway-manager/dedicated-cloud-gateways/custom-dns.md new file mode 100644 index 000000000000..ddec6e68a52e --- /dev/null +++ b/app/konnect/gateway-manager/dedicated-cloud-gateways/custom-dns.md @@ -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**. diff --git a/app/konnect/gateway-manager/dedicated-cloud-gateways/index.md b/app/konnect/gateway-manager/dedicated-cloud-gateways/index.md index 781076c5619b..d556c3cabdfb 100644 --- a/app/konnect/gateway-manager/dedicated-cloud-gateways/index.md +++ b/app/konnect/gateway-manager/dedicated-cloud-gateways/index.md @@ -59,5 +59,5 @@ This includes [Data Plane Resilience](/gateway/latest/kong-enterprise/cp-outage- * [Supported regions](/konnect/geo/#dedicated-cloud-gateways) * [Transit Gateways](/konnect/gateway-manager/dedicated-cloud-gateways/transit-gateways/) * [How to upgrade data planes](/konnect/gateway-manager/data-plane-nodes/upgrade/) -* [Custom Domains](/konnect/reference/custom-dns/) +* [Custom Domains](/konnect/gateway-manager/dedicated-cloud-gateways/custom-dns/) * [Cloud Gateways API](/konnect/api/cloud-gateways/latest/) \ No newline at end of file diff --git a/app/konnect/gateway-manager/serverless-gateways/custom-dns.md b/app/konnect/gateway-manager/serverless-gateways/custom-dns.md new file mode 100644 index 000000000000..d05b986e02c4 --- /dev/null +++ b/app/konnect/gateway-manager/serverless-gateways/custom-dns.md @@ -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**. diff --git a/app/konnect/gateway-manager/serverless-gateways/index.md b/app/konnect/gateway-manager/serverless-gateways/index.md index 9e5f4913a9f0..628bbdc27999 100644 --- a/app/konnect/gateway-manager/serverless-gateways/index.md +++ b/app/konnect/gateway-manager/serverless-gateways/index.md @@ -51,5 +51,5 @@ This includes [data plane resilience](/gateway/latest/kong-enterprise/cp-outage- ## More information * [Securing backend traffic](/konnect/gateway-manager/serverless-gateways/securing-backend-traffic) -* [Custom domains](/konnect/reference/custom-dns/) +* [Custom Domains](/konnect/gateway-manager/serverless-gateways/custom-dns/) * [Serverless gateways API](/konnect/api/cloud-gateways/latest/) \ No newline at end of file