Edge Services - Quickstart

Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets, currently available in Public Beta. It provides a caching service to improve performance by reducing load on your origin, and a customizable and secure endpoint for accessing content via Edge Services, which can be set to a subdomain of your choice.

Before you start

To complete the actions presented below, you must have:

• A Scaleway account logged into the console
• Owner status or IAM permissions allowing you to perform actions in the intended Organization
• Created either a Load Balancer or an Object Storage bucket

How to create an Edge Services pipeline

The process differs depending on whether you want to create a pipeline for an Object Storage bucket or a Load Balancer. Choose the correct tab for your case below.

• Object Storage bucket
• Load Balancer

How to configure a custom domain

If you already own a domain, you can customize an Edge Services pipeline endpoint with a subdomain of your choice, e.g. subdomain.mydomain.com. This means you can access your Object Storage bucket or Load Balancer origin through Edge Services via your own subdomain rather than the standardized Edge Services endpoint.

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

   

2. In the Endpoint panel, click Configure domain. The following screen displays:

   

3. Set a subdomain from which your Object Storage bucket or Load Balancer origin will be accessible via its Edge Services pipeline. You must already own the primary domain. For example, if you own beautiful-domain.com, choose any subdomain you like and enter my-chosen-subdomain.beautiful-domain.com into the box.

   Important

   It is not possible to use only a root domain (aka primary domain or apex domain), you must use a subdomain. This is because CNAME records, essential to point your domain to your Edge Services endpoint, cannot by definition be created for root domains, only for subdomains. ✅ blog.example.com ❌ example.com

4. This step depends on whether the domain used in the previous step is managed with Scaleway Domains and DNS, or an external domain provider. Choose the appropriate tab below.

   • Domains and DNS
   • External provider

   The domain you are using for Edge Services is considered to be managed with Scaleway Domains and DNS if:

   • You registered the domain with Domains and DNS, or
   • You transferred an externally-registered domain to Domains and DNS

   If either of the above is true, Scaleway will auto-detect that the domain is managed by Domains and DNS, and a message will display confirming that you do not need to create a CNAME record. We will auto-generate the appropriate CNAME record in your domain’s DNS records, to point your subdomain to the Edge Services endpoint. This record is generated when you click Customize domain in step 6.

   You should not attempt to modify or delete the CNAME record, which will be visible among your DNS records in the Scaleway console.

5. Provide an SSL/TLS certificate for your subdomain so that Edge Services can serve traffic for it over HTTPS. You have three options for this:

   • Generate a free Let’s Encrypt certificate, managed by Scaleway, including automatic renewals.
   • Select an existing certificate that you have stored in Scaleway Secret Manager.
   • Manually import a certificate into Scaleway Secret Manager:
     • Enter a name for your certificate (alphanumeric characters only)
     • Optionally, add tags by typing each tag and then pressing enter
     • Copy and paste the full PEM-formatted certificate chain into the box. Your certificate will be automatically stored in Secret Manager and billed accordingly.
   Tip

   For help with SSL/TLS certificates for Edge Services, and/or dealing with any errors you encounter importing a certificate into Secret Manager, see our dedicated documentation.

6. Click Customize domain to finish.

Your customized domain is set up, and you are returned to the Edge Services dashboard. The customized domain displays in the Endpoint panel. When you access your Object Storage or Load Balancer origin through this domain, its content will be served via Edge Services.

How to configure your cache

The cache feature allows you to cache your origin’s content with Edge Services. This means that content can be served directly to users from Edge Services’ servers, instead of from your Object Storage bucket or Load Balancer origin, enhancing performance.

You can disable and enable caching at will, as well as control the lifetime of an object in the cache. You can also purge your entire cache, or specific objects within it. A log is displayed to help you track your purge events.

1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer origin for which you want to enable caching:

   

2. In the Cache panel, use the «Toogle Icon» icon to enable the cache.

   The Lifetime configuration box displays. This enables you to define, in seconds, how long an object can be stored in the cache before it must be retrieved freshly from the origin (Object Storage bucket or Load Balancer).

   
   Tip

   As an example, a value of 0 means that objects will not be cached, unless they have a separately-defined caching directive. Note that in any case, if an object has a caching directive, the caching directive always takes precedence over any lifetime setting defined here in Edge Services.

3. Leave the default value of 1 hour in place, or enter another value.

The cache is now enabled.

For information on purging your cache, see our dedicated documentation.

How to delete an Edge Services pipeline

You can delete an Edge Services pipeline at any time. Follow the steps below, depending on whether your pipeline is towards an Object Storage bucket origin or a Load Balancer origin.

• Object Storage bucket
• Load Balancer