Refactor Makefile aws-vault related rules (#30)

apptension · Jul 20, 2020 · ff2ed28 · ff2ed28
1 parent 71deeed
commit ff2ed28
Show file tree

Hide file tree

Showing 11 changed files with 44 additions and 28 deletions.
diff --git a/Makefile b/Makefile
@@ -10,7 +10,7 @@ install: install-infra-cdk install-infra-functions
 
 setup-infra:
 	chmod +x ./scripts/*.sh
-	$(AWS_VAULT) scripts/cdk-bootstrap.sh
+	scripts/cdk-bootstrap.sh
 
 setup-docker:
 	docker volume create --name=$(PROJECT_NAME)-web-backend-db-data
@@ -48,7 +48,7 @@ deploy-infra-functions:
 deploy-stage-infra: deploy-infra-main deploy-infra-functions deploy-infra-ci
 
 upload-version:
-	$(AWS_VAULT) node $(BASE_DIR)/scripts/upload-version.js api,workers,webapp,admin-panel
+	node $(BASE_DIR)/scripts/upload-version.js api,workers,webapp,admin-panel
 
 
 #
@@ -57,7 +57,7 @@ upload-version:
 
 build:
 	@echo Build version: $(VERSION)
-	$(AWS_VAULT) $(MAKE) -C services/backend build
+	$(MAKE) -C services/backend build
 	$(MAKE) -C services/webapp build
 	$(MAKE) -C services/workers build
 

diff --git a/base.mk b/base.mk
@@ -30,17 +30,13 @@ export API_DOMAIN := $(call GetFromEnvCfg,domains.api)
 export WEB_APP_DOMAIN := $(call GetFromEnvCfg,domains.webApp)
 export WWW_DOMAIN := $(call GetFromEnvCfg,domains.www)
 
+AWS_VAULT_PROFILE ?= $(call GetFromCfg,aws.profile)
+AWS_VAULT = aws-vault exec $(AWS_VAULT_PROFILE) --
+
 ifeq ($(CI),true)
-	AWS_VAULT =
 	VERSION := $(shell cat $(BASE_DIR)/VERSION)
 	DOCKER_COMPOSE = docker-compose -p $(PROJECT_NAME)_$(HOST_UID) -f $(BASE_DIR)/docker-compose.yml -f $(BASE_DIR)/docker-compose.ci.yml
-else ifeq ($(ENV_STAGE),local)
-	AWS_VAULT =
-	VERSION := $(shell git describe --tags --first-parent --abbrev=11 --long --dirty --always)
-	DOCKER_COMPOSE = docker-compose -p $(PROJECT_NAME)_$(HOST_UID)
 else
-	AWS_VAULT_PROFILE := $(call GetFromCfg,aws.profile)
-	AWS_VAULT = aws-vault exec $(AWS_VAULT_PROFILE) --
 	VERSION := $(shell git describe --tags --first-parent --abbrev=11 --long --dirty --always)
 	DOCKER_COMPOSE = docker-compose -p $(PROJECT_NAME)_$(HOST_UID)
 endif
@@ -86,7 +82,7 @@ install-scripts:
 shell:
 	$(USER_SHELL)
 
-aws-shell:
+aws-vault:
 	$(AWS_VAULT) $(USER_SHELL)
 
 up:
@@ -107,4 +103,4 @@ prune:
 	docker system prune -af
 
 upload-service-version:
-	$(AWS_VAULT) node $(BASE_DIR)/scripts/upload-service-version.js $(SERVICE_NAME)
+	node $(BASE_DIR)/scripts/upload-service-version.js $(SERVICE_NAME)
diff --git a/docs/app-deployment.md b/docs/app-deployment.md
@@ -1,5 +1,10 @@
 # Deploy the app to AWS
 
+## Switch to AWS context using aws-vault
+```shell script
+make aws-vault
+```
+
 ## Deploy infrastructure of the environment
 
 ```shell script

diff --git a/docs/create-new-env.md b/docs/create-new-env.md
@@ -26,6 +26,11 @@ This command will create following file named `.awsboilerplate.<ENV_STAGE_NAME>.
 
 ## Deploy infrastructure of the new environment
 
+### Switch to AWS context using aws-vault
+```shell script
+make aws-vault
+```
+
 ```shell script
 make deploy-stage-infra ENV_STAGE=<ENV_STAGE_NAME>
 ```

diff --git a/docs/global-infra-deployment.md b/docs/global-infra-deployment.md
@@ -1,6 +1,12 @@
 #  Deploy Global Infrastructure to AWS
 This command will deploy [Global infrastructure](/docs/infrastructure-components.md#global-infrastructure) CDK stack
 
+## Switch to AWS context using aws-vault
+```shell script
+make aws-vault
+```
+
+## Deploy CDK Stack
 ```shell script
 make deploy-global-infra
 ```
diff --git a/docs/services/create-new-serverless-service.md b/docs/services/create-new-serverless-service.md
@@ -41,7 +41,7 @@ build:
 	@echo "Test <CHANGE_ME>"
 
 deploy:
-	$(AWS_VAULT) sls deploy --stage $(ENV_STAGE);
+	sls deploy --stage $(ENV_STAGE);
 	$(MAKE) upload-service-version SERVICE_NAME=<CHANGE_ME>;
 ```
 

diff --git a/docs/setup-project.md b/docs/setup-project.md
@@ -54,8 +54,12 @@ sh ./setup.sh
 
 This script will install all possible package dependencies.
 
-#### Run CDK bootstrap [^1]
+#### Switch to AWS context using aws-vault [^1]
+```shell script
+make aws-vault
+```
 
+#### Run CDK bootstrap [^1]
 ```shell script
 make setup-infra
 ```

diff --git a/infra/cdk/Makefile b/infra/cdk/Makefile
@@ -6,40 +6,40 @@ install:
 
 deploy-global-infra:
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *GlobalStack;
+	npm run cdk deploy *GlobalStack;
 
 deploy-global-tools:
 	$(MAKE) -C $(BASE_DIR)/tools/version-matrix install
 	$(MAKE) -C $(BASE_DIR)/tools/version-matrix build
 
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *GlobalToolsStack;
+	npm run cdk deploy *GlobalToolsStack;
 
 deploy-infra-main:
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *MainStack;
+	npm run cdk deploy *MainStack;
 
 deploy-infra-ci:
 	pwd;
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *CiStack;
+	npm run cdk deploy *CiStack;
 
 deploy-components:
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *ComponentsStack;
+	npm run cdk deploy *ComponentsStack;
 
 deploy-admin-panel:
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *AdminPanelStack;
+	npm run cdk deploy *AdminPanelStack;
 
 deploy-api:
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *ApiStack;
+	npm run cdk deploy *ApiStack;
 
 deploy-migrations:
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *MigrationsStack;
+	npm run cdk deploy *MigrationsStack;
 
 deploy-webapp:
 	npm run build;
-	$(AWS_VAULT) npm run cdk deploy *WebAppStack;
+	npm run cdk deploy *WebAppStack;
diff --git a/infra/functions/Makefile b/infra/functions/Makefile
@@ -6,4 +6,4 @@ install:
 	npm install
 
 deploy:
-	$(AWS_VAULT) $(SELF_DIR)node_modules/.bin/sls deploy --stage $(ENV_STAGE);
+	$(SELF_DIR)node_modules/.bin/sls deploy --stage $(ENV_STAGE);
diff --git a/services/backend/Makefile b/services/backend/Makefile
@@ -14,7 +14,7 @@ test:
 
 build:
 	$(MAKE) test
-	$(AWS_VAULT) /bin/sh ./scripts/build.sh
+	/bin/sh ./scripts/build.sh
 
 deploy-admin-panel:
 	$(MAKE) -C $(BASE_DIR)/infra/cdk deploy-admin-panel
@@ -28,7 +28,7 @@ deploy-migrations:
 	$(MAKE) -C $(BASE_DIR)/infra/cdk deploy-migrations
 
 	cd $(BASE_DIR)/infra/functions;\
-	$(AWS_VAULT) node_modules/.bin/sls invoke --stage $(ENV_STAGE) -f TriggerMigrationsJob
+	node_modules/.bin/sls invoke --stage $(ENV_STAGE) -f TriggerMigrationsJob
 
 deploy: deploy-migrations deploy-admin-panel deploy-api
 

diff --git a/services/workers/Makefile b/services/workers/Makefile
@@ -24,7 +24,7 @@ test:
 build: test
 
 deploy:
-	$(AWS_VAULT) $(SELF_DIR)node_modules/.bin/sls deploy --stage $(ENV_STAGE);
+	$(SELF_DIR)node_modules/.bin/sls deploy --stage $(ENV_STAGE);
 	$(MAKE) upload-service-version SERVICE_NAME=workers
 
 flake8:
@@ -34,5 +34,5 @@ black:
 	pipenv run black --config=pyproject.toml .
 
 invoke-hello:
-	$(AWS_VAULT) sls invoke --stage $(ENV_STAGE) -f hello;
+	sls invoke --stage $(ENV_STAGE) -f hello;