LMCache Frontend is a monitoring and proxy service for LMCache clusters, providing a web interface for cluster management and HTTP request proxying to cluster nodes.

• Cluster Monitoring: Web-based dashboard for visualizing cluster status
• Request Proxying: HTTP proxy service to forward requests to any cluster node
• Flexible Configuration: Support for both IP:port and Unix domain sockets
• Plugin System: Integration with LMCache plugin framework

1. Clone the repository:

git clone https://github.com/your-org/lmcache_frontend.git cd lmcache_frontend

2. Install dependencies:

pip install -e .

lmcache-frontend --port 8080 --host 0.0.0.0

--port Service port (default: 8000) --host Bind host address (default: 0.0.0.0) --config Path to configuration file --nodes Direct node configuration (JSON string) 

After starting the service, access the dashboard at: http://localhost:8080/

Proxy requests using the format:

/proxy/{target_host}/{target_port_or_socket}/{path} 

Example:

curl "http://localhost:8080/proxy/localhost/%252Ftmp%252Flmcache_internal_api_server%252Fsocket_8081/metrics" curl -X POST http://localhost:9090/proxy/localhost/8081/run_script -F "script=@/root/scratch.py" 

Configure the following configs to lmcache.yaml

extra_config: plugin.frontend.port: 8080 internal_api_server_enabled: True internal_api_server_port_start: 9090 plugin_locs: ["/scripts/scheduler_lmc_frontend_plugin.py"] internal_api_server_socket_path_prefix: "/tmp/lmcache_internal_api_server/socket"

Create a config.json file with node definitions:

[ { "name": "node1", "host": "127.0.0.1", "port": "/tmp/lmcache_internal_api_server/socket/9090" }, { "name": "node2", "host": "127.0.0.1", "port": "/tmp/lmcache_internal_api_server/socket/9091" } ]

port can be both configured to int type port and string type socket path.

This project uses pre-commit hooks for code quality:

pre-commit install pre-commit run --all-files

lmcache_frontend/ ├── app.py # Main application ├── lmcache_plugin/ │ └── scheduler_lmc_frontend_plugin.py # Plugin integration ├── static/ # Web assets └── __init__.py 

python setup.py sdist bdist_wheel

Apache License 2.0