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
6 changes: 5 additions & 1 deletion docs/concepts/scaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,11 @@ Instead of manually adding more instances when traffic increases, an auto-scalin

### Example

With Defang a user, with a Pro and higher plan, can enable service level autoscaling by adding a _**x-defang-autoscaling**_ extension to the service which is to be autoscaled.
With Defang, users on the Pro plan or higher can enable service-level autoscaling in three steps:

1. Add the _**x-defang-autoscaling : true**_ extension to the service you want to autoscale.
2. Remove any _**replicas**_ field in the _**deploy**_ mapping (if present).
3. Deploy using staging or production [mode](/docs/concepts/deployments#deployment-modes). (e.g. ```defang compose up --provider=aws --mode=production```)

```yaml
services:
Expand Down
5 changes: 3 additions & 2 deletions docs/tutorials/scaling-your-services.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ Autoscaling allows your services to automatically adjust the number of replicas

### Enabling Autoscaling

To enable autoscaling for a service, add the `x-defang-autoscaling: true` extension under the service definition in your `compose.yaml` file.
To enable autoscaling for a service, add the `x-defang-autoscaling: true` extension under the service definition in your `compose.yaml` file and remove the _**replicas**_ field in your
_**deploy**_ mapping, if present. Autoscaling is available in staging and production [deployments modes](/docs/concepts/deployments#deployment_modes) only.

Example:

Expand All @@ -85,9 +86,9 @@ Requirements

- BYOC, your own cloud platform account.
- You must be on the Pro or higher plan to use autoscaling. ([Defang plans](https://defang.io/#pricing))
- _**replicas**_ must **NOT** be defined
- Only staging and production deployment modes supported. ([Deployment modes](/docs/concepts/deployment-modes))
- The service must be stateless or able to run in multiple instances. ([Scaling](/docs/concepts/scaling))
- Only CPU metrics are used for scaling decisions.

Best Practices

Expand Down