Skip to content

Commit a995107

Browse files
committed
finish readme and use api rule
1 parent 7875c80 commit a995107

File tree

9 files changed

+54
-90
lines changed

9 files changed

+54
-90
lines changed

README.md

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -178,23 +178,23 @@ For the information on how to run tests and configure them, go to the [`tests`](
178178
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
179179
```
180180

181-
## Deploy busola in Kubernetes Cluster
181+
## Deploy Busola in Kubernetes Cluster
182182

183-
To install busola on k8s cluster run:
183+
To install Busola on k8s cluster run:
184184

185185
```shell
186186
(cd resources && kustomize build base/ | kubectl apply -f- )
187187
```
188188

189-
To install busola using specific environment configuration, set `ENVIRONMENT` environment variable and run:
189+
To install Busola using specific environment configuration, set `ENVIRONMENT` environment variable and run:
190190

191191
```shell
192192
(cd resources && kustomize build environments/${ENVIRONMENT} | kubectl apply -f- )
193193
```
194194

195-
### Access busola installed on Kubernetes
195+
### Access Busola installed on Kubernetes
196196

197-
You can access busola installed on Kubernetes in several ways, depends on how it's installed:
197+
You can access Busola installed on Kubernetes in several ways, depends on how it's installed:
198198

199199
### Port-forward
200200

@@ -206,6 +206,10 @@ kubectl port-forward services/busola 3001:3001
206206

207207
### K3d
208208

209+
Prerequisites:
210+
211+
- K3d with installed Traefik, by default it's installed.
212+
209213
Install ingress resources by running:
210214

211215
```shell
@@ -214,14 +218,39 @@ Install ingress resources by running:
214218

215219
Then go to `localhost`
216220

221+
#### Connect to the k3d cluster where Busola is installed.
222+
223+
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`.
224+
225+
Using shell:
226+
Prepare name of your cluster and set `K3D_CLUSTER_NAME` shell environment variable with the name of the cluster then run:
227+
228+
```shell
229+
k3d kubeconfig get ${K3D_CLUSTER_NAME} > k3d-kubeconfig.yaml
230+
yq --inplace '.clusters[].cluster.server = "https://kubernetes.default.svc:443"' k3d-kubeconfig.yaml
231+
```
232+
217233
### Istio
218234

219-
To install Istio needed resources, prepare `DOMAIN`and run:
235+
Prerequisites:
236+
237+
- 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.
238+
- Api gateway module installed, see [Install docs](https://kyma-project.io/#/02-get-started/01-quick-install)
239+
240+
Install Istio needed resources by running:
220241

221242
```shell
222-
(cd resources && ./apply-resources-istio.sh ${YOUR_DOMAIN})
243+
(cd resources && kubectl apply -k istio)
223244
```
224245

246+
To get Busola address run:
247+
248+
```shell
249+
kubectl get virtualservices.networking.istio.io
250+
```
251+
252+
and find `busola-***` virtual service. Under `HOSTS` there is address to access Busola page.
253+
225254
## Troubleshooting
226255

227256
> **TIP:** To solve most of the problems with Busola development, clear the browser cache or do a hard refresh of the website.

resources/apply-resources-istio.sh

Lines changed: 0 additions & 21 deletions
This file was deleted.

resources/apply-resources.sh

Lines changed: 0 additions & 22 deletions
This file was deleted.

resources/base/busola/deployment.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ spec:
3737
volumes:
3838
- name: config
3939
configMap:
40+
optional: true
4041
name: busola-config
4142
items:
4243
- key: config

resources/ingress/ingress.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
kind: Ingress
22
apiVersion: networking.k8s.io/v1
33
metadata:
4-
name: ingress-busola
4+
name: busola
55
spec:
66
rules:
77
- http:

resources/istio/apirule.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
apiVersion: gateway.kyma-project.io/v2alpha1
2+
kind: APIRule
3+
metadata:
4+
name: busola
5+
spec:
6+
gateway: kyma-system/kyma-gateway
7+
hosts:
8+
- busola
9+
service:
10+
name: busola
11+
port: 3001
12+
rules:
13+
- path: /{**}
14+
methods: ['GET']
15+
noAuth: true

resources/istio/gateway.tpl.yaml

Lines changed: 0 additions & 15 deletions
This file was deleted.

resources/istio/http_route.tpl.yaml

Lines changed: 0 additions & 18 deletions
This file was deleted.

resources/istio/kustomization.yaml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
11
apiVersion: kustomize.config.k8s.io/v1beta1
22
kind: Kustomization
33
resources:
4-
- gateway.yaml
5-
- http_route.yaml
6-
# Add the destinationrule for TLS into the backend pod.
7-
# This will tell the istio sidecar to use TLS to connect to the backend service.
8-
# For this to work, you need to enable TLS in the backend. See docs/install-kyma-dashboard-manually.md for more information.
9-
# - destinationrule-busola-backend.yaml
4+
- apirule.yaml

0 commit comments

Comments
 (0)