Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Today DevCloud targets **AWS**. Our long-term goal is to support the full range

## Features

- **101 AWS services scaffolded** — 4,451 operations across all major categories (run `make stats` to verify; see [services-matrix.md](docs/services-matrix.md))
- **96% boto3 compatibility** — 671/699 SDK tests pass; works with most boto3 apps
- **101 AWS services scaffolded** — 4,400+ operations across all major categories (run `make stats` for current counts; see [services-matrix.md](docs/services-matrix.md))
- **~96% boto3 compatibility** — run `make test-compat` for the current pass rate; works with most boto3 apps
- **Cross-service integration** — CFN provisioning, DDB Streams → Lambda, EventBridge targets, S3 → Lambda
- **Smithy-driven codegen** — auto-generate Go interfaces, types, and serializers from Smithy models
- **Weekly auto-sync** — GitHub Actions keeps generated code up to date with upstream AWS API changes
Expand Down Expand Up @@ -60,7 +60,7 @@ Start at the [docs index](docs/) for the full map. Quick links:
- [Getting Started](docs/getting-started.md) — Installation, first use, boto3 / AWS CLI / Terraform examples
- [Configuration](docs/configuration.md) — Config options, env-var overrides, tier shortcuts
- [Architecture](docs/architecture.md) — System design, codegen pipeline, plugin model, multi-CSP vision
- [Services Matrix](docs/services-matrix.md) — 96 services, coverage status, boto3 pass rate
- [Services Matrix](docs/services-matrix.md) — 101 services, coverage status, boto3 pass rate
- [Roadmap](docs/roadmap.md) — Phased plan toward multi-CSP support
- [FAQ](docs/faq.md) / [Troubleshooting](docs/troubleshooting.md) — Common questions and errors
- [Contributing](docs/contributing.md) — Development setup, adding new services
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This directory holds DevCloud's technical documentation. Use the map below to ju
- **[Configuration](configuration.md)** — YAML options, env-var overrides, tier shortcuts
- **[Architecture](architecture.md)** — system design, plugin model, codegen pipeline, multi-CSP vision
- **[Roadmap](roadmap.md)** — phased plan toward multi-CSP support
- **[Services Matrix](services-matrix.md)** — 96 services, coverage status, boto3 pass rate
- **[Services Matrix](services-matrix.md)** — 101 services, coverage status, boto3 pass rate

## Per-service references

Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration

**Configuration is optional.** DevCloud ships with built-in defaults: running `devcloud` with no flags enables all 96 services on port 4747, storing data under `./data/<service>/`. The embedded defaults are compiled into the binary from [`internal/config/default.yaml`](https://github.com/skyoo2003/devcloud/blob/main/internal/config/default.yaml).
**Configuration is optional.** DevCloud ships with built-in defaults: running `devcloud` with no flags enables all 101 services on port 4747, storing data under `./data/<service>/`. The embedded defaults are compiled into the binary from [`internal/config/default.yaml`](https://github.com/skyoo2003/devcloud/blob/main/internal/config/default.yaml).

To override defaults, provide a YAML file. DevCloud looks for config in this order:

Expand Down
6 changes: 3 additions & 3 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ No. DevCloud is a local development tool. It is **not** designed or tested for p
DevCloud positions itself as an **on-ramp** rather than a replacement. Key differentiators:

- **Go-based single binary** — starts in under a second, no JVM or Python runtime.
- **Smithy-driven codegen** — 96 AWS services scaffolded from official models, weekly auto-sync.
- **Smithy-driven codegen** — 101 AWS services scaffolded from official models, weekly auto-sync.
- **Multi-CSP vision** — AWS today, Azure and GCP planned; see [roadmap.md](roadmap.md).
- **Apache 2.0 licensed** with explicit patent grant.

Expand All @@ -29,7 +29,7 @@ Developers should be able to iterate locally without cloud bills and deploy to t

### Which services are supported?

96 AWS services are scaffolded and routed; coverage depth varies. See [services-matrix.md](services-matrix.md) for the canonical list and per-service operation counts. Core services (S3, SQS, DynamoDB, Lambda, IAM, STS, SNS, CloudWatch, KMS, SecretsManager, EventBridge, CloudFormation) pass 100% of their boto3 compatibility tests.
101 AWS services are scaffolded and routed; coverage depth varies. See [services-matrix.md](services-matrix.md) for the canonical list and per-service operation counts. Core services (S3, SQS, DynamoDB, Lambda, IAM, STS, SNS, CloudWatch, KMS, Secrets Manager, EventBridge, CloudFormation) pass 100% of their boto3 compatibility tests.

### Does DevCloud work on Windows?

Expand All @@ -49,7 +49,7 @@ See [configuration.md](configuration.md) for data directory options.

### Will my existing boto3 code work?

96% of boto3's official SDK test suite passes against DevCloud. Most apps that use the Big 6 (S3, SQS, DynamoDB, Lambda, IAM, STS) and common integration services (SNS, CloudWatch, KMS, SecretsManager, EventBridge, CloudFormation) will work with only an `endpoint_url` change.
~96% of boto3's official SDK test suite passes against DevCloud (run `make test-compat` for the current rate). Most apps that use the Big 6 (S3, SQS, DynamoDB, Lambda, IAM, STS) and common integration services (SNS, CloudWatch, KMS, Secrets Manager, EventBridge, CloudFormation) will work with only an `endpoint_url` change.

### What about Terraform / CDK?

Expand Down
22 changes: 12 additions & 10 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ We pursue this vision through a **phased rollout** to manage scope, architectura

## Phases

### Phase 1 — AWS Depth (Current, targeting v1.0)
### Phase 1 — AWS Depth & Stabilization (Current, targeting v1.0)

**Goal**: prove the core thesis on AWS before expanding surface area.
**Goal**: mature the already-broad AWS surface into a stable, well-tested v1.0.

- [x] Core AWS services: S3, SQS, DynamoDB, Lambda, IAM, STS
- [x] Smithy-based codegen pipeline (run `make stats` for current counts)
- [x] Cross-service integration (CFN, DDB Streams → Lambda, EventBridge, S3 → Lambda)
- [x] boto3 compatibility suite (currently 671/699 passing)
- [ ] Lift boto3 compatibility to ≥ 95%
- [ ] Deepen coverage on existing 6 implemented services (fewer `NotImplementedError` returns)
- [ ] v1.0 release with stable plugin API
- [x] 100+ AWS services scaffolded from official Smithy models via in-tree codegen (run `make stats` for current counts)
- [x] Deep hand-written coverage on core, integration, and major extended services (see [services-matrix.md](services-matrix.md) for per-tier depth)
- [x] Cross-service integration (CloudFormation, DynamoDB Streams → Lambda, SQS → Lambda, S3 → Lambda, EventBridge, SNS → SQS)
- [x] boto3 compatibility suite (`make test-compat`); core services — S3, SQS, DynamoDB, Lambda, IAM, STS, SNS, CloudWatch, KMS, Secrets Manager, EventBridge, CloudFormation — pass 100%
- [x] boto3 compatibility ≥ 95% overall (run `make test-compat` for the current rate)
- [ ] Reduce remaining `NotImplementedError` stubs (less-common operations and scaffolded "Category Expansion" services)
- [ ] Close remaining boto3 compatibility edge cases in newly-added services
- [ ] Finalize and document a stable `ServicePlugin` API (`internal/plugin/`)
- [ ] v1.0 release

### Phase 2 — Architectural Preparation (v1.x)

Expand Down Expand Up @@ -72,7 +74,7 @@ We pursue this vision through a **phased rollout** to manage scope, architectura

| Version | Focus |
|---------|-------|
| 0.x | AWS services, unstable API |
| 0.x ← current | AWS services, unstable API |
| 1.x | AWS depth, stable plugin API |
| 2.x | Multi-CSP architecture, Azure pilot |
| 3.x+ | Broad CSP coverage, community-owned providers |
10 changes: 5 additions & 5 deletions docs/services-matrix.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# DevCloud Services Matrix

**Total**: 101 services, 4,451 operations, 96% boto3 compatibility
**Total**: 101 services, 4,460 operations, ~96% boto3 compatibility

> To refresh these numbers, run `make stats` and update the line above.
> To refresh these numbers, run `make stats` (services/operations) and `make test-compat` (compatibility), then update the line above.

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

Expand Down Expand Up @@ -62,13 +62,13 @@ DevCloud is a Go-based local cloud environment with AWS API compatibility. This
## boto3 compatibility

- Tests: `tests/compatibility/`
- Pass rate: **671/699 (96%)**
- Pass rate: **~96%** (run `make test-compat` for the current count)
- Run: `make test-compat`

Remaining 28 failures are concentrated in edge cases of newly-added services
Remaining failures are concentrated in edge cases of newly-added services
(ARN path parsing in S3Tables, restJson1 jsonName in ServerlessRepo, specialized
Textract/Support endpoints). Core services (S3, SQS, DynamoDB, Lambda, IAM, STS,
SNS, CloudWatch, KMS, SecretsManager, EventBridge, CloudFormation) all pass
SNS, CloudWatch, KMS, Secrets Manager, EventBridge, CloudFormation) all pass
100% of their tests.

## Supported protocols
Expand Down