-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
docs: add compute private beta page #3472
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: "Compute private beta" | ||
| description: "Early access to the new microVM-based compute runtime." | ||
| sidebarTitle: "Compute private beta" | ||
| hidden: true | ||
| --- | ||
|
|
||
| <Warning> | ||
| MicroVM compute is in private beta. Use it in staging only - do not run production traffic on it | ||
| yet, and expect bugs. | ||
| </Warning> | ||
|
|
||
| ## What it is | ||
|
|
||
| MicroVM compute is a new runtime for your tasks, designed for fast cold starts via boot snapshots. For most tasks the migration is transparent - the same task code runs unchanged. | ||
|
|
||
| ## Getting access | ||
|
|
||
| You can't opt in yourself. Once we've enabled the private beta for your org, the `us-east-1-next` region becomes available on the **Regions** page in the dashboard. If you'd like access, ping us on Slack. | ||
|
|
||
| ## Routing runs to microVM compute | ||
|
|
||
| MicroVM compute is exposed as a region: `us-east-1-next`. The region is tagged with a **microVM** badge on the **Regions** page. | ||
|
|
||
| ### Per-trigger override (recommended) | ||
|
|
||
| The `region` option is part of `TriggerOptions`, accepted by most triggering functions. | ||
|
|
||
| ```typescript | ||
| import { yourTask } from "./trigger/your-task"; | ||
|
|
||
| await yourTask.trigger(payload, { region: "us-east-1-next" }); | ||
| ``` | ||
|
|
||
| This is the safest way to opt in during the beta - you control exactly which runs land on microVM compute. | ||
|
|
||
| To gate it on an environment variable so prod isn't affected, define one constant and reuse it at every call site: | ||
|
|
||
| ```typescript | ||
| const defaultRegion = process.env.USE_COMPUTE_BETA === "1" ? "us-east-1-next" : undefined; | ||
|
|
||
| await yourTask.trigger(payload, { region: defaultRegion }); | ||
| ``` | ||
|
|
||
| Set `USE_COMPUTE_BETA=1` in the staging environment of the app that calls `trigger()` (typically Vercel, or wherever you deploy your app). | ||
|
|
||
| ### Set it as your project default | ||
|
|
||
| Open the **Regions** page in the dashboard and set `us-east-1-next` as the project-wide default. This applies to **all environments in the project**, so only do this on a project that is running staging traffic only. | ||
|
|
||
| ## Cold start expectations | ||
|
|
||
| A few things to be aware of during the beta: | ||
|
|
||
| - **`small-1x` is the default and what we've optimized for.** Boot snapshots are precreated for `small-1x` only. Other machine sizes will have a slower first run after each deploy while we generate the snapshot - subsequent runs use it. | ||
| - **Avoid `micro` during the beta.** Cold starts on `micro` are noticeably slower than other sizes. | ||
|
|
||
| We'll be shipping CLI and SDK changes during the beta to make cold start times more consistent across machine sizes. Compute-specific prereleases will be announced on this page as we go, and we'll also reach out on Slack. | ||
|
|
||
| ## Reporting issues | ||
|
|
||
| Send anything weird (errors, slow runs, restore failures, anything that surprises you) over Slack with the run ID. The more reproductions we get during the beta, the faster we harden it for public beta. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.