diff --git a/README.md b/README.md index 4f62603..e0e8fcd 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,30 @@ devsy up . You'll need to wait for the task and environment setup. +### Customize the Task + +This provider has the following options: + +| NAME | REQUIRED | DESCRIPTION | DEFAULT | +| -------------------- | -------- | ------------------------------------------------------------------------------------------------------- | -------- | +| CLUSTER_ID | true | ECS Cluster ID either as ARN or ID. | | +| SUBNET_ID | true | ECS Subnet ID (ARN or ID) to run the tasks in. Set ASSIGN_PUBLIC_IP according to the subnet type. | | +| AWS_PROFILE | false | The aws profile name to use. | default | +| TASK_ROLE_ARN | false | ECS Task Role ARN for the task definition. If unset, the provider tries to create a new role. | | +| EXECUTION_ROLE_ARN | false | ECS Execution Role ARN for the task definition. If unset, the provider tries to create a new role. | | +| CLUSTER_ARCHITECTURE | false | The cpu architecture of the cluster. Either amd64 or arm64. | amd64 | +| TASK_CPU | false | ECS Task cpu as a string. With Fargate, ensure the TASK_MEMORY combination is supported. E.g. '.5 vcpu'. | 2 vcpu | +| TASK_MEMORY | false | ECS Task memory as a string. With Fargate, ensure the TASK_CPU combination is supported. E.g. '1 gb'. | 4 gb | +| LAUNCH_TYPE | false | ECS Task Launch Type. One of FARGATE, EC2, or EXTERNAL. | FARGATE | +| ASSIGN_PUBLIC_IP | false | Whether the task gets a public ip. ENABLED for public subnets, DISABLED for private subnets. | ENABLED | +| SECURITY_GROUP_ID | false | ECS Security Group ID to attach to the network settings of the ECS task. | | + +Options can either be set in `env` or on the command line, for example: + +```sh +devsy provider set-options -o TASK_CPU="1 vcpu" -o TASK_MEMORY="2 gb" +``` + ## Local Development To build and test the provider locally, use [task](https://taskfile.dev/) `task build:provider:dev`. The provider file is created in `./dist/provider.yaml`.