Skip to content

Commit

Permalink
add resource limits docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FarazPatankar committed Jul 25, 2024
1 parent c6e331f commit d3ac6e4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/data/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export const sidebarContent: ISidebarContent = [
makePage("Healthchecks and Restarts", "guides"),
makePage("Monorepo", "guides"),
makePage("Cron Jobs", "guides"),
makePage("Resource Limits", "guides"),
makePage("Optimize Usage", "guides"),
],
},
Expand Down Expand Up @@ -144,7 +145,7 @@ export const sidebarContent: ISidebarContent = [
makePage("Deploy an Otel Collector Stack", "tutorials"),
makePage("Deploy and Monitor Mongo", "tutorials"),
makePage("Add a CDN using CloudFront", "tutorials"),
makePage("Deploying a Monorepo", "tutorials")
makePage("Deploying a Monorepo", "tutorials"),
],
},
{
Expand Down
27 changes: 27 additions & 0 deletions src/docs/guides/resource-limits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Resource Limits
---

Resource limits are a way to limit the maximum amount of resources available to a service.

## Configure Resource Limits

You can update resource limits from the service settings page under the "Deploy" section.

<Image
src="https://res.cloudinary.com/railway/image/upload/v1721917970/resource-limits.png"
alt="Resource Limits setting"
layout="intrinsic"
width={1298}
height={658}
quality={80}
/>

### Use Resource Limits

Using resource limits makes sense in scenarios where:

1. You don't want to risk a high bill due to unexpected spikes in usage.
2. You are okay with the service possibly crashing if it exceeds the limit, possibly in non-production environments.

**Note**: We do not recommend using resource limits in production environments as setting your limits too low can cause your service to crash.

0 comments on commit d3ac6e4

Please sign in to comment.