README
¶
AIBrix Console
Management console for AIBrix. Consists of a React frontend and a Go gRPC/REST backend.
Design: https://www.figma.com/design/8GNiN53l892dYqaGUt4RJ0/aibrix-portal
Project Structure
apps/console/
├── web/ # React frontend (Vite + Tailwind + Radix UI)
│ └── src/
├── api/ # Backend service definitions
│ ├── proto/ # Protobuf service definitions
│ ├── gen/ # Generated gRPC/gateway code
│ ├── handler/ # Service handler implementations
│ ├── server/ # gRPC + HTTP gateway server
│ └── store/ # Data store (in-memory)
cmd/console/main.go # Backend entry point (in repo root)
Running the Frontend
cd apps/console/web
npm install
npm run dev
Opens at http://localhost:3000.
Running the Backend
Build from the repo root:
make build-console
Run:
./bin/console
Flags
| Flag | Default | Description |
|---|---|---|
--grpc-addr |
:50060 |
gRPC server bind address |
--http-addr |
:8090 |
HTTP REST gateway bind address |
--gateway-endpoint |
http://localhost:8888 |
AIBrix gateway for playground proxy |
The backend exposes both gRPC (:50060) and REST (:8090) APIs. The REST API is auto-generated from protobuf via grpc-gateway.
API Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/models |
List model catalog |
| GET | /api/v1/models/{id} |
Get model details |
| GET | /api/v1/deployments |
List deployments |
| GET | /api/v1/deployments/{id} |
Get deployment |
| POST | /api/v1/deployments |
Create deployment |
| DELETE | /api/v1/deployments/{id} |
Delete deployment |
| GET | /api/v1/jobs |
List batch jobs |
| GET | /api/v1/jobs/{id} |
Get job |
| POST | /api/v1/jobs |
Create batch job |
| GET | /api/v1/apikeys |
List API keys |
| POST | /api/v1/apikeys |
Create API key |
| DELETE | /api/v1/apikeys/{id} |
Delete API key |
| GET | /api/v1/secrets |
List secrets |
| POST | /api/v1/secrets |
Create secret |
| DELETE | /api/v1/secrets/{id} |
Delete secret |
| GET | /api/v1/quotas |
List quotas |
| POST | /api/v1/playground/chat/completions |
Playground chat (SSE proxy) |
Regenerating Protobuf Code
After modifying apps/console/api/proto/:
make generate-console-proto
Requires buf.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
gen/console/v1
Package consolev1 is a reverse proxy.
|
Package consolev1 is a reverse proxy. |
|
handler
JobHandler implements the Console BFF JobService:
|
JobHandler implements the Console BFF JobService: |
|
planner/api
Package plannerapi defines the Console-facing surface of the AIBrix planner: the Planner interface, the request/response shapes Enqueue / GetJob / ListJobs / GetQueueStats / GetProvisionResourceStats carry, and the typed errors Console handlers route on.
|
Package plannerapi defines the Console-facing surface of the AIBrix planner: the Planner interface, the request/response shapes Enqueue / GetJob / ListJobs / GetQueueStats / GetProvisionResourceStats carry, and the typed errors Console handlers route on. |
|
planner/client
Package client defines the planner -> Metadata Service adapter: the BatchClient interface, the request/response shapes its methods carry, and the AIBrixExtraBody fields that feed extra_body.aibrix.*.
|
Package client defines the planner -> Metadata Service adapter: the BatchClient interface, the request/response shapes its methods carry, and the AIBrixExtraBody fields that feed extra_body.aibrix.*. |
|
resource_manager/catalog
Package catalog provides instance type discovery, pricing information, and resource management.
|
Package catalog provides instance type discovery, pricing information, and resource management. |
|
resource_manager/provider/lambdacloud
Package lambdacloud is a self-contained client for the Lambda Cloud public API (https://docs.lambda.ai/public-cloud/cloud-api/).
|
Package lambdacloud is a self-contained client for the Lambda Cloud public API (https://docs.lambda.ai/public-cloud/cloud-api/). |
|
resource_manager/provider/runpod
Package runpod is a self-contained client for the RunPod REST API (https://rest.runpod.io/v1).
|
Package runpod is a self-contained client for the RunPod REST API (https://rest.runpod.io/v1). |
Click to show internal directories.
Click to hide internal directories.