Skip to content

Commit 38d0e39

Browse files
committed
feat(edge-services): doc for api public beta
1 parent d8e4ddb commit 38d0e39

20 files changed

+77
-254
lines changed
-21.1 KB
Binary file not shown.

faq/edge-services.mdx

+3-16
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,9 @@ productIcon: EdgeServicesProductIcon
1414

1515
Edge Services is a feature for Scaleway Load Balancers and Object Storage buckets. Creating Edge Services [pipelines](/edge-services/concepts/#pipeline) towards your Load Balancers or Object Storage buckets provides:
1616
-A [caching service](/edge-services/how-to/configure-cache/) to improve performance by reducing load on your [origin](/edge-services/concepts/#origin), and
17-
- A [Web Application Firewall](/edge-services/how-to/configure-waf/) to protect your origin from threats and malicious activity, and
1817
- A customizable and secure endpoint for accessing content via Edge Services, which can be set to a subdomain of your choice and secured with an SSL/TLS certificate.
1918

20-
<Lightbox src="scaleway-edge-services-pipeline.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer. A Web Application Firewall sits between the cache and origin, protecting the origin from threats." />
19+
<Lightbox src="scaleway-edge-services-pipeline.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer." />
2120

2221
## Which products are compatible with Edge Services?
2322

@@ -35,18 +34,6 @@ Yes, if you choose to [customize your Edge Services endpoint with your own subdo
3534

3635
## What is WAF?
3736

38-
**W**eb **A**pplication **F**irewall is a feature available in Public Beta via Edge Services for Load Balancer origins only. When enabled, WAF filters requests to your Load Balancer origin to determine whether they are potentially malicious. You can choose the [paranoia level](/edge-services/concepts/#paranoia-level) to be used when evaluating requests, and set [exclusions](/edge-services/concepts/#exclusions) to define traffic that shouldn't be filtered by WAF. Requests that are judged to be malicious are blocked or logged, depending on the settings you choose. Find out more about WAF in our [detailed documentation](/edge-services/reference-content/understanding-waf/).
37+
**W**eb **A**pplication **F**irewall is a feature available in Public Beta via Edge Services for Load Balancer origins. It is currently available via the [Edge Services API](https://www.scaleway.com/en/developers/api/edge-services/) only, but will be coming to the Scaleway console soon.
3938

40-
## I don't have a Load Balancer, how can I use WAF with a different type of Scaleway resource?
41-
42-
For now, this isn't possible: you must put such resources behind a Load Balancer in order to benefit from WAF. Watch this space for other solutions in the future.
43-
44-
## Can I use WAF and caching simultaneously?
45-
46-
Yes, you can have both of these features enabled at the same time on the same Load Balancer pipeline. WAF protects your Load Balancer origin only: it does not filter requests served by the cache.
47-
48-
## What ruleset is used by WAF? Is it updated automatically?
49-
50-
Scaleway Edge Services WAF uses the [OWASP **C**ore **R**ule **S**et (CRS)](https://coreruleset.org/). This is an industry standard, open source ruleset for WAF, which protects against multiple categories of attack such as SQL injection and cross-site scripting. Full details are available in the [OWASP CRS documentation](https://coreruleset.org/docs/).
51-
52-
We handle the regular updating of rules, removing this hassle from you the user.
39+
When enabled, WAF filters requests to your Load Balancer origin to determine whether they are potentially malicious. You can choose the [paranoia level](/edge-services/concepts/#paranoia-level) to be used when evaluating requests, and set [exclusions](/edge-services/concepts/#exclusions) to define traffic that shouldn't be filtered by WAF. Requests that are judged to be malicious are blocked or logged, depending on the settings you choose. Find out more about WAF in our [detailed documentation](/edge-services/reference-content/understanding-waf/).
Binary file not shown.

macros/edge-services/edge-services-bucket-benefits.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ macro: edge-services-bucket-benefits
77
- Enhance performance by caching your stored objects, to be served directly by Edge Services from the cache
88
- Finely control your cached objects via purging (cache invalidation)
99

10-
<Lightbox src="scaleway-edge-services-pipeline-nowaf.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer" />
10+
<Lightbox src="scaleway-edge-services-pipeline.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer" />

macros/edge-services/edge-services-lb-benefits.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,12 @@ macro: edge-services-lb-benefits
44

55
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.
66

7-
<Lightbox src="scaleway-edge-services-pipeline-diag.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer" />
7+
<Lightbox src="scaleway-edge-services-pipeline.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer" />
88

99
Edge Services lets you:
1010

1111
- Define the specific origin (Load Balancer, frontend port, and host) for a given pipeline and its associated cache
1212
- Choose the TTL for cached objects, and purge the entire cache or specific cached objects at any time (cache invalidation)
13-
- Configure a [Web Application Firewall (WAF)](/edge-services/how-to/configure-waf/) to protect your origin from threats and malicious activity
1413
- Customize your Edge Services pipeline endpoint using a subdomain of your own domain
1514
- Add an SSL/TLS certificate so that Edge Services can serve content over HTTPS for your subdomain
1615

menu/navigation.json

-4
Original file line numberDiff line numberDiff line change
@@ -3649,10 +3649,6 @@
36493649
"label": "Configure a cache",
36503650
"slug": "configure-cache"
36513651
},
3652-
{
3653-
"label": "Configure WAF",
3654-
"slug": "configure-waf"
3655-
},
36563652
{
36573653
"label": "Monitor with Cockpit",
36583654
"slug": "monitor-cockpit"
Binary file not shown.

pages/edge-services/concepts.mdx

+5-14
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ The CNAME record pointing your subdomain to the Edge Services endpoint, if you h
3131

3232
Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. It provides:
3333
- A [caching service](/edge-services/how-to/configure-cache/) to improve performance by reducing load on your [origin](#origin)
34-
- A [Web Application Firewall](/edge-services/how-to/configure-waf/) to protect your origin from threats and malicious activity
3534
- A customizable and secure [endpoint](#endpoint) for accessing content via Edge Services, which can be set to a subdomain of your choice.
3635

3736
## Endpoint
@@ -40,10 +39,6 @@ The endpoint from which a given Edge Services pipeline can be accessed, e.g. `ht
4039

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

43-
## Exclusions
44-
45-
In the context of an Edge Services [Web Application Firewall](#web-application-firewall), exclusions let you define filters for requests that should not be evaluated by WAF, but rather pass straight to the Load Balancer origin. Learn more about [creating exclusions](/edge-services/how-to/configure-waf/#how-to-set-exclusions)
46-
4742
## Origin
4843

4944
The primary source from which a Scaleway Edge Services pipeline retrieves and caches data. An origin can consist of either:
@@ -61,17 +56,13 @@ The origin host must be associated with the origin Load Balancer / its backend s
6156

6257
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.
6358

64-
## Paranoia level
65-
66-
In the context of an Edge Services [Web Application Firewall](#web-application-firewall), the paranoia level determines how sensitive the request-evaluation mechanism is to potential threats. Four paranoia levels are available, with level 1 being the least sensitive, and level 4 being the most sensitive. The higher the paranoia level, the more likely it is that a given request will be judged to be malicious. For full details on paranoia levels, see our [detailed documentation](/edge-services/reference-content/understanding-waf/#waf-ruleset-and-paranoia-levels).
67-
6859
## Pipeline
6960

70-
<Lightbox src="scaleway-edge-services-pipeline.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer. A Web Application Firewall sits between the cache and origin, protecting the origin from threats." />
61+
<Lightbox src="scaleway-edge-services-pipeline.webp" alt="A diagram shows the elements and workflow of an Edge Services pipeline. The user connects to the customizable Edge Services endpoint (with its SSL/TLS certificate), which fetches content from the Edge Services cache, which itself fetches content to cache from an origin which is either an Object Storage bucket or Load Balancer." />
7162

72-
An Edge Services pipeline consists of an [origin](#origin), which Edge Services can protect from threats with a [Web Application Firefall](#web-application-firewall), and for which it also requests and [caches](#cache) content. Each pipeline also has an [endpoint](#endpoint) from which content is accessed served via Edge Services. The pipeline's endpoint can be customized with a user-defined [subdomain](/domains-and-dns/concepts/#subdomain) and associated [certificate](#certificate) so that Edge Services can serve content over HTTPS. Edge Services can also protect
63+
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](/domains-and-dns/concepts/#subdomain) and associated [certificate](#certificate) so that Edge Services can serve content over HTTPS.
7364

74-
You can create an Edge Services pipeline for each of your Object Storage buckets or Load Balancer origins. Note that caching and WAF can be enabled and disabled at will, so are optional parts of the pipeline, as is the customization of the endpoint. WAF is only available for Load Balancer origins, not Object Storage buckets.
65+
You can create an Edge Services pipeline for each of your Object Storage buckets or Load Balancer origins. Note that the cache can be enabled and disabled at will, so it is an optional part of the pipeline, as is the customization of the endpoint.
7566

7667
## Protocol
7768

@@ -80,7 +71,7 @@ The protocol (HTTP or HTTPS) that the Edge Services pipeline should use when sen
8071
## WAF
8172

8273
<Message type="note">
83-
Edge Services WAF is currently in [Public Beta](https://www.scaleway.com/en/betas/).
74+
Edge Services WAF is currently in [Public Beta](https://www.scaleway.com/en/betas/) and available only via the [Edge Services API](https://www.scaleway.com/en/developers/api/edge-services/). It will be coming to the Scaleway console soon.
8475
</Message>
8576

86-
An Edge Services **W**eb **A**pplication **F**irewall (WAF) evaluates requests to your Load Balancer origin to determine whether they are potentially malicious. You can set the [paranoia level](#paranoia-level) to be used when evaluating requests. Requests that are judged to be malicious are then blocked or logged, depending on the settings you choose. Find out more about [configuring WAF](/edge-services/how-to/configure-waf/).
77+
An Edge Services **W**eb **A**pplication **F**irewall (WAF) evaluates requests to your Load Balancer origin to determine whether they are potentially malicious. You can set the paranoia level to be used when evaluating requests. Requests that are judged to be malicious are then blocked or logged, depending on the settings you choose. Find out more in our dedicated [reference documentation](/edge-services/reference-content/understanding-waf/).
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)