Skip to content

docs: document region as an array of strings with locale keywords #278

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.

Sign up for GitHub

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

Draft
jonoirwinrsa wants to merge 2 commits into
base: master
Choose a base branch
from
+40 −11
Draft

docs: document region as an array of strings with locale keywords #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aca7621
docs: document region as an array of strings with locale keywords
jonoirwinrsa May 2, 2026
d684380
Prettified Code!
jonoirwinrsa May 4, 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
35 changes: 32 additions & 3 deletions deployments/multi-region-deployment.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,17 +70,46 @@ cerebrium download results.json -r eu-north-1

## App Deployment

Set the deployment region using the `region` parameter in the `[cerebrium.hardware]` section of `cerebrium.toml`:
Set the deployment regions using the `region` parameter in the `[cerebrium.hardware]` section of `cerebrium.toml`. The value is an array of strings — apps deploy to every region in the list:

```toml
[cerebrium.hardware]
region = "us-east-1"
provider = "aws"
region = ["us-east-1"]
compute = "AMPERE_A10"
cpu = 2
memory = 8.0
```

To deploy to several regions at once, list each one explicitly:

```toml
region = ["us-east-1", "eu-west-2"]
```

### Region Keywords

In addition to explicit region names, `region` accepts shorthand keywords that expand to a group of regions. This is useful when you want to deploy across an entire locale or to every available region without listing them individually.

| Keyword | Expands to |
| ---------- | ------------------------- |
| `*` | All available regions |
| `us` | `us-east-1` |
| `us-east` | `us-east-1` |
| `eu` | `eu-west-2`, `eu-north-1` |
| `eu-west` | `eu-west-2` |
| `eu-north` | `eu-north-1` |
| `uk` | `eu-west-2` |
| `ap` | `ap-south-1` |
| `ap-south` | `ap-south-1` |

Keywords and explicit region names can be mixed in the same array:

```toml
region = ["us", "eu-west-2"]
```

If `region` is omitted, apps deploy to all available regions (`["*"]`).

## Pricing

Pricing varies by region based on local infrastructure costs and availability:
Expand Down
16 changes: 8 additions & 8 deletions toml-reference/toml-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,14 @@ The `[cerebrium.runtime.custom]` section configures custom web servers and runti

The `[cerebrium.hardware]` section defines compute resources.

| Option | Type | Default | Description |
| --------- | ------- | ----------- | ------------------------------------ |
| cpu | float | required | Number of CPU cores |
| memory | float | required | Memory allocation in GB |
| compute | string | "CPU" | Compute type (CPU, AMPERE_A10, etc.) |
| gpu_count | integer | 0 | Number of GPUs |
| provider | string | "aws" | Cloud provider |
| region | string | "us-east-1" | Deployment region |
| Option | Type | Default | Description |
| --------- | --------------- | -------- | -------------------------------------------------------------------------------------------------- |
| cpu | float | required | Number of CPU cores |
| memory | float | required | Memory allocation in GB |
| compute | string | "CPU" | Compute type (CPU, AMPERE_A10, etc.) |
| gpu_count | integer | 0 | Number of GPUs |
| provider | string | "aws" | Cloud provider |
| region | array of string | `["*"]` | Regions to deploy to. Accepts explicit region names (e.g. `"us-east-1"`) and keywords like `"eu"`. |

<Warning>
Memory refers to RAM, not GPU VRAM. Ensure sufficient memory for your
Expand Down