-
Notifications
You must be signed in to change notification settings - Fork 53
docs: Add instance_size example #347
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 |
|---|---|---|
|
|
@@ -115,7 +115,8 @@ | |
| ] | ||
| }, | ||
| "docs/account", | ||
| "docs/teams" | ||
| "docs/teams", | ||
| "docs/scaling" | ||
| ] | ||
| }, | ||
| { | ||
|
|
||
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,37 @@ | ||
| --- | ||
| title: Scaling | ||
| description: Adjusting the computational resources allocated to your application | ||
| icon: arrows-up-down | ||
| --- | ||
| At Shuttle, you can adjust the vCPU and memory resources allocated to your application’s compute environment. The level of scaling available depends on your [Account Tier](/docs/account#account-tiers). This functionality enables you to **vertically scale** your application to better suit your specific performance requirements and workload demands. | ||
|
|
||
| <Warning> | ||
| Changing the compute type or instance size of your application will result in additional charges. These are calculated according to our [usage-based pricing](/pricing/billing#usage-based-pricing) model. Please ensure you review the pricing details before making adjustments. | ||
| </Warning> | ||
|
|
||
| ### Example | ||
|
|
||
| The example below illustrates how to configure your application to use a **medium** instance size: | ||
|
|
||
| ```rust main.rs | ||
| #[shuttle_runtime::main(instance_size = "m")] | ||
| async fn main( | ||
| ) -> shuttle_axum::ShuttleAxum { | ||
| // Your application logic here | ||
| } | ||
| ``` | ||
|
|
||
| ### Available Instance Sizes | ||
|
|
||
| The table below lists the available `instance_size` values, along with the corresponding instance type and minimum required Account Tier: | ||
|
|
||
| | Instance Size | Value | Account Tier | | ||
| | --- | --- | --- | | ||
| | **Basic** | `xs` | Community+ | | ||
| | **Small** | `s` | Pro+ | | ||
| | **Medium** | `m` | Pro+ | | ||
| | **Large** | `l` | Pro+ | | ||
| | **X Large** | `xl` | Pro+ | | ||
| | **XX Large** | `xxl` | Growth+ | | ||
|
|
||
| _Ensure your selected instance size aligns with your application's current and anticipated workload._ | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe good to link to these docs here as well, to make it clear what the sizes correspond to.