Skip to content

Commit 88b89c1

Browse files
AnouckColsonchadcarlson
andauthored
Document configurable build resources (#3782)
* Document build resources * Add note * Add notes * Apply feedback from review --------- Co-authored-by: chadcarlson <[email protected]>
1 parent 58c374b commit 88b89c1

File tree

12 files changed

+80
-2
lines changed

12 files changed

+80
-2
lines changed

sites/friday/src/manage-resources/adjust-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Resource configuration
33
description: Configure CPU, RAM, and disk storage on a per-environment basis so your apps and services can run smoothly.
4-
weight: -100
4+
weight: -200
55
keywords:
66
- "resources"
77
- "flexible resources"
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Build resources
3+
description: Find out how build resources work on {{% vendor/name %}}.
4+
weight: -50
5+
---
6+
7+
When you push changes to your app through Git, your app is built then deployed.
8+
9+
During the build phase, {{% vendor/name %}} collects your entire app configuration and creates a build image into a dedicated build container.
10+
The duration of the build phase is directly linked to the amount of resources (CPU and RAM) allocated to that build container.
11+
12+
As a user, you get the following fixed amount of resources **per project for free**:
13+
14+
- 2.5 CPU hours
15+
- 5 RAM hours
16+
17+
If you consume more CPU or RAM, you get charged for them by the hour.
18+
For more information on the costs incurred, see the [{{% vendor/name %}} pricing page](https://upsun.com/pricing/).
19+
20+
You can adjust build resources through the {{% vendor/name %}} API to mitigate potential overuse,
21+
or influence the duration of your builds.
22+
To do so, run a command similar to the following:
23+
24+
```bash {location="Terminal"}
25+
{{% vendor/cli %}} project:curl settings -X PATCH -d '{"build_resources": {"cpu": 4.0, "memory": 2048}}'
26+
```
27+
28+
{{% note %}}
29+
30+
Before adding more CPU and RAM to shorten the duration of your builds,
31+
check that your build process supports using such extra resources.
32+
Otherwise, the duration of your builds will remain the same despite adding more resources.
33+
34+
{{% /note %}}
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Resource billing
3+
description: Keep an eye on costs related to resource usage.
4+
weight: -100
5+
keywords:
6+
- "resources"
7+
- "flexible resources"
8+
- "CPU"
9+
- "RAM"
10+
- "disk storage"
11+
- "costs"
12+
---
13+
14+
If you have the [**Manage Billing** permission](/administration/users.md#organization-permissions) on your organization,
15+
you can keep an eye on your costs related to resource usage.</br>
16+
To do so, after you've set or updated resources on your project,
17+
follow these steps in the [{{% vendor/name %}} Console](/administration/web/_index.md):
18+
19+
1. Navigate to your organization.
20+
2. Open the user menu (your name or profile picture).
21+
3. Click **Billing**.</br>
22+
A monthly estimate of how much each project is expected to cost is displayed.
23+
4. You can also view the costs related to every project you've been added to.</br>
24+
To do so, click **{{< icon more >}} More** next to the project,
25+
and select **Project Billing**.</br>
26+
A monthly estimate of all the expected costs related to resource allocation on the project is displayed.
27+
28+
{{< note >}}
29+
30+
These estimates reflect the expected costs **for a full month** based on the way resources are allocated **at the time of viewing**.
31+
They don't take into account the history of changes you may have made throughout the current month.</br>
32+
Therefore, if you make changes to resource allocation during the month, your monthly invoice will differ from these estimates.
33+
34+
{{< /note >}}
35+
36+
For information on resource-related costs, see the [{{% vendor/name %}} pricing page](https://upsun.com/pricing/).

sites/friday/src/manage-resources/resource-init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Resource initialization
33
description: Learn how resources are allocated by default upon first deployment, and how you can define a resource initialization strategy that better fits your needs.
4-
weight: -200
4+
weight: -300
55
keywords:
66
- "resources"
77
- "flexible resources"

sites/platform/src/create-apps/hooks/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Use build and deploy hooks
33
description: Add custom scripts at different stages in the build and deploy process.
44
layout: single
5+
weight: 13
56
---
67

78
As your app goes through the [build and deploy process](/learn/overview/build-deploy.md),

sites/platform/src/create-apps/multi-app/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ banner:
66
title: Feature availability
77
type: tiered-feature
88
body: This page applies to Grid and {{% names/dedicated-gen-3 %}} projects. To ensure you have enough resources to support multiple apps, you need at least a [{{< partial "plans/multiapp-plan-name" >}} plan](/administration/pricing/_index.md#multiple-apps-in-a-single-project). To set up multiple apps on {{% names/dedicated-gen-2 %}} environments, [contact Sales](https://platform.sh/contact/).
9+
weight: 8
910
---
1011

1112
{{% multi-app-intro %}}

sites/platform/src/create-apps/timezone.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Timezones"
33
description: Learn more about the different timezones on {{% vendor/name %}} and when you can customize them.
4+
weight: 9
45
---
56

67
On {{% vendor/name %}}, there are several timezones you might want to keep in mind.

sites/platform/src/create-apps/troubleshoot-disks.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Troubleshoot disks"
3+
weight: 10
34
---
45

56
{{% troubleshoot %}}

sites/platform/src/create-apps/troubleshoot-mounts.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Troubleshoot mounts"
3+
weight: 11
34
---
45

56
{{% troubleshoot %}}

sites/platform/src/create-apps/upgrading.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: "Upgrading"
3+
weight: 12
34
---
45

56
## Changes in version 2022.02

0 commit comments

Comments
 (0)