app scale
Change how many instances an application runs, and how large they are.
How many copies run, and how large each one is. Both are set here, together or one at a time, and neither needs a deployment.
It describes the state you want rather than an action to take, so running it twice is harmless and running it against an application that already matches costs nothing and still exits 0.
Usage
outplane app scale [APP] [flags]Arguments
| Argument | Type | Description |
|---|---|---|
APP | string | App name or id. Defaults to the linked app. |
Flags
| Flag | Type | Description |
|---|---|---|
--instances | int | Replica count, 1 to 5. |
--size | string | Instance type. The larger ones need a paid plan. One of op-20, op-22, op-34, op-46, op-58, op-70, op-82, op-94. |
The global flags apply as well.
Output
| Field | Type | Description |
|---|---|---|
app | string | |
appId | string | |
instances | int | What it will run. |
size | string | |
previousInstances | int | |
previousSize | string | |
changed | bool | False when it already matched, and for a dry run. |
Examples
Run three copies
outplane app scale checkout --instances 3See what would change, without changing it
outplane app scale checkout --instances 3 --dry-run --json{
"app": "checkout",
"changed": false,
"instances": 3,
"previousInstances": 1
}Give it more memory, keeping the count
outplane app scale checkout --size op-34What to Know
- The flag you omit is filled in from the current setting, which is read first. Two callers scaling the same application at the same time can therefore overwrite each other; the API offers no partial update.
- Applied without a deployment. The instances change within seconds, and
outplane app instancesshows it happening. - changed is false when the application already matched, and the command still exits 0: it is a statement of the desired state, not an action.
- A size above the plan's allowance is exit 7, not a validation error. The list of allowed sizes is the team's, not the platform's.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
5 | not_found | The named resource does not exist, or is not visible to this credential. |
7 | quota | Plan limit reached or payment required. Not a rate limit; retrying will not help. |
8 | upstream | The Out Plane API returned a server error. |
The code on the error object is one of app.instances_invalid, app.size_invalid, usage.missing_argument, quota.limit_reached, app.not_found, context.no_app. Branch on that, or on the exit status. The message is prose and changes.