Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benc-uk/kubeview
Kubernetes cluster visualiser and graphical explorer
https://github.com/benc-uk/kubeview
dashboard kubernetes kubernetes-api monitoring spa vuejs
Last synced: about 2 months ago
JSON representation
Kubernetes cluster visualiser and graphical explorer
- Host: GitHub
- URL: https://github.com/benc-uk/kubeview
- Owner: benc-uk
- License: mit
- Created: 2019-02-19T18:23:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T02:00:48.000Z (over 1 year ago)
- Last Synced: 2024-06-18T18:52:15.280Z (3 months ago)
- Topics: dashboard, kubernetes, kubernetes-api, monitoring, spa, vuejs
- Language: Vue
- Homepage: http://kubeview.benco.io/
- Size: 6.75 MB
- Stars: 912
- Watchers: 14
- Forks: 104
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - kubeview - Kubernetes cluster visualiser and graphical explorer (Vue)
- awesome-ops - benc-uk/kubeview - 02-19|2023-03-07 | Kubernetes 集群可视化器和图形浏览器 | (K8S-Cluster-Manage)
- awesome-ccamel - benc-uk/kubeview - Kubernetes cluster visualiser and graphical explorer (Vue)
README
# KubeView
Kubernetes cluster visualiser and visual explorer
KubeView displays what is happening inside a Kubernetes cluster (or single namespace), it maps out the API objects and how they are interconnected. Data is fetched real-time from the Kubernetes API. The status of some objects (Pods, ReplicaSets, Deployments) is colour coded red/green to represent their status and health
The app auto refreshes and dynamically updates the view as new data comes in or when it changes.
Currently displays the following Kubernetes objects:
- Deployments
- ReplicaSets / StatefulSets / DaemonSets
- Pods
- Services
- Ingresses
- LoadBalancer IPs
- PersistentVolumeClaims
- Secrets
- ConfigMaps
### Status
[](https://github.com/benc-uk/kubeview/actions?query=workflow%3A%22Build+Dockerhub+Image%22)
[](https://github.com/benc-uk/kubeview/commits/master)
[](https://github.com/benc-uk/kubeview/releases)
Note. No secrets are exposed by the Kubeview API, values are redacted and replaced with `__VALUE REDACTED__` before being sent.
## Demo & Screenshots
#### Short video demo
[](https://www.youtube.com/watch?v=ukF6aLIUu58)
#### Screenshots
## Application Components
The app consists of two separate but connected elements, in the standard pattern of backend REST API and JS client frontend
- **Client SPA** - Vue.js single page app. All visualisation, mapping & object connection logic is done client side
- **API Server** - Scrapes Kubernetes API and presents it back out as a custom REST API. Also acts as HTTP serving host to the SPA. Written in Go
# Repo Details
This projects follows the 'Standard Go Project Layout' directory structure and naming conventions as described [here](https://github.com/golang-standards/project-layout)
- [/cmd/server](./cmd/server) - Source of the API server, written in Go. See the readme there for more details
- [/web/client](./web/client) - Source of the client app, written in Vue.js. See the readme in there for more details
- [/deployments/helm](./deployments/helm) - Helm chart for simplifying deployment. See the readme in there for more details
- [/build](./build) - Build artifacts such as the Dockerfile
# Docker Image
Builds of the Docker image are hosted publicly on GitHub Container Registry here: https://github.com/users/benc-uk/packages/container/package/kubeview
- The `latest` tag is likely to be unstable
- Versioned tags are build and pushed in sync with released versions of this repo, e.g. `docker pull ghcr.io/benc-uk/kubeview:0.1.17`
# Helm Chart
Helm chart called 'kubeview' is provided in the [charts](./charts) directory to help deploy and install KubeView into your cluster. The chart is also available in packaged form, [in the releases section](https://github.com/benc-uk/kubeview/releases)
Use the supplied sample `example-values.yaml` file (copy it to a new name, e.g. `myvalues.yaml`) to configure how to deploy KubeView. The main choice is if you want to expose the service via an ingress `ingress.enabled: true` or a load-balancer service `ingress.enabled: false`
When using an Ingress additionally configure the DNS hostname and TLS certs if you want to use HTTPS
### Cluster or Namespaced Deployment
the chart supports deployment in a single namespace, set `limitNamespace: true`. In this mode, KubeView will be limited to displaying only the namespace it is deployed into (via the helm `--namespace` flag), and the namespace picker will not be shown in the UI. The ServiceAccount/Role/Binding will be scoped to this namespace too, rather than cluster wide.
This is passed to the server via the `NAMESPACE_SCOPE` env variable
### Usage
Deploy with the standard Helm install command:
```
cd charts
helm install kubeview ./kubeview -f myvalues.yaml
```
# Project Meta
## Known Issues
- Filtering only applies to certain objects such as pods and controllers
- On Firefox, the namespace picker doesn't show a drop down list, you have to start typing a name for the list to appear. This is Firefox behavior not a bug
## Todo / Roadmap
- Support some CRDs
- Display Nodes
- Filtering improvements (no refresh)
- Settings with detail levels
## Change Log
[See releases](https://github.com/benc-uk/kubeview/releases)