This repository has been archived by the owner on Oct 30, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 52
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #776 from apollographql/jack-custom-domains
Add Custom Domains to Dedicated docs
- Loading branch information
Showing
7 changed files
with
127 additions
and
6 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
66 changes: 66 additions & 0 deletions
66
src/content/graphos/cloud-routing/dedicated/custom-domains.mdx
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,66 @@ | ||
--- | ||
title: Custom domains | ||
subtitle: Use a custom subdomain for your cloud router endpoint | ||
description: Use a custom domain for your cloud router endpoint to minimize client-side changes, use existing security policies, and shield against DDoS attacks. | ||
--- | ||
|
||
<DedicatedPreview /> | ||
|
||
The **custom domains** feature lets you replace the default `apollographos.net` [router endpoint URL](./quickstart#router-endpoint-url) with your own subdomain, for example `api.apollographql.com`. | ||
|
||
Custom domains can help to: | ||
|
||
- Minimize client-side changes | ||
- Use your existing CORS policies and security controls | ||
- Protect your cloud routers from DDoS attacks | ||
|
||
## How custom domains works | ||
|
||
Custom domains run on [Cloudflare's](https://www.cloudflare.com/) global network. | ||
Using a custom domain provides DDoS protections and TLS termination to your cloud routers. | ||
Custom domains support CNAME records which are assigned at the variant level. | ||
|
||
## Custom domains setup | ||
|
||
Setup includes two steps: | ||
|
||
1. Setting up a new CNAME record in your DNS provider. | ||
2. Verifying your CNAME with Apollo. | ||
<Note> | ||
|
||
Later in 2024, custom domains will be available self service through GraphOS Studio. In the meantime, you need to open a support request to verify your CNAME with Apollo. | ||
|
||
</Note> | ||
|
||
### Setup a CNAME | ||
|
||
To get started with custom domains, create a [CNAME record](https://www.cloudflare.com/learning/dns/dns-records/dns-cname-record/) in your DNS provider that points at your Dedicated variant's [existing subdomain](./quickstart#router-endpoint-url). For example, create a CNAME for `api.mydomain.com` that points to `current--docs-example.apollographos.net`. | ||
|
||
<img | ||
className="screenshot" | ||
alt="A cloud router's endpoint displayed on the Cloud Router page in GraphOS Studio" | ||
src="../../img/cloud-dedicated/router-endpoint.png" | ||
/> | ||
|
||
### Verify CNAME | ||
|
||
Next, open a support ticket requesting Apollo to enable your new CNAME. | ||
You can open a ticket by clicking the **?** icon in the top right of [GraphOS Studio](https://studio.apollographql.com?referrer=docs-content) and selecting **Contact Support**. | ||
|
||
<img | ||
className="screenshot" | ||
alt="Requesting a new CNAME in GraphOS Studio" | ||
src="../../img/cloud-dedicated/support-ticket.png" | ||
/> | ||
|
||
Apollo will reply with a new TXT record you need to add to your DNS to verify your CNAME. | ||
Once you've created your TXT record, let Apollo know. | ||
Upon verification, your new CNAME will be live. | ||
|
||
## Limitations | ||
|
||
Custom domains doesn't support: | ||
|
||
- [Apex records](https://learn.microsoft.com/en-us/azure/dns/dns-zones-records#record-names) or [A records](https://learn.microsoft.com/en-us/azure/dns/dns-zones-records#record-types) | ||
- Multiple custom domains per variant | ||
- Load balancing traffic across multiple variants |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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