Skip to content

Commit 48cf6ad

Browse files
authored
docs: add ephemeral storage documentation (#2240)
<!-- Provide summary of changes --> <!-- Issue number, if available. E.g. "Fixes #31", "Addresses #42, 77" --> By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
1 parent 14b0f13 commit 48cf6ad

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

site/content/docs/include/common-svc-fields.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,29 @@ Key-value pairs that represent secret values from [AWS Systems Manager Parameter
137137
<div class="separator"></div>
138138

139139
<a id="storage" href="#storage" class="field">`storage`</a> <span class="type">Map</span>
140-
The Storage section lets you specify external EFS volumes for your containers and sidecars to mount. This allows you to access persistent storage across regions for data processing or CMS workloads. For more detail, see the [storage](../developing/storage.en.md) page.
140+
The Storage section lets you specify external EFS volumes for your containers and sidecars to mount. This allows you to access persistent storage across regions for data processing or CMS workloads. For more detail, see the [storage](../developing/storage.en.md) page. You can also specify extensible ephemeral storage at the task level.
141+
142+
<span class="parent-field">storage.</span><a id="ephemeral" href="#ephemeral" class="field">`ephemeral`</a> <span class="type">Int</span>
143+
Specify how much ephemeral task storage to provision in GiB. The default value and minimum is 20 GiB. The maximum size is 200 GiB. Sizes above 20 GiB incur additional charges.
144+
145+
To create a shared filesystem context between an essential container and a sidecar, you can use an empty volume:
146+
```yaml
147+
storage:
148+
ephemeral: 100
149+
volumes:
150+
scratch:
151+
path: /var/data
152+
read_only: false
153+
154+
sidecars:
155+
mySidecar:
156+
image: public.ecr.aws/my-image:latest
157+
mount_points:
158+
- source_volume: scratch
159+
path: /var/data
160+
read_only: false
161+
```
162+
This example will provision 100 GiB of storage to be shared between the sidecar and the task container. This can be useful for large datasets, or for using a sidecar to transfer data from EFS into task storage for workloads with high disk I/O requirements.
141163

142164
<span class="parent-field">storage.</span><a id="volumes" href="#volumes" class="field">`volumes`</a> <span class="type">Map</span>
143165
Specify the name and configuration of any EFS volumes you would like to attach. The `volumes` field is specified as a map of the form:
@@ -155,10 +177,10 @@ Specify the configuration of a volume.
155177
<span class="parent-field">volume.</span><a id="path" href="#path" class="field">`path`</a> <span class="type">String</span>
156178
Required. Specify the location in the container where you would like your volume to be mounted. Must be fewer than 242 characters and must consist only of the characters `a-zA-Z0-9.-_/`.
157179

158-
<span class="parent-field">volume.</span><a id="read_only" href="#read-only" class="field">`read_only`</a> <span class="type">Bool</span>
180+
<span class="parent-field">volume.</span><a id="read_only" href="#read-only" class="field">`read_only`</a> <span class="type">Boolean</span>
159181
Optional. Defaults to `true`. Defines whether the volume is read-only or not. If false, the container is granted `elasticfilesystem:ClientWrite` permissions to the filesystem and the volume is writable.
160182

161-
<span class="parent-field">volume.</span><a id="efs" href="#efs" class="field">`efs`</a> <span class="type">Bool or Map</span>
183+
<span class="parent-field">volume.</span><a id="efs" href="#efs" class="field">`efs`</a> <span class="type">Boolean or Map</span>
162184
Specify more detailed EFS configuration. If specified as a boolean, or using only the `uid` and `gid` subfields, creates a managed EFS filesystem and dedicated Access Point for this workload.
163185
```yaml
164186
// Simple managed EFS
@@ -185,7 +207,7 @@ Optional. Must be specified with `uid`. Mutually exclusive with `root_dir`, `aut
185207
<span class="parent-field">volume.efs.</span><a id="auth" href="#auth" class="field">`auth`</a> <span class="type">Map</span>
186208
Specify advanced authorization configuration for EFS.
187209

188-
<span class="parent-field">volume.efs.auth.</span><a id="iam" href="#iam" class="field">`iam`</a> <span class="type">Bool</span>
210+
<span class="parent-field">volume.efs.auth.</span><a id="iam" href="#iam" class="field">`iam`</a> <span class="type">Boolean</span>
189211
Optional. Defaults to `true`. Whether or not to use IAM authorization to determine whether the volume is allowed to connect to EFS.
190212

191213
<span class="parent-field">volume.efs.auth.</span><a id="access_point_id" href="#access-point-id" class="field">`access_point_id`</a> <span class="type">String</span>

0 commit comments

Comments
 (0)