diff --git a/.gitignore b/.gitignore index 7a29af8..9972cff 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,5 @@ /.vscode /vendor /internal/ui/ui/ +**/Dockerfile.dapper* +!**/Dockerfile.dapper diff --git a/README.md b/README.md index df51eff..9274d8d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Please download the binary from the [release page](https://github.com/cnrancher/ To run an HTTP only server: -``` +```bash ./kube-explorer --kubeconfig=xxxx --http-listen-port=9898 --https-listen-port=0 ``` @@ -22,20 +22,47 @@ Then, open the browser to visit http://x.x.x.x:9898 . To debug on an AMD64 Linux host: -``` +```bash make dev # $basedir=/opt/ui/dist/ # prepare the file trees like this # $basedir/dashboard/ +# $basedir/api-ui/ # $basedir/index.html # good to go! -./kube-explorer --debug --ui-path /opt/ui/dist/ --http-listen-port=9898 --https-listen-port=0 +./bin/kube-explorer --debug --ui-path /opt/ui/dist/ --http-listen-port=9898 --https-listen-port=0 ``` To build all cross-platform binaries: +```bash +CROSS=tag make ``` -CROSS=1 make -``` + +## Supported features + +- Specified system default registry for shell image, e.g. `--system-default-registry` +- Specified shell image name, e.g. `--pod-image` +- Deployed behind proxy + - [Behind ingress with dns name](./deploy/kubectl/README.md) + - [Behind ingress with dns name and path prefix](./deploy/kubectl/path-prefix/Readme.md) + - Base auth via ingress such as [nginx](./deploy/kubectl/nginx-auth/README.md), [traefik-v1](./deploy/kubectl/traefik-v1-auth/README.md) and [traefik-v2](./deploy/kubectl/traefik-v2-auth/README.md) + +## 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. + +## Related Projects + +- kube-explorer ui([https://github.com/cnrancher/kube-explorer-ui](https://github.com/cnrancher/kube-explorer-ui)) +- autok3s([https://github.com/cnrancher/autok3s](https://github.com/cnrancher/autok3s)) +- api-ui([https://github.com/rancher/api-ui](https://github.com/rancher/api-ui)) diff --git a/scripts/dev b/scripts/dev index 7ebe5fd..181ce81 100755 --- a/scripts/dev +++ b/scripts/dev @@ -1,8 +1,10 @@ #!/bin/bash set -e -cd $(dirname $0) -./download +cd "$(dirname $0)/.." +./scripts/download + +source $(dirname $0)/version [ "$(uname)" != "Darwin" ] && LINKFLAGS="-extldflags -static -s"