{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/307", "result": {"data":{"issuesJson":{"id":"c07505b8-d058-59a9-a18c-f1fd7f9775ac","title":"astefanutti/kubebox: K8s 终端版管理工具","number":307,"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
Reposastefanutti/kubebox
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

= Kubebox [small]#^⎈❏^#
\nAntonin Stefanutti https://github.com/astefanutti[@astefanutti]
\n// Meta
\n:description: Terminal and Web console for Kubernetes
\n// Settings
\n:idprefix:
\n:idseparator: -
\n:experimental:
\n// Aliases
\nifdef::env-github[]
\n:note-caption: ℹ️
\n:icon-check: ✔️
\n:icon-edit: ✏️
\nendif::[]
\nifndef::env-github[]
\n:icons: font
\n:icon-check: icon:check[]
\n:icon-edit: icon:pencil[fw]
\nendif::[]
\n// URIs
\n:uri-kubebox-download: https://github.com/astefanutti/kubebox/releases/download/v0.10.0
\n:uri-kubebox-twitter: https://twitter.com/kubebox
\n:uri-kube-apiserver: https://kubernetes.io/docs/admin/kube-apiserver/
\n:uri-ingress-controllers: https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-controllers
\n:uri-service-account: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
\n:uri-xterm-js: https://github.com/xtermjs/xterm.js
\n:uri-cadvisor: https://github.com/google/cadvisor

\n

{description}

\n

// image::./docs/kubebox.png[kubebox, align=\"center\"]
\n++++

\n

\n \n \n \n

\n++++\n

=== Features

\n\n

See the <> section for some examples, and follow image:https://img.shields.io/badge/%40kubebox-00ACEE.svg?&logo=twitter&colorA=555&logoColor=fff[link={uri-kubebox-twitter}] for some updates.

\n

== Run

\n

The following alternatives are available for you to use Kubebox, depending on your preferences and constraints:

\n

=== Executable

\n

Download the Kubebox standalone executable for your OS:

\n

[source,shell,subs=attributes+]

\n

Linux (x86_64)

\n

$ curl -Lo kubebox {uri-kubebox-download}/kubebox-linux && chmod +x kubebox

\n

Linux (ARMv7)

\n

$ curl -Lo kubebox {uri-kubebox-download}/kubebox-linux-arm && chmod +x kubebox

\n

OSX

\n

$ curl -Lo kubebox {uri-kubebox-download}/kubebox-macos && chmod +x kubebox

\n

Windows

\n

$ curl -Lo kubebox.exe {uri-kubebox-download}/kubebox-windows.exe

\n

Then run:

\n
$ ./kubebox
\n

=== Server

\n

Kubebox can be served from a service hosted in your Kubernetes cluster.
\nTerminal emulation is provided by {uri-xterm-js}[Xterm.js] and the communication with the Kubernetes master API is proxied by the server.

\n

To deploy the server in your Kubernetes cluster, run:

\n
$ kubectl apply -f https://raw.github.com/astefanutti/kubebox/master/kubernetes.yaml
\n

To shut down the server and clean-up resources, run:

\n
$ kubectl delete namespace kubebox
\n

For the Ingress resource to work, the cluster must have an Ingress controller running.
\nSee {uri-ingress-controllers}[Ingress controllers] for more information.

\n

Alternatively, to deploy the server in your OpenShift cluster, run:

\n
$ oc new-app -f https://raw.github.com/astefanutti/kubebox/master/openshift.yaml
\n

=== Kubectl

\n

You can run Kubebox as an in-cluster client with kubectl, e.g.:

\n
$ kubectl run kubebox -it --rm --env=\"TERM=xterm\" --image=astefanutti/kubebox --restart=Never
\n

If RBAC is enabled, you'll have to use the --serviceaccount option and reference a service account with sufficient permissions.

\n

=== Docker

\n

You can run Kubebox using Docker, e.g.:

\n
$ docker run -it --rm astefanutti/kubebox
\n

You may want to mount your home directory so that Kubebox can rely on the ~/.kube/config file, e.g.:

\n
$ docker run -it --rm -v ~/.kube/:/home/node/.kube/:ro astefanutti/kubebox
\n

=== Online

\n

Kubebox is available online at https://astefanutti.github.com/kubebox.
\nNote that it requires this address to match the allowed origins for CORS by the API server.
\nThis can be achived with the {uri-kube-apiserver}[Kubernetes API server CLI], e.g.:

\n
$ kube-apiserver --cors-allowed-origins .*
\n

== Authentication

\n

We try to support the various authentication strategies supported by kubectl, in order to provide seamless integration with your local setup. Here are the different authentication strategies we support, depending on how you're using Kubebox:

\n

[cols=\"<,^,^,^\",options=\"header\"]
\n|===
\n||Executable|Docker|Online

\n

|OpenID Connect
\n|{icon-check}
\n|{icon-check}
\n|{icon-check}footnote:[Custom IDP certificate authority files are not supported in Web versions.]

\n

|Amazon EKS|
\n{icon-check}
\n|
\n|

\n

|Digital Ocean
\n|{icon-check}
\n|
\n|

\n

|Google Kubernetes Engine|
\n{icon-check}
\n|
\n|
\n|===

\n

If the mode you're using isn't supported, you can refresh the authentication token/certs manually and update your kubeconfig file accordingly.

\n

== cAdvisor

\n

Kubebox relies on {uri-cadvisor}[cAdvisor] to retrieve the resource usage metrics.
\nBefore version 0.8.0, Kubebox used to access the cAdvisor endpoints, that are embedded in the Kubelet. However, these endpoints are being deprecated, and will eventually be removed, as discussed in https://github.com/kubernetes/kubernetes/issues/68522[kubernetes#68522].

\n

Starting version 0.8.0, Kubebox expects cAdvisor to be deployed as a https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/[DaemonSet].
\nThis can be achieved with:

\n
$ kubectl apply -f https://raw.githubusercontent.com/astefanutti/kubebox/master/cadvisor.yaml
\n

It's recommended to use the provided cadvisor.yaml file, that's tested to work with Kubebox.
\nHowever, the DaemonSet example, from the {uri-cadvisor}[cAdvisor] project, should also work just fine.
\nNote that the cAdvisor containers must run with a privileged security context, so that they can access the container runtime on each node.

\n

You can change the default --storage_duration and --housekeeping_interval options, added to the cAdvisor container arguments declared in the cadvisor.yaml file, to adjust the duration of the storage moving window (default to 5m0s), and the sampling period (default to 10s) respectively.
\nYou may also have to provide the path of your cluster container runtime socket, in case it's not following the usual convention.

\n

== Hotkeys

\n

[cols=\"1v,2v\"]
\n|===
\n|Keybinding |Description

\n

2+^.e|General

\n

|kbd:[l], kbd:[Ctrl+l]
\n|Login

\n

|kbd:[n]
\n|Change current namespace

\n

|[kbd:[Shift]+]kbd:[←], kbd:[→] +
\n[kbd:[Alt]+]kbd:[1], ..., kbd:[9]
\n|Navigate screens +
\n(use kbd:[Shift] or kbd:[Alt] inside exec terminal)

\n

|kbd:[Tab], kbd:[Shift+Tab]
\n|Change focus within the active screen

\n

|kbd:[↑], kbd:[↓]
\n|Navigate list / form / log

\n

|kbd:[PgUp], kbd:[PgDn]
\n|Move one page up / down

\n

|kbd:[Enter]
\n|Select item / submit form

\n

|kbd:[Esc]
\n|Close modal window / cancel form

\n

|kbd:[Ctrl+z]
\n|Close current screen

\n

|kbd:[q], kbd:[Ctrl+q]
\n|Exit footnote:[Not available in Web versions.]

\n

2+^.e|Login

\n

|kbd:[←], kbd:[→]
\n|Navigate Kube configurations

\n

2+^.e|Pods

\n

|kbd:[Enter]
\n|Select pod / cycle containers

\n

|kbd:[r]
\n|Remote shell into container

\n

|kbd:[m]
\n|Memory usage

\n

|kbd:[c]
\n|CPU usage

\n

|kbd:[t]
\n|Network usage

\n

|kbd:[f]
\n|File system usage

\n

|kbd:[e]
\n|Pod events

\n

|kbd:[Shift+e]
\n|Namespace events

\n

|kbd:[Ctrl+e]
\n|Cluster events

\n

|===

\n

== FAQ

\n\n\n

** Starting version 0.8.0, Kubebox expects {uri-cadvisor}[cAdvisor] to be deployed as a DaemonSet. See the <> section for more details;

\n

** The metrics are retrieved from the REST API, of the cAdvisor pod running on the same node as the container for which the metrics are being requested. That REST API is accessed via the API server proxy, which requires proper RBAC permission, e.g.:
\n+
\n[source,shell]

\n

Permission to list the cAdvisor pods (selected using the spec.nodeName field selector)

\n

$ kubectl auth can-i list pods -n cadvisor
\nyes

\n

Permission to proxy the selected cAdvisor pod, to call its REST API

\n

$ kubectl auth can-i get pod --subresource proxy -n cadvisor
\nyes

\n

== Development

\n
$ git clone https://github.com/astefanutti/kubebox.git\n$ cd kubebox\n$ npm install\n$ node index.js
\n

== Screenshots

\n

Cluster events:
\n++++

\n

\n \n \n \n

\n++++\n

Shell into a container:
\n++++

\n

\n \n \n \n

\n++++\n

Terminal theme support:
\n++++

\n

\n \n \n \n

\n++++\n

Web browser version:
\n++++

\n

\n \n \n \n

\n++++","updatedAt":"2025-05-21T16:07:24Z","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":"astefanutti","color":"a16717"}}]},"comments":{"edges":[]}}},"pageContext":{"number":307,"previous":{"title":"aquasecurity/kube-bench: 检查 Kubernetes 是否根据 CIS Kubernetes Benchmark 定义的安全最佳实践进行部署","number":306},"next":{"title":"kubeclipper/kubeclipper: KubeClipper 是一个轻量级的 Web 服务，为 Kubernetes 集群生命周期管理 提供友好的 Web 控制台 GUI、API 和 CLI 工具。","number":308}}}, "staticQueryHashes": ["151096407","2861350382"]}