Update readme, and add comments to makefile

MITLibraries · Oct 12, 2021 · 982ca6b · 982ca6b
1 parent dacbcbd
commit 982ca6b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -24,7 +24,7 @@ publish: dist ## Build, tag and push
 	docker push $(ECR_REGISTRY)/dspacesubmissionservice-stage:latest
 	docker push $(ECR_REGISTRY)/dspacesubmissionservice-stage:`git describe --always`
 
-run-stage: 
+run-stage:  ## Runs the task in stage - see readme for more info
 	aws ecs run-task --cluster dspacesubmissionservice-stage --task-definition dspacesubmissionservice-stage --network-configuration "awsvpcConfiguration={subnets=[subnet-0744a5c9beeb49a20],securityGroups=[sg-06b90b77a06e5870a],assignPublicIp=DISABLED}" --launch-type FARGATE --region us-east-1
 
 lint: bandit black flake8 isort ## Runs all linters

diff --git a/README.md b/README.md
@@ -38,3 +38,8 @@ docker run submitter:latest --
 ```
 
 note: the application requires being run in an environment with Roles based access to the AWS resources. in addition, the environment must have WORKSPACE and SSM_PATH variables set according to stage and prod conventions.
+
+## Makefile Info 
+### Run-Stage
+Run-stage is outputted by the terraform used to create the infrastructure and copy/pasted here for convenience.
+Calling run-stage will execute the latest version of the container in the stage environment using the MITVPC.