Skip to content

Commit 3b1c0ed

Browse files
committed
Update README.md to contain information on how to configure Amazon EBS Volumes
1 parent 0f3d04b commit 3b1c0ed

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,41 @@ You can propagate your custom tags from your existing service using `propagate-t
132132
propagate-tags: SERVICE
133133
```
134134

135+
### EBS Volume Configuration
136+
This action supports configuring Amazon EBS volumes for both services and standalone tasks.
137+
138+
For Services (Update Service):
139+
140+
```yaml
141+
- name: Deploy to Amazon ECS with EBS Volume
142+
uses: aws-actions/amazon-ecs-deploy-task-definition@v2
143+
with:
144+
task-definition: task-definition.json
145+
service: my-service
146+
cluster: my-cluster
147+
wait-for-service-stability: true
148+
service-managed-ebs-volume-name: "ebs1"
149+
service-managed-ebs-volume: '{"sizeInGiB": 30, "volumeType": "gp3", "encrypted": true, "roleArn":"arn:aws:iam::<account-id>:role/ebs-role"}'
150+
```
151+
152+
Note: Note: Your task definition must include a volume that is configuredAtLaunch:
153+
154+
155+
156+
For Standalone Tasks (RunTask):
157+
158+
```yaml
159+
- name: Deploy to Amazon ECS
160+
uses: aws-actions/amazon-ecs-deploy-task-definition@v2
161+
with:
162+
task-definition: task-definition.json
163+
cluster: my-cluster
164+
run-task: true
165+
run-task-launch-type: EC2
166+
run-task-managed-ebs-volume-name: "ebs1"
167+
run-task-managed-ebs-volume: '{"filesystemType":"xfs", "roleArn":"arn:aws:iam::<account-id>:role/github-actions-setup-stack-EBSRole-YwVmgS4g7gQE", "encrypted":false, "sizeInGiB":30}'
168+
```
169+
135170
## Credentials and Region
136171

137172
This action relies on the [default behavior of the AWS SDK for Javascript](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/setting-credentials-node.html) to determine AWS credentials and region.

0 commit comments

Comments
 (0)