A portable explorer for Kubernetes, without any dependency.
Go to file
2024-11-25 09:43:22 +08:00
.github/workflows fix: wrong branch name 2024-10-21 21:52:17 +08:00
deploy/kubectl docs: Add docs for path prefix deploy example 2024-07-29 15:07:34 +08:00
docs/assets Add GIF record [CI SKIP] 2022-02-07 14:35:15 +08:00
internal fix: Should handle stale socket file 2024-10-10 21:21:35 +08:00
package fix: the usage is not compatible with old version 2024-11-25 09:43:22 +08:00
scripts fix: CROSS push 2024-10-21 21:45:17 +08:00
.dockerignore fix: Add dockerignore file to clean up each ci build 2024-07-17 15:02:39 +08:00
.drone_backup.yml feat: switch to GHA 2024-07-18 10:08:15 +08:00
.gitignore feat: use goreleaser to build binaries 2024-10-21 16:29:04 +08:00
.golangci.json refactor: No need to customize steve for explorer 2024-07-16 16:30:23 +08:00
.goreleaser.yaml fix: aliyun-metadata should have registry name for image 2024-10-21 21:14:13 +08:00
Dockerfile.dapper feat: use goreleaser to build binaries 2024-10-21 16:29:04 +08:00
go.mod feat: Support to serve http via socket 2024-10-09 22:53:08 +08:00
go.sum feat: Support to serve http via socket 2024-10-09 22:53:08 +08:00
LICENSE Initial commit 2021-04-13 11:30:50 +08:00
main.go feat: Support to serve http via socket 2024-10-09 22:53:08 +08:00
Makefile Support dapper for build process 2021-04-17 11:44:46 +08:00
README.md fix(docs): enhance Readme 2024-10-09 09:12:48 +08:00

kube-explorer

kube-explorer is a portable explorer for Kubernetes without any dependency.

It integrates the Rancher steve framework and its dashboard, and is recompiled, packaged, compressed, and provides an almost completely stateless Kubernetes resource manager.

Usage

Please download the binary from the release page.

To run an HTTP only server:

./kube-explorer --kubeconfig=xxxx --http-listen-port=9898 --https-listen-port=0

Then, open the browser to visit http://x.x.x.x:9898 .

Build

To debug on an AMD64 Linux host:

make dev

# $basedir=/opt/ui/dist/
# prepare the file trees like this
# $basedir/dashboard/
# $basedir/api-ui/
# $basedir/index.html

# good to go!
./bin/kube-explorer --debug  --ui-path /opt/ui/dist/ --http-listen-port=9898 --https-listen-port=0

To build all cross-platform binaries:

CROSS=tag make

Supported features

Support Matrix

Currently, there are several major versions under maintenance, each tailored to different Kubernetes version ranges due to the use of varying steve and client-go versions.

Major Target Rancher Branch K8s version range
v0.4 v2.8.x >= 1.25 <= 1.28
v0.5 v2.9.x >= 1.27 <= 1.30

Please use the proper kube-explorer version for your k8s setup.