search

openrca / orca-ui

Web UI for OpenRCA
https://openrca.io
Apache License 2.0
33 stars 4 forks source link
analytics cloud kubernetes rca root-cause-analysis

readme

OpenRCA UI

CII Best Practices Build Status License Gitter

This repository contains the source code for the OpenRCA web interface.

Cluster View Cluster Filtering Alerts View
Graph View Graph Filtering Alerts View

Usage

Build and run in Docker

Build Docker image:

docker build -t openrca/orca-ui .

Run Docker container (specify correct IP and port of API container):

docker run -it \
    --name orca-ui \
    -e "BACKEND_URL=http://172.17.0.2:5000" \
    -p 80:8080 \
    openrca/orca-ui

To specify listen port LISTEN_PORT environment variable can be used:

docker run -it \
    --name orca-ui \
    --network=host \
    -e "LISTEN_PORT=8555" \
    -e "BACKEND_URL=http://127.0.0.1:5000" \
    openrca/orca-ui

Build and run locally

Install dependencies:

yarn

Build:

yarn build

Run:

yarn start

Development

Navigate to utils directory. Build and start containers by executing command below (requres docker-compose):

docker-compose up

Orca UI is now available at http://localhost.

The code can be modified locally as it is bound to running container. It will be recompiled on the fly. Hot reload feature is also enabled, so any changes should be visible without reloading the webpage.

Contact

Reach project contributors via these channels: