The Reports Dashboard is a web-based tool for tracking and analyzing sliver allocations across projects and users. It provides insights into resource usage with time-based, user-based, and project-based filtering.
The system consists of multiple services, including a PostgreSQL database, an API layer, a Dash-based visualization app, and Nginx for reverse proxying.
- Filter slivers by component type (SharedNIC, SmartNIC, FPGA, GPU, NVMe, Storage).
- Time-based filtering to analyze sliver allocations over specific periods.
- Identify the project or user with the most allocated slivers.
- Secure authentication with Vouch Proxy integration.
- Scalable microservices architecture using Docker.
The system is composed of the following Docker containers:
- reports-db: PostgreSQL database storing sliver data.
- reports-nginx: Nginx reverse proxy handling HTTPS traffic.
- reports-api: Backend API serving sliver-related data.
- dash-app: Dash-based web application for visualization.
- vouch-proxy: Authentication proxy for securing API requests.
- frontend network: Exposes services to the external world (e.g., Nginx, Dash app).
- backend network: Internal network for database and API communication.
- Docker & Docker Compose installed on your system.
- SSL certificates for secure API communication (optional).
git clone https://github.com/yourusername/reports.git
cd reports
Create a .env file to specify database and service settings:
POSTGRES_HOST=database
POSTGRES_DB=analytics
POSTGRES_USER=fabric
POSTGRES_PASSWORD=fabric
PGDATA=/var/lib/postgresql/data
API_URL=http://reports-api:8080
docker-compose up --build -d
--build ensures any changes in the application are incorporated.
-d runs services in detached mode.
Accessing the Dashboard Once the containers are running, open your browser and navigate to: https://reports.fabric-testbed.net:8443/
Ensure you have the proper SSL certificates configured in the ./ssl/ directory.
The backend API provides endpoints for fetching sliver-related data: https://reports.fabric-testbed.net:8443/reports/ui/
- Vouch Proxy ensures API requests are authenticated.
- HTTPS is enforced using Nginx with SSL certificates.
- Check Logs
- To view logs for a specific container, use:
docker logs -f reports-api
- Restart a Service If a service fails, restart it with:
docker-compose restart dash-app
- Remove & Rebuild Everything
docker-compose down -v
docker-compose up --build -d
- Role-based access control (RBAC) for API endpoints.
- Advanced filtering (e.g., resource utilization trends, forecasting).
Feel free to fork this repository and submit pull requests.
This project is licensed under the MIT License.