How veegres/ivory works
Ivory is a self-hosted web console for deploying and operating high-availability database clusters. The principal workflow is to register, discover, or deploy a cluster, then monitor its health and perform node, keeper, and database operations. The UI uses feature API clients to reach a Go server, which exposes domain services and database, keeper, and platform plugins. The README documents the product capabilities; some server-side connections are shown only as unverified because the relevant implementation was not excerpted.
Main entry points: Body.tsx Page routing · Keeper.tsx Node operations · QueryRouter.ts Query API client · query_service.go Query services
Components 22
Web application
- Application shell
app/core/App.tsx - Page routing
app/shared/component/layout/Body.tsx - Access and setup
app/core/pages/config/ConfigBody.tsx
Cluster operations
- Cluster console
app/core/pages/cluster/ClusterBody.tsx - Cluster API
app/features/cluster/api/ClusterRouter.ts - Cluster deployment
app/features/cluster/component/ClusterDeploy.tsx - Health and HA
app/core/pages/cluster/overview/Overview.tsx - Node operations
app/features/node/component/keeper/Keeper.tsx
Database work
- Query console
app/features/query/component/Query.tsx - Query API client
app/features/query/api/QueryRouter.ts - Table compaction
app/tools/pg_compacttable/component/PgCompactTable.tsx
Server services
- Query endpoints
server/features/query/query_router.go - Query services
server/features/query/query_service.go - Saved queries and logs
server/features/query/query_repository.go - Compaction jobs
server/tools/pg_compacttable/pg_compacttable_service.go - Authentication
server/features/auth/auth_service.go - Management features
server/features/management/management_service.go - Persistent storage
server/clients/storage/storage_db.go
Runtime integrations
- Host platform
server/plugins/platform/platform_plugin.go - Keeper adapters
server/plugins/keeper/keeper_adapter.go - Database adapters
server/plugins/database/database_adapter.go
Other components
- Operator
Connections 24
- Operator → Application shell: uses
- Application shell → Page routing: renders
app/core/App.tsx - Page routing → Cluster console: renders
app/shared/component/layout/Body.tsx - Page routing → Access and setup: routes
app/shared/component/layout/Body.tsx - Operator → Cluster console: manages clusters
- Cluster console → Cluster API: requests cluster actions · Inferred; not shown in the code that was read.
- Operator → Cluster deployment: deploys cluster
- Cluster deployment → Cluster API: submits deployment · Inferred; not shown in the code that was read.
- Operator → Health and HA: monitors and operates
- Operator → Node operations: operates nodes
- Node operations → Host platform: controls host · Inferred; not shown in the code that was read.
- Node operations → Keeper adapters: runs keeper actions · Inferred; not shown in the code that was read.
- Operator → Query console: runs queries
- Query console → Query API client: loads charts
- Query API client → Query endpoints: calls API · Inferred; not shown in the code that was read.
app/features/query/api/QueryRouter.ts - Query API client → Query endpoints: sends query requests · Inferred; not shown in the code that was read.
- Query endpoints → Query services: dispatches · Inferred; not shown in the code that was read.
- Query services → Database adapters: executes database work · Inferred; not shown in the code that was read.
- Query services → Saved queries and logs: reads and writes · Inferred; not shown in the code that was read.
- Operator → Table compaction: runs maintenance
- Table compaction → Compaction jobs: starts jobs · Inferred; not shown in the code that was read.
- Operator → Access and setup: configures access
- Access and setup → Authentication: authenticates · Inferred; not shown in the code that was read.
- Management features → Persistent storage: persists application data · Inferred; not shown in the code that was read.