improve install makefiles descriptions

kyma-project · Apr 5, 2024 · 80bbd0a · 80bbd0a
1 parent edc319f
commit 80bbd0a
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/components/operator/Makefile b/components/operator/Makefile
@@ -70,7 +70,7 @@ build-image-operator: ## Build serverless operator from local sources on k3d
 	docker build -t $(OPERATOR_NAME) -f Dockerfile $(PROJECT_ROOT)
 
 .PHONY: install-operator-k3d
-install-operator-k3d: build-image-operator ## Build and install serverless operator from local sources on k3d
+install-operator-k3d: build-image-operator ## Build and replace serverless operator from local sources on k3d
 	$(eval HASH_TAG=$(shell docker images $(OPERATOR_NAME):latest --quiet))
 	docker tag $(OPERATOR_NAME) $(OPERATOR_NAME):$(HASH_TAG)
 

diff --git a/components/operator/README.md b/components/operator/README.md
@@ -11,13 +11,16 @@ The Function Operator requires the following components to be installed:
 ## Development
 
 ### Installing locally build serverless operator image on k3d with serverless
+Prerequisite:
+- installed operator on cluster
 
 To install serverless-manager from local sources on k3d cluster run:
 
 ```bash
 make install-operator-k3d
 ```
 
+
 This target does:
 
 - build local image with serverless-operator

diff --git a/components/serverless/Makefile b/components/serverless/Makefile
@@ -43,7 +43,7 @@ CONTROLLER_NAME = function-controller
 build-image-function-controller:
 	docker build -t $(CONTROLLER_NAME) -f $(COMPONENT_ROOT)/deploy/manager/Dockerfile $(PROJECT_ROOT)
 
-install-controller-k3d: build-image-function-controller disable-operator ## Build and install serverless manager from local sources on k3d
+install-controller-k3d: build-image-function-controller disable-operator ## Build and replace serverless manager from local sources on k3d
 	$(eval HASH_TAG=$(shell docker images $(CONTROLLER_NAME):latest --quiet))
 	docker tag $(CONTROLLER_NAME) $(CONTROLLER_NAME):$(HASH_TAG)
 
@@ -57,7 +57,7 @@ WEBHOOK_NAME = function-webhook
 build-image-function-webhook:
 	docker build -t $(WEBHOOK_NAME) -f $(COMPONENT_ROOT)/deploy/webhook/Dockerfile $(PROJECT_ROOT)
 
-install-webhook-k3d: build-image-function-webhook disable-operator ## Build and install serverless webhook from local sources on k3d
+install-webhook-k3d: build-image-function-webhook disable-operator ## Build and replace serverless webhook from local sources on k3d
 	$(eval HASH_TAG=$(shell docker images $(WEBHOOK_NAME):latest --quiet))
 	docker tag $(WEBHOOK_NAME) $(WEBHOOK_NAME):$(HASH_TAG)
 

diff --git a/components/serverless/README.md b/components/serverless/README.md
@@ -15,8 +15,10 @@ To develop the Function Controller, you need:
 - <!-- markdown-link-check-disable-line -->[kustomize](https://github.com/kubernetes-sigs/kustomize/releases/tag/kustomize%2Fv4.5.7) (v4.5.7)
 
 ### Installing locally build serverless controller image on k3d with serverless
+Prerequisite:
+- installed serverless on cluster
 
-To install serverless-manager from local sources on k3d cluster run:
+To install serverless-controller from local sources on k3d cluster run:
 ```bash
 make install-controller-k3d
 ```