Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions public/changelog.json
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,13 @@
"title": "Bounded Market Price Feeds",
"topic": "Data Feeds"
},
{
"category": "release",
"date": "2026-03-20",
"description": "CRE CLI version 1.6.0 is now available. This release adds a `--limits` flag to `cre workflow simulate`, letting you simulate workflows under specific resource constraints to better reflect production behavior. It also includes improvements to the `cre init` experience, a binding bug fix, and improved WASM debug symbol retention during simulation.\n\nUpdate your CLI by running `cre update` when prompted, or follow the [CLI Installation guide](https://docs.chain.link/cre/getting-started/cli-installation) for fresh installations.\n\n[See all changes on GitHub](https://github.com/smartcontractkit/cre-cli/compare/v1.5.0...v1.6.0)",
"title": "CRE CLI v1.6.0 — Simulation Limits and Init Improvements",
"topic": "CRE"
},
{
"category": "release",
"date": "2026-03-17",
Expand Down
4 changes: 4 additions & 0 deletions src/config/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -359,6 +359,10 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
title: "Simulating Workflows",
url: "cre/guides/operations/simulating-workflows",
},
{
title: "Testing Production Limits",
url: "cre/guides/operations/understanding-limits",
},
{
title: "Deploying Workflows",
url: "cre/guides/operations/deploying-workflows",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -338,5 +338,6 @@ Despite these limitations, simulation is an essential tool for catching bugs, va

## Next steps

- **Test against production limits**: Use the `--limits` flag to enforce production quotas during simulation. See [Testing Production Limits](/cre/guides/operations/understanding-limits).
- **Deploy your workflow**: Once you're confident your workflow works correctly, see [Deploying Workflows](/cre/guides/operations/deploying-workflows).
- **CLI reference**: For a complete list of flags and options, see the [CLI Workflow Commands reference](/cre/reference/cli/workflow/).
128 changes: 128 additions & 0 deletions src/content/cre/guides/operations/understanding-limits.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
---
section: cre
date: Last Modified
title: "Testing Production Limits"
metadata:
description: "Test workflows against production limits locally: use the --limits flag to enforce, disable, or customize simulation limits before deploying."
datePublished: "2026-03-19"
lastModified: "2026-03-19"
---

import { Aside, CodeSample } from "@components"

Simulation limits let you test your workflows against production constraints locally before deploying. By enforcing the same quotas that apply in production, you can catch violations early and avoid surprises at deploy time.

## Why use simulation limits

When you simulate a workflow, the CLI can enforce the same [service quotas](/cre/service-quotas) that your workflow will be subject to in production. This helps you:

- **Catch violations early**: Identify workflows that exceed timeout, memory, or rate limits before deploying.
- **Match production behavior**: Ensure your local simulation mirrors how your workflow will run on the network.
- **Avoid surprises at deploy time**: Confidently deploy knowing your workflow operates within quota boundaries.

## Using the `--limits` flag

The `--limits` flag controls how simulation limits are enforced. It supports three modes:

### Default limits (default behavior)

By default, the simulator enforces embedded production limits. You do not need to pass any flag:

```bash
cre workflow simulate my-workflow --target staging-settings
```

This is equivalent to explicitly passing `--limits default`:

```bash
cre workflow simulate my-workflow --limits default --target staging-settings
```

### No limits

To disable all limit enforcement during simulation, use `--limits none`:

```bash
cre workflow simulate my-workflow --limits none --target staging-settings
```

<Aside type="caution" title="Use with care">
Running without limits is useful for debugging, but your workflow may still fail when deployed if it exceeds
production quotas. Always validate with limits enabled before deploying.
</Aside>

### Custom limits

You can provide a custom limits file to override specific values:

```bash
cre workflow simulate my-workflow --limits ./my-limits.json --target staging-settings
```

See [Customizing limits](#customizing-limits) for how to create a custom limits file.

## Viewing default limits

Use the [`cre workflow limits export`](/cre/reference/cli/workflow#cre-workflow-limits) command to inspect the default production limits:

```bash
cre workflow limits export
```

This outputs the default limits as JSON to stdout. You can redirect the output to a file:

```bash
cre workflow limits export > my-limits.json
```

## Customizing limits

To customize limits for simulation:

1. **Export the defaults** to a JSON file:

```bash
cre workflow limits export > my-limits.json
```

2. **Edit the JSON file** to adjust the values you want to change. For example, you might increase the execution timeout or HTTP call limit for testing purposes.

3. **Pass the custom file** to the simulator:

```bash
cre workflow simulate my-workflow --limits ./my-limits.json --target staging-settings
```

<Aside type="note" title="Custom limits are for simulation only">
Custom limits only affect local simulation. Production deployments always use the platform-enforced quotas listed on
the [Service Quotas](/cre/service-quotas) page. To change production limits, see [Requesting limit
increases](#requesting-limit-increases).
</Aside>

## Default limit values

The default limits enforced during simulation match the production quotas documented on the [Service Quotas](/cre/service-quotas) page. Use `cre workflow limits export` to inspect the exact values applied to your simulations.

## Requesting limit increases

If your workflow requires higher limits than the defaults, you can request a limit increase:

1. Go to [cre.chain.link](https://cre.chain.link) and log in to your account.
2. Click **Help** in the sidebar.
3. Set **Issue Type** to **Other**.
4. In the **Description** field, include:
- Which limit you need increased
- The desired value
- The reason for the increase

<Aside type="tip" title="Be specific">
Include the quota key from the [Service Quotas](/cre/service-quotas) page (e.g., `PerWorkflow.ExecutionTimeout`) in
your request to help the team process it faster.
</Aside>

## Next steps

- **Service quotas reference**: See the full [Service Quotas](/cre/service-quotas) page for all quota keys and values.
- **Simulating workflows**: Learn more about the simulation environment in [Simulating Workflows](/cre/guides/operations/simulating-workflows).
- **CLI reference**: See the [`cre workflow simulate`](/cre/reference/cli/workflow#cre-workflow-simulate) and [`cre workflow limits`](/cre/reference/cli/workflow#cre-workflow-limits) command references for all available flags.
- **Deploy your workflow**: Once validated, see [Deploying Workflows](/cre/guides/operations/deploying-workflows).
Loading
Loading