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

dbadura · 2024-12-18T12:49:10Z

Description

Changes proposed in this pull request:

adjust k8s resources
add docs how to deploy busola on k8s and access it in different scenarios

Related issue(s)

Definition of done

The PR's title starts with one of the following prefixes:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding tests
- chore: Maintainance changes to the build process or auxiliary tools, libraries, workflows, etc.
Related issues are linked. To link internal trackers, use the issue IDs like backlog#4567
Explain clearly why you created the PR and what changes it introduces
All necessary steps are delivered, for example, tests, documentation, merging

#3375

akucharska

lgtm

pbochynski

I followed the instruction to deploy busola to local k3d cluster, but I failed to access this cluster from busola. Probably the latest image does not include all the changes required to work properly. I've seen also some errors to fetch localhost:3001/backend, even though my busola is hosted on port 80.

pbochynski · 2025-01-07T08:48:11Z

README.md

+(cd resources && kubectl apply -f ingress/ingress.yaml)
+```
+
+Go to `localhost`


What port? Provide a command to create k3d cluster with load balancer port mapping, e.g.

k3d cluster create -p "80:80@loadbalancer"

Otherwise, the port is not exposed in the host machine (at least on mac os)

pbochynski · 2025-01-07T08:52:24Z

README.md

+
+```shell
+k3d kubeconfig get ${K3D_CLUSTER_NAME} > k3d-kubeconfig.yaml
+yq --inplace '.clusters[].cluster.server = "https://kubernetes.default.svc:443"' k3d-kubeconfig.yaml


yq not mentioned before
I suppose the edited kubeconfig should be used in busola. Mention it.

grego952 · 2025-01-07T09:04:58Z

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:


Suggested change

To install Busola on Kubernetes cluster run:

To install Busola on the Kubernetes cluster, run:

grego952 · 2025-01-07T09:05:14Z

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


Suggested change

## Deploy Busola in Kubernetes Cluster

## Deploy Busola on the Kubernetes Cluster

grego952 · 2025-01-07T09:07:24Z

README.md

+(cd resources && kustomize build base/ | kubectl apply -f- )
+```
+
+To install Busola using specific environment configuration, set `ENVIRONMENT` shell environment variable and run:


Suggested change

To install Busola using specific environment configuration, set `ENVIRONMENT` shell environment variable and run:

To install Busola using a specific environment configuration, set the `ENVIRONMENT` shell environment variable and run:

grego952 · 2025-01-07T09:07:39Z

README.md

+(cd resources && kustomize build environments/${ENVIRONMENT} | kubectl apply -f- )
+```
+
+## Access Busola installed on Kubernetes


Suggested change

## Access Busola installed on Kubernetes

## Access Busola Installed on Kubernetes

grego952 · 2025-01-07T09:07:46Z

README.md

+
+## Access Busola installed on Kubernetes
+
+### Kubectl


Suggested change

### Kubectl

### kubectl

grego952 · 2025-01-07T09:22:04Z

README.md

+
+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.


Suggested change

- 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.

- Sidecar Proxy injection enabled, see [Enable Istio Sidecar Proxy Injection](https://kyma-project.io/#/istio/user/tutorials/01-40-enable-sidecar-injection?id=enable-istio-sidecar-proxy-injection).

grego952 · 2025-01-07T09:23:34Z

README.md

+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)


Suggested change

- Api gateway module installed, see [install docs](https://kyma-project.io/#/02-get-started/01-quick-install)

- The API Gateway module installed, see [Quick Install](https://kyma-project.io/#/02-get-started/01-quick-install)

grego952 · 2025-01-07T09:24:19Z

README.md

+- 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:


Suggested change

Install Istio needed resources by running:

1. Install the Istio required resources:

grego952 · 2025-01-07T09:24:34Z

README.md

+(cd resources && kubectl apply -k istio)
+```
+
+To get Busola address run:


Suggested change

To get Busola address run:

2. To get the Busola address, run:

grego952 · 2025-01-07T09:25:15Z

README.md

+kubectl get virtualservices.networking.istio.io
+```
+
+and find `busola-***` virtual service. Under `HOSTS` there is address to access Busola page.


Suggested change

and find `busola-***` virtual service. Under `HOSTS` there is address to access Busola page.

and find the `busola-***` virtual service. Under `HOSTS,` there is an address where you can access the Busola page.

dbadura added 3 commits December 18, 2024 13:42

ingress works

8d7152d

wip

4fc041e

first version od tests adjustement

c34619e

kyma-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cla: yes Indicates the PR's author has signed the CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 18, 2024

dbadura force-pushed the busola-k8s branch 2 times, most recently from 30debff to b19a45c Compare December 18, 2024 12:51

revert changes related to ci

13f3721

dbadura force-pushed the busola-k8s branch from b19a45c to 13f3721 Compare December 18, 2024 12:51

dbadura added 2 commits December 20, 2024 17:26

wip

c8ae781

adjust k8s resources to use single image

6e305b4

kyma-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 30, 2024

dbadura and others added 7 commits December 30, 2024 16:45

revert changes related to backend env

b79c481

cleanup

3f42b81

first istio steps

7875c80

finish readme and use api rule

a995107

improve docs

b5e436e

remove not needed env

bfb8321

Merge branch 'main' into busola-k8s

fcfde0b

dbadura marked this pull request as ready for review December 31, 2024 14:13

dbadura requested review from a team, akucharska, mrCherry97, chriskari and OliwiaGowor as code owners December 31, 2024 14:13

kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 31, 2024

dbadura added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 31, 2024

kyma-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 2, 2025

improve readme

575accc

dbadura linked an issue Jan 2, 2025 that may be closed by this pull request

Releasing with semantic versioning #3375

Open

4 tasks

revert deletion of validation schemas

c342b15

dbadura force-pushed the busola-k8s branch from 84f4510 to c342b15 Compare January 3, 2025 10:13

kyma-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 3, 2025

dbadura added 2 commits January 3, 2025 11:16

remove accident addition

b1c5fc6

improve cm location

b78c98d

akucharska reviewed Jan 3, 2025

View reviewed changes

pbochynski requested changes Jan 7, 2025

View reviewed changes

kyma-bot assigned pbochynski Jan 7, 2025

grego952 reviewed Jan 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

dbadura commented Dec 18, 2024 •

edited

Loading

akucharska left a comment

pbochynski left a comment

pbochynski Jan 7, 2025

pbochynski Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

grego952 Jan 7, 2025

	To install Busola on Kubernetes cluster run:
	To install Busola on the Kubernetes cluster, run:

	## Deploy Busola in Kubernetes Cluster
	## Deploy Busola on the Kubernetes Cluster

	To install Busola using specific environment configuration, set `ENVIRONMENT` shell environment variable and run:
	To install Busola using a specific environment configuration, set the `ENVIRONMENT` shell environment variable and run:

	## Access Busola installed on Kubernetes
	## Access Busola Installed on Kubernetes


		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)
	- The API Gateway module installed, see [Quick Install](https://kyma-project.io/#/02-get-started/01-quick-install)

	Install Istio needed resources by running:
	1. Install the Istio required resources:

	To get Busola address run:
	2. To get the Busola address, run:

	and find `busola-***` virtual service. Under `HOSTS` there is address to access Busola page.
	and find the `busola-***` virtual service. Under `HOSTS,` there is an address where you can access the Busola page.

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

Are you sure you want to change the base?

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

Conversation

dbadura commented Dec 18, 2024 • edited Loading

akucharska left a comment

Choose a reason for hiding this comment

pbochynski left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbadura commented Dec 18, 2024 •

edited

Loading