Skip to content

Commit

Permalink
Merge pull request #1127 from tpmccallum/limitations-custom-domains
Browse files Browse the repository at this point in the history
Updating limitations of custom domains
  • Loading branch information
Timothy McCallum authored Jan 5, 2024
2 parents bfe1f9d + 92d7128 commit 2dd480d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
8 changes: 5 additions & 3 deletions content/cloud/custom-domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,18 @@ If you do not own a domain and you **are** interested in purchasing one, you can
## Setting Up Custom Domains

To take advantage of Fermyon Cloud Custom Domain, you must delegate your domain to Fermyon Cloud. For a full set of instructions, please follow the [Ferymon Cloud Custom Domains tutorial](./custom-domains-tutorial.md).
To take advantage of Fermyon Cloud Custom Domain, you must delegate your domain to Fermyon Cloud.

>> Please consider [these limitations of delegating your apex domain to Fermyon Cloud](./faq.md#custom-domains-limitations) first.
For a full set of top-level (apex) domain delegation instructions, follow the [Ferymon Cloud Custom Domains tutorial](./custom-domains-tutorial.md).

### Relationship Between Custom Domains and Spin Applications

Currently, you can apply a maximum of one custom domain to your Spin application, and a custom domain cannot be shared between multiple Spin applications. If you apply a custom domain to a Spin application and you wish to reassign it, you must first remove the custom domain from the current Spin application and then apply it to your desired Spin application. The Fermyon Cloud Custom Domain feature will generate 4 nameserver records. You must share these with your domain registrar and wait for DNS propagation (the mapping of IP address and DNS record information across nameservers on the internet).

Note that this propagation is generally performed in a reasonable time frame (minutes/hours). However, in some cases, propagation can take up to 72 hours. You can check the DNS record types for your domain name using the [Google Public DNS](https://dns.google/) service.

Be aware that updating your domain's nameserver records will cause any additional records you've set through you registrar to no longer take effect. This includes, for example, TXT or MX records for services like Google Workspace. You can work around this by connecting your Fermyon Cloud app to a subdomain. But if you need to use the apex domain (example.com rather than app.example.com) and you also need to set additional DNS records, you should choose a different hosting service for the time being.

### Next Steps

* Follow the [Ferymon Cloud Custom Domains tutorial](./custom-domains-tutorial.md) to add your custom domain.
Expand Down
2 changes: 2 additions & 0 deletions content/cloud/custom-domains-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ url = "https://github.com/fermyon/developer/blob/main/content/cloud/custom-domai

Custom domains enable you to bring your own domain to Fermyon Cloud. Unlike generic or randomly generated domains, a custom domain reflects the brand, identity, or purpose of the workload. For a conceptual overview of custom domains on Fermyon Cloud, visit [Custom Domains on Fermyon Cloud](./custom-domain.md). This tutorial will walk you through how to apply a custom domain to your Spin application running on Fermyon Cloud.

>> Please consider [these limitations of delegating your apex domain to Fermyon Cloud](./faq.md#custom-domains-limitations) first.
If you prefer video format, you can watch the following instructional video (which is complimentary to the text-based content on this page).

<iframe width="854" height="480" src="https://www.youtube.com/embed/TfOPcGMj7Q0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Expand Down
5 changes: 5 additions & 0 deletions content/cloud/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ url = "https://github.com/fermyon/developer/blob/main/content/cloud/faq.md"
- [Quota Limits](#quota-limits)
- [Known Limitations](#known-limitations)
- [Fermyon Cloud Limitations](#fermyon-cloud-limitations)
- [Custom Domains Limitations](#custom-domains-limitations)
- [Spin Limitations](#spin-limitations)
- [Other Limitations](#other-limitations)
- [Technical Frequently Asked Questions](#technical-frequently-asked-questions)
Expand Down Expand Up @@ -62,6 +63,10 @@ The following are the quota for users based, stratified by the three [Subscripti
- The device and browser token lifetime for Fermyon Cloud Dashboard authentication is 7 days
- A Spin application can have a maximum of 1 key value store

### Custom Domains Limitations

Additional records for custom domains are not supported on Fermyon Cloud at this time. This means any additional records (such as TXT or MX) that you have already set through your registrar will become inactive once top-level (apex) domain delegation to Fermyon Cloud is completed. Updating your domain's nameserver records will cause any additional records you've set through your registrar to no longer take effect e.g. TXT or MX records for services like Google Workspace. If you need to assign your Spin application to an apex domain (`example.com` rather than a subdomain of the apex domain `app.example.com`) _and_ you also need to set additional DNS records associated with that domain, please share this [feedback here](https://github.com/fermyon/feedback/issues/47). In the meantime, please consider delegating a subdomain or using a [Fermyon custom subdomain for your Spin application](./custom-fermyon-subdomain) instead.

### Spin Limitations

Fermyon Cloud supports Spin CLI v0.6.0 or newer. That being said, there are certain Spin SDK triggers and APIs that are not yet supported on Fermyon Cloud. Please review the table below to see what is supported today on Fermyon Cloud:
Expand Down

0 comments on commit 2dd480d

Please sign in to comment.