[Rules] Zstandard support / Update availability (#16876)

pedrosousa · elithrar · commit 81bb7df0f344 · 2024-10-15T11:26:11.000+01:00
* Add Zstandard compression
* Add changelog entry
diff --git a/.github/styles/config/vocabularies/cloudflare/accept.txt b/.github/styles/config/vocabularies/cloudflare/accept.txt
@@ -40,3 +40,5 @@ Workers
 VMware
 VPN
 YubiKey
+Zstandard
+Zstd
diff --git a/src/content/changelogs/rules.yaml b/src/content/changelogs/rules.yaml
@@ -5,6 +5,11 @@ productLink: "/rules/"
 productArea: Application performance
 productAreaLink: /fundamentals/reference/changelog/performance/
 entries:
+  - publish_date: "2024-09-17"
+    title: Compression Rules available to all plans with Zstandard support
+    description: |-
+      [Compression Rules](/rules/compression-rules/) now support Zstandard compression and are available in all Cloudflare plans. Users in the Free plan will gradually get access throughout 2024.
+
   - publish_date: "2024-09-13"
     title: Snippets now available in beta
     description: |-
diff --git a/src/content/docs/rules/compression-rules/create-api.mdx b/src/content/docs/rules/compression-rules/create-api.mdx
@@ -6,25 +6,27 @@ sidebar:
 head:
   - tag: title
     content: Create a compression rule via API
-
 ---
 
-import { Render } from "~/components"
+import { Render } from "~/components";
 
 Use the [Rulesets API](/ruleset-engine/rulesets-api/) to create a compression rule via API.
 
 ## Basic rule settings
 
 When creating a compression rule via API, make sure you:
 
-* Set the rule action to `compress_response`.
-* Define the parameters in the `action_parameters` field according to the [settings](/rules/compression-rules/settings/#api-configuration-settings) you wish to override for matching requests.
-* Deploy the rule to the `http_response_compression` phase at the zone level.
+- Set the rule action to `compress_response`.
+- Define the parameters in the `action_parameters` field according to the [settings](/rules/compression-rules/settings/#api-configuration-settings) you wish to override for matching requests.
+- Deploy the rule to the `http_response_compression` phase at the zone level.
 
 ## Procedure
 
-<Render file="rules-creation-workflow" params={{ one: "a compression rule", two: "http_response_compression" }} />
+<Render
+	file="rules-creation-workflow"
+	params={{ one: "a compression rule", two: "http_response_compression" }}
+/>
 
-## Example requests
+## Examples
 
-Refer to the [Rules examples gallery](/rules/compression-rules/examples/) for example API requests.
+For example API requests, refer to the [Examples gallery](/rules/compression-rules/examples/).
diff --git a/src/content/docs/rules/compression-rules/create-dashboard.mdx b/src/content/docs/rules/compression-rules/create-dashboard.mdx
@@ -6,14 +6,13 @@ sidebar:
 head:
   - tag: title
     content: Create a compression rule in the dashboard
-
 ---
 
 1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and domain.
 2. Go to **Rules** > **Compression Rules**.
 3. To create a new empty rule, select **Create rule**. To duplicate an existing rule, select the three dots next to it > **Duplicate**.
 4. Enter a descriptive name for the rule in **Rule name**.
-5. Under **When incoming requests match**, select if you wish to apply the rule to all incoming requests or only to requests that match a custom filter expression.
+5. Under **When incoming requests match**, select if you wish to apply the rule to [default content types](/speed/optimization/content/brotli/content-compression/#compression-between-cloudflare-and-website-visitors) (content types that Cloudflare compresses by default), or to requests that match a custom filter expression.
 6. (Optional) To define a custom expression, use the Expression Builder (specifying one or more values for **Field**, **Operator**, and **Value**) or manually enter an expression using the Expression Editor. For more information, refer to [Edit rule expressions](/ruleset-engine/rules-language/expressions/edit-expressions/).
-7. Under **Compression options**, set the [compression options](/rules/compression-rules/settings/#dashboard-configuration-settings) for requests matching the rule expression.
+7. Under **Compression options**, set the [compression options](/rules/compression-rules/settings/#dashboard-configuration-settings).
 8. To save and deploy your rule, select **Deploy**. If you are not ready to deploy your rule, select **Save as Draft**.
diff --git a/src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx b/src/content/docs/rules/compression-rules/examples/disable-all-brotli.mdx
@@ -9,7 +9,9 @@ description: Create a compression rule to turn off Brotli compression for all
   incoming requests of a given zone.
 ---
 
-import { Example } from "~/components";
+import { Example, TabItem, Tabs } from "~/components";
+
+<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
 
 The following example rule will disable Brotli compression for all incoming requests of a given zone. The only available compression algorithm will be Gzip.
 
@@ -28,7 +30,7 @@ The following example rule will disable Brotli compression for all incoming requ
 
 If the client does not support Gzip compression, the response will be uncompressed.
 
-## Example API request
+</TabItem> <TabItem label="API">
 
 The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation:
 
@@ -51,3 +53,5 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
   ]
 }'
 ```
+
+</TabItem> </Tabs>
diff --git a/src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx b/src/content/docs/rules/compression-rules/examples/disable-compression-avif.mdx
@@ -11,7 +11,9 @@ description: Create a compression rule to turn off compression for AVIF images,
   request.
 ---
 
-import { Example } from "~/components";
+import { Example, TabItem, Tabs } from "~/components";
+
+<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
 
 The following example rule will disable compression for AVIF images, based on either the content type or the file extension specified in the request.
 
@@ -30,11 +32,11 @@ The following example rule will disable compression for AVIF images, based on ei
 
 </Example>
 
-## Example API request
+</TabItem> <TabItem label="API">
 
 The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation:
 
-```bash
+```bash wrap
 curl --request PUT \
 https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
 --header "Authorization: Bearer <API_TOKEN>" \
@@ -53,3 +55,5 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
   ]
 }'
 ```
+
+</TabItem> </Tabs>
diff --git a/src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx b/src/content/docs/rules/compression-rules/examples/enable-zstandard.mdx
@@ -0,0 +1,57 @@
+---
+pcx_content_type: example
+summary: Create a compression rule to turn on Zstandard compression for response content types where Cloudflare applies compression by default.
+products:
+  - Compression Rules
+title: Enable Zstandard compression for default content types
+description: Create a compression rule to turn on Zstandard compression for response content types where Cloudflare applies compression by default.
+---
+
+import { Example, TabItem, Tabs } from "~/components";
+
+<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
+
+The following example rule will turn on Zstandard compression for response content types where [Cloudflare applies compression by default](/speed/optimization/content/brotli/content-compression/). If the client does not support Zstandard compression, it will use Brotli or Gzip compression as a fallback.
+
+<Example>
+
+**When incoming requests match**
+
+- Custom filter expression:
+
+  - _Media Type_ _is in_ `text/html, text/richtext, text/plain, text/css, text/x-script, text/x-component, text/x-java-source, text/x-markdown, application/javascript, application/x-javascript, text/javascript, text/js, image/x-icon, image/vnd.microsoft.icon, application/x-perl, application/x-httpd-cgi, text/xml, application/xml, application/rss+xml, application/vnd.api+json, application/x-protobuf, application/json, multipart/bag, multipart/mixed, application/xhtml+xml, font/ttf, font/otf, font/x-woff, image/svg+xml, application/vnd.ms-fontobject, application/ttf, application/x-ttf, application/otf, application/x-otf, application/truetype, application/opentype, application/x-opentype, application/font-woff, application/eot, application/font, application/font-sfnt, application/wasm, application/javascript-binast, application/manifest+json, application/ld+json, application/graphql+json, application/geo+json`
+
+**Then**
+
+- **Compression options**: Custom
+- **Define a custom order for compression types**: `Zstandard`, `Brotli`, `Gzip`
+
+</Example>
+
+</TabItem> <TabItem label="API">
+
+The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation:
+
+```bash wrap
+curl --request PUT \
+https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
+--header "Authorization: Bearer <API_TOKEN>" \
+--header "Content-Type: application/json" \
+--data '{
+  "rules": [
+    {
+      "expression": "(http.response.content_type.media_type in {\"text/html\" \"text/richtext\" \"text/plain\" \"text/css\" \"text/x-script\" \"text/x-component\" \"text/x-java-source\" \"text/x-markdown\" \"application/javascript\" \"application/x-javascript\" \"text/javascript\" \"text/js\" \"image/x-icon\" \"image/vnd.microsoft.icon\" \"application/x-perl\" \"application/x-httpd-cgi\" \"text/xml\" \"application/xml\" \"application/rss+xml\" \"application/vnd.api+json\" \"application/x-protobuf\" \"application/json\" \"multipart/bag\" \"multipart/mixed\" \"application/xhtml+xml\" \"font/ttf\" \"font/otf\" \"font/x-woff\" \"image/svg+xml\" \"application/vnd.ms-fontobject\" \"application/ttf\" \"application/x-ttf\" \"application/otf\" \"application/x-otf\" \"application/truetype\" \"application/opentype\" \"application/x-opentype\" \"application/font-woff\" \"application/eot\" \"application/font\" \"application/font-sfnt\" \"application/wasm\" \"application/javascript-binast\" \"application/manifest+json\" \"application/ld+json\" \"application/graphql+json\" \"application/geo+json\"})",
+      "action": "compress_response",
+      "action_parameters": {
+        "algorithms": [
+          { "name": "zstd" },
+          { "name": "brotli" },
+          { "name": "gzip" }
+        ]
+      }
+    }
+  ]
+}'
+```
+
+</TabItem> </Tabs>
diff --git a/src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx b/src/content/docs/rules/compression-rules/examples/gzip-for-csv.mdx
@@ -9,7 +9,9 @@ description: Create a compression rule to set Gzip compression as the preferred
   compression method for CSV files.
 ---
 
-import { Example } from "~/components";
+import { Example, TabItem, Tabs } from "~/components";
+
+<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
 
 The following example rule will configure Gzip compression as the preferred compression method for CSV files. If the visitor does not support this algorithm, Cloudflare will try to compress the response using a different algorithm supported by the visitor.
 
@@ -28,7 +30,7 @@ The following example rule will configure Gzip compression as the preferred comp
 
 </Example>
 
-## Example API request
+</TabItem> <TabItem label="API">
 
 The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation:
 
@@ -52,3 +54,5 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
   ]
 }'
 ```
+
+</TabItem> </Tabs>
diff --git a/src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx b/src/content/docs/rules/compression-rules/examples/only-brotli-url-path.mdx
@@ -9,7 +9,9 @@ description: Create a compression rule to set Brotli as the only supported
   compression algorithm for a specific URI path.
 ---
 
-import { Example } from "~/components";
+import { Example, TabItem, Tabs } from "~/components";
+
+<Tabs syncKey="dashPlusAPI"> <TabItem label="Dashboard">
 
 The following example rule will configure only Brotli compression for a specific URI path.
 
@@ -30,7 +32,7 @@ The following example rule will configure only Brotli compression for a specific
 
 Since the rule configuration does not include _Auto_ at the end of the custom algorithms list, the response will be uncompressed if the web visitor does not support Brotli.
 
-## Example API request
+</TabItem> <TabItem label="API">
 
 The following example sets the rules of an existing [entry point ruleset](/ruleset-engine/about/rulesets/#entry-point-ruleset) (with ID `{ruleset_id}`) for the `http_response_compression` phase to a single compression rule, using the [Update a zone ruleset](/api/operations/updateZoneRuleset) operation:
 
@@ -53,3 +55,5 @@ https://api.cloudflare.com/client/v4/zones/{zone_id}/rulesets/{ruleset_id} \
   ]
 }'
 ```
+
+</TabItem> </Tabs>
diff --git a/src/content/docs/rules/compression-rules/index.mdx b/src/content/docs/rules/compression-rules/index.mdx
@@ -31,7 +31,7 @@ Alternatively, follow the instructions in the following pages to get started:
 
 ## Availability
 
-Compression Rules are available to Enterprise customers.
+Compression Rules are available in all Cloudflare plans. Users in the Free plan will gradually get access throughout 2024.
 
 <FeatureTable id="rules.compression_rules" />
 
@@ -47,7 +47,7 @@ The following fields are commonly used in expressions of compression rules:
 
 ## Important remarks
 
-- If there is a match for a compression rule but the client does not support any of the compression algorithms configured in the rule (according to the provided `Accept-Encoding` request header), the response sent to the client will not be compressed.
+- If there is a match for a compression rule but the client does not support any of the compression algorithms configured in the rule (according to the provided `accept-encoding` request header), the response sent to the client will not be compressed.
 
 - If there is a match for a compression rule but the response sent from the origin server contains a `cache-control: no-transform` HTTP header, the compression rule will not perform any changes to the response.
 
diff --git a/src/content/docs/rules/compression-rules/settings.mdx b/src/content/docs/rules/compression-rules/settings.mdx
diff --git a/src/content/docs/speed/optimization/content/brotli/content-compression.mdx b/src/content/docs/speed/optimization/content/brotli/content-compression.mdx
diff --git a/src/content/plans/index.json b/src/content/plans/index.json

-Original file line number
+Diff line change
 VMware
 VPN
 YubiKey
 +Zstandard
 +Zstd