-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Minor formatting changes. Signed-off-by: Stacy Kim <[email protected]>
- Loading branch information
Showing
1 changed file
with
75 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,101 @@ | ||
| # Hubble UI | ||
| <h1 align="center">Hubble UI</h1> | ||
| <p align="center"> | ||
| Hubble UI is an open-source user interface for <a href="https://github.com/cilium/hubble">Cilium Hubble</a>. | ||
| </p> | ||
|
|
||
| Hubble UI is open source user interface for [Cilium Hubble](https://github.com/cilium/hubble). | ||
| ## 🚀 Installation | ||
|
|
||
| ## 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. | ||
|
|
||
| Hubble UI is installed as part of hubble, please see [Hubble Getting Started Guide](https://docs.cilium.io/en/stable/gettingstarted/hubble/#deploy-cilium-and-hubble) for details. | ||
| ## 🌐 Why Hubble UI? | ||
|
|
||
| ## Why Hubble UI? | ||
|
|
||
| Troubleshooting microservices application connectivity is a challenging task. Simply looking at "kubectl get pods" does not indicate dependencies between each service or external APIs or databases. | ||
| 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 | ||
| ## 🛠 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. | ||
|
|
||
| #### Backend | ||
| ```shell | ||
| cd ./server | ||
| ``` | ||
|
|
||
| If you want to point frontend to backend deployed into minikube, then just do next port forward: `kubectl port-forward -n kube-system deployment/hubble-ui 8081`. | ||
| Assuming Envoy has already been installed, execute: | ||
|
|
||
| Otherwise, if you want to change something in Go backend there are additional steps: | ||
| ```shell | ||
| envoy -c ./envoy.yaml | ||
| ``` | ||
|
|
||
| 1. Go to backend directory `cd ./backend`, execute `./ctl.sh run`, wait build and server running | ||
| 2. In another terminal go to server directory with envoy config `cd ./server` and execute `envoy -c ./envoy.yaml` (envoy must be installed) | ||
| 3. In another terminal do port forward to hubble-relay `kubectl port-forward -n kube-system deployment/hubble-relay 50051:4245` | ||
| 3. In a separate terminal, run a port forward to Hubble Relay. | ||
|
|
||
| To build the docker image run: | ||
| 1. `make hubble-ui-backend` | ||
| ```shell | ||
| kubectl port-forward -n kube-system deployment/hubble-relay 50051:4245 | ||
| ``` | ||
|
|
||
| #### Frontend | ||
| #### 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 | ||
| ``` | ||
|
|
||
| 1. Install deps `npm install` | ||
| 2. Start development server `npm run watch` | ||
| 3. Open [http://localhost:8080](http://localhost:8080) | ||
|
|
||
| To build the docker image run: | ||
| 1. `make hubble-ui` | ||
| #### Docker 🐳 | ||
|
|
||
| Build the frontend Docker image: | ||
|
|
||
| ```shell | ||
| make hubble-ui | ||
| ``` | ||
|
|
||
| ## Community | ||
| ## 🐝 Community | ||
|
|
||
| Learn more about [Cilium Community](https://github.com/cilium/cilium#community) | ||
| Learn more about the [Cilium community](https://github.com/cilium/cilium#community). | ||
|
|
||
| ## Perform a release | ||
| ## 🌏 Releases | ||
|
|
||
| Push a tag into GitHub and ping a maintainer of the project to [accept the | ||
| GitHub action run](https://github.com/cilium/hubble-ui/actions) which will | ||
| push the images built into the official repositories. | ||
| 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 | ||
| ## ⚖️ License | ||
|
|
||
| Hubble UI is [Apache License, Version 2.0](https://github.com/cilium/hubble-ui/blob/master/LICENSE) | ||
| [Apache License, Version 2.0](https://github.com/cilium/hubble-ui/blob/master/LICENSE) |