From 1ea89e81c265ed2636dbacc019f2b645816f87ea Mon Sep 17 00:00:00 2001 From: Rowena Date: Wed, 24 Jul 2024 18:04:28 +0200 Subject: [PATCH 1/5] feat(edge): how to content --- menu/navigation.json | 2 +- network/edge-services/concepts.mdx | 48 ++++++- .../assets/scaleway-edge-services-cache.webp | Bin ...ay-edge-services-certificate-complete.webp | Bin ...aleway-edge-services-configure-domain.webp | Bin .../scaleway-edge-services-customised.webp | Bin .../scaleway-edge-services-dashboard.webp | Bin .../scaleway-edge-services-metrics.webp | Bin .../scaleway-edge-services-purge-cache.webp | Bin .../scaleway-edge-services-purge-object.webp | Bin .../scaleway-edge-services-select-bucket.webp | Bin .../assets/scaleway-edge-services-splash.webp | Bin .../edge-services/how-to/configure-cache.mdx | 103 ++++++++++++++ .../how-to/configure-custom-domain.mdx | 123 +++++++++++++++++ .../how-to/create-pipeline-bucket.mdx | 78 +++++++++++ .../how-to/create-pipeline-lb.mdx | 130 ++++++++++++++++++ .../edge-services/how-to/delete-pipeline.mdx | 27 ++++ .../edge-services/how-to/monitor-cockpit.mdx | 81 +++++++++++ 18 files changed, 590 insertions(+), 2 deletions(-) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-cache.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-certificate-complete.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-configure-domain.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-customised.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-dashboard.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-metrics.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-purge-cache.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-purge-object.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-select-bucket.webp (100%) rename {storage/object => network/edge-services}/how-to/assets/scaleway-edge-services-splash.webp (100%) create mode 100644 network/edge-services/how-to/configure-cache.mdx create mode 100644 network/edge-services/how-to/configure-custom-domain.mdx create mode 100644 network/edge-services/how-to/create-pipeline-bucket.mdx create mode 100644 network/edge-services/how-to/create-pipeline-lb.mdx create mode 100644 network/edge-services/how-to/delete-pipeline.mdx create mode 100644 network/edge-services/how-to/monitor-cockpit.mdx diff --git a/menu/navigation.json b/menu/navigation.json index fecbe3aa4c..b9bc2b7b16 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -2809,7 +2809,7 @@ }, { "label": "Create a Load Balancer pipeline", - "slug": "create-pipeine-lb" + "slug": "create-pipeline-lb" }, { "label": "Configure a custom domain", diff --git a/network/edge-services/concepts.mdx b/network/edge-services/concepts.mdx index 3ad0a0927c..e3cad014f9 100644 --- a/network/edge-services/concepts.mdx +++ b/network/edge-services/concepts.mdx @@ -11,4 +11,50 @@ dates: validation: 2024-07-24 categories: - networks ---- \ No newline at end of file +--- + +TODO INSERT OVERALL DIAGRAM + +### Pipeline + +An Edge Services pipeline consists of an [origin](#origin) for which Edge Services requests and [caches](#cache) content, and an [endpoint](#endpoint) from which this content is served via Edge Services. The pipeline's endpoint can be customized with a user-defined [subdomain](#subdomain) and associated [certificate](#certificate) so that Edge Services can serve content over HTTPS. + +You can create one or more Edge Services pipelines for each of your Load Balancers. If creating multiple pipelines for the same origin Load Balancer, each one must be configured for a different frontend. + +### Origin + +The primary source from which an Edge Services pipeline retrieves and caches data. An origin consists of the [Load Balancer](#origin-load-balancer) and frontend port that Edge Services connects to to request content, and (optionally) a specified [host](#origin-host) associated with the Load Balancer, used in the HTTP request Host Header. + +### Origin Load Balancer + +The Load Balancer defined by the user as origin for a given Edge Services pipeline. The pipeline connects to this Load Balancer, on the specified frontend port to request content. + +### Protocol + +The protocol (HTTP or HTTPS) that the Edge Services pipeline should use when sending requests to the origin. HTTPS is recommended, but you should choose the protocol that corresponds with your Load Balancer setup. + +### Origin host + +The specific host for which Edge Services requests and caches data. This is an optional setting: when specified, this host (e.g. `mydomain.com`) is used in the HTTP Host Header when Edge Services requests data from the Load Balancer. If no origin host is specified, the Load Balancer's IP address is used in the Host Header. + +The origin host must be associated with the origin Load Balancer / its backend servers, and only one host may be set per pipeline. If your Load Balancer is in front of multiple hosts, you can create a separate Edge Services pipeline for each. Each host will therefore get its own Edge Services endpoint and cache. + +### Cache + +The storage location where Edge Services stores copies of content that it has retrieved from a given Load Balancer origin. When users request content from the Edge Services endpoint, it serves content directly from the cache wherever possible, in accordance with the caching rules defined by the user. This reduces load on the Load Balancer and its backend servers. + +Note that if an object has a caching directive, the caching directive always takes precedence over any lifetime setting defined in Edge Services. + +### Endpoint + +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 Load Balancer and its backend servers directly. Edge Services automatically manages redirection from HTTP to HTTPS + +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) will be required, in this case. + +### Certificate + +The SSL/TLS certificate for your subdomain to enable Edge Services to serve content over HTTPS, if you have customized your [Edge Services endpoint](#endpoint). You can choose between uploading your own certificate held in Scaleway Secret Manager, or letting Edge Services generate a fully-managed Let's Encrypt certificate. + +### CNAME record + +The CNAME record pointing your subdomain to the Edge Services endpoint, if you have customized your [Edge Services endpoint](#endpoint). This is necessary to ensure that traffic for your customized subdomain is correctly directed towards the Edge Services endpoint by DNS servers. \ No newline at end of file diff --git a/storage/object/how-to/assets/scaleway-edge-services-cache.webp b/network/edge-services/how-to/assets/scaleway-edge-services-cache.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-cache.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-cache.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-certificate-complete.webp b/network/edge-services/how-to/assets/scaleway-edge-services-certificate-complete.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-certificate-complete.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-certificate-complete.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-configure-domain.webp b/network/edge-services/how-to/assets/scaleway-edge-services-configure-domain.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-configure-domain.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-configure-domain.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-customised.webp b/network/edge-services/how-to/assets/scaleway-edge-services-customised.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-customised.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-customised.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-dashboard.webp b/network/edge-services/how-to/assets/scaleway-edge-services-dashboard.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-dashboard.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-dashboard.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-metrics.webp b/network/edge-services/how-to/assets/scaleway-edge-services-metrics.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-metrics.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-metrics.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-purge-cache.webp b/network/edge-services/how-to/assets/scaleway-edge-services-purge-cache.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-purge-cache.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-purge-cache.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-purge-object.webp b/network/edge-services/how-to/assets/scaleway-edge-services-purge-object.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-purge-object.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-purge-object.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-select-bucket.webp b/network/edge-services/how-to/assets/scaleway-edge-services-select-bucket.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-select-bucket.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-select-bucket.webp diff --git a/storage/object/how-to/assets/scaleway-edge-services-splash.webp b/network/edge-services/how-to/assets/scaleway-edge-services-splash.webp similarity index 100% rename from storage/object/how-to/assets/scaleway-edge-services-splash.webp rename to network/edge-services/how-to/assets/scaleway-edge-services-splash.webp diff --git a/network/edge-services/how-to/configure-cache.mdx b/network/edge-services/how-to/configure-cache.mdx new file mode 100644 index 0000000000..2b753f736d --- /dev/null +++ b/network/edge-services/how-to/configure-cache.mdx @@ -0,0 +1,103 @@ +--- +meta: + title: How to configure an Edge Services cache + description: Learn how to configure a cache for Edge Services. Enhance performance and finely control your cached objects via purging (cache invalidation). +content: + h1: How to configure an Edge Services cache + paragraph: Learn how to configure a cache for Edge Services. Enhance performance and finely control your cached objects via purging (cache invalidation). +dates: + validation: 2024-07-24 + posted: 2024-07-24 +tags: object storage edge services edge-services cdn content delivery network cache invalidation purge +categories: + - network +--- + +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. + +## How to enable the cache + +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: + + TODO INSERT SCREENSHOT + +2. In the **Cache** panel, use the 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). + + TODO CHECK + + + 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. + +## How to purge all objects from your cache + +This clears all objects from your cache. Afterwards, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. + +1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer origin whose cache you want to purge: + + TODO INSERT SCREENSHOT + +2. In the **Purge cache** panel, click **Purge all**. + + TODO CHECK + + A screen displays warning you that your cache will be emptied, and Edge Services will have to retrieve objects from your origin before re-caching them. + +3. Click **Purge cache** to confirm. + +## How to purge specific objects from your cache + +This allows you to specify the precise objects that you want to clear from the cache. Afterwards, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. + +1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer origin whose cache you want to purge: + + TODO INSERT SCREENSHOT + +2. In the **Purge cache** panel, click **Purge by object**. + + TODO CHECK + + A screen displays prompting you to enter the path of each object you want to purge from the cache. + + TODO CHECK + +3. Enter the path of each object you want to purge. You can purge a maximum of 5 objects at a time. + + + + The path for each object should be defined from the root and must start with a slash, e.g. `/videos/my-video.mp4`. + + You **cannot** purge entire directories by simply specifying the path to the directory, e.g. `/videos`. Purging objects must done strictly object-by-object, so `/videos/my-video1.mp4`, `/videos/my-video2.mp4`, `/videos/my-video3.mp4` etc. Watch this space for updates to this feature in the future. + + For example, if we imagine a Object Storage bucket containing one file at the root level called `object1.jpg`, and a subfolder at root level called `videos` containing an item called `my-video.mp4`, we would enter the object paths as follows: + + - `/object1.jpg` + - `/videos/my-video.mp4` + + + +4. Click **Purge objects from cache** + + The specified objects are purged from your cache and you are returned to the Edge Services dashboard. + +## How to disable your cache + +1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer origin whose cache you want to disable: + + TODO INSERT SCREENSHOT + +2. In the **Cache** panel, use the icon to disable the cache. + + A pop-up displays, asking you to confirm the action. + +3. Click **Disable cache**. + + Your cache is purged and disabled. Edge Services will now serve content by fetching it from your origin (Object Storage bucket or Load Balancer) directly. If you reenable your cache at a later point, you will begin with an empty cache. \ No newline at end of file diff --git a/network/edge-services/how-to/configure-custom-domain.mdx b/network/edge-services/how-to/configure-custom-domain.mdx new file mode 100644 index 0000000000..be57e63cd4 --- /dev/null +++ b/network/edge-services/how-to/configure-custom-domain.mdx @@ -0,0 +1,123 @@ +--- +meta: + title: How to configure a custom domain for Edge Services + description: Learn how to configure an Edge Services endpoint with a custom subdomain. Access your Object Storage bucket or Load Balancer origin via your own domain name instead of the standardized endpoint. +content: + h1: How to configure a custom domain for Edge Services + paragraph: Learn how to configure an Edge Services endpoint with a custom subdomain. Access your Object Storage bucket or Load Balancer origin via your own domain name instead of the standardized endpoint. +dates: + validation: 2024-07-24 + posted: 2024-07-24 +tags: object storage edge services edge-services cdn content delivery network domain certificate ssl tls custom-domain https +categories: + - network +--- + +If you already own a domain, you customize an Edge Services pipeline endpoint with a subdomain of your choice. 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. + +For example, if you own `beautiful-domain.com`, you can customize the endpoint to be `whatever-i-want.beautiful-domain.com`. You must also add an SSL/TLS certificate so that Edge Services can securely serve your content via HTTPS. + +You cannot customize your endpoint with a primary domain directly (e.g. `beautiful-domain.com`), only with a subdomain of it. + +## How to configure a custom domain + +The procedure for adding a customized endpoint is as follows: + +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: + + TODO INSERT SCREENSHOT + +2. In the **Endpoint** panel, click **Configure domain**. The following screen displays: + + TODO SCREENSHOT + +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. + + + 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](https://www.scaleway.com/en/docs/network/domains-and-dns/), or an external domain provider. Choose the appropriate tab below. + + + + + The domain you are using for Edge Services is considered to be managed with Scaleway Domains and DNS if: + - You [registered the domain](/network/domains-and-dns/how-to/register-internal-domain/) with Domains and DNS, or + - You [transferred an externally-registered domain](/network/domains-and-dns/how-to/transfer-external-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](/network/domains-and-dns/how-to/manage-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](/network/domains-and-dns/how-to/manage-dns-records/) in the Scaleway console. + + + + Scaleway cannot itself create the appropriate CNAME record to point your subdomain to Edge Services if your domain is managed by an external provider. You must create the CNAME record yourself. + + Log into your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services pipeline endpoint displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](TODO) + + Back in the Scaleway console, click the `Verify CNAME` button to check whether your CNAME record has been correctly configured. Edge Services will carry out a check, and if it is successful the following message displays: + + TODO CHECK + + If the check fails, an error message will display. See the documentation linked above for help troubleshooting such errors. + + + +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](/identity-and-access-management/secret-manager/quickstart/). + - 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](TODO LINK). + + + 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](TODO LINK). + + +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. + + +If you chose to generate a managed Let's Encrypt certificate, allow a few minutes for the certificate to finish creating. When the process is complete and the certificate is ready, you will see a green status light for **SSL/TLS certificate** on your endpoint dashboard. + + TODO CHECK + + + +## How to edit your customized domain or its certificate + +After customizing your domain, you can edit it (or its certificate) at any time as follows: + +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: + + TODO INSERT SCREENSHOT + +2. In the **Endpoint** panel, click **Edit**. The **Edit Domain** screen displays. + +3. Edit the subdomain as desired - do not forget to also set up a new CNAME record, if necessary. + +4. Edit your certificate options as required - choose to generate a managed Let's Encrypt certificate, managed by Scaleway including automatic renewals, or select a different certificate from Secret Manager, or manually import a new certificate for your custom domain. + +5. Click **Edit domain** to finish. + +## How to reset your customized domain + +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: + +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 reset: + + TODO INSERT SCREENSHOT + +2. In the **Endpoint** panel, click **Reset**. + + A screen displays warning you that this will reset the pipeline's domain back to the default Edge Services endpoint. Edge Services will consider your customized subdomain as unknown. You should also remember to: + - Delete your CNAME record from your domain provider, unless your domain is managed with Scaleway Domains and DNS, in which case we take care of deletion for you. + - Delete any SSL/TLS certificates you imported into Secret Manager (if no longer required elsewhere, so that you are no longer billed for it). If you generated a managed Let's Encrypt certificate however, Scaleway takes care of the deletion for you. + +3. Click **Reset domain** to finish. diff --git a/network/edge-services/how-to/create-pipeline-bucket.mdx b/network/edge-services/how-to/create-pipeline-bucket.mdx new file mode 100644 index 0000000000..afab8a8089 --- /dev/null +++ b/network/edge-services/how-to/create-pipeline-bucket.mdx @@ -0,0 +1,78 @@ +--- +meta: + title: How to create an Edge Services pipeline for an Object Storage bucket + description: This page explains how to configure an Edge Services pipeline for a Scaleway Object Storage bucket. Set up your own custom domain to point to your bucket, and enable a caching service for faster and more efficient delivery. +content: + h1: How to create an Edge Services pipeline for an Object Storage bucket + paragraph: This page explains how to configure an Edge Services pipeline for a Scaleway Object Storage bucket. Set up your own custom domain to point to your bucket, and enable a caching service for faster and more efficient delivery. +dates: + validation: 2024-07-24 + posted: 2024-07-24 +tags: object storage edge services edge-services cdn content delivery network cache domain certificate custom-domain https +categories: + - network +--- + +Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets, currently available in [Public Beta](https://www.scaleway.com/en/betas/). + +Enabling Edge Services on your Object Storage bucket creates an Edge Services pipeline which brings you a number of possible benefits: + +- Customize your bucket's endpoint using a subdomain of your own domain +- Add your own SSL/TLS certificate, safeguarded in [Scaleway Secret Manager](/identity-and-access-management/secret-manager/quickstart/), or generate a managed Let's Encrypt certificate, so your subdomain can serve content from your bucket over HTTPS +- Enhance performance by caching your stored objects, to be served directly by Edge Services from the cache +- Finely control your cached objects via purging (cache invalidation) + +Read on to learn how to create an Edge Services pipeline by enabling Edge Services on your bucket. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- An [Object Storage bucket](/storage/object/how-to/create-a-bucket/) + +## How to create an Edge Services pipeline + +Edge Services is available as a feature on Object Storage buckets. You enable it on a bucket-by-bucket basis. When you enable Edge Services on a particular bucket, a [pipeline](/network/edge-services/concepts/#pipeline) is automatically created for that bucket. + +1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. + +2. Click the name of the bucket you want to enable Edge Services on. + + +3. Click the **Edge Services** tab. + + + +4. Click **Enable Edge Services for free**. + + A pop-up informs you that your bucket will be exposed via Edge Services and that you can disable Edge Services at any time. Edge Services is free during the beta stage, and you will be notified before it becomes billable. + +5. Click **Enable Edge Services** to confirm. + + Edge Services is enabled on your bucket, and a pipeline is automatically created. Various features are now visible on the Edge Services tab, ready to be configured. + + + + + + Your bucket's [visibility](/storage/object/concepts/#visibility) can be set to **private**, but any objects within it that you want to expose via Edge Services must be set to [**public** visibility](/storage/object/how-to/manage-object-visibility/). However, in the case that you are using Edge Services with bucket website (see below), objects can remain private. + + + + + Note the following important information about using Edge Services with the [bucket website](/storage/object/how-to/use-bucket-website/) feature: + - **If you want to use bucket website and Edge Services**: Ensure that you activate bucket website **before** you enable Edge Services. Avoid deactivating bucket website afterwards.

+ - **If you do not want to use bucket website**: Simply enable Edge Services. Note however that if you activate bucket website after this, Edge Services will not be able to serve your bucket website URLs, and will continue to serve the regular bucket URLs.

+ - **If you want to change your bucket website setting**: Disable Edge Services first, activate or deactivate bucket website as you wish, and then enable Edge Services. Edge Services will now pick up the new configuration, and will serve content from your bucket website URLS if bucket website is activated, or from your regular bucket URLs if bucket website is deactivated. + + +## How to access your bucket via Edge Services + +Once you have enabled Edge Services on your bucket, you can access your bucket and its content via the following endpoints (replace `bucket-name` with the name of your bucket.) + +| Endpoint | Where to find this endpoint in the console | Notes | +|-----------------------------------------|--------------------------|-----------------------------------------------------------------------------------| +| `https://bucket-name.s3.nl-ams.scw.cloud` | The **Bucket settings** tab | Edge Services is bypassed when bucket is accessed via this endpoint | +| `https://bucket-name.svc.edge.scw.cloud` | The **Edge Services** tab | Edge Services serves bucket content when this endpoint is used | + +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](TODO LINK). \ No newline at end of file diff --git a/network/edge-services/how-to/create-pipeline-lb.mdx b/network/edge-services/how-to/create-pipeline-lb.mdx new file mode 100644 index 0000000000..5db1f3608d --- /dev/null +++ b/network/edge-services/how-to/create-pipeline-lb.mdx @@ -0,0 +1,130 @@ +--- +meta: + title: How to create an Edge Services pipeline for a Load Balancer + description: This page explains how to configure an Edge Services pipeline on your Load Balancer, enabling a caching service for faster and more efficient delivery. +content: + h1: How to create an Edge Services pipeline for a Load Balancer + paragraph: This page explains how to configure an Edge Services pipeline on your Load Balancer, enabling a caching service for faster and more efficient delivery. +dates: + validation: 2024-07-24 + posted: 2024-07-24 +tags: load-balancer edge services edge-services cdn content delivery network cache domain certificate custom-domain https +categories: + - network +--- + +Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets, currently available in [Public Beta](https://www.scaleway.com/en/betas/). + +Creating an Edge Services pipeline for your Load Balancer helps to reduce load on your Load Balancer's backend servers. The origin configuration you define is used by Edge Services to connect to your Load Balancer and request content, which is then stored in the cache. Then, when your Load Balancer origin is accessed via its customizable Edge Services endpoint, the requested content is served from the cache (if present), without the need to fetch this content via the Load Balancer and its backend servers. + +Edge Services lets you: + +- Define the specific origin (Load Balancer, frontend port and host) for a given pipeline and its associated cache +- Choose the TTL for cached objects +- Purge the entire cache or specific cached objects at any time (cache invalidation) +- Customize your Edge Services pipeline endpoint using a subdomain of your own domain +- Add an SSL/TLS certificate so that Edge Services can serve content over HTTPS for your subdomain + +An Edge Services pipeline can be created for any Load Balancer with a public IP address. Load Balancers with frontends/backends using both TCP and/or HTTP are supported. [Private Load Balancers](/network/load-balancer/reference-content/public-private-accessibility/#private-load-balancers) are not compatible with Edge Services. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- A [Load Balancer](/network/load-balancer/how-to/create-load-balancer/) + +## How to create an Edge Services pipeline for Load Balancer + +You can create one or more Edge Services pipelines for each of your Load Balancers. Each pipeline has its own [origin](/network/edge-services/concepts/#origin), [endpoint](/network/edge-services/concepts/#endpoint) and [cache](/network/edge-services/concepts/#cache). If you create multiple Edge Services pipelines for the same origin Load Balancer, each one must be configured for a different frontend. + +Follow the steps below to create an Edge Services pipeline. + +1. Click **Load Balancers** in the **Network** section of the Scaleway console side menu. The list of your Load Balancers displays. + +2. Click the **Edge Services** tab. + +3. Click **create Edge Services pipeline**. The pipeline creation wizard displays. + + TODO SCREENSHOT + +4. Configure the [origin](/network/edge-services/concepts/#origin) for this pipeline: + - Select the **origin Load Balancer** from the dropdown list. The Edge Services pipeline will connect to this Load Balancer when requesting content. + - Select a **frontend** associated with the origin Load Balancer from the dropdown list. The Edge Services pipeline will connect to the Load Balancer on this port when requesting content. We recommend that you select an HTTPS port, e.g. `443`. + + + For Kubernetes Load Balancers, see our [dedicated documentation](#help-for-kubernetes-load-balancers) for help selecting the correct Load Balancer and frontend. + + +5. Define the protocol and origin host for this pipeline: + - Select the protocol that Edge Services should use when making requests to the origin, either `HTTP` or `HTTPS` (recommended). Choose the protocol that corresponds with your Load Balancer setup. + - Optionally, enter an [origin host](/network/edge-services/concepts/#origin-host) associated with your Load Balancer for this pipeline. When specified, this host replaces the Load Balancer IP address in the HTTP Host Header of the requests made from Edge Services to your Load Balancer. + +6. Enter a name for this Edge Services pipeline, or leave the auto-generated name in place. + + Edge Services for Load Balancer is free during Public Beta. You will be notified before the service leaves beta and becomes billable. + +7. Click **Create Edge Services pipeline** to finish. + +Your pipeline is created and your are taken to its **Overview** page. The endpoint displays from which you can access your Load Balancer origin via Edge Services, e.g. `https://pipeline-id.edge.scw.cloud` + +## Troubleshooting pipeline creation + +If you see the message `Edge Services was unable to contact the host via the Load Balancer Please check your origin configuration settings and try again`, check the following elements of your configuration: + +- **Protocol**: Ensure you did not select the wrong protocol, e.g. HTTP selected while the frontend chosen is configured to receive HTTPS, or the opposite. +- **Origin host**: Ensure that you entered the correct origin host, with no typos, for a host that exists behind the selected Load Balancer. +- **Load Balancer ACLs**: Ensure that there are no [ACLs](/network/load-balancer/how-to/create-manage-acls/) configured on your Load Balancer which are blocking traffic from Edge Services. + +## Help for Kubernetes Load Balancers + +If you are setting up an Edge Services pipeline for a [Kubernetes Kapsule](/containers/kubernetes) Load Balancer, follow these steps to determine which Load Balancer and frontend to configure for your pipeline: + +1. Run `kubectl describe svc`. + + An output displays. + +2. Locate the section of the output that relates to your LoadBalancer service. It should look something like this: + + ``` + Name: myloadbalancer + Namespace: default + Labels: app=mydeployment + Annotations: service.beta.kubernetes.io/scw-loadbalancer-id: fr-par-1/a92de52e-262f-99f9-be66-5220003a2e42 + Selector: app=mydeployment + Type: LoadBalancer + IP Family Policy: SingleStack + IP Families: IPv4 + IP: 10.32.220.60 + IPs: 10.32.220.60 + LoadBalancer Ingress: 51.159.25.111 + Port: http 8000/TCP + TargetPort: 8000/TCP + NodePort: http 32041/TCP + Endpoints: + Session Affinity: None + External Traffic Policy: Cluster + ``` +3. Find the `service.beta.kubernetes.io/scw-loadbalancer-id` annotation, and note your Load Balancer ID (e.g. `a92de52e-262f-99f9-be66-5220003a2e42`). Check your Load Balancer list in the [console](https://console.scaleway.com/load-balancer/lbs) to find the Load Balancer name that corresponds to this ID. This is the Load Balancer you should select for the Edge Services pipeline. + +4. Find the **NodePort** line and note the port mentioned (in the case above, `32041`). In the [console](https://console.scaleway.com/load-balancer/lbs), find the frontend of the Load Balancer from step 3 that corresponds with this port. This is the frontend and port you should select for the Edge Services pipeline. + +## How to edit an Edge Services pipeline origin + +You can edit the protocol, origin host and name of an Edge Services pipeline as follows. + +1. Click **Load Balancers** in the **Network** section of the Scaleway console side menu. The list of your Load Balancers displays. + +2. Click the **Edge Services** tab. + +3. Click the Edge Services pipeline you want to edit. The **Overview** page for the pipeline displays. + +4. In the top right corner, click **Edit**. A pop-up displays. + + TODO INSERT SCREENSHOT + +5. Make the edits required. You can: + - Change the **protocol** + - Change the **origin host** + - Change the pipeline **name** + +6. Click **Save**. \ No newline at end of file diff --git a/network/edge-services/how-to/delete-pipeline.mdx b/network/edge-services/how-to/delete-pipeline.mdx new file mode 100644 index 0000000000..772b20a4dd --- /dev/null +++ b/network/edge-services/how-to/delete-pipeline.mdx @@ -0,0 +1,27 @@ +## How to disable Edge Services + +You can disable Edge Services at any time via the following procedure: + +1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. + +2. Click the name of the bucket you want to disable Edge Services for. + +3. Click the **Edge Services** tab. + + + +4. In the **Disable Edge Services** panel at the bottom of the screen, click **Disable Edge Services**. + + A pop-up displays, informing you that the bucket will be removed from Edge Services. + - The bucket will no longer be accessible via its Edge Services endpoint, or any customized domains pointing to this endpoint. + - Any files stored in the Edge Services cache will be removed. + + + Remember to: + - Delete your CNAME record from your domain provider, unless your domain is managed with Scaleway Domains and DNS, in which case we take care of deletion for you. + - Delete any SSL/TLS certificates you imported into Secret Manager (if no longer required elsewhere, so that you are no longer billed for it). If you generated a managed Let's Encrypt certificate however, Scaleway takes care of the deletion for you. + + +5. Click **Disable Edge Services**. + + Edge Services is disabled. You can enable it again at any time, but you will need to reconfigure your custom domain, and the cache will initially be empty. \ No newline at end of file diff --git a/network/edge-services/how-to/monitor-cockpit.mdx b/network/edge-services/how-to/monitor-cockpit.mdx new file mode 100644 index 0000000000..d60292a64b --- /dev/null +++ b/network/edge-services/how-to/monitor-cockpit.mdx @@ -0,0 +1,81 @@ +--- +meta: + title: How to monitor Edge Services with Scaleway Cockpit + description: Get easy access to your Edge Services metrics via Scaleway Cockpit. Monitor ingress, egress, request rate and cache hit ratio in a convenient managed Grafana dashboard. +content: + h1: How to monitor Edge Services with Scaleway Cockpit + paragraph: Get easy access to your Edge Services metrics via Scaleway Cockpit. Monitor ingress, egress, request rate and cache hit ratio in a convenient managed Grafana dashboard. +dates: + validation: 2024-07-24 + posted: 2024-07-24 +tags: load-balancer edge services edge-services cdn content delivery network metrics cache-hit-ratio grafana observability +categories: + - network +--- + +You can view your Edge Services metrics via [Scaleway Cockpit](/observability/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard. + +Access your Edge Services dashboard in the Scaleway console via the shortcut in the Edge Services tab of the pipeline in question. Note that you will first need to [create a Grafana user and credentials](https://www.scaleway.com/en/docs/observability/cockpit/how-to/retrieve-grafana-credentials/). + +CHECK FROM HERE + +### Understanding the dashboard + +The Grafana dashboard presents a number of different metrics. Use the drop-down in the top left to select which pipeline and origin to view Edge Services metrics for, and the time range drop-down in the top right to modify the time period to apply to the metrics. + + + +- **Request rate**: The number of requests made to Edge Services per second, for the specified origin, averaged over the specified time period. +- **Cache hit ratio**: The percentage of requests served from Edge Services' cache, compared to the total number of requests in total to Edge Services for this origin, over the specified time period. +- **Cache HIT/MISS**: A visual representation of the ratio of cache hits to misses, for the specified origin, over the specified time period. + - **Cache hit line**: The number of requests per second made to Edge Services for this origin, which were served directly from its cache. + - **Cache miss line**: The number of requests per second made to Edge Services for this origin, where the content was fetched from the origin rather than the cache. + - **Total line**: The number of requests per second made to Edge Services for this origin. + +- **Egress (to client)**: The total volume of data served to clients from Edge Services, for the specified origin, over the specified time period. +- **Ingress (from origin)**: The total volume of data from the origin server to Edge Services over the specified time period. This represents the traffic that occurs when Edge Services retrieves content from the origin server in order to fulfill requests. +- **Edge Services throughput**: A visual representation of the rate of data transfer for the specified origin with Edge Services over the specified time period. + - **Output bitrate line**: The rate at which data is being delivered from Edge Services to end users. + - **Input bitrate line**: The rate at which Edge Services is fetching data from the origin server. Peaks in this line may represent times when Edge Services had to fetch content from the origin server, rather than being able to serve it directly from its own cache. + +- **Requests served**: The total number of requests that Edge Services has successfully served, for the specified origin, over the specified time period. +- **Edge Services response statuses**: A visual representation of the distribution of HTTP response statuses for requests served by Edge Services over the specified time period. Consult [the full list of HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for more information if necessary. + +- **Request origin country**: The proportion of requests (to Edge Services for the specified origin over the specified time period) originating from different countries. +- **End users location**: A visual representation of where Edge Services end users have been making requests from geographically. + +--- + +OBJECT STORAGE + + +## How to monitor Edge Services with Scaleway Cockpit + +You can view your Edge Services metrics via [Scaleway Cockpit](/observability/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard. + +Access your Edge Services dashboard in the Scaleway console via the shortcut in Edge Services tab of the bucket in question. Note that you will first need to [create a Grafana user and credentials](https://www.scaleway.com/en/docs/observability/cockpit/how-to/retrieve-grafana-credentials/). + +### Understanding the dashboard + +The Grafana dashboard presents a number of different metrics. Use the `Bucket name` drop-down in the top left to select which bucket to view Edge Services metrics for, and the time range drop-down in the top right to modify the time period to apply to the metrics. + + + +- **Request rate**: The number of requests made to Edge Services per second, for the specified bucket, averaged over the specified time period. +- **Cache hit ratio**: The percentage of requests served from Edge Services' cache, compared to the total number of requests in total to Edge Services for this bucket, over the specified time period. +- **Cache HIT/MISS**: A visual representation of the ratio of cache hits to misses, for the specified bucket, over the specified time period. + - **Cache hit line**: The number of requests per second made to Edge Services for this bucket, which were served directly from its cache. + - **Cache miss line**: The number of requests per second made to Edge Services for this bucket, where the content was fetched from the bucket rather than the cache. + - **Total line**: The number of requests per second made to Edge Services for this bucket. + +- **Egress (to client)**: The total volume of data served to clients from Edge Services, for the specified bucket, over the specified time period. +- **Ingress (from origin)**: The total volume of data from the origin bucket's server to Edge Services over the specified time period. This represents the traffic that occurs when Edge Services retrieves content from the bucket's server in order to fulfill requests. +- **Edge Services throughput**: A visual representation of the rate of data transfer for the specified bucket with Edge Services over the specified time period. + - **Output bitrate line**: The rate at which data is being delivered from Edge Services to end users. + - **Input bitrate line**: The rate at which Edge Services is fetching data from the origin bucket server. Peaks in this line may represent times when Edge Services had to fetch content from the origin bucket, rather than being able to serve it directly from its own cache. + +- **Requests served**: The total number of requests that Edge Services has successfully served, for the specified bucket, over the specified time period. +- **Edge Services response statuses**: A visual representation of the distribution of HTTP response statuses for requests served by Edge Services over the specified time period. Consult [the full list of HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for more information if necessary. + +- **Request origin country**: The proportion of requests (to Edge Services for the specified bucket over the specified time period) originating from different countries. +- **End users location**: A visual representation of where Edge Services end users have been making requests from geographically. From 084316d04f5f92207a6c9ab07183b3d253676062 Mon Sep 17 00:00:00 2001 From: Rowena Date: Thu, 25 Jul 2024 15:18:41 +0200 Subject: [PATCH 2/5] feat(edge): how tos --- menu/navigation.json | 4 - .../how-to/configure-custom-domain.mdx | 6 +- .../how-to/create-pipeline-bucket.mdx | 2 +- .../how-to/create-pipeline-lb.mdx | 3 +- .../edge-services/how-to/delete-pipeline.mdx | 47 ++- .../edge-services/how-to/monitor-cockpit.mdx | 40 +- .../how-to/get-started-edge-services.mdx | 350 +----------------- 7 files changed, 53 insertions(+), 399 deletions(-) diff --git a/menu/navigation.json b/menu/navigation.json index b9bc2b7b16..4ae4afa5ce 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -3772,10 +3772,6 @@ "label": "Use Object Storage with Private Networks", "slug": "use-obj-stor-with-private-networks" }, - { - "label": "Use Object Storage with Edge Services", - "slug": "get-started-edge-services" - }, { "label": "Delete an object", "slug": "delete-an-object" diff --git a/network/edge-services/how-to/configure-custom-domain.mdx b/network/edge-services/how-to/configure-custom-domain.mdx index be57e63cd4..cd16a3eb2b 100644 --- a/network/edge-services/how-to/configure-custom-domain.mdx +++ b/network/edge-services/how-to/configure-custom-domain.mdx @@ -56,7 +56,7 @@ The procedure for adding a customized endpoint is as follows: Scaleway cannot itself create the appropriate CNAME record to point your subdomain to Edge Services if your domain is managed by an external provider. You must create the CNAME record yourself. - Log into your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services pipeline endpoint displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](TODO) + Log into your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services pipeline endpoint displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](/network/edge-services/reference-content/cname-record/) Back in the Scaleway console, click the `Verify CNAME` button to check whether your CNAME record has been correctly configured. Edge Services will carry out a check, and if it is successful the following message displays: @@ -73,10 +73,10 @@ The procedure for adding a customized endpoint is as follows: - 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](TODO LINK). + Your certificate will be automatically stored in Secret Manager and [billed accordingly](https://www.scaleway.com/en/pricing/security-and-account/). - 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](TODO LINK). + 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](/network/edge-services/reference-content/ssl-tls-certificate/). 6. Click **Customize domain** to finish. diff --git a/network/edge-services/how-to/create-pipeline-bucket.mdx b/network/edge-services/how-to/create-pipeline-bucket.mdx index afab8a8089..42edb42752 100644 --- a/network/edge-services/how-to/create-pipeline-bucket.mdx +++ b/network/edge-services/how-to/create-pipeline-bucket.mdx @@ -75,4 +75,4 @@ Once you have enabled Edge Services on your bucket, you can access your bucket a | `https://bucket-name.s3.nl-ams.scw.cloud` | The **Bucket settings** tab | Edge Services is bypassed when bucket is accessed via this endpoint | | `https://bucket-name.svc.edge.scw.cloud` | The **Edge Services** tab | Edge Services serves bucket content when this endpoint is used | -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](TODO LINK). \ No newline at end of file +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](/network/edge-services/how-to/configure-custom-domain/). \ No newline at end of file diff --git a/network/edge-services/how-to/create-pipeline-lb.mdx b/network/edge-services/how-to/create-pipeline-lb.mdx index 5db1f3608d..a3f24b47a6 100644 --- a/network/edge-services/how-to/create-pipeline-lb.mdx +++ b/network/edge-services/how-to/create-pipeline-lb.mdx @@ -49,10 +49,11 @@ Follow the steps below to create an Edge Services pipeline. 4. Configure the [origin](/network/edge-services/concepts/#origin) for this pipeline: - Select the **origin Load Balancer** from the dropdown list. The Edge Services pipeline will connect to this Load Balancer when requesting content. - - Select a **frontend** associated with the origin Load Balancer from the dropdown list. The Edge Services pipeline will connect to the Load Balancer on this port when requesting content. We recommend that you select an HTTPS port, e.g. `443`. + - Select a **frontend** associated with the origin Load Balancer from the dropdown list. The Edge Services pipeline will connect to the Load Balancer on this port when requesting content. We recommend that you select an HTTPS port, e.g. `443`. Note that if you are creating multiple pipelines for the same origin Load Balancer, each one must be configured for a different frontend. For Kubernetes Load Balancers, see our [dedicated documentation](#help-for-kubernetes-load-balancers) for help selecting the correct Load Balancer and frontend. + 5. Define the protocol and origin host for this pipeline: diff --git a/network/edge-services/how-to/delete-pipeline.mdx b/network/edge-services/how-to/delete-pipeline.mdx index 772b20a4dd..16f8dbe04b 100644 --- a/network/edge-services/how-to/delete-pipeline.mdx +++ b/network/edge-services/how-to/delete-pipeline.mdx @@ -1,6 +1,21 @@ -## How to disable Edge Services +--- +meta: + title: How to delete an Edge Services pipeline + description: Learn how to delete or disable a Scaleway Edge Services pipeline with this step-by-step guide. Follow our instructions to ensure a smooth process and manage your domains and SSL/TLS certificates effectively. +content: + h1: How to delete an Edge Services pipeline + paragraph: Learn how to delete or disable a Scaleway Edge Services pipeline with this step-by-step guide. Follow our instructions to ensure a smooth process and manage your domains and SSL/TLS certificates effectively. +dates: + validation: 2024-07-24 + posted: 2024-07-24 +tags: load-balancer edge services edge-services cdn content delivery network delete disable pipeline +categories: + - network +--- -You can disable Edge Services at any time via the following procedure: +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. + +## How to disable Edge Services for an Object Storage bucket 1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. @@ -8,7 +23,7 @@ You can disable Edge Services at any time via the following procedure: 3. Click the **Edge Services** tab. - + TODO CHECK 4. In the **Disable Edge Services** panel at the bottom of the screen, click **Disable Edge Services**. @@ -24,4 +39,28 @@ You can disable Edge Services at any time via the following procedure: 5. Click **Disable Edge Services**. - Edge Services is disabled. You can enable it again at any time, but you will need to reconfigure your custom domain, and the cache will initially be empty. \ No newline at end of file + Edge Services is disabled and the pipeline for this bucket is deleted. You can enable it again at any time to create a new pipeline, but you will need to reconfigure your custom domain, and the cache will initially be empty. + +## How to delete an Edge Services pipeline for a Load Balancer origin + +1. Click **Load Balancers** in the **Network** section of the Scaleway console side menu. The list of your Load Balancers displays. + +2. Click the **Edge Services** tab. A list of your pipelines displays. + +3. Click the pipeline you want to delete. The Edge Services dashboard for that pipeline displays. + +4. In the **Delete Edge Services pipeline** panel at the bottom of the screen, click **Delete Edge Services pipeline**. + + A pop-up displays, informing you that the pipeline will be deleted + - The Load Balancer origin will no longer be accessible via its Edge Services endpoint, or any customized domains pointing to this endpoint. + - Any files stored in the Edge Services cache for this pipeline will be removed. + + + If you set up a customized domain for your Edge Services endpoint, remember to: + - Delete your CNAME record from your domain provider, unless your domain is managed with Scaleway Domains and DNS, in which case we take care of deletion for you. + - Delete any SSL/TLS certificates you imported into Secret Manager (if no longer required elsewhere, so that you are no longer billed for it). If you generated a managed Let's Encrypt certificate however, Scaleway takes care of the deletion for you. + + +5. Click **Confirm*. + + The Edge Services pipeline for this Load Balancer origin is deleted. You create a new pipeline at any time, but you will need to reconfigure any custom domains, and the cache will initially be empty. \ No newline at end of file diff --git a/network/edge-services/how-to/monitor-cockpit.mdx b/network/edge-services/how-to/monitor-cockpit.mdx index d60292a64b..e997640478 100644 --- a/network/edge-services/how-to/monitor-cockpit.mdx +++ b/network/edge-services/how-to/monitor-cockpit.mdx @@ -17,13 +17,11 @@ You can view your Edge Services metrics via [Scaleway Cockpit](/observability/co Access your Edge Services dashboard in the Scaleway console via the shortcut in the Edge Services tab of the pipeline in question. Note that you will first need to [create a Grafana user and credentials](https://www.scaleway.com/en/docs/observability/cockpit/how-to/retrieve-grafana-credentials/). -CHECK FROM HERE - ### Understanding the dashboard The Grafana dashboard presents a number of different metrics. Use the drop-down in the top left to select which pipeline and origin to view Edge Services metrics for, and the time range drop-down in the top right to modify the time period to apply to the metrics. - + TODO CHECK - **Request rate**: The number of requests made to Edge Services per second, for the specified origin, averaged over the specified time period. - **Cache hit ratio**: The percentage of requests served from Edge Services' cache, compared to the total number of requests in total to Edge Services for this origin, over the specified time period. @@ -43,39 +41,3 @@ The Grafana dashboard presents a number of different metrics. Use the drop-down - **Request origin country**: The proportion of requests (to Edge Services for the specified origin over the specified time period) originating from different countries. - **End users location**: A visual representation of where Edge Services end users have been making requests from geographically. - ---- - -OBJECT STORAGE - - -## How to monitor Edge Services with Scaleway Cockpit - -You can view your Edge Services metrics via [Scaleway Cockpit](/observability/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard. - -Access your Edge Services dashboard in the Scaleway console via the shortcut in Edge Services tab of the bucket in question. Note that you will first need to [create a Grafana user and credentials](https://www.scaleway.com/en/docs/observability/cockpit/how-to/retrieve-grafana-credentials/). - -### Understanding the dashboard - -The Grafana dashboard presents a number of different metrics. Use the `Bucket name` drop-down in the top left to select which bucket to view Edge Services metrics for, and the time range drop-down in the top right to modify the time period to apply to the metrics. - - - -- **Request rate**: The number of requests made to Edge Services per second, for the specified bucket, averaged over the specified time period. -- **Cache hit ratio**: The percentage of requests served from Edge Services' cache, compared to the total number of requests in total to Edge Services for this bucket, over the specified time period. -- **Cache HIT/MISS**: A visual representation of the ratio of cache hits to misses, for the specified bucket, over the specified time period. - - **Cache hit line**: The number of requests per second made to Edge Services for this bucket, which were served directly from its cache. - - **Cache miss line**: The number of requests per second made to Edge Services for this bucket, where the content was fetched from the bucket rather than the cache. - - **Total line**: The number of requests per second made to Edge Services for this bucket. - -- **Egress (to client)**: The total volume of data served to clients from Edge Services, for the specified bucket, over the specified time period. -- **Ingress (from origin)**: The total volume of data from the origin bucket's server to Edge Services over the specified time period. This represents the traffic that occurs when Edge Services retrieves content from the bucket's server in order to fulfill requests. -- **Edge Services throughput**: A visual representation of the rate of data transfer for the specified bucket with Edge Services over the specified time period. - - **Output bitrate line**: The rate at which data is being delivered from Edge Services to end users. - - **Input bitrate line**: The rate at which Edge Services is fetching data from the origin bucket server. Peaks in this line may represent times when Edge Services had to fetch content from the origin bucket, rather than being able to serve it directly from its own cache. - -- **Requests served**: The total number of requests that Edge Services has successfully served, for the specified bucket, over the specified time period. -- **Edge Services response statuses**: A visual representation of the distribution of HTTP response statuses for requests served by Edge Services over the specified time period. Consult [the full list of HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for more information if necessary. - -- **Request origin country**: The proportion of requests (to Edge Services for the specified bucket over the specified time period) originating from different countries. -- **End users location**: A visual representation of where Edge Services end users have been making requests from geographically. diff --git a/storage/object/how-to/get-started-edge-services.mdx b/storage/object/how-to/get-started-edge-services.mdx index 1cbf924065..9421b44270 100644 --- a/storage/object/how-to/get-started-edge-services.mdx +++ b/storage/object/how-to/get-started-edge-services.mdx @@ -7,357 +7,13 @@ content: paragraph: Introduction to getting started with Scaleway Edge Services. tags: object storage edge services edge-services cdn content delivery network cache domain certificate custom-domain https dates: - validation: 2024-03-18 + validation: 2024-07-25 posted: 2023-09-14 categories: - storage - object-storage --- -Edge Services is an additional feature for Scaleway Object Storage buckets, currently available in [Public Beta](https://www.scaleway.com/en/betas/). +Edge Services is an additional feature for Scaleway Object Storage buckets and Load Balancers, currently available in [Public Beta](https://www.scaleway.com/en/betas/). -Enabling Edge Services on your Object Storage bucket brings you a number of possible benefits: - -- Customize your bucket's endpoint using a subdomain of your own domain -- Add your own SSL/TLS certificate, safeguarded in [Scaleway Secret Manager](/identity-and-access-management/secret-manager/quickstart/), or generate a managed Let's Encrypt certificate, so your subdomain can serve content from your bucket over HTTPS -- Enhance performance by caching your stored objects, to be served directly by Edge Services from the cache -- Finely control your cached objects via purging (cache invalidation) - -Read on to learn how to enable Edge Services on your bucket, and configure your endpoint and cache. - - - -- A Scaleway account logged into the [console](https://console.scaleway.com) -- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization -- An [Object Storage bucket](/storage/object/how-to/create-a-bucket/) - -## How to enable Edge Services - -Edge Services is available as a feature on Object Storage buckets. It must be enabled on a bucket-by-bucket basis. - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to enable Edge Services on. - - -3. Click the **Edge Services** tab. - - - -4. Click **Enable Edge Services for free**. - - A pop-up informs you that your bucket will be exposed via Edge Services and that you can disable Edge Services at any time. Edge Services is free during the beta stage, and you will be notified before it becomes billable. - -5. Click **Enable Edge Services** to confirm. - - Edge Services is enabled on your bucket, and its various features are now visible on the Edge Services tab, ready to be configured. - - - - - - Your bucket's [visibility](https://www.scaleway.com/en/docs/storage/object/concepts/#visibility) can be set to **private**, but any objects within it that you want to expose via Edge Services must be set to [**public** visibility](https://www.scaleway.com/en/docs/storage/object/how-to/manage-object-visibility/). However, in the case that you are using Edge Services with bucket website (see below), objects can remain private. - - - - - Note the following important information about using Edge Services with the [bucket website](/storage/object/how-to/use-bucket-website/) feature: - - **If you want to use bucket website and Edge Services**: Ensure that you activate bucket website **before** you enable Edge Services. Avoid deactivating bucket website afterwards.

- - **If you do not want to use bucket website**: Simply enable Edge Services. Note however that if you activate bucket website after this, Edge Services will not be able to serve your bucket website URLs, and will continue to serve the regular bucket URLs.

- - **If you want to change your bucket website setting**: Disable Edge Services first, activate or deactivate bucket website as you wish, and then enable Edge Services. Edge Services will now pick up the new configuration, and will serve content from your bucket website URLS if bucket website is activated, or from your regular bucket URLs if bucket website is deactivated. - - -## How to access your bucket via Edge Services - -Once you have enabled Edge Services on your bucket, you can access your bucket and its content via the following endpoints (replace `bucket-name` with the name of your bucket.) - -| Endpoint | Where to find this endpoint in the console | Notes | -|-----------------------------------------|--------------------------|-----------------------------------------------------------------------------------| -| `https://bucket-name.s3.nl-ams.scw.cloud` | The **Bucket settings** tab | Edge Services is bypassed when bucket is accessed via this endpoint | -| `https://bucket-name.svc.edge.scw.cloud` | The **Edge Services** tab | Edge Services serves bucket content when this endpoint is used | - -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. - -## How to use custom domains - -### How to configure a custom domain - -If you already own a domain, you can use Edge Services to set a subdomain of your choice through which your bucket can be accessed. - -For example, if you own `beautiful-domain.com`, you can configure your bucket to be accessed via the subdomain `whatever-i-want.beautiful-domain.com`. You must also add an SSL/TLS certificate so that your subdomain can securely serve your bucket's content via HTTPS. - -| Endpoint | Where to find this endpoint in the console |Notes | -|----------------------------------------------|-------------------------------------------------|-------------------------------------------------------------| -| `https://whatever-i-want.beautiful-domain.com`| The **Edge Services** tab (after customization) | Edge Services serves bucket content when this endpoint is used. The pre-existing endpoints shown in the table in the previous section also continue to be functional as before. | - -You cannot customize your endpoint with a primary domain directly (e.g. `beautiful-domain.com`), only with a subdomain of it. - -The procedure for adding a customized endpoint is as follows: - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to configure a custom domain for. - -3. Click the **Edge Services** tab. - - - -4. In the **Endpoint** panel, click **Configure domain**. The following screen displays: - - - -5. Set a subdomain from which your bucket will be accessible. 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. - - - 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 - - -6. This step depends on whether the domain used in the previous step is managed with [Scaleway Domains and DNS](https://www.scaleway.com/en/docs/network/domains-and-dns/), or an external domain provider. Choose the appropriate tab below. - - - - - The domain you are using for Edge Services is considered to be managed with Scaleway Domains and DNS if: - - You [registered the domain](/network/domains-and-dns/how-to/register-internal-domain/) with Domains and DNS, or - - You [transferred an externally-registered domain](/network/domains-and-dns/how-to/transfer-external-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](/network/domains-and-dns/how-to/manage-dns-records/), to point your subdomain to the Edge Services endpoint for your bucket. This record is generated when you click `Customize domain` in step 8. - - You should not attempt to modify or delete the CNAME record, which will be visible among your [DNS records](/network/domains-and-dns/how-to/manage-dns-records/) in the Scaleway console. - - - - Scaleway cannot itself create the appropriate CNAME record to point your subdomain to Edge Services if your domain is managed by an external provider. You must create the CNAME record yourself. - - Log into your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services endpoint for your bucket displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](/storage/object/reference-content/cname-record/) - - Back in the Scaleway console, click the `Verify CNAME` button to check whether your CNAME record has been correctly configured. Edge Services will carry out a check, and if it is successful the following message displays: - - - - If the check fails, an error message will display. See the documentation linked above for help troubleshooting such errors. - - - -7. Provide an SSL/TLS certificate for your subdomain so that it can serve traffic 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](/identity-and-access-management/secret-manager/quickstart/). - - 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](https://www.scaleway.com/en/pricing/?tags=available,securityandidentity-secretmanager-secretmanager). - - - 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](/storage/object/reference-content/ssl-tls-certificate/). - - -8. 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 bucket through this domain, its content will be served via Edge Services. - - -If you chose to generate a managed Let's Encrypt certificate, allow a few minutes for the certificate to finish creating. When the process is complete and the certificate is ready, you will see a green status light for **SSL/TLS certificate** on your endpoint dashboard. - - - - - -### How to edit your customized domain or its certificate - -After customizing your domain, you can edit it (or its certificate) at any time as follows: - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to configure a custom domain for. - -3. Click the **Edge Services** tab. - - - -4. In the **Endpoint** panel, click **Edit**. The **Edit Domain** screen displays. - -5. Edit the subdomain as desired - do not forget to also set up a new CNAME record, if necessary. - -6. Edit your certificate options as required - choose to generate a managed Let's Encrypt certificate, managed by Scaleway including automatic renewals, or select a different certificate from Secret Manager, or manually import a new certificate for your custom domain. - -7. Click **Edit domain** to finish. - -### How to reset your customized domain to the original Edge Services endpoint - -Even though the original Edge Services endpoint (e.g. `https://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: - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to configure a custom domain for. - -3. Click the **Edge Services** tab. - - - -4. In the **Endpoint** panel, click **Reset**. - - A screen displays warning you that this will reset the bucket's domain back to the default Edge Services endpoint. Edge Services will consider your customized subdomain as unknown. You should also remember to: - - Delete your CNAME record from your domain provider, unless your domain is managed with Scaleway Domains and DNS, in which case we take care of deletion for you. - - Delete any SSL/TLS certificates you imported into Secret Manager (if no longer required elsewhere, so that you are no longer billed for it). If you generated a managed Let's Encrypt certificate however, Scaleway takes care of the deletion for you. - -5. Click **Reset domain** to finish. - -## How to configure your cache - -The cache feature allows you to cache your bucket's content with Edge Services. This means that content can be served directly to users from Edge Services' servers, 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. - -### How to enable your cache - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to configure a cache for. - -3. Click the **Edge Services** tab. - - - -4. In the **Cache** panel, use the 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 bucket. - - - - - 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. - - -5. Leave the default value of 1 hour in place, or enter another value. - -The cache is now enabled. - -### How to purge all objects from your cache - -This clears all objects from your cache. Afterwards, Edge Services will retrieve fresh copies from the bucket before it stores them again in the cache. - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to purge the cache for. - -3. Click the **Edge Services** tab. - -4. In the **Purge cache** panel, click **Purge all**. - - - - A screen displays warning you that your cache will be emptied, and Edge Services will have to retrieve objects from your bucket before re-caching them. - -5. Click **Purge cache** to confirm. - -### How to purge specific objects from your cache - -This allows you to specify the precise objects that you want to clear from the cache. Afterwards, Edge Services will retrieve fresh copies from the bucket before it stores them again in the cache. - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to purge cache objects for. - -3. Click the **Edge Services** tab. - -4. In the **Purge cache** panel, click **Purge by object**. - - - - A screen displays prompting you to enter the path of each object you want to purge from the cache. - - - -5. Enter the path of each object you want to purge. You can purge a maximum of 5 objects at a time. - - - - The path for each object should be defined from the root of the bucket, and must start with a slash. If we imagine a bucket containing one file at the root level called `object1.jpg`, and a subfolder at root level called `videos` containing an item called `my-video.mp4`, we would enter the object paths as follows: - - - `/object1.jpg` - - `/videos/my-video.mp4` - - You **cannot** purge entire subfolders by simply specifying the path to the subfolder, e.g. `/videos`. Purging objects must done strictly object-by-object, so `/videos/my-video1.mp4`, `/videos/my-video2.mp4`, `/videos/my-video3.mp4` etc. Watch this space for updates to this feature in the future. - - -6. Click **Purge objects from cache** - - The specified objects are purged from your cache and you are returned to the Edge Services dashboard. - -### How to disable your cache - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to disable caching for. - -3. Click the **Edge Services** tab. - -4. In the **Cache** panel, use the icon to disable the cache. - - A pop-up displays, asking you to confirm the action. - -5. Click **Disable cache**. - - Your cache is purged and disabled. Edge Services will now serve content by fetching it from your Object Storage bucket directly. If you reenable your cache at a later point, you will begin with an empty cache. - -## How to monitor Edge Services with Scaleway Cockpit - -You can view your Edge Services metrics via [Scaleway Cockpit](/observability/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard. - -Access your Edge Services dashboard in the Scaleway console via the shortcut in Edge Services tab of the bucket in question. Note that you will first need to [create a Grafana user and credentials](https://www.scaleway.com/en/docs/observability/cockpit/how-to/retrieve-grafana-credentials/). - -### Understanding the dashboard - -The Grafana dashboard presents a number of different metrics. Use the `Bucket name` drop-down in the top left to select which bucket to view Edge Services metrics for, and the time range drop-down in the top right to modify the time period to apply to the metrics. - - - -- **Request rate**: The number of requests made to Edge Services per second, for the specified bucket, averaged over the specified time period. -- **Cache hit ratio**: The percentage of requests served from Edge Services' cache, compared to the total number of requests in total to Edge Services for this bucket, over the specified time period. -- **Cache HIT/MISS**: A visual representation of the ratio of cache hits to misses, for the specified bucket, over the specified time period. - - **Cache hit line**: The number of requests per second made to Edge Services for this bucket, which were served directly from its cache. - - **Cache miss line**: The number of requests per second made to Edge Services for this bucket, where the content was fetched from the bucket rather than the cache. - - **Total line**: The number of requests per second made to Edge Services for this bucket. - -- **Egress (to client)**: The total volume of data served to clients from Edge Services, for the specified bucket, over the specified time period. -- **Ingress (from origin)**: The total volume of data from the origin bucket's server to Edge Services over the specified time period. This represents the traffic that occurs when Edge Services retrieves content from the bucket's server in order to fulfill requests. -- **Edge Services throughput**: A visual representation of the rate of data transfer for the specified bucket with Edge Services over the specified time period. - - **Output bitrate line**: The rate at which data is being delivered from Edge Services to end users. - - **Input bitrate line**: The rate at which Edge Services is fetching data from the origin bucket server. Peaks in this line may represent times when Edge Services had to fetch content from the origin bucket, rather than being able to serve it directly from its own cache. - -- **Requests served**: The total number of requests that Edge Services has successfully served, for the specified bucket, over the specified time period. -- **Edge Services response statuses**: A visual representation of the distribution of HTTP response statuses for requests served by Edge Services over the specified time period. Consult [the full list of HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for more information if necessary. - -- **Request origin country**: The proportion of requests (to Edge Services for the specified bucket over the specified time period) originating from different countries. -- **End users location**: A visual representation of where Edge Services end users have been making requests from geographically. - -## How to disable Edge Services - -You can disable Edge Services at any time via the following procedure: - -1. Click **Object Storage** in the **Storage** section of the Scaleway console side menu. The list of your buckets displays. - -2. Click the name of the bucket you want to disable Edge Services for. - -3. Click the **Edge Services** tab. - - - -4. In the **Disable Edge Services** panel at the bottom of the screen, click **Disable Edge Services**. - - A pop-up displays, informing you that the bucket will be removed from Edge Services. - - The bucket will no longer be accessible via its Edge Services endpoint, or any customized domains pointing to this endpoint. - - Any files stored in the Edge Services cache will be removed. - - - Remember to: - - Delete your CNAME record from your domain provider, unless your domain is managed with Scaleway Domains and DNS, in which case we take care of deletion for you. - - Delete any SSL/TLS certificates you imported into Secret Manager (if no longer required elsewhere, so that you are no longer billed for it). If you generated a managed Let's Encrypt certificate however, Scaleway takes care of the deletion for you. - - -5. Click **Disable Edge Services**. - - Edge Services is disabled. You can enable it again at any time, but you will need to reconfigure your custom domain, and the cache will initially be empty. \ No newline at end of file +Documentation has moved to the new dedicated [Edge Services](/network/edge-services/) section. \ No newline at end of file From de85963cccfb2cb1f12eef33efb7f2357c312159 Mon Sep 17 00:00:00 2001 From: Rowena Date: Thu, 25 Jul 2024 17:01:00 +0200 Subject: [PATCH 3/5] fix(concepts): forgot to save last time --- network/edge-services/concepts.mdx | 51 ++++++++++++++++-------------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/network/edge-services/concepts.mdx b/network/edge-services/concepts.mdx index e3cad014f9..a3421def7d 100644 --- a/network/edge-services/concepts.mdx +++ b/network/edge-services/concepts.mdx @@ -13,48 +13,53 @@ categories: - networks --- -TODO INSERT OVERALL DIAGRAM +## Cache -### Pipeline +The storage location where Edge Services stores copies of content that it has retrieved from a given origin. When users request content from the Edge Services endpoint, it serves content directly from the cache wherever possible, in accordance with the caching rules defined by the user. This reduces load on the origin bucket or Load Balancer/backend servers. -An Edge Services pipeline consists of an [origin](#origin) for which Edge Services requests and [caches](#cache) content, and an [endpoint](#endpoint) from which this content is served via Edge Services. The pipeline's endpoint can be customized with a user-defined [subdomain](#subdomain) and associated [certificate](#certificate) so that Edge Services can serve content over HTTPS. +Note that if an object has a caching directive, the caching directive always takes precedence over any lifetime setting defined in Edge Services. -You can create one or more Edge Services pipelines for each of your Load Balancers. If creating multiple pipelines for the same origin Load Balancer, each one must be configured for a different frontend. +## Certificate -### Origin +The SSL/TLS certificate for your subdomain to enable Edge Services to serve content over HTTPS, if you have customized your [Edge Services endpoint](#endpoint). You can choose between uploading your own certificate held in Scaleway Secret Manager, or letting Edge Services generate a fully-managed Let's Encrypt certificate. -The primary source from which an Edge Services pipeline retrieves and caches data. An origin consists of the [Load Balancer](#origin-load-balancer) and frontend port that Edge Services connects to to request content, and (optionally) a specified [host](#origin-host) associated with the Load Balancer, used in the HTTP request Host Header. +## CNAME record -### Origin Load Balancer +The CNAME record pointing your subdomain to the Edge Services endpoint, if you have customized your [Edge Services endpoint](#endpoint). This is necessary to ensure that traffic for your customized subdomain is correctly directed towards the Edge Services endpoint by DNS servers. -The Load Balancer defined by the user as origin for a given Edge Services pipeline. The pipeline connects to this Load Balancer, on the specified frontend port to request content. +## Edge Services -### Protocol +Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets, currently available in [Public Beta](https://www.scaleway.com/en/betas/). It provides a [caching service](/network/edge-services/how-to/configure-cache/) to improve performance by reducing load on your [origin](#origin), and a customizable and secure [endpoint](#endpoint) for accessing content via Edge Services, which can be set to a subdomain of your choice. -The protocol (HTTP or HTTPS) that the Edge Services pipeline should use when sending requests to the origin. HTTPS is recommended, but you should choose the protocol that corresponds with your Load Balancer setup. +## Endpoint -### Origin host +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. -The specific host for which Edge Services requests and caches data. This is an optional setting: when specified, this host (e.g. `mydomain.com`) is used in the HTTP Host Header when Edge Services requests data from the Load Balancer. If no origin host is specified, the Load Balancer's IP address is used in the Host Header. +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) will be required, in this case. -The origin host must be associated with the origin Load Balancer / its backend servers, and only one host may be set per pipeline. If your Load Balancer is in front of multiple hosts, you can create a separate Edge Services pipeline for each. Each host will therefore get its own Edge Services endpoint and cache. +## Origin -### Cache +The primary source from which a Scaleway Edge Services pipeline retrieves and caches data. An origin can consist of either: -The storage location where Edge Services stores copies of content that it has retrieved from a given Load Balancer origin. When users request content from the Edge Services endpoint, it serves content directly from the cache wherever possible, in accordance with the caching rules defined by the user. This reduces load on the Load Balancer and its backend servers. +- An [Object Storage bucket](/storage/object/how-to/create-a-bucket/), or +- A [Load Balancer](#origin-load-balancer) and frontend port that Edge Services connects to to request content, and (optionally) a specified [host](#origin-host) associated with the Load Balancer, used in the HTTP request Host Header. -Note that if an object has a caching directive, the caching directive always takes precedence over any lifetime setting defined in Edge Services. +## Origin host -### Endpoint +In the case of a Load Balancer origin, the specific host for which Edge Services requests and caches data. This is an optional setting: when specified, this host (e.g. `mydomain.com`) is used in the HTTP Host Header when Edge Services requests data from the Load Balancer. If no origin host is specified, the Load Balancer's IP address is used in the Host Header. -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 Load Balancer and its backend servers directly. Edge Services automatically manages redirection from HTTP to HTTPS +The origin host must be associated with the origin Load Balancer / its backend servers, and only one host may be set per pipeline. If your Load Balancer is in front of multiple hosts, you can create a separate Edge Services pipeline for each. Each host will therefore get its own Edge Services endpoint and cache. -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) will be required, in this case. +## Origin Load Balancer -### Certificate +The Load Balancer defined by the user as origin for a given Edge Services pipeline. The pipeline connects to this Load Balancer, on the specified frontend port to request content. -The SSL/TLS certificate for your subdomain to enable Edge Services to serve content over HTTPS, if you have customized your [Edge Services endpoint](#endpoint). You can choose between uploading your own certificate held in Scaleway Secret Manager, or letting Edge Services generate a fully-managed Let's Encrypt certificate. +## Pipeline + +An Edge Services pipeline consists of an [origin](#origin) for which Edge Services requests and [caches](#cache) content, and an [endpoint](#endpoint) from which this content is served via Edge Services. The pipeline's endpoint can be customized with a user-defined [subdomain](#subdomain) and associated [certificate](#certificate) so that Edge Services can serve content over HTTPS. + +You can create one or more Edge Services pipelines for each of your Object Storage buckets or Load Balancer origins. -### CNAME record +## Protocol -The CNAME record pointing your subdomain to the Edge Services endpoint, if you have customized your [Edge Services endpoint](#endpoint). This is necessary to ensure that traffic for your customized subdomain is correctly directed towards the Edge Services endpoint by DNS servers. \ No newline at end of file +The protocol (HTTP or HTTPS) that the Edge Services pipeline should use when sending requests to an origin Load Balancer. HTTPS is recommended, but you should choose the protocol that corresponds with your Load Balancer setup. \ No newline at end of file From 9d783dddb40902be6e716c7e5a13efb3b82d45e7 Mon Sep 17 00:00:00 2001 From: Rowena Jones <36301604+RoRoJ@users.noreply.github.com> Date: Thu, 25 Jul 2024 17:36:59 +0200 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> --- network/edge-services/how-to/configure-cache.mdx | 12 ++++++------ .../edge-services/how-to/configure-custom-domain.mdx | 6 +++--- .../edge-services/how-to/create-pipeline-bucket.mdx | 6 +++--- network/edge-services/how-to/create-pipeline-lb.mdx | 8 ++++---- network/edge-services/how-to/delete-pipeline.mdx | 4 ++-- network/edge-services/how-to/monitor-cockpit.mdx | 4 ++-- 6 files changed, 20 insertions(+), 20 deletions(-) diff --git a/network/edge-services/how-to/configure-cache.mdx b/network/edge-services/how-to/configure-cache.mdx index 2b753f736d..e16e4ba369 100644 --- a/network/edge-services/how-to/configure-cache.mdx +++ b/network/edge-services/how-to/configure-cache.mdx @@ -8,7 +8,7 @@ content: dates: validation: 2024-07-24 posted: 2024-07-24 -tags: object storage edge services edge-services cdn content delivery network cache invalidation purge +tags: object-storage edge-services cdn network cache purge categories: - network --- @@ -39,7 +39,7 @@ The cache is now enabled. ## How to purge all objects from your cache -This clears all objects from your cache. Afterwards, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. +This clears all objects from your cache. Afterward, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer origin whose cache you want to purge: @@ -49,13 +49,13 @@ This clears all objects from your cache. Afterwards, Edge Services will retrieve TODO CHECK - A screen displays warning you that your cache will be emptied, and Edge Services will have to retrieve objects from your origin before re-caching them. + A screen displays, warning you that your cache will be emptied, and Edge Services will have to retrieve objects from your origin before re-caching them. 3. Click **Purge cache** to confirm. ## How to purge specific objects from your cache -This allows you to specify the precise objects that you want to clear from the cache. Afterwards, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. +This allows you to specify the precise objects that you want to clear from the cache. Afterward, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer origin whose cache you want to purge: @@ -75,7 +75,7 @@ This allows you to specify the precise objects that you want to clear from the c The path for each object should be defined from the root and must start with a slash, e.g. `/videos/my-video.mp4`. - You **cannot** purge entire directories by simply specifying the path to the directory, e.g. `/videos`. Purging objects must done strictly object-by-object, so `/videos/my-video1.mp4`, `/videos/my-video2.mp4`, `/videos/my-video3.mp4` etc. Watch this space for updates to this feature in the future. + You **cannot** purge entire directories by simply specifying the path to the directory, e.g. `/videos`. Purging objects must be done strictly object-by-object, so `/videos/my-video1.mp4`, `/videos/my-video2.mp4`, `/videos/my-video3.mp4` etc. Watch this space for updates to this feature in the future. For example, if we imagine a Object Storage bucket containing one file at the root level called `object1.jpg`, and a subfolder at root level called `videos` containing an item called `my-video.mp4`, we would enter the object paths as follows: @@ -84,7 +84,7 @@ This allows you to specify the precise objects that you want to clear from the c -4. Click **Purge objects from cache** +4. Click **Purge objects from cache**. The specified objects are purged from your cache and you are returned to the Edge Services dashboard. diff --git a/network/edge-services/how-to/configure-custom-domain.mdx b/network/edge-services/how-to/configure-custom-domain.mdx index cd16a3eb2b..a582dfb91d 100644 --- a/network/edge-services/how-to/configure-custom-domain.mdx +++ b/network/edge-services/how-to/configure-custom-domain.mdx @@ -8,7 +8,7 @@ content: dates: validation: 2024-07-24 posted: 2024-07-24 -tags: object storage edge services edge-services cdn content delivery network domain certificate ssl tls custom-domain https +tags: object-storage edge-services cdn network domain ssl tls https categories: - network --- @@ -56,7 +56,7 @@ The procedure for adding a customized endpoint is as follows: Scaleway cannot itself create the appropriate CNAME record to point your subdomain to Edge Services if your domain is managed by an external provider. You must create the CNAME record yourself. - Log into your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services pipeline endpoint displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](/network/edge-services/reference-content/cname-record/) + Log into your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services pipeline endpoint displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](/network/edge-services/reference-content/cname-record/). Back in the Scaleway console, click the `Verify CNAME` button to check whether your CNAME record has been correctly configured. Edge Services will carry out a check, and if it is successful the following message displays: @@ -116,7 +116,7 @@ Even though the original Edge Services endpoint (e.g. `https://pipeline-id-or-bu 2. In the **Endpoint** panel, click **Reset**. - A screen displays warning you that this will reset the pipeline's domain back to the default Edge Services endpoint. Edge Services will consider your customized subdomain as unknown. You should also remember to: + A screen displays, warning you that this will reset the pipeline's domain back to the default Edge Services endpoint. Edge Services will consider your customized subdomain as unknown. You should also remember to: - Delete your CNAME record from your domain provider, unless your domain is managed with Scaleway Domains and DNS, in which case we take care of deletion for you. - Delete any SSL/TLS certificates you imported into Secret Manager (if no longer required elsewhere, so that you are no longer billed for it). If you generated a managed Let's Encrypt certificate however, Scaleway takes care of the deletion for you. diff --git a/network/edge-services/how-to/create-pipeline-bucket.mdx b/network/edge-services/how-to/create-pipeline-bucket.mdx index 42edb42752..d85d47a7f4 100644 --- a/network/edge-services/how-to/create-pipeline-bucket.mdx +++ b/network/edge-services/how-to/create-pipeline-bucket.mdx @@ -8,7 +8,7 @@ content: dates: validation: 2024-07-24 posted: 2024-07-24 -tags: object storage edge services edge-services cdn content delivery network cache domain certificate custom-domain https +tags: object-storage edge-services cdn network cache domain https categories: - network --- @@ -61,7 +61,7 @@ Edge Services is available as a feature on Object Storage buckets. You enable it Note the following important information about using Edge Services with the [bucket website](/storage/object/how-to/use-bucket-website/) feature: - - **If you want to use bucket website and Edge Services**: Ensure that you activate bucket website **before** you enable Edge Services. Avoid deactivating bucket website afterwards.

+ - **If you want to use bucket website and Edge Services**: Ensure that you activate bucket website **before** you enable Edge Services. Avoid deactivating bucket website afterward.

- **If you do not want to use bucket website**: Simply enable Edge Services. Note however that if you activate bucket website after this, Edge Services will not be able to serve your bucket website URLs, and will continue to serve the regular bucket URLs.

- **If you want to change your bucket website setting**: Disable Edge Services first, activate or deactivate bucket website as you wish, and then enable Edge Services. Edge Services will now pick up the new configuration, and will serve content from your bucket website URLS if bucket website is activated, or from your regular bucket URLs if bucket website is deactivated. @@ -72,7 +72,7 @@ Once you have enabled Edge Services on your bucket, you can access your bucket a | Endpoint | Where to find this endpoint in the console | Notes | |-----------------------------------------|--------------------------|-----------------------------------------------------------------------------------| -| `https://bucket-name.s3.nl-ams.scw.cloud` | The **Bucket settings** tab | Edge Services is bypassed when bucket is accessed via this endpoint | +| `https://bucket-name.s3.nl-ams.scw.cloud` | The **Bucket settings** tab | Edge Services is bypassed when the bucket is accessed via this endpoint | | `https://bucket-name.svc.edge.scw.cloud` | The **Edge Services** tab | Edge Services serves bucket content when this endpoint is used | 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](/network/edge-services/how-to/configure-custom-domain/). \ No newline at end of file diff --git a/network/edge-services/how-to/create-pipeline-lb.mdx b/network/edge-services/how-to/create-pipeline-lb.mdx index a3f24b47a6..1cb4763a36 100644 --- a/network/edge-services/how-to/create-pipeline-lb.mdx +++ b/network/edge-services/how-to/create-pipeline-lb.mdx @@ -8,7 +8,7 @@ content: dates: validation: 2024-07-24 posted: 2024-07-24 -tags: load-balancer edge services edge-services cdn content delivery network cache domain certificate custom-domain https +tags: load-balancer edge-services cdn network cache domain https categories: - network --- @@ -19,7 +19,7 @@ Creating an Edge Services pipeline for your Load Balancer helps to reduce load o Edge Services lets you: -- Define the specific origin (Load Balancer, frontend port and host) for a given pipeline and its associated cache +- Define the specific origin (Load Balancer, frontend port, and host) for a given pipeline and its associated cache - Choose the TTL for cached objects - Purge the entire cache or specific cached objects at any time (cache invalidation) - Customize your Edge Services pipeline endpoint using a subdomain of your own domain @@ -35,7 +35,7 @@ An Edge Services pipeline can be created for any Load Balancer with a public IP ## How to create an Edge Services pipeline for Load Balancer -You can create one or more Edge Services pipelines for each of your Load Balancers. Each pipeline has its own [origin](/network/edge-services/concepts/#origin), [endpoint](/network/edge-services/concepts/#endpoint) and [cache](/network/edge-services/concepts/#cache). If you create multiple Edge Services pipelines for the same origin Load Balancer, each one must be configured for a different frontend. +You can create one or more Edge Services pipelines for each of your Load Balancers. Each pipeline has its own [origin](/network/edge-services/concepts/#origin), [endpoint](/network/edge-services/concepts/#endpoint), and [cache](/network/edge-services/concepts/#cache). If you create multiple Edge Services pipelines for the same origin Load Balancer, each one must be configured for a different frontend. Follow the steps below to create an Edge Services pipeline. @@ -66,7 +66,7 @@ Follow the steps below to create an Edge Services pipeline. 7. Click **Create Edge Services pipeline** to finish. -Your pipeline is created and your are taken to its **Overview** page. The endpoint displays from which you can access your Load Balancer origin via Edge Services, e.g. `https://pipeline-id.edge.scw.cloud` +Your pipeline is created and you are taken to its **Overview** page. The endpoint displays from which you can access your Load Balancer origin via Edge Services, e.g. `https://pipeline-id.edge.scw.cloud`. ## Troubleshooting pipeline creation diff --git a/network/edge-services/how-to/delete-pipeline.mdx b/network/edge-services/how-to/delete-pipeline.mdx index 16f8dbe04b..1051c12e95 100644 --- a/network/edge-services/how-to/delete-pipeline.mdx +++ b/network/edge-services/how-to/delete-pipeline.mdx @@ -8,12 +8,12 @@ content: dates: validation: 2024-07-24 posted: 2024-07-24 -tags: load-balancer edge services edge-services cdn content delivery network delete disable pipeline +tags: load-balancer edge-services cdn network pipeline categories: - network --- -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. +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. ## How to disable Edge Services for an Object Storage bucket diff --git a/network/edge-services/how-to/monitor-cockpit.mdx b/network/edge-services/how-to/monitor-cockpit.mdx index e997640478..7b6cbad86d 100644 --- a/network/edge-services/how-to/monitor-cockpit.mdx +++ b/network/edge-services/how-to/monitor-cockpit.mdx @@ -8,12 +8,12 @@ content: dates: validation: 2024-07-24 posted: 2024-07-24 -tags: load-balancer edge services edge-services cdn content delivery network metrics cache-hit-ratio grafana observability +tags: load-balancer edge-services cdn cache-hit-ratio grafana observability categories: - network --- -You can view your Edge Services metrics via [Scaleway Cockpit](/observability/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard. +You can view your Edge Services metrics via [Scaleway Cockpit](/observability/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate, and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard. Access your Edge Services dashboard in the Scaleway console via the shortcut in the Edge Services tab of the pipeline in question. Note that you will first need to [create a Grafana user and credentials](https://www.scaleway.com/en/docs/observability/cockpit/how-to/retrieve-grafana-credentials/). From 4192cb48b812a2017fb98a4449ffee7bf78dc736 Mon Sep 17 00:00:00 2001 From: Rowena Jones <36301604+RoRoJ@users.noreply.github.com> Date: Fri, 26 Jul 2024 11:01:07 +0200 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: nerda-codes <87707325+nerda-codes@users.noreply.github.com> --- network/edge-services/how-to/configure-cache.mdx | 4 ++-- network/edge-services/how-to/configure-custom-domain.mdx | 6 +++--- network/edge-services/how-to/create-pipeline-bucket.mdx | 2 +- network/edge-services/how-to/create-pipeline-lb.mdx | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/network/edge-services/how-to/configure-cache.mdx b/network/edge-services/how-to/configure-cache.mdx index e16e4ba369..9fc2b91525 100644 --- a/network/edge-services/how-to/configure-cache.mdx +++ b/network/edge-services/how-to/configure-cache.mdx @@ -39,7 +39,7 @@ The cache is now enabled. ## How to purge all objects from your cache -This clears all objects from your cache. Afterward, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. +Purging objects clears all objects from your cache. Afterward, Edge Services will retrieve fresh copies from the origin (Object Storage bucket or Load Balancer) before it stores them again in the cache. 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer origin whose cache you want to purge: @@ -77,7 +77,7 @@ This allows you to specify the precise objects that you want to clear from the c You **cannot** purge entire directories by simply specifying the path to the directory, e.g. `/videos`. Purging objects must be done strictly object-by-object, so `/videos/my-video1.mp4`, `/videos/my-video2.mp4`, `/videos/my-video3.mp4` etc. Watch this space for updates to this feature in the future. - For example, if we imagine a Object Storage bucket containing one file at the root level called `object1.jpg`, and a subfolder at root level called `videos` containing an item called `my-video.mp4`, we would enter the object paths as follows: + For example, if we imagine an Object Storage bucket containing one file at the root level called `object1.jpg`, and a subfolder at root level called `videos` containing an item called `my-video.mp4`, we would enter the object paths as follows: - `/object1.jpg` - `/videos/my-video.mp4` diff --git a/network/edge-services/how-to/configure-custom-domain.mdx b/network/edge-services/how-to/configure-custom-domain.mdx index a582dfb91d..fec7696266 100644 --- a/network/edge-services/how-to/configure-custom-domain.mdx +++ b/network/edge-services/how-to/configure-custom-domain.mdx @@ -13,7 +13,7 @@ categories: - network --- -If you already own a domain, you customize an Edge Services pipeline endpoint with a subdomain of your choice. 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. +If you already own a domain, you can customize an Edge Services pipeline endpoint with a subdomain of your choice. 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. For example, if you own `beautiful-domain.com`, you can customize the endpoint to be `whatever-i-want.beautiful-domain.com`. You must also add an SSL/TLS certificate so that Edge Services can securely serve your content via HTTPS. @@ -39,7 +39,7 @@ The procedure for adding a customized endpoint is as follows: ❌ example.com -4. This step depends on whether the domain used in the previous step is managed with [Scaleway Domains and DNS](https://www.scaleway.com/en/docs/network/domains-and-dns/), or an external domain provider. Choose the appropriate tab below. +4. This step depends on whether the domain used in the previous step is managed with [Scaleway Domains and DNS](/network/domains-and-dns/), or an external domain provider. Choose the appropriate tab below. @@ -56,7 +56,7 @@ The procedure for adding a customized endpoint is as follows: Scaleway cannot itself create the appropriate CNAME record to point your subdomain to Edge Services if your domain is managed by an external provider. You must create the CNAME record yourself. - Log into your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services pipeline endpoint displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](/network/edge-services/reference-content/cname-record/). + Log in to your domain provider, and locate the DNS settings for your domain. Create a new CNAME record pointing your subdomain to the Edge Services pipeline endpoint displayed in the Scaleway console. For help setting up CNAME records and troubleshooting any problems, [check out our dedicated documentation](/network/edge-services/reference-content/cname-record/). Back in the Scaleway console, click the `Verify CNAME` button to check whether your CNAME record has been correctly configured. Edge Services will carry out a check, and if it is successful the following message displays: diff --git a/network/edge-services/how-to/create-pipeline-bucket.mdx b/network/edge-services/how-to/create-pipeline-bucket.mdx index d85d47a7f4..678da4da92 100644 --- a/network/edge-services/how-to/create-pipeline-bucket.mdx +++ b/network/edge-services/how-to/create-pipeline-bucket.mdx @@ -68,7 +68,7 @@ Edge Services is available as a feature on Object Storage buckets. You enable it ## How to access your bucket via Edge Services -Once you have enabled Edge Services on your bucket, you can access your bucket and its content via the following endpoints (replace `bucket-name` with the name of your bucket.) +Once you have enabled Edge Services on 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. | Endpoint | Where to find this endpoint in the console | Notes | |-----------------------------------------|--------------------------|-----------------------------------------------------------------------------------| diff --git a/network/edge-services/how-to/create-pipeline-lb.mdx b/network/edge-services/how-to/create-pipeline-lb.mdx index 1cb4763a36..98779873aa 100644 --- a/network/edge-services/how-to/create-pipeline-lb.mdx +++ b/network/edge-services/how-to/create-pipeline-lb.mdx @@ -111,7 +111,7 @@ If you are setting up an Edge Services pipeline for a [Kubernetes Kapsule](/cont ## How to edit an Edge Services pipeline origin -You can edit the protocol, origin host and name of an Edge Services pipeline as follows. +You can edit the protocol, origin host, and name of an Edge Services pipeline as follows. 1. Click **Load Balancers** in the **Network** section of the Scaleway console side menu. The list of your Load Balancers displays.