Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cilium/hubble-ui
Observability & Troubleshooting for Kubernetes Services
https://github.com/cilium/hubble-ui
cilium ebpf graphical kubernetes observability reactjs security troubleshooting ui
Last synced: 3 days ago
JSON representation
Observability & Troubleshooting for Kubernetes Services
- Host: GitHub
- URL: https://github.com/cilium/hubble-ui
- Owner: cilium
- License: apache-2.0
- Created: 2020-01-27T17:29:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-31T03:54:41.000Z (4 months ago)
- Last Synced: 2024-12-12T12:05:07.882Z (10 days ago)
- Topics: cilium, ebpf, graphical, kubernetes, observability, reactjs, security, troubleshooting, ui
- Language: TypeScript
- Homepage: https://www.cilium.io
- Size: 46.9 MB
- Stars: 403
- Watchers: 15
- Forks: 64
- Open Issues: 64
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
Hubble UI
Hubble UI is an open-source user interface for Cilium Hubble.
## 🚀 Installation
Hubble UI is installed as part of Hubble. Please see the Hubble [Getting Started Guide](https://docs.cilium.io/en/stable/gettingstarted/hubble/#deploy-cilium-and-hubble) for instructions.
## 🌐 Why Hubble UI?
Troubleshooting microservices application connectivity is a challenging task. Simply looking at `kubectl get pods` does not indicate dependencies between each service, external APIs, or databases.
Hubble UI enables zero-effort automatic discovery of the service dependency graph for Kubernetes Clusters at L3/L4 and even L7, allowing user-friendly visualization and filtering of those dataflows as a Service Map.
See [Hubble Getting Started Guide](https://docs.cilium.io/en/stable/gettingstarted/hubble/#deploy-cilium-and-hubble) for details.
## 🛠 Development
### Backend
If you want to point the frontend to a backend deployed in Minikube, simply create a port forward.
```shell
kubectl port-forward -n kube-system deployment/hubble-ui 8081
```
To make changes to the Go backend, there are additional steps.
1. Go to the 📁 `backend` directory and execute `./ctl.sh`.
```shell
cd ./backend
./ctl.sh run
```
Wait until the build and server are running.
2. In a separate terminal, enter the 📁 `server` directory containing the Envoy config.
```shell
cd ./server
```
Assuming Envoy has already been installed, execute:
```shell
envoy -c ./envoy.yaml
```
3. In a separate terminal, run a port forward to Hubble Relay.
```shell
kubectl port-forward -n kube-system deployment/hubble-relay 50051:4245
```
#### Docker 🐳
Build the backend Docker image:
```shell
make hubble-ui-backend
```
### Frontend
1. Install dependencies.
```shell
npm install
```
2. Start the development server.
```shell
npm run watch
```
3. Open [http://localhost:8080](http://localhost:8080)
#### Docker 🐳
Build the frontend Docker image:
```shell
make hubble-ui
```
## 🐝 Community
Learn more about the [Cilium community](https://github.com/cilium/cilium#community).
## 🌏 Releases
Push a tag into GitHub and ping a maintainer to accept the [GitHub action run](https://github.com/cilium/hubble-ui/actions) which pushes the built images into the official repositories.
## ⚖️ License
[Apache License, Version 2.0](https://github.com/cilium/hubble-ui/blob/master/LICENSE)