Skip to content

Commit 4a0feed

Browse files
committed
Minor documentation updates.
1 parent 38e738b commit 4a0feed

File tree

1 file changed

+4
-15
lines changed

1 file changed

+4
-15
lines changed

README.md

+4-15
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Overview
22

3-
RunECS is a tool for running one-off processes in an ECS cluster. The tool was created as a simple solution for occasional running of processes in the ECS cluster - e.g. various data migrations.
3+
RunECS is a tool for executing one-off processes in an ECS cluster.
44

55
## Limitations
66

77
* Only FARGATE launch type is supported.
8-
* One container in the task.
8+
* Sidecar containers are not supported
99

1010

11-
## How to Use
11+
# How to Use
1212

1313
RunECS executes the command using the specified service. The service must be specified in `cluster/service` format. Further, you must specify the environment variables that determine access to AWS.
1414

@@ -24,7 +24,7 @@ runecs rake orders:upload[14021] --service my-cluster/my-service -w
2424

2525
### Run
2626

27-
The process runs using the last task definition. Using the `--image-tag` parameter creates a new task definition with which to run the process.
27+
Executes the process using the last available task definition. You can pick a specific docker tag by using the `--image-tag` argument. In this case, it changes the task definition and inserts the specified docker tag.
2828

2929
The task is run asynchronously by default. Using the `--wait` argument, the task starts synchronously and returns the EXIT code of the container.
3030

@@ -76,14 +76,3 @@ runecs revisions \
7676
--service my-cluster/my-service \
7777
--last 10
7878
```
79-
80-
# Build
81-
82-
```shell
83-
git clone [email protected]:meap/runecs.git
84-
85-
cd runecs
86-
make
87-
88-
./bin/runecs --help
89-
```

0 commit comments

Comments
 (0)