Skip to content

Commit

Permalink
Merge pull request #1623 from appwrite/feat-compute-docs
Browse files Browse the repository at this point in the history
Add docs for compute
  • Loading branch information
eldadfux authored Jan 9, 2025
2 parents 335ae3e + 565e678 commit 590b5b3
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/routes/docs/advanced/platform/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,16 @@
}
]
},
{
label: 'Add ons',
items: [
{
new: true,
label: 'Compute',
href: '/docs/advanced/platform/compute'
},
]
},
{
label: 'Configuration',
items: [
Expand Down
10 changes: 10 additions & 0 deletions src/routes/docs/advanced/platform/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,13 @@ Add a custom domain for your Appwrite APIs.
Create custom branding and messages when you communicate with users.
{% /cards_item %}
{% /cards %}

# Add Ons {% #add-ons %}

Learn about additional features and functionalities that Appwrite offers.

{% cards %}
{% cards_item href="/docs/advanced/platform/compute" title="Compute" %}
Learn about Appwrite's different compute add-ons.
{% /cards_item %}
{% /cards %}
55 changes: 55 additions & 0 deletions src/routes/docs/advanced/platform/compute/+page.markdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
layout: article
title: Compute
description: Learn about Appwrite Functions compute add-ons and the different CPU and memory options for function runtimes.
---

{% info title="Note" %}
Pricing changes will take effect on March 1st, 2025. Check out [this blog post](https://appwrite.io/blog/post/introducing-new-compute-capabilities-appwrite-functions) for more information.
{% /info %}

Appwrite's paid plans give you the ability to change your function's allocated CPU Cores and Memory, enabling functions and builds to perform more computionally demanding actions quicker.

These options enable greater performance and flexibility, allowing developers to optimize their functions based on specific requirements. For instance, resource-intensive tasks such as real-time data processing or complex computational operations can now be executed more efficiently. Additionally, enhanced memory configurations support larger datasets and more demanding applications, broadening the scope of what can be achieved with Appwrite Functions.

# Specifications {% #specifications %}

Appwrite Cloud has the following specifications available:

| Memory | CPU Cores | Hourly Usage |
|--------|-----------|--------------|
| 512MB | 0.5 | 0.25 |
| 512MB | 1 | 0.5 |
| 1GB | 1 | 1 |
| 2GB | 2 | 4 |
| 4GB | 2 | 8 |
| 4GB | 4 | 16 |

{% info title="Note" %}
Only customers on either Pro or Scale are able to change their specification from the default 512MB & 0.5 CPU option. For custom compute options please contact our [sales team](https://appwrite.io/contact-us/enterprise).
{% /info %}

# GB-Hours

GB-hours is a metric used to quantify the consumption of compute resources by combining both memory usage and the duration of that usage. Specifically, it represents the number of gigabytes (GB) of memory utilized multiplied by the number of hours those resources are active. This metric provides a comprehensive view of resource usage over time, allowing for accurate tracking, optimization, and billing based on actual compute needs.

How It Works:
- Memory Allocation: Determine the amount of memory (in GB) that your application or function requires while running.
- Duration: Measure the total time (in hours) that the allocated memory is in use.
- Calculation: Multiply the memory allocated by the duration to obtain the total GB-hours consumed.

Example:

Assuming you have a function that requires 4 GB of memory to operate. If this function runs continuously for 2 hours, the compute resource usage would be:

**4GB * 2 hours = 8 GB-hours**

This means the function has consumed 8 GB-hours of compute resources.

## Allocation and pricing plans

- Free plan includes up to 100 GB-hours of execution and build time per month.

- Pro and Scale plans include up to 1,000GB of execution and build time per month. Additional usage is available at a rate of $0.09 per GB-hour.

Once the monthly GB-hours limit is reached, additional usage will automatically apply add-ons to your Pro or Scale account. It is recommended to set budget alerts and a budget cap to prevent unexpected payments.

0 comments on commit 590b5b3

Please sign in to comment.