Add PROVIDER variable in funcbench and prombench make file, change documentation to make it more general

Signed-off-by: Drumil Patel <[email protected]>

Author: weastel

.github/workflows/grafana_dashboard.yaml

@@ -14,7 +14,7 @@ jobs:
       id: apply_configmap
       uses: docker://prominfra/prombench:master
       env:
-        AUTH_FILE: ${{ secrets.TEST_INFRA_GKE_AUTH }}
+        AUTH_FILE: ${{ secrets.TEST_INFRA_PROVIDER_AUTH }}
         GKE_PROJECT_ID: macro-mile-203600
         CLUSTER_NAME: test-infra
         ZONE: europe-west3-a

funcbench/Makefile

@@ -1,5 +1,6 @@
 INFRA_CMD        ?= ../infra/infra
 
+PROVIDER 		 ?= gke
 ifeq ($(PACKAGE_PATH),)
 PACKAGE_PATH = ./...
 endif
@@ -11,17 +12,17 @@ deploy: cluster_create resource_apply
 clean: resource_delete cluster_delete
 
 cluster_create:
-	$(INFRA_CMD) gke cluster create -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) cluster create -a ${AUTH_FILE} \
 		-v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v ZONE:${ZONE} -v CLUSTER_NAME:funcbench-${PR_NUMBER} -v PR_NUMBER:${PR_NUMBER} \
-		-f manifests/cluster_gke.yaml
+		-f manifests/cluster_$(PROVIDER).yaml
 
 cluster_delete:
-	$(INFRA_CMD) gke cluster delete -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) cluster delete -a ${AUTH_FILE} \
 		-v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v ZONE:${ZONE} -v CLUSTER_NAME:funcbench-${PR_NUMBER} -v PR_NUMBER:${PR_NUMBER} \
-		-f manifests/cluster_gke.yaml
+		-f manifests/cluster_$(PROVIDER).yaml
 
 resource_apply:
-	$(INFRA_CMD) gke resource apply -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) resource apply -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v CLUSTER_NAME:funcbench-${PR_NUMBER} \
 		-v PR_NUMBER:${PR_NUMBER} -v GITHUB_TOKEN:${GITHUB_TOKEN} \
 		-v GITHUB_ORG:${GITHUB_ORG} -v GITHUB_REPO:${GITHUB_REPO} \
@@ -31,7 +32,7 @@ resource_apply:
 
 # Removal of namespace should be at the end, after all other resources get removed.
 resource_delete:
-	$(INFRA_CMD) gke resource delete -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) resource delete -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v CLUSTER_NAME:funcbench-${PR_NUMBER} \
 		-v PR_NUMBER:${PR_NUMBER} -v GITHUB_TOKEN:${GITHUB_TOKEN} \
 		-v GITHUB_ORG:${GITHUB_ORG} -v GITHUB_REPO:${GITHUB_REPO} \

prombench/Makefile

@@ -1,43 +1,45 @@
 INFRA_CMD        ?= ../infra/infra
 
+PROVIDER 		 ?= gke
+
 .PHONY: deploy clean
 deploy: nodepool_create resource_apply
 # GCP sometimes takes longer than 30 tries when trying to delete nodepools
 # if k8s resources are not already cleared
 clean: resource_delete nodepool_delete
 
 nodepool_create:
-	$(INFRA_CMD) gke nodes create -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) nodes create -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v CLUSTER_NAME:${CLUSTER_NAME} -v PR_NUMBER:${PR_NUMBER} \
-		-f manifests/prombench/nodes_gke.yaml
+		-f manifests/prombench/nodes_$(PROVIDER).yaml
 
 resource_apply:
-	$(INFRA_CMD) gke resource apply -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) resource apply -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v CLUSTER_NAME:${CLUSTER_NAME} \
 		-v PR_NUMBER:${PR_NUMBER} -v RELEASE:${RELEASE} -v DOMAIN_NAME:${DOMAIN_NAME} \
 		-v GITHUB_ORG:${GITHUB_ORG} -v GITHUB_REPO:${GITHUB_REPO} \
 		-f manifests/prombench/benchmark
 
 # Required because namespace and cluster-role are not part of the created nodepools
 resource_delete:
-	$(INFRA_CMD) gke resource delete -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) resource delete -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v CLUSTER_NAME:${CLUSTER_NAME} -v PR_NUMBER:${PR_NUMBER} \
 		-f manifests/prombench/benchmark/1c_cluster-role-binding.yaml \
 		-f manifests/prombench/benchmark/1a_namespace.yaml
 
 nodepool_delete:
-	$(INFRA_CMD) gke nodes delete -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) nodes delete -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} -v CLUSTER_NAME:${CLUSTER_NAME} -v PR_NUMBER:${PR_NUMBER} \
-		-f manifests/prombench/nodes_gke.yaml
+		-f manifests/prombench/nodes_$(PROVIDER).yaml
 
 all_nodepools_running:
-	$(INFRA_CMD) gke nodes check-running -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) nodes check-running -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} \
 		-v CLUSTER_NAME:${CLUSTER_NAME} -v PR_NUMBER:${PR_NUMBER} \
-		-f manifests/prombench/nodes_gke.yaml
+		-f manifests/prombench/nodes_$(PROVIDER).yaml
 
 all_nodepools_deleted:
-	$(INFRA_CMD) gke nodes check-deleted -a ${AUTH_FILE} \
+	$(INFRA_CMD) $(PROVIDER) nodes check-deleted -a ${AUTH_FILE} \
 		-v ZONE:${ZONE} -v GKE_PROJECT_ID:${GKE_PROJECT_ID} \
 		-v CLUSTER_NAME:${CLUSTER_NAME} -v PR_NUMBER:${PR_NUMBER} \
-		-f manifests/prombench/nodes_gke.yaml
+		-f manifests/prombench/nodes_$(PROVIDER).yaml

prombench/README.md

@@ -13,18 +13,18 @@ The `/manifest` directory contains all the kubernetes manifest files.
 - `cluster-infra/` : These are the persistent components of the Main Node.
 - `prombench/` : These resources are created and destroyed for each prombench test.
 
-## Providers
+## Setup and run prombench
 
-Presently prombench supports following providers:
+Following sections consist of detail documentation to run prombench in their respective providers.
 
-- [Google Kubernetes Engine](docs/gke.md)
+- Instructions for [Google Kubernetes Engine](docs/gke.md)
 
 ## Setup GitHub Actions
 
 Place a workflow file in the `.github` directory of the repository.
 See the [prometheus/prometheus](https://github.com/prometheus/prometheus) repository for an example.
 
-Create a github action `TEST_INFRA_GKE_AUTH` secret with the base64 encoded content of the `service-account.json` file.
+Create a github action `TEST_INFRA_PROVIDER_AUTH` secret with the base64 encoded content of the `service-account.json` file.
 
 ```
 cat $AUTH_FILE | base64 -w 0