{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/520", "result": {"data":{"issuesJson":{"id":"bc6906c7-e540-5933-93fa-2948fe7863c7","title":"skooner-k8s/skooner: 简单的 Kubernetes 实时仪表板和管理工具","number":520,"bodyHTML":"

\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Repos	skooner-k8s/skooner
Views	$\"views\"$
Stars	$\"stars\"$
Forks	$\"forks\"$
License	$\"license\"$
UpdatedAt	$\"last-commit\"$
CreatedAt	$\"create-at\"$

\n\n

\n

\n

\n

Skooner - Kubernetes Dashboard

\n

We are changing our name from k8dash to Skooner! Please bear with us as we update our documentation and codebase to reflect this change. If you previously installed k8dash, you will need to uninstall it from your cluster and install Skooner instead. For most cases this can be done by running the following kubectl delete deployment,service k8dash

\n

Skooner is the easiest way to manage your Kubernetes cluster. Skooner is now a sandbox project of the Cloud Native Computing Foundation!

\n

Full cluster management: Namespaces, Nodes, Pods, Replica Sets, Deployments, Storage, RBAC and more
Blazing fast and Always Live: no need to refresh pages to see the latest cluster status
Quickly visualize cluster health at a glance: Real time charts help quickly track down poorly performing resources
Easy CRUD and scaling: plus inline API docs to easily understand what each field does
100% responsive (runs on your phone/tablet)
Simple OpenID integration: no special proxies required
Simple installation: use the provided yaml resources to have skooner up and running in under 1 minute (no, seriously)
See Skooner in action:

\n $\"Skooner$

\n
\n

Table of Contents

\n

Skooner - Kubernetes Dashboard\n
- Table of Contents
- Prerequisites
- Getting Started
- kubectl proxy
- Logging in\n
  - Service Account Token
  - OIDC
  - NodePort
  - Metrics
  \n
- Development
- Skooner Architecture\n
  - Server
  - Client
  \n
- License
\n

\n

Prerequisites

\n

A running Kubernetes cluster (e.g., minikube), with...\n
- metrics server installed (optional, but strongly recommended)
- configuration for OpenId Connect authentication (optional)
\n

\n

(Back to Table of Contents)

\n

Getting Started

\n

Deploy Skooner with something like the following...

\n

NOTE: never trust a file downloaded from the internet. Make sure to review the contents of kubernetes-skooner.yaml before running the script below.

\n

kubectl apply -f https://raw.githubusercontent.com/skooner-k8s/skooner/master/kubernetes-skooner.yaml

\n

To access skooner, you must make it publicly visible. If you have an ingress server setup, you can accomplish by adding a route like the following:

\n

kind: Ingress\napiVersion: networking.k8s.io/v1\nmetadata:\n  name: skooner\n  namespace: kube-system\nspec:\n  rules:\n    - host: skooner.example.com\n      http:\n        paths:\n          - path: /\n            backend:\n              service:\n                name: skooner\n                port:\n                  number: 80\n            pathType: ImplementationSpecific

\n

Note: networking.k8s.io/v1 Ingress is required for Kubernetes v1.22+; extensions/v1beta1 Ingress is deprecated in v1.14+ and unavailable in v1.22+.

\n

(Back to Table of Contents)

\n

kubectl proxy

\n

Unfortunately, kubectl proxy cannot be used to access Skooner. According to this comment, it seems that kubectl proxy strips the Authorization header when it proxies requests.

\n

\n
this is working as expected. \"proxying\" through the apiserver will not get you standard proxy behavior (preserving Authorization headers end-to-end), because the API is not being used as a standard proxy
\n

\n

(Back to Table of Contents)

\n

Logging in

\n

There are multiple options for logging into the dashboard: Service Account Token, OIDC, and NodePort.

\n

Service Account Token

\n

The first (and easiest) option is to create a dedicated service account. In the command line:

\n

# Create the service account in the current namespace (we assume default)\nkubectl create serviceaccount skooner-sa\n\n# Give that service account root on the cluster\nkubectl create clusterrolebinding skooner-sa --clusterrole=cluster-admin --serviceaccount=default:skooner-sa\n\n# For Kubernetes v1.21 or lower\n# Find the secret that was created to hold the token for the SA\nkubectl get secrets\n\n# Show the contents of the secret to extract the token\nkubectl describe secret skooner-sa-token-xxxxx\n\n# For Kubernetes v1.22 or higher\nkubectl create token skooner-sa\n

\n

Copy the token value from the secret, and enter it into the login screen to access the dashboard.

\n

OIDC

\n

Skooner makes using OpenId Connect for authentication easy. Assuming your cluster is configured to use OIDC, all you need to do is create a secret containing your credentials and apply kubernetes-skooner-oidc.yaml.

\n

To learn more about configuring a cluster for OIDC, check out these great links

\n

\n

You can deploy Skooner with OIDC support using something like the following script...

\n

NOTE: never trust a file downloaded from the internet. Make sure to review the contents of kubernetes-skooner-oidc.yaml before running the script below.

\n

OIDC_URL=<put your endpoint url here... something like https://accounts.google.com>\nOIDC_ID=<put your id here... something like blah-blah-blah.apps.googleusercontent.com>\nOIDC_SECRET=<put your oidc secret here>\n\nkubectl create secret -n kube-system generic skooner \\\n--from-literal=url=$OIDC_URL \\\n--from-literal=id=$OIDC_ID \\\n--from-literal=secret=$OIDC_SECRET\n\nkubectl apply -f https://raw.githubusercontent.com/skooner-k8s/skooner/master/kubernetes-skooner-oidc.yaml\n

\n

Additionally, you can provide other OIDC options via these environment variables:

\n

OIDC_SCOPES: The default value for this value is openid email, but additional scopes can also be added using something like OIDC_SCOPES=\"openid email groups\"
OIDC_METADATA: Skooner uses the excellent node-openid-client module. OIDC_METADATA will take a JSON string and pass it to the Client constructor. Docs here. For example, OIDC_METADATA='{\"token_endpoint_auth_method\":\"client_secret_post\"}

\n

NodePort

\n

If you do not have an ingress server setup, you can utilize a NodePort service as configured in kubernetes-skooner-nodeport.yaml. This is ideal when creating a single node master, or if you want to get up and running as fast as possible.

\n

This will map Skooner port 4654 to a randomly selected port on the running node. The assigned port can be found using:

\n

$ kubectl get svc --namespace=kube-system\n\nNAME       TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)          AGE\nskooner     NodePort    10.107.107.62   <none>        4654:32565/TCP   1m\n

\n

Metrics

\n

Skooner relies heavily on metrics-server to display real time cluster metrics. It is strongly recommended to have metrics-server installed to get the best experience from Skooner.

\n

\n

(Back to Table of Contents)

\n

Development

\n

You will need:

\n

A running Kubernetes cluster\n
- Installing and running minikube is an easy way to get this.
- Once minikube is installed, you can run it with the command minikube start --driver=docker
\n
Once the cluster is up and running, create some login credentials as described above

\n

(Back to Table of Contents)

\n

Skooner Architecture

\n

Server

\n

To run the server, run npm i from the /server directory to install dependencies and then npm start to run the server.
\nThe server is a simple express.js server that is primarily responsible for proxying requests to the Kubernetes api server.

\n

During development, the server will use whatever is configured in ~/.kube/config to connect the desired cluster. If you are using minikube, for example, you can run kubectl config set-context minikube to get ~/.kube/config set up correctly.

\n

Client

\n

The client is a React application (using TypeScript) with minimal other dependencies.

\n

To run the client, open a new terminal tab and navigate to the /client directory, run npm i and then npm start. This will open up a browser window to your local Skooner dashboard. If everything compiles correctly, it will load the site and then an error message will pop up Unhandled Rejection (Error): Api request error: Forbidden.... The error message has an 'X' in the top righthand corner to close that message. After you close it, you should see the UI where you can enter your token.

\n

(Back to Table of Contents)

\n

Troubleshooting

\n

Recommendation for keycloak configuration:

\n

Set OIDC_URL to keycloak OpenId endpoint configuration page.

\n

OIDC_URL=https://{keycloak_domain}/realms/foo/.well-known/openid-configuration
Also set $OIDC_ID locally with OIDC_ID={client_id}
You can get $OIDC_SECRET from keycloak\n
- (You need to set the Client authentication toggle to be on, for older version of keycloaks you should switch access type to confidential )
  \n $\"img.png\"$
- $\"img.png\"$
\n

\n

While creating secret, use correct var name and use skooner namespace (by default it's kube-system):

\n

kubectl create secret generic skooner \\\n--from-literal=url=$OIDC_URL \\\n--from-literal=id=$OIDC_ID \\\n--from-literal=secret=$OIDC_SECRET \\\n--namespace=kube-system\n

\n

\n
following that, redeploy skooner server with
\nkubectl apply -f https://raw.githubusercontent.com/skooner-k8s/skooner/master/kubernetes-skooner-oidc.yaml
\n
\n
Make sure skooner is running by checking kubectl rollout status deploy/skooner --namespace=kube-system
\nIf not, report error with logging in kubectl describe pod skooner --namespace=kube-system
\n
\n
[Optional] create an ingress for skooner, you can take provision/keycloak/skooner-ingress.yaml as an example
\n
\n
visit skooner, check if login succeeded
\n
\n
[Trouble Shooting] If the api call returns 403 with a message containing some error like: User \\\"system:anonymous\\\" cannot list resource \\\"selfsubjectrulesreviews\\\" in API group \\\"authorization.k8s.io\\\" at the cluster scope\"
\n
- it means you'll need a cluster role bond. You can take provision/keycloak/skooner-oidc-patch.yaml as an example
- @elieassi suggests create a serviceaccount separately, I feel like it's more secure but I hadn't test it out. See this issue for more details
\n
\n
If failed, please report both client and server error.
\nClient error: check browser console and send a screenshot
\nServer error: check logs by kubectl logs deploy/skooner --namespace=kube-system
\nNote that RequestError: connect ECONNREFUSED may indicate a configuration issue rather than Skooner's issue.
\n

\n

License

\n

Apache License 2.0

\n

\n

(Back to Table of Contents)

","updatedAt":"2025-05-22T01:48:33Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"K8S-Tools","color":"2d411a"}},{"node":{"name":"skooner-k8s","color":"57c2ad"}}]},"comments":{"edges":[]}}},"pageContext":{"number":520,"previous":{"title":"lotabout/skim: 一个类似 grep 命令的通用的模糊查找器，可以节省您的时间。","number":519},"next":{"title":"apache/skywalking: 一个开源的 APM 系统，为云原生架构中的分布式系统提供监控、跟踪和诊断功能。","number":521}}}, "staticQueryHashes": ["151096407","2861350382"]}