feat: Add documentation about busola in k8s and adjust k8s configs

Makefile

@@ -1,9 +1,9 @@
-IMG_NAME = busola-web
-LOCAL_IMG_NAME = busola
-IMG = $(DOCKER_PUSH_REPOSITORY)$(DOCKER_PUSH_DIRECTORY)/$(IMG_NAME)
-LOCAL_IMG = $(DOCKER_PUSH_REPOSITORY)$(DOCKER_PUSH_DIRECTORY)/$(LOCAL_IMG_NAME)
-KYMA_DASHBOARD_IMG = $(DOCKER_PUSH_REPOSITORY)$(DOCKER_PUSH_DIRECTORY)/$(KYMA_DASHBOARD_IMG_NAME)
-TAG = $(DOCKER_TAG)
+APP_NAME = busola
+.DEFAULT_GOAL=help
+
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
 
 .PHONY: resolve
 resolve:
@@ -21,30 +21,12 @@ release: build-image push-image
 
 release-local: build-image-local push-image-local
 
-build-image:
-	docker build -t $(IMG_NAME) -f Dockerfile .
-
-build-image-local:
-	docker build -t $(LOCAL_IMG_NAME) -f Dockerfile.local .
-
-push-image:
-	docker tag $(IMG_NAME) $(IMG):$(TAG)
-	docker push $(IMG):$(TAG)
-ifeq ($(JOB_TYPE), postsubmit)
-	@echo "Sign image with Cosign"
-	cosign version
-	cosign sign -key ${KMS_KEY_URL} $(REPO)$(IMG):$(TAG)
-else
-	@echo "Image signing skipped"
-endif
-
-push-image-local:
-	docker tag $(LOCAL_IMG_NAME) $(LOCAL_IMG):$(TAG)
-	docker push $(LOCAL_IMG):$(TAG)
-ifeq ($(JOB_TYPE), postsubmit)
-	@echo "Tag image with latest"
-	docker tag $(LOCAL_IMG_NAME) $(LOCAL_IMG):latest
-	docker push $(LOCAL_IMG):latest
-else
-	@echo "Image tagging with latest skipped"
-endif
+build-image: ## Build busola backend image
+	docker build -t $(APP_NAME) -f Dockerfile .
+
+install-busola: build-image ## Build busola web image and install it on local k3d cluster
+	$(eval HASH_TAG=$(shell docker images $(APP_NAME):latest --quiet))
+	docker tag $(APP_NAME) $(APP_NAME):$(HASH_TAG)
+
+	k3d image import $(APP_NAME):$(HASH_TAG) -c kyma
+	kubectl set image deployment busola busola=$(APP_NAME):$(HASH_TAG)

README.md

@@ -178,6 +178,78 @@ For the information on how to run tests and configure them, go to the [`tests`](
    docker run --rm -it -p 3001:3001 -v <path to your custom config>:/app/core-ui/environments/ --env ENVIRONMENT={your-env} --pid=host --name busola europe-docker.pkg.dev/kyma-project/prod/busola:latest
    ```
 
+## Deploy Busola in Kubernetes Cluster
+
+To install Busola on Kubernetes cluster run:
+
+```shell
+(cd resources && kustomize build base/ | kubectl apply -f- )
+```
+
+To install Busola using specific environment configuration, set `ENVIRONMENT` shell environment variable and run:
+
+```shell
+(cd resources && kustomize build environments/${ENVIRONMENT} | kubectl apply -f- )
+```
+
+## Access Busola installed on Kubernetes
+
+### Kubectl
+
+The simplest method which always works is to use capabilities of `kubectl`.
+
+```shell
+kubectl port-forward services/busola 3001:3001
+```
+
+### Busola installed on K3d
+
+Prerequisites:
+
+- K3d with installed Traefik, by default it's installed.
+
+Install ingress resources by running:
+
+```shell
+(cd resources && kubectl apply -f ingress/ingress.yaml)
+```
+
+Go to `localhost`
+
+#### Connect to the k3d cluster where Busola is installed.
+
+To be able to connect to the same K3d cluster where Busola is installed.
+Download kubeconfig and change cluster server address to `https://kubernetes.default.svc:443`.
+
+Using shell:
+Set `K3D_CLUSTER_NAME` shell environment variable to name of your cluster.
+
+```shell
+k3d kubeconfig get ${K3D_CLUSTER_NAME} > k3d-kubeconfig.yaml
+yq --inplace '.clusters[].cluster.server = "https://kubernetes.default.svc:443"' k3d-kubeconfig.yaml
+```
+
+### Kubernetes cluster with Istio installed
+
+Prerequisites:
+
+- Sidecar Proxy injection enabled, see [Kyma docs](https://kyma-project.io/#/istio/user/tutorials/01-40-enable-sidecar-injection?id=enable-istio-sidecar-proxy-injection), how to enable it.
+- Api gateway module installed, see [install docs](https://kyma-project.io/#/02-get-started/01-quick-install)
+
+Install Istio needed resources by running:
+
+```shell
+(cd resources && kubectl apply -k istio)
+```
+
+To get Busola address run:
+
+```shell
+kubectl get virtualservices.networking.istio.io
+```
+
+and find `busola-***` virtual service. Under `HOSTS` there is address to access Busola page.
+
 ## Troubleshooting
 
 > **TIP:** To solve most of the problems with Busola development, clear the browser cache or do a hard refresh of the website.

backend/Makefile

@@ -1,12 +1,6 @@
-APP_NAME = busola-backend
-IMG_NAME := $(DOCKER_PUSH_REPOSITORY)$(DOCKER_PUSH_DIRECTORY)/$(APP_NAME)
-TAG := $(DOCKER_TAG)
-
-
-build-image:
-	docker build -t $(APP_NAME) -f Dockerfile .
-push-image:
-	docker tag $(APP_NAME):latest $(IMG_NAME):$(TAG)
-	docker push $(IMG_NAME):$(TAG)
-
-release: build-image push-image 
+##@ General
+.DEFAULT_GOAL=help
+.PHONY: help
+.PHONY: help
+help: ## Display this help.
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

resources/base/web/deployment.yaml → resources/base/busola/deployment.yaml

@@ -1,7 +1,7 @@
 apiVersion: apps/v1
 kind: Deployment
 metadata:
-  name: web
+  name: busola
   labels:
     app: busola
 spec:
@@ -16,27 +16,28 @@ spec:
     spec:
       containers:
         - name: busola
-          image: busola-web
-          imagePullPolicy: Always
+          image: busola
+          imagePullPolicy: IfNotPresent
           env:
             - name: ENVIRONMENT
               valueFrom:
                 configMapKeyRef:
                   optional: true
                   key: ENVIRONMENT
                   name: environment
+          volumeMounts:
+            - name: config
+              mountPath: /app/core-ui/config
           resources:
             requests:
               cpu: 100m
               memory: 21Mi
           ports:
-            - containerPort: 8080
-          volumeMounts:
-            - name: config
-              mountPath: /app/core-ui/config
+            - containerPort: 3001
       volumes:
         - name: config
           configMap:
+            optional: true
             name: busola-config
             items:
               - key: config

resources/base/web/hpa.yaml → resources/base/busola/hpa.yaml

@@ -1,7 +1,7 @@
 apiVersion: autoscaling/v2
 kind: HorizontalPodAutoscaler
 metadata:
-  name: web
+  name: busola
   labels:
     app: busola
 spec:

resources/base/web/service.yaml → resources/base/busola/service.yaml

@@ -1,13 +1,13 @@
 apiVersion: v1
 kind: Service
 metadata:
-  name: web
+  name: busola
   labels:
     app: busola
 spec:
   ports:
-    - port: 8080
-      name: http-web
-      targetPort: 8080
+    - port: 3001
+      name: http-busola
+      targetPort: 3001
   selector:
     app: busola