kubevious / portable

Application-centric Kubernetes viewer and validator

What is Kubevious Portable?

Kubevious (pronounced [kju:bvi:əs]) is open-source software that provides a usable and highly graphical interface for Kubernetes. Kubevious renders all configurations relevant to the application in one place. That saves a lot of time from operators, eliminating the need for looking up settings and digging within selectors and labels.

While Kubevious operates inside the cluster and provides UI and configuration validation for the local cluster only, Kubevious Portable runs from the development workstation and connects to remote clusters. That allows rapid debugging for clusters that are configured in ~/.kube/config file.

Compared with Kubevious, Kubevious Portable is not equipped with Time Machine and Rules Engine. Those capabilities require significant processing and are not able to be executed within the Portable version. If required, consider installing full operation here.

Running Kubevious Portable

Running on Mac OS X or Linux:

docker run --rm -it \
  -p 5001:5001 \
  -v ~/.kube/config:/root/.kube/config:ro \
  kubevious/portable

Running on Windows

docker run --rm -it ^
  -p 5001:5001 ^
  -v "%USERPROFILE%/.kube/config:/root/.kube/config:ro" ^
  kubevious/portable

Issue Reporting

In case you identify issues or have suggestions to improve Kubevious Portable, please take a minute and report here.

Running Kubevious Portable for Minikube

docker run --rm -it \
  -p 5001:5001 \
  -v ~/.kube/config:/root/.kube/config:ro \
  -v ~/.minikube/ca.crt:/data/$HOME/.minikube/ca.crt:ro \
  -v ~/.minikube/profiles/minikube/client.crt:/data/$HOME/.minikube/profiles/minikube/client.crt:ro \
  -v ~/.minikube/profiles/minikube/client.key:/data/$HOME/.minikube/profiles/minikube/client.key:ro \
  kubevious/portable

Because of differences on Windows it is not possible to connect to Minikube running on the same host. The host.docker.internal address that allows connecting to the host from inside the container is not implemented on Windows. For details see Networking features in Docker Desktop for Windows.

Running Kubevious Portable for Docker Desktop Kubernetes

docker run --rm -it \
  -p 5001:5001 \
  -v ~/.kube/config:/root/.kube/config:ro \
  kubevious/portable

Because of differences on Windows it is not possible to connect to Docker Desktop Kubernetes running on the same host. The host.docker.internal address that allows connecting to the host from inside the container is not implemented on Windows. For details see Networking features in Docker Desktop for Windows.

Running Kubevious Portable for Google Cloud Platform (GKE)

Running on Mac OS X or Linux:

docker run --rm -it \
  -p 5001:5001 \
  -v ~/.kube/config:/root/.kube/config:ro \
  -v ~/.config/gcloud:/root/.config/gcloud \
  kubevious/portable:gcp

Running on Windows

docker run --rm -it ^
  -p 5001:5001 ^
  -v "%USERPROFILE%/.kube/config:/root/.kube/config:ro" ^
  -v "%USERPROFILE%/AppData/Roaming/gcloud:/root/.config/gcloud" ^
  kubevious/portable

Running Kubevious Portable for Amazon Web Services (EKS)

Running on Mac OS X or Linux:

docker run --rm -it \
  -p 5001:5001 \
  -v ~/.kube/config:/root/.kube/config:ro \
  -v ~/.aws/credentials:/root/.aws/credentials:ro \
  kubevious/portable:aws

Running on Windows

docker run --rm -it ^
  -p 5001:5001 ^
  -v "%USERPROFILE%/.kube/config:/root/.kube/config:ro" ^
  -v "%USERPROFILE%/.aws/credentials:/root/.aws/credentials:ro" ^
  kubevious/portable

Running Kubevious Portable for Digital Ocean (DOKE)

Running on Mac OS X

docker run --rm -it \
  -p 5001:5001 \
  -v ~/.kube/config:/root/.kube/config:ro \
  -v ~/Library/Application\ Support/doctl/config.yaml:/root/.config/doctl/config.yaml:ro \
  kubevious/portable:do

Running on Linux

docker run --rm -it \
  -p 5001:5001 \
  -v ~/.kube/config:/root/.kube/config:ro \
  -v ~/.config/doctl/config.yaml:/root/.config/doctl/config.yaml:ro \
  kubevious/portable:do

Running on Windows

docker run --rm -it ^
  -p 5001:5001 ^
  -v "%USERPROFILE%/.kube/config:/root/.kube/config:ro" ^
  -v "%USERPROFILE%/AppData/Local/doctl/config/config.yaml:/root/.config/doctl/config.yaml:ro" ^
  kubevious/portable:do

Operating Instructions

Upon startup Kubevious Portable lists contexts from ~/.kube/config file. The only big difference from full version of Kubevious is the choice of cluster that has to be made upon launch. Users can change cluster selection afterwards.

portable's Issues

Namespace and K8 Labels as filter

Is your feature request related to a problem? Please describe.

Is it possible to have filter on namespace and labels?
User will use some kube context with permission to access only one namespace in that case this might break.
Sometime we need to view only some resources on the basis of labels.

Kubevious fails when API ressources NotFound

Describe the bug

Kubevious does not seems to work when some apiservices are Stuck or not available.

To Reproduce

Steps to reproduce the behavior:

http://localhost:5001[2021-12-03 02:13:40.560 +0000] ERROR (ParserContext/1 on 1449d13bf81b): Error connecting: 
    arg0: {
      "status": 0,
      "message": "connect ECONNREFUSED 172.18.100.90:6443",
      "method": "GET",
      "baseURL": "https://172.18.100.90:6443",
      "url": "/api"
    }
[2021-12-03 12:44:54.490 +0000] ERROR (ParserContext/1 on 1449d13bf81b): Error connecting: 
    arg0: {
      "status": 503,
      "message": "Service Unavailable",
      "method": "GET",
      "baseURL": "https://172.18.100.90:6443",
      "url": "/apis/cluster.loft.sh/v1"

Expected behavior

The bellow ressources were in this state, Kubevious will fail with above errors:

v1.cluster.loft.sh                     loft/loft-agent-apiservice   False (ServiceNotFound)   8h
v1.management.loft.sh                  loft/loft-apiservice         False (ServiceNotFound)   8h

Screenshots

If applicable, add screenshots to help explain your problem.

Environment Details:

• Kubernetes Distribution/Version 1.23.0.beta.0
• Local OS MacOS
• Browser safari
• Version Latest

Additional context

Add any other context about the problem here.

exit with :1

Describe the bug

I am trying portable kubevious on mac os and I got the following error:

[2021-06-28 23:24:14.895 +0000] ERROR (Context/1 on 0a69aca058db):
msg: {}
[Backend::_exitHandler] event: exit
[Backend::_exitHandler] cleanup
[Backend::_exitHandler] exiting with: 1

To Reproduce

Steps to reproduce the behavior:
1- mac os big sur 11.4
2- docker desktop version

Client:
Cloud integration: 1.0.17
Version: 20.10.7
API version: 1.41
Go version: go1.16.4
Git commit: f0df350
Built: Wed Jun 2 11:56:22 2021
OS/Arch: darwin/amd64
Context: desktop-linux
Experimental: true

Server: Docker Engine - Community
Engine:
Version: 20.10.7
API version: 1.41 (minimum version 1.12)
Go version: go1.13.15
Git commit: b0f5bc3
Built: Wed Jun 2 11:54:58 2021
OS/Arch: linux/amd64
Experimental: false
containerd:
Version: 1.4.6
GitCommit: d71fcd7d8303cbf684402823e425e9dd2e99285d
runc:
Version: 1.0.0-rc95
GitCommit: b9ee9c6314599f1b4a7f497e1f1f856fe433d3b7
docker-init:
Version: 0.19.0
GitCommit: de40ad0

Expected behavior

expect portable container up and running

Screenshots

Environment Details:

• Kubernetes Distribution/Version [e.g. GKE v1.13.12-gke.25, OpenShift 4.3]
• Local OS
• Browser [e.g. chrome, safari]
• Version [e.g. v0.7]

Additional context

Add any other context about the problem here.

Allowing k8s connection using self signed certificate

Is your feature request related to a problem? Please describe.

I have multiple clusters that uses a private chain and kubevious is unable to connect on them, printing this error:

Describe the solution you'd like

Passing and env variable or some other tips at runtime to configure kubevious to not verify endpoint certificate.

aws-iam-authenticator not in image

Hello, got everything running, however, while trying to connect to my EKS cluster:

Some configuration files or tools were not found.
Tool not found: "aws-iam-authenticator"

Kubevious Portable (0.7.31)

Can you please add this tool to the image? would be a great help, thank you!

Container fails vulnerability scan, 3x CVE found.

Describe the bug

I'd love to use this, but kubevious/portable:0.7.31 has some packages that fail our vulnerability scanning. Can these be upgraded?

To Reproduce

Steps to reproduce the behavior:

1. Scan with a popular scanner, such as Aqua.

Expected behavior

No vulnerabilities found.

Actual behaviour

• CVE-2020-8237 found in json-bigint.
• CVE-2020-8116 found in dot-prop.
• CVE-2020-8203 found in lodash.