Karmada-dashboard

Karmada Dashboard is a general-purpose, web-based control panel for Karmada which is a multi-cluster management project. !image

🚀QuickStart

Prerequisites

If you don't already have the Karmada, you can launch one by following this tutorial.

Generate independent dashboard kubeconfig

hack/generate-karmada-dashboard-kubeconfig.sh "$HOME/.kube/karmada.config" karmada-host

Install Karmada-dashboard

1. Switch user-context of your Karmada config to karmada-host.

export KUBECONFIG="$HOME/.kube/karmada.config"
kubectl config use-context karmada-host

Now, you should be able to see Karmada control plane components by following command:

kubectl get deployments.apps -n karmada-system

If everything works fine, you will get similar messages as following:

NAME                                  READY   UP-TO-DATE   AVAILABLE   AGE
karmada-aggregated-apiserver          2/2     2            2           3d
karmada-apiserver                     1/1     1            1           3d
karmada-controller-manager            1/1     1            1           3d
karmada-kube-controller-manager       1/1     1            1           3d
karmada-scheduler                     2/2     2            2           3d
karmada-webhook                       2/2     2            2           3d

1. Deploy Karmada Dashboard

git clone https://github.com/karmada-io/dashboard.git

Change to the dashboard directory:

cd dashboard

Create the secret that the Karmada Dashboard uses to talk to the Karmada API server. This generates the karmada-dashboard-config secret (the exact name the dashboard deployments mount) from the certificates in ${HOME}/.karmada:

hack/generate-karmada-dashboard-kubeconfig.sh "$HOME/.kube/karmada.config" karmada-host

If you already ran this in the Generate independent dashboard kubeconfig

step above, you can skip it here.

Deploy Karmada Dashboard:

kubectl apply -k artifacts/overlays/nodeport-mode

This will deploy two components in karmada-system namespace:

kubectl get deployments.apps -n karmada-system                                                                                                                karmada-dev-linux-renhongcai: Fri Jan 10 16:08:38 2025
NAME                                  READY   UP-TO-DATE   AVAILABLE   AGE
karmada-dashboard-api                 1/1     1            1           2m
karmada-dashboard-web                 1/1     1            1           2m
...

Then you will be able to access the Karmada Dashboard by http://your-karmada-host:32000. Note that, the Karmada Dashboard service type is NodePort, this exposes the dashboard on a specific port on each node of your host cluster, allowing you to access it via any node's IP address and that port.

You also can use kubectl port-forward to forward a local port to the Dashboard's backend pod:

kubectl port-forward -n karmada-system services/karmada-dashboard-web --address 0.0.0.0 8000:8000

You still need the jwt token to login to the dashboard.

1. Create Service Account

kubectl config use-context karmada-apiserver

kubectl apply -f artifacts/dashboard/karmada-dashboard-sa.yaml

1. [Optional] For member-cluster management

kubectl --kubeconfig ~/.kube/karmada.config --context karmada-apiserver apply -f artifacts/dashboard/karmada-dashboard-clusterrolebinding.yaml

member_clusters=(
        member1
        member2
        member3
      )
      for member_cluster in ${member_clusters[@]}; do
        echo "$member_cluster config start"
        kubectl --kubeconfig ~/.kube/members.config --context $member_cluster apply -f artifacts/dashboard/member-cluster-clusterrolebinding.yaml
        echo "$member_cluster config finish"
      done

1. Get jwt token

kubectl -n karmada-system get secret/karmada-dashboard-secret -o go-template="{{.data.token | base64decode}}"

it should print results like this:

eyJhbGciOiJSUzI1NiIsImtpZCI6InZLdkRNclVZSFB6SUVXczBIRm8zMDBxOHFOanQxbWU4WUk1VVVpUzZwMG8ifQ.eyJpc3MiOiJrdWJlcm5ldGVzL3NlcnZpY2VhY2NvdW50Iiwia3ViZXJuZXRlcy5pby9zZXJ2aWNlYWNjb3VudC9uYW1lc3BhY2UiOiJrYXJtYWRhLXN5c3RlbSIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VjcmV0Lm5hbWUiOiJrYXJtYWRhLWRhc2hib2FyZC10b2tlbi14NnhzcCIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VydmljZS1hY2NvdW50Lm5hbWUiOiJrYXJtYWRhLWRhc2hib2FyZCIsImt1YmVybmV0ZXMuaW8vc2VydmljZWFjY291bnQvc2VydmljZS1hY2NvdW50LnVpZCI6ImE5Y2RkZDc3LTkyOWYtNGM0MS1iZDY4LWIzYWVhY2E0NGJiYiIsInN1YiI6InN5c3RlbTpzZXJ2aWNlYWNjb3VudDprYXJtYWRhLXN5c3RlbTprYXJtYWRhLWRhc2hib2FyZCJ9.F0BqSxl0GVGvJZ_WNwcEFtChE7joMdIPGhv8--eN22AFTX34IzJ_2akjZcWQ63mbgr1mVY4WjYdl7KRS6w4fEQpqWkWx2Dfp3pylIcMslYRrUPirHE2YN13JDxvjtYyhBVPlbYHSj7y0rvxtfTr7iFaVRMFFiUbC3kVKNhuZtgk_tBHg4UDCQQKFALGc8xndU5nz-BF1gHgzEfLcf9Zyvxj1xLy9mEkLotZjIcnZhwiHKFYtjvCnGXxGyrTvQ5rgilAxBKv0TcmjQep_TG_Q5M9r0u8wmxhDnYd2a7wsJ3P3OnDw7smk6ikY8UzMxVoEPG7XoRcmNqhhAEutvcJoyw

Login Dashboard

copy the token you just generated and paste it into the Enter token field on the login page. !image Once the process of authentication passed, you can use karmada dashboard freely. You can follow the Usage of karmada-dashboard to have a quick experience of karmada dashboard.

Meeting

Regular Meeting For dashboard:

• Wednesday at 14:30 UTC+8 (Chinese)(biweekly). Convert to your timezone.
• There isn't a dedicated English meeting yet. If you have any topics to discuss, please join the community meeting.

• Meeting Notes and Agenda
• Meeting Calendar | Subscribe
• Meeting Link

💻Contributing

License

Karmada-dashboard is under the Apache 2.0 license. See the LICENSE file for details.