Skip to content

Commit dcb9ad6

Browse files
pedrosousanevikashah
authored andcommitted
[WAF] Use Steps component (#24723)
1 parent 9d95ff1 commit dcb9ad6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+450
-94
lines changed

src/content/docs/ruleset-engine/rules-language/expressions/edit-expressions.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ description: Edit expressions in the Cloudflare dashboard using the Expression
1111
in which you type the expression.
1212
---
1313

14-
In the Cloudflare dashboard, there are two options for editing [expressions](/ruleset-engine/rules-language/expressions/):
14+
import { Render } from "~/components";
1515

16-
- **Expression Builder**: Allows you to create expressions using drop-down lists, emphasizing a visual approach to defining an expression.
17-
- **Expression Editor**: A text-only interface that supports advanced features, such as grouping symbols and functions for transforming and validating values.
16+
<Render file="expression-builder-editor" product="ruleset-engine" />
1817

1918
In general, you can switch back and forth between the Expression Builder and the Expression Editor. However, the Expression Builder does not support [nested expressions](#create-nested-expressions) or the [raw string syntax](/ruleset-engine/rules-language/values/#raw-string-syntax).
2019

src/content/docs/waf/account/custom-rulesets/create-dashboard.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ head:
1010
content: Work with WAF custom rulesets in the dashboard
1111
---
1212

13-
import { Render } from "~/components";
13+
import { Render, Steps } from "~/components";
1414

1515
:::note
1616
This feature requires an Enterprise plan with a paid add-on.
@@ -20,6 +20,8 @@ Custom rulesets are configured at the account level. To work with custom ruleset
2020

2121
## Create and deploy a custom ruleset
2222

23+
<Steps>
24+
2325
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
2426

2527
2. Go to Account Home > **WAF** > **Custom rulesets**.
@@ -54,8 +56,12 @@ Custom rulesets are configured at the account level. To work with custom ruleset
5456

5557
13. Select **Create**.
5658

59+
</Steps>
60+
5761
## Edit a custom ruleset
5862

63+
<Steps>
64+
5965
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
6066

6167
2. Go to Account Home > **WAF** > **Custom rulesets**.
@@ -68,17 +74,23 @@ Custom rulesets are configured at the account level. To work with custom ruleset
6874

6975
5. When you are done, select **Back to rulesets list**.
7076

77+
</Steps>
78+
7179
:::caution
7280
Deployed custom rulesets will only apply to incoming traffic of Enterprise domains. The Expression Builder will automatically include this filter. If you define a custom expression for the ruleset using the Expression Editor, you must use parentheses to enclose any custom conditions and end your expression with `and cf.zone.plan eq "ENT"` so that the rule only applies to domains on an Enterprise plan.
7381
:::
7482

7583
## Delete a custom ruleset
7684

85+
<Steps>
86+
7787
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
7888
2. Go to Account Home > **WAF** > **Custom rulesets**.
7989
3. To delete a custom ruleset, select the three dots next to it > **Delete**.
8090
4. To confirm the delete operation, select **Delete**.
8191

92+
</Steps>
93+
8294
## Configure a custom response for blocked requests
8395

8496
<Render

src/content/docs/waf/account/managed-rulesets/deploy-dashboard.mdx

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ head:
99
content: Deploy a WAF managed ruleset in the dashboard for an account
1010
---
1111

12-
import { Render } from "~/components";
12+
import { Render, Steps } from "~/components";
1313

1414
:::note
1515
This feature requires an Enterprise plan with a paid add-on.
@@ -23,6 +23,8 @@ To deploy a managed ruleset for a single zone, refer to [Deploy a managed rulese
2323

2424
## Deploy a managed ruleset
2525

26+
<Steps>
27+
2628
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
2729

2830
2. Go to Account Home > **WAF** > **Managed rulesets** tab.
@@ -46,6 +48,8 @@ To deploy a managed ruleset for a single zone, refer to [Deploy a managed rulese
4648

4749
8. To deploy the managed ruleset immediately, select **Deploy**. If you are not ready to deploy, select **Save as Draft**.
4850

51+
</Steps>
52+
4953
The **Deployed managed rulesets** list will show an _Execute_ rule for the managed ruleset you deployed.
5054

5155
## Turn on or off a managed ruleset
@@ -67,6 +71,8 @@ Some managed rulesets may not allow custom configuration, depending on your Clou
6771

6872
To configure an entire managed ruleset:
6973

74+
<Steps>
75+
7076
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
7177

7278
2. Go to Account Home > **WAF** > **Managed rulesets** tab.
@@ -85,6 +91,8 @@ To configure an entire managed ruleset:
8591

8692
5. If you are editing a deployed managed ruleset, select **Save**. If you have not deployed the managed ruleset yet, select **Deploy** to deploy the ruleset immediately, or **Save as Draft** to save your deployment settings for later.
8793

94+
</Steps>
95+
8896
### Configure rules in bulk in a managed ruleset
8997

9098
<Render file="managed-rules-browse-account" product="waf" />
@@ -101,6 +109,8 @@ To configure an entire managed ruleset:
101109

102110
You can browse the available rules in a managed ruleset and search for individual rules or tags.
103111

112+
<Steps>
113+
104114
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
105115

106116
2. Go to Account Home > **WAF** > **Managed rulesets** tab.
@@ -115,8 +125,14 @@ You can browse the available rules in a managed ruleset and search for individua
115125

116126
![The Browse rules page displaying the list of rules in the Cloudflare Managed Ruleset](~/assets/images/waf/waf-browse-rules.png)
117127

128+
</Steps>
129+
118130
### Delete a managed ruleset deployment rule or an exception
119131

132+
<Steps>
133+
120134
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
121135
2. Go to Account Home > **WAF** > **Managed rulesets** tab.
122136
3. Under **Deployed managed rulesets** and next to the rule you want to delete, select the three dots > **Delete** and confirm the operation.
137+
138+
</Steps>

src/content/docs/waf/account/rate-limiting-rulesets/create-dashboard.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ head:
99
content: Create a rate limiting ruleset in the dashboard for an account
1010
---
1111

12-
import { Render } from "~/components";
12+
import { Render, Steps } from "~/components";
1313

1414
:::note
1515
This feature requires an Enterprise plan with a paid add-on.
@@ -19,7 +19,7 @@ At the account level, rate limiting rules are grouped into rate limiting ruleset
1919

2020
## 1. Create a custom rate limiting ruleset
2121

22-
To create a new custom rate limiting ruleset:
22+
<Steps>
2323

2424
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account.
2525

@@ -59,10 +59,14 @@ To create a new custom rate limiting ruleset:
5959

6060
16. Create additional rate limiting rules as needed, and then select **Create** to create the ruleset.
6161

62+
</Steps>
63+
6264
## 2. Deploy the custom rate limiting ruleset
6365

6466
To deploy a custom rate limiting ruleset to one or more zones on an Enterprise plan:
6567

68+
<Steps>
69+
6670
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account.
6771

6872
2. Go to Account Home > **WAF** > **Rate limiting rulesets**.
@@ -79,6 +83,8 @@ To deploy a custom rate limiting ruleset to one or more zones on an Enterprise p
7983

8084
6. To deploy your rule immediately, select **Deploy**. If you are not ready to deploy your rule, select **Save as Draft**.
8185

86+
</Steps>
87+
8288
The **Deployed custom rate limiting rulesets** list will show a rule for each deployed custom rate limiting ruleset.
8389

8490
## Configure a custom response for blocked requests

src/content/docs/waf/analytics/security-analytics.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
order: 1
66
---
77

8-
import { FeatureTable, GlossaryTooltip, Badge } from "~/components";
8+
import { FeatureTable, GlossaryTooltip, Badge, Steps } from "~/components";
99

1010
Security Analytics displays information about all incoming HTTP requests for your domain, including requests not handled by Cloudflare security products.
1111

@@ -32,13 +32,16 @@ Zone/domain-level analytics are included with all plans, though the retention pe
3232

3333
To use Security Analytics:
3434

35+
<Steps>
36+
3537
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
3638

3739
2. Go to the account or zone/domain dashboard:
38-
3940
- For the zone/domain dashboard, select your domain and go to **Security** > **Analytics**.
4041
- For the account dashboard, go to **Security Center** > **Security Analytics**.
4142

43+
</Steps>
44+
4245
## Adjusting displayed data
4346

4447
### Apply filters
@@ -47,10 +50,14 @@ Adjust the scope of analytics by manually entering filter conditions. You can al
4750

4851
To manually add a filter:
4952

53+
<Steps>
54+
5055
1. Select **Add filter**.
5156
2. Select a field, an operator, and a value. For example, to filter events by source IP address, select the _Source IP_ field, select the _equals_ operator, and enter the IP address.
5257
3. Select **Apply**.
5358

59+
</Steps>
60+
5461
Take the following into account when entering filter values:
5562

5663
- Do not add quotes around values.
@@ -92,7 +99,6 @@ Each suspicious activity is classified with a severity score that can vary from
9299
The main chart displays the following data for the selected time frame, according to the selected tab:
93100

94101
- **Traffic analysis**: Traffic mitigated by the Cloudflare security platform, served by Cloudflare, and served by the origin server, according to the following classification:
95-
96102
- **Mitigated by WAF**: Requests blocked or challenged by Cloudflare's application security products such as the WAF and HTTP DDoS protection. It does not include requests that had the following actions applied: _Log_, _Skip_, and _Allow_.
97103
- **Served by Cloudflare**: Requests served by the Cloudflare global network such as cached content and redirects.
98104
- **Served by origin**: Requests served by your origin server.

src/content/docs/waf/analytics/security-events.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
order: 2
66
---
77

8-
import { FeatureTable, GlossaryTooltip } from "~/components";
8+
import { FeatureTable, GlossaryTooltip, Steps } from "~/components";
99

1010
Security Events allows you to review <GlossaryTooltip term="mitigated request">mitigated requests</GlossaryTooltip> and helps you tailor your security configurations.
1111

@@ -45,10 +45,14 @@ You can adjust the scope of analytics by manually entering filter conditions. Al
4545

4646
To manually add a filter:
4747

48+
<Steps>
49+
4850
1. Select **Add filter**.
4951
2. Select a field, an operator, and a value. For example, to filter events by IP address, select _IP_ for **Action**, select _equals_ for the operator, and enter the IP address.
5052
3. Select **Apply**.
5153

54+
</Steps>
55+
5256
Take the following into account when entering filter values:
5357

5458
- Do not add quotes around values.

src/content/docs/waf/custom-rules/create-dashboard.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,12 @@ head:
1010
content: Create a custom rule in the dashboard
1111
---
1212

13-
import { Render, Tabs, TabItem } from "~/components";
13+
import { Render, Tabs, TabItem, Steps } from "~/components";
1414

1515
<Tabs syncKey="dashNewNav"> <TabItem label="Old dashboard">
1616

17+
<Steps>
18+
1719
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com), and select your account and domain.
1820

1921
2. Go to **Security** > **WAF** > **Custom rules**.
@@ -32,8 +34,12 @@ import { Render, Tabs, TabItem } from "~/components";
3234

3335
8. To save and deploy your rule, select **Deploy**. If you are not ready to deploy your rule, select **Save as Draft**.
3436

37+
</Steps>
38+
3539
</TabItem> <TabItem label="New dashboard" icon="rocket">
3640

41+
<Steps>
42+
3743
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com), and select your account and domain.
3844

3945
2. Go to **Security** > **Security rules**.
@@ -53,6 +59,8 @@ import { Render, Tabs, TabItem } from "~/components";
5359

5460
8. To save and deploy your rule, select **Deploy**. If you are not ready to deploy your rule, select **Save as Draft**.
5561

62+
</Steps>
63+
5664
</TabItem> </Tabs>
5765

5866
## Configure a custom response for blocked requests

src/content/docs/waf/custom-rules/index.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,4 @@ To define sets of custom rules that apply to more than one zone, use [custom rul
2323

2424
To create custom rules using the Cloudflare dashboard, refer to [Create custom rules in the dashboard](/waf/custom-rules/create-dashboard/).
2525

26-
You can also create custom rules using the [Rulesets API](/ruleset-engine/rulesets-api/). Refer to [Create custom rules via API](/waf/custom-rules/create-api/) for more information.
27-
28-
For Terraform examples, refer to [WAF custom rules configuration using Terraform](/terraform/additional-configurations/waf-custom-rules/).
26+
You can also create custom rules [via API](/waf/custom-rules/create-api/) or [using Terraform](/terraform/additional-configurations/waf-custom-rules/).

src/content/docs/waf/custom-rules/skip/index.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,16 @@ head:
88
content: Configure a custom rule with the Skip action
99
---
1010

11-
import { TabItem, Tabs } from "~/components";
11+
import { TabItem, Tabs, Steps } from "~/components";
1212

1313
Use the _Skip_ action in a custom rule to skip one or more security features. A rule configured with the _Skip_ action is also known as a skip rule.
1414

1515
For more information on the available options, refer to [Available skip options](/waf/custom-rules/skip/options/).
1616

1717
<Tabs syncKey="dashNewNav"> <TabItem label="Old dashboard">
1818

19+
<Steps>
20+
1921
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com), and select your account and domain.
2022

2123
2. Go to **Security** > **WAF** > **Custom rules**.
@@ -32,8 +34,12 @@ For more information on the available options, refer to [Available skip options]
3234

3335
7. Save your changes.
3436

37+
</Steps>
38+
3539
</TabItem> <TabItem label="New dashboard" icon="rocket">
3640

41+
<Steps>
42+
3743
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com), and select your account and domain.
3844

3945
2. Go to **Security** > **Security rules**.
@@ -50,6 +56,8 @@ For more information on the available options, refer to [Available skip options]
5056

5157
7. Save your changes.
5258

59+
</Steps>
60+
5361
</TabItem> <TabItem label="API">
5462

5563
Use the [Rulesets API](/ruleset-engine/rulesets-api/) to configure custom rules via API.

src/content/docs/waf/custom-rules/use-cases/allow-traffic-from-ips-in-allowlist.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@ head:
66
content: Allow traffic from IP addresses in allowlist only
77
---
88

9+
import { Steps } from "~/components";
10+
911
This example skips WAF rules for requests from IP addresses in an allowlist (defined using an [IP list](/waf/tools/lists/custom-lists/#ip-lists)).
1012

13+
<Steps>
14+
1115
1. [Create an IP list](/waf/tools/lists/create-dashboard/) with the IP addresses for which you want to allow access.<br/>
1216
For example, create an IP list named `allowed_ips` with one or more IP addresses. For more information on the accepted IP address formats, refer to [IP lists](/waf/tools/lists/custom-lists/#ip-lists).
1317

1418
2. [Create a custom rule](/waf/custom-rules/create-dashboard/) skipping all rules for any request from the IPs in the list you created (`allowed_ips` in the current example).
15-
1619
- **Expression**: `(ip.src in $allowed_ips)`
1720
- **Action**: _Skip:_
1821
- _All remaining custom rules_
@@ -21,6 +24,8 @@ This example skips WAF rules for requests from IP addresses in an allowlist (def
2124
- _All Super Bot Fight Mode rules_
2225
- _All managed rules_
2326

27+
</Steps>
28+
2429
Make sure the new rule appears before any other custom rules in the rules list.
2530

2631
## Other resources

0 commit comments

Comments
 (0)