service deployment makefile cleanup

Makefile

@@ -82,97 +82,51 @@ infra.clean:
 .PHONY: infra.clean
 
 #
-# Istio
-#
-
-isto.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) istio svc
-.PHONY: isto.deploy
-
-#
-# Metrics
-#
-
-metrics.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) metrics svc
-.PHONY: metrics.deploy
-
-#
-# Cluster Service
-#
-
-cs.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) cluster-service svc
-.PHONY: cs.deploy
-
-#
-# Maestro
-#
-
-maestro.server.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) maestro/server svc
-.PHONY: maestro.server.deploy
-
-maestro.agent.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) maestro/agent mgmt
-.PHONY: maestro.agent.deploy
-
-maestro.registration.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) maestro/registration svc
-.PHONY: maestro.registration.deploy
-
-maestro: maestro.server.deploy maestro.agent.deploy maestro.registration.deploy
-.PHONY: maestro
-
-#
-# Resource Provider
-#
-
-rp.frontend.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) frontend svc
-.PHONY: rp.frontend.deploy
-
-rp.backend.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) backend svc
-.PHONY: rp.backend.deploy
-
-#
-# PKO
-#
-
-pko.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) pko mgmt
-.PHONY: pko.deploy
-
-#
-# ACM
-#
-
-acm.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) acm mgmt
-.PHONY: acm.deploy
-
-#
-# Hypershift
-#
-
-hypershift.deploy:
-	@./svc-deploy.sh $(DEPLOY_ENV) hypershiftoperator mgmt
-.PHONY: hypershift.deploy
-
-#
-# Deploy ALL components
-#
-
-deploy.svc.all: isto.deploy metrics.deploy maestro.server.deploy maestro.registration.deploy cs.deploy rp.frontend.deploy rp.backend.deploy
-.PHONY: deploy.svc.all
-
-deploy.mgmt.all: acm.deploy maestro.agent.deploy hypershift.deploy
-.PHONY: deploy.mgmt.all
-
-deploy.all: deploy.svc.all deploy.mgmt.all
-.PHONY: deploy.all
+# Services
+#
+
+# Service Deployment Conventions:
+#
+# - Services are deployed in aks clusters (either svc or mgmt), which are
+#   provisioned via infra section above
+# - Makefile targets to deploy services ends with ".deploy" suffix
+# - To deploy all services on svc or mgmt cluster, we have special targets
+#   `svc.deploy` and `mgmt.deploy`, or `all.deploy` to deploy all services.
+# - Placement of a service is controlled via services_svc and services_mgmt
+#   variables
+# - If the name of the service contains a dot, it's interpreted as directory
+#   separator "/" (used for maestro only).
+
+# Services deployed on "svc" aks cluster
+services_svc = istio metrics maestro.server maestro.registration cluster-service frontend backend
+# Services deployed on "mgmt" aks cluster(s)
+services_mgmt = acm maestro.agent pko hypershiftoperator
+# List of all services
+services_all = $(join services_svc,services_mgmt)
+
+.PHONY: $(addsuffix .deploy, $(services_all)) all.list list clean
+
+# Service deployment on either svc or mgmt aks cluster, a service name
+# needs to be listed either in services_svc or services_mgmt variable (wich
+# defines where it will be deployed).
+%.deploy:
+	$(eval export dirname=$(subst .,/,$(basename $@)))
+	@if [ $(words $(filter $(basename $@), $(services_svc))) = 1 ]; then\
+	    ./svc-deploy.sh $(DEPLOY_ENV) $(dirname) svc;\
+	elif [ $(words $(filter $(basename $@), $(services_mgmt))) = 1 ]; then\
+	    ./svc-deploy.sh $(DEPLOY_ENV) $(dirname) mgmt;\
+	else\
+	    echo "'$(basename $@)' is not to be deployed on neither svc nor mgmt cluster";\
+	    exit 1;\
+	fi
+
+svc.deploy:  $(addsuffix .deploy, $(services_svc))
+mgmt.deploy: $(addsuffix .deploy, $(services_mgmt))
+all.deploy:  svc.deploy mgmt.deploy
+
+all.list:
+	@echo svc: ${services_svc}
+	@echo mgmt: ${services_mgmt}
 
 list:
 	@grep '^[^#[:space:]].*:' Makefile
-.PHONY: list

dev-infrastructure/docs/development-setup.md

@@ -239,14 +239,14 @@ There are more fine grained cleanup tasks available as well
 To followup sections describe how to deploy the components individually. But if you are looking for a quick and easy way to install or update ALL components on both clusters with one command, then run this:
 
   ```bash
-  make deploy.svc.all
-  make deploy.mgmt.all
+  make svc.deploy
+  make mgmt.deploy
   ```
 
 Or even simpler with
 
   ```bash
-  make deploy.all
+  make all.deploy
   ```
 
 ## Deploy Services to the service cluster
@@ -273,7 +273,7 @@ To access the HTTP and GRPC endpoints of maestro, run
 > This might not work with `oc` 4.17.0, please use oc 4.16.x until this is fixed in 4.17
 
    ```bash
-   make cs.deploy
+   make cluster-service.deploy
    ```
 
 To validate, have a look at the `cluster-service` namespace or the service cluster.
@@ -283,8 +283,8 @@ To validate, have a look at the `cluster-service` namespace or the service clust
 The ARO-HCP resource provider consists of independent frontend and backend components.
 
   ```bash
-  make rp.frontend.deploy
-  make rp.backend.deploy
+  make frontend.deploy
+  make backend.deploy
   ```
 
 To validate, have a look at the `aro-hcp` namespace on the service cluster.
@@ -300,7 +300,7 @@ To validate, have a look at the `aro-hcp` namespace on the service cluster.
 ### Hypershift Operator and External DNS
 
   ```bash
-  make hypershift.deploy
+  make hypershift-operator.deploy
   ```
 
 ### Maestro Agent

svc-deploy.sh

@@ -1,23 +1,28 @@
 #!/bin/bash
 
+# bash will report what is happening and stop in case of non zero return code
+set -xe
+
 # deploy a service to a cluster
 # ./svc-deploy <deploy-env> <dir> <cluster> [target]
 # this script expects the <dir> to contain a Makefile that takes care
 # of processing any config.mk template on its own
 
-cd $(dirname "$(realpath "${BASH_SOURCE[0]}")") || exit
+cd "$(dirname "$(realpath "${BASH_SOURCE[0]}")")"
 
 export DEPLOY_ENV=$1
 export DIR=$2
 export CLUSTER=$3
 export TARGET=${4:-deploy}
 
-if [[ "$CLUSTER" != "svc" && "$CLUSTER" != "mgmt" ]]; then
-    echo "Error: CLUSTER must be either 'svc' or 'mgmt'."
+if [[ "${CLUSTER}" != "svc" && "${CLUSTER}" != "mgmt" ]]; then
+    echo "Error: CLUSTER must be either 'svc' or 'mgmt'." >&2
     exit 1
 fi
 
-export KUBECONFIG=$(cd dev-infrastructure || exit ; make --no-print-directory $CLUSTER.aks.kubeconfigfile)
+cd dev-infrastructure
+KUBECONFIG=$(make --no-print-directory "${CLUSTER}.aks.kubeconfigfile")
+export KUBECONFIG
 
-cd ${DIR} || exit
-make $TARGET
+cd "${DIR}"
+make "${TARGET}"