Setup on K3D

July 8, 2023 ยท View on GitHub

This describes how to set up such a platform with k3d for local testing and development.

If you use any other technology to run a k8s cluster please follow the Setup K8S manually Guide.

Requirements

IMPORTANT NOTE: All scripts are only tested on Linux and macOS, but they also should work with any BASH emulation on Windows.

Create a new cluster and setup the Microfrontend platform

./k3d/setup-mashroom-cluster.sh

This creates a new Kubernetes cluster, sets up the common services and deploys the Mashroom Portal with two demo Microfrontends.

After the script finishes the Portal should now be available under http://localhost:30082, and you should be able to add Microfrontend Demo1 and Microfrontend Demo2 to any page.

Re-Deploy the Mashroom Portal

./portal/kubernetes/k3d/build-and-deploy.sh

Re-Deploy the Microfrontends

./microfrontend-demo1/kubernetes/k3d/build-and-deploy.sh
./microfrontend-demo2/kubernetes/k3d/build-and-deploy.sh

Check if the platform is up and running

  • Install Lens or a similar tool, connect to the cluster and check the workloads: Workloads

  • Enter http://localhost:30082 in your browser

  • Login with admin/admin

  • On an arbitrary page click Add App, search for Microfrontend Demo1 and add via Drag'n'Drop: Microfrontends

  • You can check the registered Microfrontends on http://localhost:30082/portal-remote-app-registry-kubernetes Kubernetes Services

  • To check the messaging add the Mashroom Portal Demo Remote Messaging App (as admin) to a page, open the same page as another user (john/john) and send as john a message to user/admin/test - it should appear in the other users Demo Remote Messaging App Remote Messaging

  • The Keycloak Admin UI will be at http://localhost:30081

  • The Prometheus metrics will be available on http://localhost:30082/metrics. If you open this URL you should see something like this: Prometheus Metrics

  • If you want access other internal service use kubectl port-forward. E.g. for Redis:

      kubectl port-forward --namespace mashroom-common  svc/redis-master 6380:6379

Setup Monitoring and Lens Metrics

Run

./k3d/setup-monitoring.sh

Grafana will be available at http://localhost:30083 with admin credentials test/test.

Besides a bunch of useful Kubernetes dashboard there is also a preconfigured Mashroom Portal dashboard available:

Grafana Dashboard Grafana Dashboard

To enable metrics in Lens:

  • From the Cluster list select Settings from the menu
  • Select Metrics in the Settings menu
  • In the Prometheus field select Prometheus Operator
  • in the *Prometheus Service Address" field enter monitoring/prometheus-operated:9090

Cleanup

k3d cluster stop mashroom-cluster
k3d cluster delete mashroom-cluster