homelab/dozzle
1
0
Fork 0
mirror of https://github.com/amir20/dozzle.git synced 2026-06-23 04:10:12 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs: remove stale GraphQL references and fix paths

Browse Source 
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Amir Raminfar
2026-05-16 07:03:38 -07:00
parent 2a69d5fb80
commit 37a135804b
2 changed files with 5 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+4 -22
View File
@@ -126,8 +126,8 @@ The Go backend is organized into these key packages:
- **`internal/support/`** - Support utilities - **`internal/support/`** - Support utilities
- `cli/`: Command-line argument parsing and validation - `cli/`: Command-line argument parsing and validation
- `docker/`: Multi-host Docker management and Swarm support - `docker/`: Multi-host Docker management and Swarm support (`docker_service.go`, client managers)
- `container/`: Container service abstractions - `k8s/`: Kubernetes service abstractions
- `web/`: Web service utilities - `web/`: Web service utilities
- **`internal/auth/`** - Authentication providers - **`internal/auth/`** - Authentication providers
@@ -143,10 +143,6 @@ The Go backend is organized into these key packages:
- `log_listener.go`: Log pattern matching for alerts - `log_listener.go`: Log pattern matching for alerts
- `dispatcher/`: Notification channel implementations (email, webhook, etc.) - `dispatcher/`: Notification channel implementations (email, webhook, etc.)
- **`graph/`** - GraphQL API layer
- `schema.graphqls`: GraphQL schema definitions
- `*.resolvers.go`: GraphQL resolver implementations
- **`main.go`** - Application entry point with mode switching (server/swarm/k8s/agent) - **`main.go`** - Application entry point with mode switching (server/swarm/k8s/agent)
### Frontend (Vue 3) ### Frontend (Vue 3)
@@ -207,7 +203,6 @@ The frontend uses file-based routing with these conventions:
3. **Stats**: Real-time CPU/memory stats streamed via SSE alongside events 3. **Stats**: Real-time CPU/memory stats streamed via SSE alongside events
4. **Actions**: POST to `/api/hosts/{host}/containers/{id}/actions/{action}` (start/stop/restart) 4. **Actions**: POST to `/api/hosts/{host}/containers/{id}/actions/{action}` (start/stop/restart)
5. **Terminal**: WebSocket connections for container attach/exec at `/api/hosts/{host}/containers/{id}/attach` 5. **Terminal**: WebSocket connections for container attach/exec at `/api/hosts/{host}/containers/{id}/attach`
6. **GraphQL**: POST to `/api/graphql` for queries and mutations (container metadata, historical logs, notifications)
### Build System ### Build System
@@ -245,9 +240,6 @@ The frontend uses file-based routing with these conventions:
- Certificate generation is required (`make generate` creates shared_key.pem and shared_cert.pem) - Certificate generation is required (`make generate` creates shared_key.pem and shared_cert.pem)
- Protocol buffer generation happens via `go generate` directive in `main.go` - Protocol buffer generation happens via `go generate` directive in `main.go`
- Docker client uses API version negotiation for compatibility - Docker client uses API version negotiation for compatibility
- **GraphQL API**: Uses gqlgen with schema in `graph/schema.graphqls`, generated code in `graph/generated.go`
- Run `pnpm codegen` to regenerate GraphQL types
- Resolvers follow-schema layout in `graph/*.resolvers.go`
- **Service Layer Architecture**: - **Service Layer Architecture**:
- `ClientService` interface abstracts Docker/K8s/Agent backends - `ClientService` interface abstracts Docker/K8s/Agent backends
- `MultiHostService` orchestrates multi-host operations - `MultiHostService` orchestrates multi-host operations
@@ -315,7 +307,7 @@ Implementation (DockerClient, K8sClient, AgentClient)
1. Define method in `container.Client` interface (`internal/container/client.go`) 1. Define method in `container.Client` interface (`internal/container/client.go`)
2. Implement in `internal/docker/client.go` (and `internal/k8s/client.go` if applicable) 2. Implement in `internal/docker/client.go` (and `internal/k8s/client.go` if applicable)
3. Add wrapper method in `ClientService` interface (`internal/support/container/service.go`) 3. Add wrapper method in `ClientService` interface (`internal/support/docker/docker_service.go`)
4. Add HTTP handler in `internal/web/` with appropriate route 4. Add HTTP handler in `internal/web/` with appropriate route
### Frontend Data Flow ### Frontend Data Flow
@@ -395,14 +387,6 @@ Implementation (DockerClient, K8sClient, AgentClient)
4. Use `LogViewer.vue` component to render messages 4. Use `LogViewer.vue` component to render messages
5. Add backend API endpoint if needed (see above) 5. Add backend API endpoint if needed (see above)
### Adding a New GraphQL Query/Mutation
1. Define in `graph/schema.graphqls`
2. Run `pnpm codegen` to regenerate types
3. Implement resolver in `graph/schema.resolvers.go`
4. Use `hostService` from resolver context to access backend services
5. Frontend calls via urql client (auto-imported via `@urql/vue`)
### Adding Container Stats/Metrics ### Adding Container Stats/Metrics
1. Add field to `Stat` type in `internal/container/types.go` 1. Add field to `Stat` type in `internal/container/types.go`
@@ -424,7 +408,7 @@ Implementation (DockerClient, K8sClient, AgentClient)
**Frontend** (`assets/pages/notifications.vue`, `assets/components/Notification/`): **Frontend** (`assets/pages/notifications.vue`, `assets/components/Notification/`):
- `AlertForm.vue`, `DestinationForm.vue`: UI for creating rules - `AlertForm.vue`, `DestinationForm.vue`: UI for creating rules
- Rules stored via GraphQL mutations - Rules persisted to `./data/notifications.yml` via `internal/notification/persist.go`
- Alert state displayed in notification cards - Alert state displayed in notification cards
**Adding a new notification channel:** **Adding a new notification channel:**
@@ -432,7 +416,6 @@ Implementation (DockerClient, K8sClient, AgentClient)
1. Implement dispatcher interface in `internal/notification/dispatcher/` 1. Implement dispatcher interface in `internal/notification/dispatcher/`
2. Register in `manager.go` dispatcher factory 2. Register in `manager.go` dispatcher factory
3. Add UI form in `assets/components/Notification/DestinationForm.vue` 3. Add UI form in `assets/components/Notification/DestinationForm.vue`
4. Add GraphQL schema fields if needed
### Adding a New Cloud Tool ### Adding a New Cloud Tool
@@ -465,5 +448,4 @@ Implementation (DockerClient, K8sClient, AgentClient)
- Backend logs: Set `--level debug` flag or `DOZZLE_LEVEL=debug` env var - Backend logs: Set `--level debug` flag or `DOZZLE_LEVEL=debug` env var
- Frontend: Vue DevTools browser extension - Frontend: Vue DevTools browser extension
- GraphQL: Use GraphQL Playground at `/api/graphql` (when enabled)
- SSE streams: Browser DevTools Network tab shows EventSource connections - SSE streams: Browser DevTools Network tab shows EventSource connections
README.md
+1 -1
View File
@@ -172,7 +172,7 @@ On Windows, we recommend using [WSL2](https://learn.microsoft.com/en-us/windows/
git clone https://github.com/amir20/dozzle.git git clone https://github.com/amir20/dozzle.git
cd dozzle cd dozzle
pnpm install # installs frontend dependencies pnpm install # installs frontend dependencies
go install tool # installs Go build tools listed in go.mod (gqlgen, protoc-gen-go, etc.) go install tool # installs Go build tools listed in go.mod (air, protoc-gen-go, etc.)
make generate # generates TLS certificates and protobuf code (only needed once) make generate # generates TLS certificates and protobuf code (only needed once)
``` ```