Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
f26726b
docs(guides): remove the residual "These checks confirm" use-case lin…
egermano Nov 9, 2026
88ad68a
chore(deps): bump npm and GitHub Actions dependencies (#2590)
isaque-bock-azion Nov 9, 2026
c1df92f
docs(applications): review the Applications section and apply the upd…
marcus-souza-azion Nov 9, 2026
a93e244
chore(main): release docs 2.4.3 (#2616)
github-actions[bot] Nov 9, 2026
1f841e4
fix(applications): apply live test results and define each resource b…
marcus-souza-azion Nov 10, 2026
d655dd1
chore(deploy): promote docs-v2.4.3 to production (#2617)
github-actions[bot] Nov 10, 2026
47236e0
chore(main): release docs 2.4.4 (#2627)
github-actions[bot] Nov 10, 2026
43ad7ac
chore(deploy): promote docs-v2.4.4 to production (#2631)
github-actions[bot] Nov 11, 2026
c1871a9
docs(terraform): rewrite the samples for provider v2.10.0 (#2557)
bruno-andrade-azion Nov 11, 2026
b596a5c
docs(cli): document azion workload-deployment and fix pages that say …
bruno-andrade-azion Nov 11, 2026
1cac328
fix(firewall): correct the CLI binding, the WAF config sample, and th…
bruno-andrade-azion Nov 11, 2026
1fe477d
chore(scripts): add pnpm lint:terraform to validate Terraform samples…
bruno-andrade-azion Nov 11, 2026
43199bf
docs(guides): make the auth layer and vector search tutorials runnabl…
bruno-andrade-azion Nov 11, 2026
76aacb5
Merge remote-tracking branch 'origin/docs/mm-16252-remove-use-case-te…
egermano Nov 11, 2026
96c8b6b
docs(guides): close each confirm section with its use case's expected…
egermano Nov 11, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,8 @@ updates:
minor-and-patch:
patterns: ["*"]
update-types: ["minor", "patch"]
ignore:
- dependency-name: "remark-directive"
versions: [">=4"]
- dependency-name: "eslint-plugin-mdx"
versions: [">=3.9"]
4 changes: 2 additions & 2 deletions .github/workflows/ci-gate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ jobs:
run: pnpm ci:ratchet audit

- name: Secret detection
uses: trufflesecurity/trufflehog@c85580b712841eda4c53bc28fc6ace6100e8c16c # main
uses: trufflesecurity/trufflehog@ea68ca03c865c5f324e86e849ced20ed3cf9dbbb # main
with:
path: ./
base: ${{ github.event.pull_request.base.sha }}
Expand Down Expand Up @@ -138,7 +138,7 @@ jobs:

- name: Prettier (changed files)
if: ${{ always() && steps.diff.outcome == 'success' && steps.diff.outputs.fmt != '0' }}
run: tr '\n' '\0' < changed-fmt.txt | xargs -0 pnpm exec prettier --check --plugin-search-dir=.
run: tr '\n' '\0' < changed-fmt.txt | xargs -0 pnpm exec prettier --check

- name: Stylelint (changed files)
if: ${{ always() && steps.diff.outcome == 'success' && steps.diff.outputs.style != '0' }}
Expand Down
1 change: 1 addition & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": true,
"plugins": ["prettier-plugin-astro"],
"overrides": [
{
"files": [".*", "*.json", "*.md", "*.mdx", "*.toml", "*.yml"],
Expand Down
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"apps/docs": "2.4.2"
"apps/docs": "2.4.4"
}
14 changes: 14 additions & 0 deletions apps/docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## [2.4.4](https://github.com/aziontech/docs/compare/docs-v2.4.3...docs-v2.4.4) (2026-11-10)


### Bug Fixes

* **applications:** apply live test results and define each resource by its role ([#2626](https://github.com/aziontech/docs/issues/2626)) ([1f841e4](https://github.com/aziontech/docs/commit/1f841e408508ef9bf9f5be03f32d17416477199e))

## [2.4.3](https://github.com/aziontech/docs/compare/docs-v2.4.2...docs-v2.4.3) (2026-11-09)


### Documentation

* **applications:** review the Applications section and apply the updated writing rules ([#2615](https://github.com/aziontech/docs/issues/2615)) ([c1df92f](https://github.com/aziontech/docs/commit/c1df92f2885e5a4a17ded9eb44186a12203ebf35))

## [2.4.2](https://github.com/aziontech/docs/compare/docs-v2.4.1...docs-v2.4.2) (2026-11-09)


Expand Down
68 changes: 34 additions & 34 deletions apps/docs/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "docs",
"type": "module",
"version": "2.4.2",
"version": "2.4.4",
"private": true,
"scripts": {
"consts:local": "test -f ./src/consts.ts || cp ./env/consts.localhost.ts ./src/consts.ts",
Expand Down Expand Up @@ -42,69 +42,69 @@
},
"dependencies": {
"@astrojs/vue": "^7.1.2",
"@aziontech/icons": "^4.2.0",
"@aziontech/theme": "5.2.0",
"@aziontech/icons": "^4.4.0",
"@aziontech/theme": "5.2.2",
"@aziontech/webkit": "5.3.0",
"@babel/types": "^8.0.6",
"@tailwindcss/vite": "^4.3.3",
"@babel/types": "^8.1.0",
"@tailwindcss/vite": "^4.3.5",
"github-slugger": "^2.0.0",
"gray-matter": "^4.0.3",
"hast-util-has-property": "^3.0.0",
"hast-util-heading-rank": "^3.0.0",
"mermaid": "^12.2.0",
"mermaid": "^12.3.0",
"nanostores": "^0.10.3",
"rehype-autolink-headings": "^7.1.0",
"remark-smartypants": "^2.0.0",
"remark-smartypants": "^3.0.2",
"sharp": "^0.35.5",
"tailwindcss": "^4.3.3",
"vue": "^3.5.44"
"tailwindcss": "^4.3.5",
"vue": "^3.5.45"
},
"devDependencies": {
"@actions/core": "^3.0.1",
"@astrojs/check": "^0.9.12",
"@astrojs/markdown-remark": "^7.3.4",
"@astrojs/mdx": "^7.0.5",
"@astrojs/markdown-remark": "^7.3.6",
"@astrojs/mdx": "^8.1.3",
"@astrojs/sitemap": "3.7.4",
"@tailwindcss/typography": "^0.5.20",
"@types/hast": "^2.3.4",
"@types/hast": "^3.0.5",
"@types/html-escaper": "^3.0.0",
"@types/mdast": "^3.0.10",
"@types/node": "^18.6.4",
"@types/mdast": "^4.0.4",
"@types/node": "^26.6.6",
"algoliasearch": "^4.22.1",
"astro": "^7.3.8",
"astro": "^7.4.7",
"astro-auto-import": "^0.6.0",
"bcp-47-normalize": "^2.1.0",
"cssnano": "^6.0.3",
"cssnano": "^9.9.0",
"dedent-js": "^1.0.1",
"domhandler": "^4.3.1",
"domhandler": "^6.0.1",
"fast-glob": "^3.2.11",
"hast-util-to-html": "^8.0.4",
"hast-util-to-html": "^9.0.6",
"hast-util-to-string": "^3.0.1",
"hastscript": "^7.0.2",
"hastscript": "^9.0.3",
"html-escaper": "^3.0.3",
"htmlparser2": "^7.2.0",
"htmlparser2": "^12.0.0",
"kleur": "^4.1.5",
"mdast-util-mdx-jsx": "^2.1.2",
"mdast-util-to-string": "^3.1.1",
"mdast-util-mdx-jsx": "^3.2.1",
"mdast-util-to-string": "^4.0.0",
"node-fetch": "^3.2.10",
"organize-imports-cli": "^1.0.2",
"p-retry": "^5.1.1",
"postcss": "^8.5.31",
"p-retry": "^9.0.0",
"postcss": "^8.5.32",
"prompts": "^2.4.2",
"remark": "^14.0.2",
"remark-directive": "^2.0.1",
"remark-gfm": "^3.0.1",
"remark-mdx": "^2.3.0",
"remark": "^15.0.1",
"remark-directive": "^3.0.1",
"remark-gfm": "^4.0.1",
"remark-mdx": "^3.1.1",
"simple-git": "^4.0.2",
"stream-json": "^3.7.0",
"stream-json": "^3.8.0",
"tsm": "^2.3.0",
"tsx": "^4.23.15",
"typescript": "^5.3.2",
"unified": "^10.1.2",
"typescript": "^6.0.3",
"unified": "^11.0.5",
"unist-util-remove": "^4.0.0",
"unist-util-visit": "^5.1.0",
"unist-util-visit": "^5.2.0",
"unist-util-walker": "^1.0.0",
"vfile": "^5.3.6",
"vitest": "^5.0.5"
"vfile": "^6.0.3",
"vitest": "^5.1.0"
}
}
6 changes: 3 additions & 3 deletions apps/docs/plugins/rehype-doc-table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const NOWRAP_CODE_MAX = 48;
const unbreakable = (value: string) => value.length <= NOWRAP_CODE_MAX && !/\s/.test(value);

const addClass = (node: Element, className: string) => {
node.properties = { ...node.properties, className };
node.properties = { ...node.properties, className: [className] };
};

/*
Expand All @@ -37,7 +37,7 @@ const addCellClass = (cell: Element, baseClass: string) => {
? baseClass.replace('text-start', align === 'center' ? 'text-center' : 'text-end')
: baseClass;
const rest = inline.replace(/text-align:\s*[a-z]+;?\s*/, '').trim();
cell.properties = { ...cell.properties, className };
cell.properties = { ...cell.properties, className: [className] };
delete cell.properties.align;
if (rest) cell.properties.style = rest;
else delete cell.properties.style;
Expand Down Expand Up @@ -96,7 +96,7 @@ export default function rehypeDocTable() {
parent.children[index] = {
type: 'element',
tagName: 'div',
properties: { 'data-doc-block': '', className: 'w-full overflow-x-auto' },
properties: { 'data-doc-block': '', className: ['w-full', 'overflow-x-auto'] },
children: [node],
position: node.position,
};
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/plugins/rehype-optimize-static.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export function rehypeOptimizeStatic(): Transformer<Root, Root> {
const allPossibleElements = new Set<Node>();
const elementStack: Node[] = [];

walk(tree, {
walk(tree as Node, {
enter(node) {
// @ts-expect-error test tagName naively
const isHeading = node.tagName && headingRe.test(node.tagName);
Expand Down
7 changes: 4 additions & 3 deletions apps/docs/scripts/lib/linkcheck/base/page.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { Document, Element } from 'domhandler';
import htmlparser2 from 'htmlparser2';
import { isTag, type Document, type Element } from 'domhandler';
import * as htmlparser2 from 'htmlparser2';

export interface AllPagesByPathname {
[key: string]: HtmlPage;
Expand Down Expand Up @@ -91,7 +91,8 @@ export class HtmlPage {
let el: Element | null = start;
while (el) {
if (test(el)) return el;
el = htmlparser2.DomUtils.getParent(el);
const parent = htmlparser2.DomUtils.getParent(el);
el = parent && isTag(parent) ? parent : null;
}
return null;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import FrameBox from '@aziontech/webkit/frame-box'
import ItemList from '@aziontech/webkit/item-list'
import DocItem from '@aziontech/webkit/doc-item'

This design serves teams whose API responses are personalized or transactional and cannot be cached. The application bypasses the cache on those paths, so every call reaches the origin through a connector. Application Accelerator unlocks that bypass and the `OPTIONS`, `POST`, `PUT`, `PATCH`, and `DELETE` methods an API needs. The cacheable paths of the same site keep their cache rules. The design implements the use case [Accelerate websites and APIs with a CDN](/en/documentation/use-cases/improve-performance-and-reliability/accelerate-websites-and-apis-with-a-cdn/).
This design serves teams whose API responses are personalized or transactional and cannot be cached. The application bypasses the cache on those paths, so every call reaches the origin through a connector. Application Accelerator unlocks that bypass. The cacheable paths of the same site keep their cache rules. The design implements the use case [Accelerate websites and APIs with a CDN](/en/documentation/use-cases/improve-performance-and-reliability/accelerate-websites-and-apis-with-a-cdn/).

## Architecture diagram

Expand Down Expand Up @@ -43,18 +43,18 @@ flowchart TD
1. A client sends a request to the domain of a workload, and the workload's deployment names the application.
2. The application runs its Request Phase rules in order. A rule that matches a dynamic path, such as `/api/`, carries the **Bypass Cache** behavior.
3. **Bypass Cache** sends the request to the origin through the connector that a **Set Connector** rule names, and Azion stores no copy of the response. A response to a request sent with `Pragma: azion-debug-cache` reports `BYPASS` in its `x-cache` header.
4. The connector reaches the origin with the protocol its settings decide. Where possible, the bypassed request travels on a keep-alive connection to the origin.
4. The connector reaches the origin with the protocol its settings decide.
5. A request on a cacheable path takes the cache setting that a **Set Cache Policy** rule applies. Cache answers from a valid copy, and a miss reaches the origin through the same connector.
6. Real-Time Metrics records every request to the domain. On a dynamic path, the request time always includes the time the origin takes to answer.

Every response returns through the application, which delivers it to the client. Nothing on a dynamic path is stored, so that path has no TTL to set and nothing to purge. It also has no copy to serve when the origin fails, so [Keep an application online when an origin fails](/en/documentation/use-cases/improve-performance-and-reliability/keep-an-application-online-when-an-origin-fails/) adds a standby origin behind the same connector to keep those paths answering. The decisions are which paths bypass the cache and how the connector reaches the origin.

## Components

- **application**: the Platform Resource that holds the per-path rules. A Request Phase rule with **Bypass Cache** matches each dynamic path, and **Set Cache Policy** rules apply cache settings to the other paths. A **Max Age** of `0` does not replace the bypass. It merges parallel requests for one object into one origin request, so two simultaneous callers receive the same answer.
- **Application Accelerator**: the Product that lets the application accept `OPTIONS`, `POST`, `PUT`, `PATCH`, and `DELETE`, beyond the `GET` and `HEAD` it accepts natively. It also unlocks **Bypass Cache**. A request that **Bypass Cache** sends to the origin keeps protocol optimizations and, where possible, a keep-alive connection to it. Its switch belongs to the application and is off on a new one.
- **application**: the Platform Resource that holds the per-path rules. A Request Phase rule with **Bypass Cache** matches each dynamic path, and **Set Cache Policy** rules apply cache settings to the other paths.
- **Application Accelerator**: the Platform Resource that unlocks **Bypass Cache** and makes `POST` and `OPTIONS` responses cacheable. Its switch belongs to the application and is off on a new one.
- **connector**: the Platform Resource that carries the origin's address and shapes each request to it, for every dynamic request and every cache miss. Its **Transport Protocol Policy** sets the protocol to the origin: forcing HTTPS protects that leg and costs a TLS handshake on every new connection. Without Load Balancer, the connection's timeouts follow platform defaults and are not settings.
- **Cache**: stores the responses of the paths that stay cacheable, under the cache setting each path's rule applies. **Bypass Cache** does not reach the Tiered Cache layer. An application whose cache settings have Tiered Cache on keeps caching objects there for the minimum TTL.
- **Cache**: stores the responses of the paths that stay cacheable, under the cache setting each path's rule applies. **Bypass Cache** does not reach the Tiered Cache layer. An application whose cache settings have Tiered Cache on keeps caching objects there for the Max Age of the cache setting.
- **Real-Time Metrics**: shows how long the application takes to answer a request, filtered to the domain. The **Requests** dashboard charts **Average Request Time**, and a filter on **Upstream Cache Status** set to `BYPASS` keeps only the bypassed requests. In the GraphQL API, the `upstreamResponseTime` field of [`workloadMetrics`](/en/documentation/devtools/graphql/gql-real-time-metrics-fields/#workloadmetrics) sums the time Azion takes to receive the origin's responses.

## Implementation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ flowchart TD

1. Edge DNS resolves the domain to the workload, and the user's request reaches the application in a nearby data center.
2. The application's rules read the path in the Request Phase and apply a cache setting. A valid copy in the cache of that data center answers the request, and the origin is not asked.
3. On a miss for a static file, the data center asks the Tiered Cache layer, which every data center shares, before it asks the origin.
3. On a miss for a static file, the data center asks the Tiered Cache layer, in the region that the topology of the cache setting selects, before it asks the origin.
4. A miss in every layer reaches the origin through the connector, and the response is stored for the next request. A call on a bypassed path, such as `/api/`, always reaches the origin, and its response is never stored.
5. The connector reaches the origin from an address on the `Azion Origin Shield` list, and the firewall of the origin refuses every other source.
6. When content changes, a cache key purge removes it from the Tiered Cache layer first and from Cache second. The next request then fetches the new version from the origin.
Expand All @@ -63,7 +63,7 @@ Every response returns through the application, which delivers it to the user. T
- **Edge DNS**: resolves the domain to the workload. A subdomain points at the workload domain with a `CNAME` record, and the apex points at it with an `ANAME` record.
- **application**: the Platform Resource that holds the cache rules. Each rule matches a set of paths and applies a cache setting. A rule with the **Bypass Cache** behavior keeps a path out of the cache, and that behavior requires Application Accelerator on the application.
- **Cache**: stores each response in the data center that fetched it, for the TTL of its cache setting, and answers repeated requests from that copy. The cache key is the scheme, the host, and the path, plus the variations a cache setting adds. A request that carries `Pragma: azion-debug-cache` receives the key in the `x-cache-key` header. For static files, the design keeps the TTL at 15 days (`1296000` seconds) or less, the default maximum of the [Static Cache template](/en/documentation/guides/application-development/frameworks/static-cache-template/).
- **Tiered Cache**: the Feature that adds a second cache layer between Cache and the origin, shared by every data center, in the region its topology names. It requires _Override cache behavior_ and a **Max Age** of at least 3 seconds.
- **Tiered Cache**: the Feature that adds a second cache layer between Cache and the origin, in the region its topology names. It requires _Override cache behavior_ and, with Application Accelerator on, a **Max Age** of at least 3 seconds.
- **connector**: the Platform Resource that reaches the origin on a miss in every cache layer, and on every call to a bypassed path.
- **Origin Shield**: with Origin IP ACL on the connector, the origin's firewall allows the prefixes of the `Azion Origin Shield` list and refuses every other source. Azion does not enforce the allowlist, and the list carries IPv4 and IPv6 prefixes that the allowlist needs together.
- **Real-Time Purge**: the Platform Resource that removes changed content before its TTL ends. A cache key purge takes up to 50 keys per request, and it is the only purge type that reaches the Tiered Cache layer.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ Request the same URL twice with the `Pragma: azion-debug-cache` header:
curl -sI -H "Accept: image/webp" -H "Pragma: azion-debug-cache" "https://www.example.com/images/blue-shirt.jpg?ims=fit-in/800x800/filters:quality(85)"
```

The second response carries `x-cache: HIT`, and `x-cache-key` ends with the `ims` value and `@@webp`, the format the variant was converted to. The `400x400` URL, requested with the same headers, has a different `x-cache-key`, and its first response carries `x-cache: MISS`. The `800x800` URL requested with `-H "Accept: image/jpeg"` and the `Pragma: azion-debug-cache` header carries the original format in `content-type`, and its `x-cache-key` carries no `@@webp`. For how to read the debug headers, refer to [Check the cache status of a response](/en/documentation/guides/application-performance/cache-and-purge/check-page-cache-time/).
The second response carries `x-cache: HIT`, and `x-cache-key` ends with the `ims` value followed by `webp`, the format the variant was converted to. The `400x400` URL, requested with the same headers, has a different `x-cache-key`, and its first response carries `x-cache: MISS`. The `800x800` URL requested with `-H "Accept: image/jpeg"` and the `Pragma: azion-debug-cache` header carries the original format in `content-type`, and its `x-cache-key` carries no `webp` at the end. For how to read the debug headers, refer to [Check the cache status of a response](/en/documentation/guides/application-performance/cache-and-purge/check-page-cache-time/).

In the [Build and run marketing websites](/en/documentation/use-cases/build-and-run-applications/build-and-run-marketing-websites/) use case, expect:

Expand All @@ -516,7 +516,10 @@ In the [Build e-commerce storefronts](/en/documentation/use-cases/build-and-run-

- **Product images are processed.** An image requested with an `ims` query string, such as `https://www.example.com/media/blue-shirt.jpg?ims=400x`, carries `x-ims: Enabled`.

These checks confirm the [Optimize images for websites and mobile apps](/en/documentation/use-cases/improve-performance-and-reliability/optimize-images-for-websites-and-mobile-apps/) use case.
In the [Optimize images for websites and mobile apps](/en/documentation/use-cases/improve-performance-and-reliability/optimize-images-for-websites-and-mobile-apps/) use case, expect:

- **Each variant is converted to a format the browser accepts.** A request with `Accept: image/webp` carries `x-ims: Enabled` and `content-type: image/webp`.
- **Each size is cached on its own.** The second request for the `800x800` URL carries `x-cache: HIT`, and the `400x400` URL has a different `x-cache-key`.

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ An application. To create one, refer to [Applications quickstart](/en/documentat

## Enable a Product on the application

A new application runs Cache and Functions. Application Accelerator and Image Processor stay off until you enable them. Azion Console labels Cache "Automatically enabled in all accounts."
A new application runs Cache and Functions. Application Accelerator and Image Processor stay off until you enable them. Azion Console labels Cache "Automatically enabled in all accounts." Cache cannot be turned off: the API refuses `modules.cache.enabled` set to `false` with error `31001`, `Cache Cannot Be False`.

Each Product changes what the rules and settings of the application can do:

Expand Down
Loading
Loading