Skip to content

Commit a3e5c33

Browse files
authored
Revert "Revert instance mounts and temporary alias doc" (#3868)
1 parent 79e9b63 commit a3e5c33

File tree

2 files changed

+2
-16
lines changed

2 files changed

+2
-16
lines changed

sites/friday/src/create-apps/app-reference.md

+1-15
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ See how to [troubleshoot the warning](./troubleshoot-mounts.md#overlapping-folde
188188

189189
| Name | Type | Required | Description |
190190
| ------------- | -------------------- | -------- | ----------- |
191-
| `source` | `storage`, `tmp`, or `service` | Yes | Specifies the type of the mount:<br/><br/>- By design, `storage` mounts can be shared between instances of the same app. You can also configure them so they are [shared between different apps](#share-a-mount-between-several-apps).<br/><br/>- `tmp` mounts are local ephemeral mounts, where an external directory is mounted to the `/tmp` directory of your app.<br/>The content of a `tmp` mount **may be removed during infrastructure maintenance operations**. Therefore, `tmp` mounts allow you to **store files that you’re not afraid to lose**, such as your application cache that can be seamlessly rebuilt.<br/>Note that the `/tmp` directory has **a maximum allocation of 8 GB**.<br/><br/>- `service` mounts can be useful if you want to explicitly define and use a [Network Storage](/add-services/network-storage.md) service to share data between different apps (instead of using a `storage` mount).|
191+
| `source` | `storage`, `instance`, `tmp` (also called `temporary`), or `service` | Yes | Specifies the type of the mount:<br/><br/>- By design, `storage` mounts can be shared between instances of the same app. You can also configure them so they are [shared between different apps](#share-a-mount-between-several-apps).<br/><br/>-`instance` mounts are local mounts. Unique to your app, they are useful to store files that remain local to the app instance, such as application logs.<br/><br/>- `tmp` (or `temporary`) mounts are local ephemeral mounts, where an external directory is mounted to the `/tmp` directory of your app.<br/>The content of a `tmp` mount **may be removed during infrastructure maintenance operations**. Therefore, `tmp` mounts allow you to **store files that you’re not afraid to lose**, such as your application cache that can be seamlessly rebuilt.<br/>Note that the `/tmp` directory has **a maximum allocation of 8 GB**.<br/><br/>- `service` mounts can be useful if you want to explicitly define and use a [Network Storage](/add-services/network-storage.md) service to share data between different apps (instead of using a `storage` mount).|
192192
| `source_path` | `string` | No | Specifies where the mount points **inside the [external directory](#mounts)**.<br/><br/> - If you explicitly set a `source_path`, your mount points to a specific subdirectory in the external directory. <br/><br/> - If the `source_path` is an empty string (`""`), your mount points to the entire external directory.<br/><br/> - If you don't define a `source_path`, {{% vendor/name %}} uses the {{< variable "MOUNT_PATH" >}} as default value, without leading or trailing slashes.</br>For example, if your mount lives in the `/web/uploads/` directory in your app container, it will point to a directory named `web/uploads` in the external directory. </br></br> **WARNING:** Changing the name of your mount affects the `source_path` when it's undefined. See [how to ensure continuity](#ensure-continuity-when-changing-the-name-of-your-mount) and maintain access to your files. |
193193
| `service` | `string` | | The purpose of the `service` key depends on your use case.</br></br> In a multi-app context where a `storage` mount is shared between apps, `service` is required. Its value is the name of the app whose mount you want to share. See how to [share a mount between several apps](#share-a-mount-between-several-apps).</br></br> In a multi-app context where a [Network Storage service](../add-services/network-storage.md) (`service` mount) is shared between apps, `service` is required and specifies the name of that Network Storage. |
194194

@@ -334,20 +334,6 @@ Follow these steps:
334334

335335
Note that another way to share data between apps through a mount is by explicitly [defining a Network Storage service](/add-services/network-storage.md).
336336

337-
### Local mounts
338-
339-
If you need a local mount (i.e. unique per container),
340-
{{% vendor/name %}} allows you to mount a directory within the `/tmp` directory of your app.
341-
However, the following limitations apply:
342-
343-
- Content from `tmp` mounts is removed when your app container is moved to another host during an infrastructure maintenance operation
344-
- The `/tmp` directory has a [maximum allocation of 8 GB](/create-apps/troubleshoot-disks.md#no-space-left-on-device)
345-
346-
Therefore, `tmp` mounts are ideal to store non-critical data, such as your application cache which can be seamlessly rebuilt,
347-
but aren't suitable for storing files that are necessary for your app to run smoothly.
348-
349-
Note that {{% vendor/name %}} will provide new local mounts in the near future.
350-
351337
## Web
352338

353339
Use the `web` key to configure the web server running in front of your app.

sites/friday/src/create-apps/workers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ and, if appropriate, adjust its behavior accordingly.
264264
When defining a [worker](../create-apps/app-reference.md#workers) instance,
265265
keep in mind what mount behavior you want.
266266

267-
`tmp` local mounts are a separate storage area for each instance,
267+
`tmp` and `instance` local mounts are a separate storage area for each instance,
268268
while `storage` mounts can be shared between instances.
269269

270270
For example, you can define a `storage` mount (called `shared_dir`) to be used by a `web` instance,

0 commit comments

Comments
 (0)