53 lines
1.9 KiB
Markdown
53 lines
1.9 KiB
Markdown
# lightscale-admin
|
||
|
||
A thin admin control plane for Lightscale. It stores operator metadata in CockroachDB and calls one or more Lightscale control plane APIs to manage networks, nodes, tokens, ACLs, key policies, and audit streams. The UI is a SPA (no SSR) and can be served by the backend or hosted separately.
|
||
|
||
## Layout
|
||
- `backend/`: Rust (Axum) API server, `/admin/api` namespace.
|
||
- `frontend/`: Vite React SPA.
|
||
|
||
## Quick start
|
||
1) Start CockroachDB (single node for local dev):
|
||
|
||
```bash
|
||
cd /home/centra/dev/lightscale-admin
|
||
|
||
docker compose up -d
|
||
```
|
||
|
||
2) Create a config:
|
||
|
||
```bash
|
||
cp config.example.toml config.toml
|
||
```
|
||
|
||
3) Build the UI (optional if you run the Vite dev server):
|
||
|
||
```bash
|
||
cd frontend
|
||
npm install
|
||
npm run build
|
||
```
|
||
|
||
4) Run the backend from the repo root:
|
||
|
||
```bash
|
||
cargo run -p lightscale-admin-server
|
||
```
|
||
|
||
The admin UI will be served from `server.static_dir` if configured. Otherwise, run the Vite dev server and set `server.allowed_origins` to `http://localhost:5173`.
|
||
|
||
## Configuration
|
||
Configuration loads from `config.toml` and `LS_ADMIN__` environment variables (nested keys separated by `__`). See `config.example.toml`.
|
||
|
||
Key settings:
|
||
- `server.base_url`: used for OIDC redirect URLs.
|
||
- `auth.bootstrap_admin_email` / `auth.bootstrap_admin_password`: creates the first admin if the database is empty.
|
||
- `server.allowed_origins`: set when the UI is hosted separately (CORS + cookies).
|
||
- `server.static_dir`: serve the SPA from this folder (usually `../frontend/dist`).
|
||
|
||
## Control planes
|
||
Create control planes in the UI and store their admin tokens. The admin API will call each control plane’s `/v1/*` endpoints to manage networks and nodes.
|
||
|
||
## Multi-region notes
|
||
CockroachDB allows multi-region deployments. For production, run a multi-node cluster and point `database.url` at the load-balanced SQL endpoint. The admin API itself is stateless and can be deployed across regions.
|