Skip to content

Commit 636cbb3

Browse files
committed
docs: sync documentation with actual codebase state
- Update service count (96→101) and operation count (4,438→4,451) verified against default.yaml and provider.go sources - Fix Next.js version reference (15→16) to match web/package.json - Document DEVCLOUD_PORT environment variable (implemented but previously undocumented in config.go) - Add environment variable overview table to configuration.md - Update architecture.md directory structure to reflect actual service counts instead of partial enumeration - Fix pinpoint operation count (91→93)
1 parent 7671329 commit 636cbb3

7 files changed

Lines changed: 34 additions & 23 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ First public release of DevCloud — a local development companion for cloud-nat
5050
- Generated files (`internal/generated/**`) include SPDX license headers and are marked `DO NOT EDIT`.
5151

5252
**Web dashboard** (optional, gated on `dashboard.enabled`)
53-
- Next.js 15 / React 19 / Tailwind UI served statically by the Go server.
53+
- Next.js 16 / React 19 / Tailwind UI served statically by the Go server.
5454
- Service status, resource browser, WebSocket-based live API log stream.
5555

5656
**Docker packaging**

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,13 @@ Today DevCloud targets **AWS**. Our long-term goal is to support the full range
2323

2424
## Features
2525

26-
- **96 AWS services scaffolded** — 4,438 operations across all major categories (see [services-matrix.md](docs/services-matrix.md))
26+
- **101 AWS services scaffolded** — 4,451 operations across all major categories (see [services-matrix.md](docs/services-matrix.md))
2727
- **96% boto3 compatibility** — 671/699 SDK tests pass; works with most boto3 apps
2828
- **Cross-service integration** — CFN provisioning, DDB Streams → Lambda, EventBridge targets, S3 → Lambda
2929
- **Smithy-driven codegen** — auto-generate Go interfaces, types, and serializers from Smithy models
3030
- **Weekly auto-sync** — GitHub Actions keeps generated code up to date with upstream AWS API changes
3131
- **Single binary, zero-config** — one Docker image, one port (4747), no config file required (embedded defaults)
32+
- **Environment variable overrides**`DEVCLOUD_SERVICES`, `DEVCLOUD_DATA_DIR`, `DEVCLOUD_PORT` for quick configuration without YAML
3233
- **SDK/CLI compatible** — works with the AWS SDK, CLI, Terraform, CDK out of the box
3334
- **Web dashboard** — real-time monitoring and resource browser
3435

changes/v0.1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ First public release of DevCloud — a local development companion for cloud-nat
2929

3030
**Web dashboard** (optional, gated on `dashboard.enabled`)
3131

32-
- Next.js 15 / React 19 / Tailwind UI served statically by the Go server.
32+
- Next.js 16 / React 19 / Tailwind UI served statically by the Go server.
3333
- Service status, resource browser, WebSocket-based live API log stream.
3434

3535
**Docker packaging**

docs/architecture.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -158,19 +158,8 @@ devcloud/
158158
│ ├── plugin/ # ServicePlugin interface, Registry
159159
│ ├── codegen/ # Smithy parser, code generators, templates
160160
│ ├── config/ # YAML config loading, env overrides
161-
│ ├── generated/ # Auto-generated code (DO NOT EDIT)
162-
│ │ ├── s3/
163-
│ │ ├── sqs/
164-
│ │ ├── dynamodb/
165-
│ │ ├── lambda/
166-
│ │ ├── iam/
167-
│ │ └── sts/
168-
│ ├── services/ # Service implementations
169-
│ │ ├── s3/ # FileSystem + SQLite
170-
│ │ ├── sqs/ # In-memory queues
171-
│ │ ├── dynamodb/ # BadgerDB
172-
│ │ ├── lambda/ # SQLite + filesystem (stub runtime)
173-
│ │ └── iam/ # SQLite (IAM + STS)
161+
│ ├── generated/ # Auto-generated code (DO NOT EDIT, 93 services)
162+
│ ├── services/ # Service implementations (101 services)
174163
│ ├── dashboard/ # Dashboard REST API + WebSocket
175164
│ ├── eventbus/ # In-memory event pub/sub
176165
│ └── storage/ # Shared storage abstractions
@@ -186,11 +175,11 @@ devcloud/
186175

187176
## Startup Flow
188177

189-
1. Load config from `devcloud.yaml` (or specified path)
178+
1. Load config from `devcloud.yaml` (or specified path), applying environment variable overrides (`DEVCLOUD_PORT`, `DEVCLOUD_SERVICES`, `DEVCLOUD_DATA_DIR`)
190179
2. Initialize structured logger (slog)
191180
3. Create plugin registry
192-
4. Register service factories (S3, SQS, DynamoDB, IAM, Lambda)
193-
5. Initialize services in order: S3 → SQS → DynamoDB → IAM STS → Lambda
181+
4. Register service factories (101 services)
182+
5. Initialize services in dependency order (IAM before STS, etc.)
194183
6. IAM store is shared with STS via plugin config options
195184
7. Set up event bus, log collector, dashboard API
196185
8. Create gateway with middleware chain and service router

docs/configuration.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ To override defaults, provide a YAML file. DevCloud looks for config in this ord
88
2. `./devcloud.yaml` in the current working directory (auto-detected)
99
3. Embedded defaults (used when neither of the above is present)
1010

11-
Environment variables override YAML values for selected keys (see [Environment Variable Overrides](#environment-variable-overrides)).
11+
Environment variables override YAML values for selected keys (see [Environment Variable Overrides](#environment-variable-overrides)):
12+
13+
| Variable | Overrides | Description |
14+
|----------|-----------|-------------|
15+
| `DEVCLOUD_PORT` | `server.port` | HTTP server port |
16+
| `DEVCLOUD_SERVICES` | `services.*.enabled` | Comma-separated list of services to enable |
17+
| `DEVCLOUD_DATA_DIR` | `services.*.data_dir` | Base data directory for all services |
1218

1319
## Configuration File
1420

@@ -92,6 +98,18 @@ logging:
9298
9399
## Environment Variable Overrides
94100
101+
### `DEVCLOUD_PORT`
102+
103+
Overrides the HTTP server port. Takes precedence over both the YAML `server.port` value and the embedded default.
104+
105+
```bash
106+
# Run on port 8080 instead of 4747
107+
DEVCLOUD_PORT=8080 ./dist/devcloud
108+
109+
# With Docker (map the host port accordingly)
110+
docker run -p 8080:8080 -e DEVCLOUD_PORT=8080 ghcr.io/skyoo2003/devcloud:latest
111+
```
112+
95113
### `DEVCLOUD_SERVICES`
96114

97115
Comma-separated list of services to enable. All other services listed in the config file are disabled. Accepts individual service names and tier shortcuts.

docs/roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ We pursue this vision through a **phased rollout** to manage scope, architectura
1919
**Goal**: prove the core thesis on AWS before expanding surface area.
2020

2121
- [x] Core AWS services: S3, SQS, DynamoDB, Lambda, IAM, STS
22-
- [x] Smithy-based codegen pipeline (96 services, 4,438 operations scaffolded)
22+
- [x] Smithy-based codegen pipeline (101 services, 4,451 operations scaffolded)
2323
- [x] Cross-service integration (CFN, DDB Streams → Lambda, EventBridge, S3 → Lambda)
2424
- [x] boto3 compatibility suite (currently 671/699 passing)
2525
- [ ] Lift boto3 compatibility to ≥ 95%

docs/services-matrix.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DevCloud Services Matrix
22

3-
**Total**: 96 services, 4,438 operations, 96% boto3 compatibility
3+
**Total**: 101 services, 4,451 operations, 96% boto3 compatibility
44

55
_Last updated with each release. For unreleased changes, see [CHANGELOG.md](../CHANGELOG.md)._
66

@@ -21,7 +21,7 @@ DevCloud is a Go-based local cloud environment with AWS API compatibility. This
2121
|---|---------|-----|----------|
2222
| 1 | sesv2 | 155 | Business Apps |
2323
| 2 | appconfig | 97 | Management |
24-
| 3 | pinpoint | 91 | Business Apps |
24+
| 3 | pinpoint | 93 | Business Apps |
2525
| 4 | opensearch | 87 | Analytics |
2626
| 5 | iot | 82 | IoT |
2727
| 6 | backup | 82 | Storage |
@@ -97,6 +97,9 @@ for svc in $(ls internal/services/); do
9797
count=$(grep -c 'case "' internal/services/$svc/provider.go 2>/dev/null || echo 0)
9898
[ "$count" -gt "0" ] && echo "$count $svc"
9999
done | sort -rn
100+
101+
# Count total scaffolded services
102+
awk '/^services:/,/^auth:/' internal/config/default.yaml | grep -cE '^\s+[a-z][a-z0-9_]*:$'
100103
```
101104

102105
See [Getting Started](getting-started.md) for installation and [contributing.md](contributing.md) for development setup.

0 commit comments

Comments
 (0)