You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/serverless-containers/how-to/add-a-custom-domain-to-a-container.mdx
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ content:
7
7
paragraph: Add a custom domain to Scaleway Serverless Containers.
8
8
tags: custom-domain container serverless cname record
9
9
dates:
10
-
validation: 2024-10-01
10
+
validation: 2025-04-08
11
11
posted: 2022-02-21
12
12
categories:
13
13
- serverless
@@ -23,9 +23,7 @@ Each container comes with an automatically generated domain, on which it is avai
23
23
- A running [Serverless Container](/serverless-containers/how-to/deploy-container/)
24
24
- Registered a domain name with the provider of your choice and have access to the domain name's DNS zone file
25
25
26
-
1. On your domain provider's platform (for example, [Scaleway's domains](/domains-and-dns/how-to/manage-dns-records/)), add a CNAME record pointing to your container default URL in the domain's DNS zone file.
27
-
28
-
26
+
1. On your domain provider's platform (for example, [Scaleway domains](/domains-and-dns/how-to/manage-dns-records/)), add a CNAME record pointing to your container default URL in the domain's DNS zone file.
29
27
30
28
<Messagetype="note">
31
29
- All domains are supported.
@@ -37,13 +35,17 @@ Each container comes with an automatically generated domain, on which it is avai
37
35
- If your DNS provider does not support CNAME flattening, you need to create an ALIAS on your root domain (named `@` or with an empty name) instead of a CNAME.
38
36
</Message>
39
37
2. Before continuing, make sure the DNS entry is available. If not, the custom domain will likely end up in `error` on step 6. You can check this by:
40
-
- running `dig`, `drill` or `nslookup` commands on your domain using common DNS resolvers `1.1.1.1` and `8.8.8.8`: `dig <your_custom_domain> @1.1.1.1`, `dig <your_custom_domain> @8.8.8.8`
41
-
- or using a DNS check tool of your choice (some are available online)
38
+
- running `dig`, `drill` or `nslookup` commands on your domain using common DNS resolvers `1.1.1.1` and `8.8.8.8`:
39
+
```shell
40
+
dig <your_custom_domain> @1.1.1.1
41
+
dig <your_custom_domain> @8.8.8.8
42
+
```
43
+
- using a DNS check tool of your choice (some are available online)
42
44
3. Click the **Endpoints** tab on your containers' page.
43
45
4. Click **+ Add endpoint**.
44
46
5. Enter your custom domain name and validate the form.
45
47
<Messagetype="note">
46
-
Before being `ready`, some checks are performed. See technical details below to know more about these checks.
48
+
Before being `ready`, some checks are performed. Refer to the [technical details](#technical-details-and-troubleshooting) below to know more about these checks.
47
49
</Message>
48
50
6. Connect to your container through that custom domain once the custom domain status is `ready`.
49
51
@@ -58,7 +60,7 @@ Read this section if you want more details about how custom domains are handled
58
60
When adding a custom domain, the following tasks will be performed on Scaleway's side:
59
61
60
62
1. Configure the custom domain on our gateways, so that they can handle traffic for that custom domain.
61
-
2. Ensure that the custom domain points to one of the Serverless Container existing endpoints: either the default one `....functions.fnc.<region>.scw.cloud`, or an existing custom domain.
63
+
2. Ensure that the custom domain points to one of the Serverless Container existing endpoints: either the default one `....containers.fnc.<region>.scw.cloud`, or an existing custom domain.
62
64
3. If step 2 is OK, generate a dedicated TLS certificate for that custom domain so it can answer to HTTPS requests.
63
65
64
66
<Messagetype="note">
@@ -77,8 +79,8 @@ HTTP-01 challenge failure (and by extension, a custom domain in `error` status)
77
79
78
80
| Issue | Description | How to fix or avoid this? |
79
81
| ----- | ----------- | ----------- |
80
-
| DNS record is not correctly configured. | If the DNS record (mostly CNAME) is misconfigured on your DNS provider side, and the custom domain to the Serverless Container default endpoint, we will not be able to configure the custom domain. | Ensure that on your DNS provider, a CNAME record links your custom domain to the Serverless Container. To test, you can run the following command: `dig <your_custom_domain>` (or `nslookup`), and make sure that the value returned is a `CNAME` record to `<your_function>.functions.fnc.<region>.scw.cloud`. |
81
-
| DNS record is not available yet. | This can be the case if the custom domain is created immediately after the CNAME is configured on your DNS provider side. |As a rule of thumb, wait a few minutes after creating the CNAME on your DNS provider, or at least wait until the DNS record is available on main resolvers (`1.1.1.1`, `8.8.8.8`). |
82
+
| DNS record is not correctly configured. | If the DNS record (mostly CNAME) is misconfigured on your DNS provider side, and the custom domain to the Serverless Container default endpoint, we will not be able to configure the custom domain. | Ensure that on your DNS provider, a CNAME record links your custom domain to the Serverless Container. To test, you can run the following command: `dig <your_custom_domain>` (or `nslookup`), and make sure that the value returned is a `CNAME` record to `<your_container>.containers.fnc.<region>.scw.cloud`. |
83
+
| DNS record is not available yet. | This can be the case if the custom domain is created immediately after the CNAME is configured on your DNS provider side. |Wait a few minutes after creating the CNAME on your DNS provider, or at least wait until the DNS record is available on main resolvers (`1.1.1.1`, `8.8.8.8`). |
82
84
| DNS cache is stale (still pointing to an old endpoint). | If the custom domain was pointing to another endpoint before adding the CNAME record to the Serverless Container, and if the TTL is greater than the maximum time of the check (3 min), it can sometimes happen that the custom domain still resolves to the old endpoint, thus making the challenge fail. | Wait until DNS entry is available and use a smaller TTL. |
83
85
| Negative DNS cache is stale | If the initial check fails (DNS record is not available yet), and the negative TTL configured on your DNS provider side is high, the negative TTL will prevent subsequent checks from querying the nameserver again, until it expires. Depending on the negative TTL configured, this can take more or less time. | Either reduce the negative TTL in your DNS provider configuration, or just wait until you are sure DNS record is available. If you already tried to add the custom domain and faced this issue, you likely have to wait for the negative TTL to expire before making another attempt (so the cache can also expire on our side). |
84
86
| Route `/.well-known/acme-challenge` is not handled correctly. | To perform the HTTP-01 challenge, a call will be made on `<your_custom_domain>/.well-known/acme-challenge/<token>`. If you are using a proxying/caching tool (like Cloudflare) between the custom domain and the Serverless Container endpoint, a cached version of that route can be served, making the check fails. | Do not configure caching rules for routes starting with `/.well-known/acme-challenge`. Refer to the example below with Cloudflare. |
@@ -97,14 +99,14 @@ To clarify, let's take a concrete example:
97
99
- you own a domain `mydomain.com`
98
100
- an `A` record is configured on `website.mydomain.com` and points to `51.15.x.x`
99
101
- when a client accesses `http://website.mydomain.com`, the request hits your Instance IP `51.15.x.x:80`
100
-
- you also have a running version of your website hosted as a Serverless Container (only accessible using `example-website.functions.fnc.fr-par.scw.cloud`), and now you want your users to access this version from `http://website.mydomain.com`
102
+
- you also have a running version of your website hosted as a Serverless Container (only accessible using `example-website.containers.fnc.fr-par.scw.cloud`), and now you want your users to access this version from `http://website.mydomain.com`
101
103
102
104
Before adding the custom domain on your Serverless Container, you must change the DNS record to point to the Serverless Container endpoint:
103
105
104
106
- before: `website.mydomain.com` is an A record to `51.15.x.x`
105
-
- after: `website.mydomain.com` is a CNAME record to `example-website.functions.fnc.fr-par.scw.cloud`
107
+
- after: `website.mydomain.com` is a CNAME record to `example-website.containers.fnc.fr-par.scw.cloud`
106
108
107
-
By doing this, clients that already have the `website.mydomain.com` DNS record cached locally will continue to hit `51.15.x.x`, until the TTL expires. New clients (or those whose cache has expired) will start to hit `example-website.functions.fnc.fr-par.scw.cloud`. **However**, as long as the custom domain is not configured on the Serverless Container, these requests will end up in 404, because `website.mydomain.com` is not (yet) known in our infrastructure. Depending on your downtime tolerance (clients receiving 404) for a few minutes, there are 2 cases:
109
+
By doing this, clients that already have the `website.mydomain.com` DNS record cached locally will continue to hit `51.15.x.x`, until the TTL expires. New clients (or those whose cache has expired) will start to hit `example-website.containers.fnc.fr-par.scw.cloud`. **However**, as long as the custom domain is not configured on the Serverless Container, these requests will end up in 404, because `website.mydomain.com` is not (yet) known in our infrastructure. Depending on your downtime tolerance (clients receiving 404) for a few minutes, there are 2 cases:
108
110
109
111
- downtime is acceptable or can be planned (e.g. during the night or when there is less traffic on your website). In that case, after creating the CNAME record, and once you are sure DNS is available everywhere, create the custom domain on the Serverless Container. Once ready, requests to `http://website.mydomain.com` will hit your Serverless Container (no more 404).
110
112
- downtime is not acceptable. Unfortunately, this is not possible right now out-of-the-box. To serve requests from `website.mydomain.com`, our infrastructure must know it, so a custom domain has to be configured. However, for the custom domain to be configured, the DNS record must point to the Serverless Container endpoint, resulting in a chicken-and-egg problem. To handle such scenarios, a CDN can be configured to serve a cached version of your website while the domain is being reconfigured (for example with [`stale-if-error`](https://developer.mozilla.org/fr/docs/Web/HTTP/Headers/Cache-Control#stale-if-error) option). If you choose this solution, be sure to disable caching on routes starting with `/.well-known/acme-challenge` to avoid issues described in the "Technical details and troubleshooting" section.
@@ -46,9 +46,7 @@ A higher number of instances processing requests at the same time implies a grea
46
46
47
47
## Concurrency setting
48
48
49
-
When [deploying a container](/serverless-containers/how-to/deploy-container/), Scaleway Serverless Containers allows you to configure the [concurrency](/serverless-containers/concepts/#concurrency), which is the maximum number of requests a single container instance can handle at the same time. The concurrency setting ranges from 1 to 1,000 simultaneous instances.
50
-
51
-
By default, Serverless Containers allow **80 concurrent requests** per container instance. We recommend using the default value, as Serverless Containers are designed to efficiently function with it, but you can lower it to better fit specific requirements.
49
+
When [deploying a container](/serverless-containers/how-to/deploy-container/), Scaleway Serverless Containers allows you to configure the [concurrency](/serverless-containers/concepts/#concurrency), which is the maximum number of requests a single container instance can handle at the same time. By default, Serverless Containers allow **80 concurrent requests** per container instance. We recommend using the default value, as Serverless Containers are designed to efficiently function with it, but you can lower it to better fit specific requirements.
0 commit comments