Skip to content

Commit 398f2bf

Browse files
authored
fix(es): change endpoint format (#4353)
1 parent 175db45 commit 398f2bf

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

pages/edge-services/concepts.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Edge Services is an additional feature for Scaleway Load Balancers and Object St
3333

3434
## Endpoint
3535

36-
The endpoint from which a given Edge Services pipeline can be accessed, e.g. `https://pipeline-id-or-bucket-name.svc.edge.scw.cloud`. When a client requests content from the Edge Services endpoint, it is served by Edge Services and its cache, rather than from the origin (Object Storage bucket or Load Balancer backend servers) directly. Edge Services automatically manages redirection from HTTP to HTTPS.
36+
The endpoint from which a given Edge Services pipeline can be accessed, e.g. `https://pipeline-id.svc.edge.scw.cloud`. When a client requests content from the Edge Services endpoint, it is served by Edge Services and its cache, rather than from the origin (Object Storage bucket or Load Balancer backend servers) directly. Edge Services automatically manages redirection from HTTP to HTTPS.
3737

3838
The endpoint can be customized with a user-defined subdomain, allowing you to replace the standardized endpoint with the subdomain of a domain you already own, e.g. `http://my-own-domain.com`. An associated [certificate](#certificate), and [CNAME record](#cname-record) will be required, in this case.
3939

pages/edge-services/how-to/configure-custom-domain.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ After customizing your domain, you can edit it (or its certificate) at any time
108108

109109
## How to reset your customized domain
110110

111-
Even though the original Edge Services endpoint (e.g. `https://pipeline-id-or-bucket-name.svc.edge.scw.cloud`) will continue to work after you add a customized domain, you can choose to remove your customized domain completely and go back to the original Edge Services endpoint only. This is done via the reset function:
111+
Even though the original Edge Services endpoint (e.g. `https://pipeline-id.svc.edge.scw.cloud`) will continue to work after you add a customized domain, you can choose to remove your customized domain completely and go back to the original Edge Services endpoint only. This is done via the reset function:
112112

113113
1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose domain you want to reset:
114114

pages/edge-services/how-to/create-pipeline-bucket.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ You can create an Edge Services pipeline [from the Object Storage section of the
5858

5959
## How to access your bucket via Edge Services
6060

61-
Once you have created an Edge Services pipeline for your bucket, you can access your bucket and its content via the following endpoints. Make sure that you replace `bucket-name` with the name of your bucket.
61+
Once you have created an Edge Services pipeline for your bucket, you can access your bucket and its content via the following endpoints. Make sure that you replace `bucket-name` or `pipeline-id` with relevant details for your bucket/pipeline.
6262

6363
| Endpoint | Where to find this endpoint in the console | Notes |
6464
|-----------------------------------------|--------------------------|-----------------------------------------------------------------------------------|
6565
| `https://bucket-name.s3.nl-ams.scw.cloud` | The **Bucket settings** tab | Edge Services is bypassed when the bucket is accessed via this endpoint |
66-
| `https://bucket-name.svc.edge.scw.cloud` | The **Edge Services** tab | Edge Services serves bucket content when this endpoint is used |
66+
| `https://pipeline-id.svc.edge.scw.cloud` | The **Edge Services** tab | Edge Services serves bucket content when this endpoint is used |
6767

6868
The two endpoints shown above are available as standard. However, with Edge Services, you can also choose to configure a **custom domain** from which your bucket can be accessed. Read more about this in the [next section](/edge-services/how-to/configure-custom-domain/).

pages/edge-services/how-to/create-pipeline-lb.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ You can create an Edge Services pipeline from the Load Balancer section of the c
5858

5959
You are returned to the **Pipelines** tab, where the newly created pipeline now displays.
6060

61-
Click on the pipeline to go to its **Overview** page and start configuration. From the **Overview**, you can see the endpoint from which you can access your Load Balancer origin via Edge Services, e.g. `https://pipeline-id.edge.scw.cloud`.
61+
Click on the pipeline to go to its **Overview** page and start configuration. From the **Overview**, you can see the endpoint from which you can access your Load Balancer origin via Edge Services, e.g. `https://pipeline-id.svc.edge.scw.cloud`.
6262

6363
## Troubleshooting pipeline creation
6464

pages/edge-services/reference-content/cname-record.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ When the client actually connects to `otherdomain.com`'s IP address, the web ser
3030

3131
## When and why do I need to create a CNAME record for Edge Services?
3232

33-
When you create an Edge Services pipeline to an [origin](/edge-services/concepts/#origin) (Object Storage bucket or Load Balancer), initially the origin content is served through the standard Edge Services endpoint, e.g. `pipeline-id-or-bucket-name.svc.edge.scw.cloud`. If you do not want to customize the standard Edge Services endpoint, you do not need to worry about CNAME records.
33+
When you create an Edge Services pipeline to an [origin](/edge-services/concepts/#origin) (Object Storage bucket or Load Balancer), initially the origin content is served through the standard Edge Services endpoint, e.g. `pipeline-id.svc.edge.scw.cloud`. If you do not want to customize the standard Edge Services endpoint, you do not need to worry about CNAME records.
3434

3535
However, if you choose to [customize your Edge Services endpoint with your own subdomain](/edge-services/how-to/configure-custom-domain/), a CNAME record must be created to point your subdomain to the Edge Services endpoint.
3636

@@ -47,22 +47,22 @@ The interface used by different domain providers varies, but creating your CNAME
4747

4848
| Record | Destination |
4949
|--------------------------------------------|------------------------------------------|
50-
| `my-chosen-subdomain.beautiful-domain.com` | `pipeline-id-or-bucket-name.svc.edge.scw.cloud.` |
50+
| `my-chosen-subdomain.beautiful-domain.com` | `pipeline-id.svc.edge.scw.cloud.` |
5151

5252
| Subdomain | Target host |
5353
|--------------------------------------------|------------------------------------------------|
54-
| `my-chosen-subdomain` | `pipeline-id-or-bucket-name.svc.edge.scw.cloud.` |
54+
| `my-chosen-subdomain` | `pipeline-id.svc.edge.scw.cloud.` |
5555

5656
| Host record | Points to |
5757
|--------------------------------------------|------------------------------------------------|
58-
| `my-chosen-subdomain` | `pipeline-id-or-bucket-name.svc.edge.scw.cloud.` |
58+
| `my-chosen-subdomain` | `pipeline-id.svc.edge.scw.cloud.` |
5959

6060
| `my-chosen-subdomain` | Record Type | Value |
6161
|--------------------------------------------|-----------------|------------------------------------------------|
62-
| `@` | `CNAME` | is an alias of `pipeline-id-or-bucket-name.svc.edge.scw.cloud.`|
62+
| `@` | `CNAME` | is an alias of `pipeline-id.svc.edge.scw.cloud.`|
6363

6464
<Message type="tip">
65-
The trailing dot at the end of the target endpoint (`pipeline-id-or-bucket-name.svc.edge.scw.cloud.`) is implicitly added by some domain and DNS providers, and must be explicitly added for others. Check with yours whether the dot is necessary.
65+
The trailing dot at the end of the target endpoint (`pipeline-id.svc.edge.scw.cloud.`) is implicitly added by some domain and DNS providers, and must be explicitly added for others. Check with yours whether the dot is necessary.
6666
</Message>
6767

6868
You may also see a `TTL` field, which stands for **T**ime **T**o **L**ive. This tells the DNS resolver how long it can cache this record, before it must re-check the origin source in case something has changed. TTL is measured in seconds, and the default value is usually 12 hours (43200 seconds) or 24 hours (86400 seconds).
@@ -82,7 +82,7 @@ See the table below for help with troubleshooting these errors:
8282
| Error message | Solution |
8383
|-------------------------------------------|---------------------------------------------------------------------|
8484
| No CNAME record found | Make sure you have created a valid DNS record of type **CNAME** (not **A**, **AAAA** or another type), where your subdomain points to the Edge Services endpoint. |
85-
| Incorrect CNAME | Make sure your CNAME record points to the Edge Services endpoint in the format `bucket-name.svc.edge.scw.cloud.`, and that you have replaced `pipeline-id-or-bucket-name` with the name of your bucket in the case of an Object Storage origin, or the pipeline ID in the case of a Load Balancer origin. |
85+
| Incorrect CNAME | Make sure your CNAME record points to the Edge Services endpoint in the format `pipeline-id.svc.edge.scw.cloud.`, and that you have replaced `pipeline-id` with the ID of your bucket or Load Balancer's Edge Services pipeline. |
8686
| Domain does not exist | You must own the domain name you are attempting to configure. If you do not already own the domain name, you cannot create a subdomain or CNAME record for it. Register the domain name, for example using our [Domains and DNS](/domains-and-dns/how-to/register-internal-domain/) product, then create a CNAME record for the subdomain. Otherwise, ensure you did not make a typo when entering the domain name into the Scaleway console. |
8787
| scw.cloud is forbidden | You cannot use subdomains of the `scw.cloud` domain, as the domain is owned and managed by Scaleway and you cannot create DNS records for it. Use your own domain and subdomain. |
8888
| Invalid Top Level Domain | Make sure the Top-Level Domain (e.g. `.com`, `.fr`) you entered is correct. |

pages/edge-services/reference-content/ssl-tls-certificate.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The private key is also used by the host for generating digital signatures, whil
2828

2929
### When and why do I need an SSL/TLS certificate for Edge Services?
3030

31-
When you create an Edge Services pipeline, initially your [origin's](/edge-services/concepts/#origin) content is served through the standard Edge Services endpoint, e.g. `https://pipeline-id-or-bucket-name.svc.edge.scw.cloud`. Scaleway's own SSL/TLS certificate, which covers this subdomain, is used to establish the encrypted connection between client and host. If you do not want to customize the standard Edge Services endpoint, you do not need to worry about creating SSL/TLS certificates.
31+
When you create an Edge Services pipeline, initially your [origin's](/edge-services/concepts/#origin) content is served through the standard Edge Services endpoint, e.g. `https://pipeline-id.svc.edge.scw.cloud`. Scaleway's own SSL/TLS certificate, which covers this subdomain, is used to establish the encrypted connection between client and host. If you do not want to customize the standard Edge Services endpoint, you do not need to worry about creating SSL/TLS certificates.
3232

3333
However, if you choose to [customize your Edge Services endpoint with your own subdomain](/edge-services/how-to/configure-custom-domain/), Scaleway's own SSL/TLS certificate can no longer be used to establish encrypted connections to your subdomain. Client connections are now initially going to a different domain which needs to be "guaranteed" by its own certificate (despite the CNAME record for the subdomain pointing to the Scaleway endpoint).
3434

0 commit comments

Comments
 (0)