Skip to content

Commit 68436c4

Browse files
author
DeanLuus22021994
committed
docs: update documentation for new Dapr component directory structure
Updated References: - .devcontainer/README.md: Updated component table with file paths - .devcontainer/dapr-components/README.md: Added directory structure diagram Changes: - Added directory tree showing component organization - Updated file paths to reflect subdirectory structure - Added note about Dapr automatic subdirectory discovery - Clarified customization process (add files to appropriate subdirectory) All references now point to new locations: - statestore/default.yaml (was statestore.yaml) - statestore/redis.yaml (was statestore-redis.yaml) - statestore/postgres.yaml (was statestore-postgres.yaml) - pubsub/redis.yaml (was pubsub-redis.yaml) - secretstore/env.yaml (was secretstore-env.yaml) - bindings/http.yaml (was bindings-http.yaml) - configuration/default.yaml (was configuration.yaml)
1 parent 8bf783e commit 68436c4

File tree

2 files changed

+42
-18
lines changed

2 files changed

+42
-18
lines changed

.devcontainer/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,17 +163,17 @@ Invoke-RestMethod -Uri "http://localhost:3500/v1.0/state/statestore/test"
163163

164164
## Dapr Components
165165

166-
Dapr components are located in `.devcontainer/dapr-components/`:
167-
168-
| Component | Type | Backend |
169-
|-----------|------|---------|
170-
| `statestore` | State Store | PostgreSQL |
171-
| `statestore-redis` | State Store | Redis |
172-
| `statestore-postgres` | State Store | PostgreSQL |
173-
| `pubsub-redis` | Pub/Sub | Redis |
174-
| `secretstore-env` | Secret Store | Environment Variables |
175-
| `bindings-http` | Binding | HTTP |
176-
| `configuration` | Configuration | None |
166+
Dapr components are organized by type in `.devcontainer/dapr-components/`:
167+
168+
| Component | Type | Backend | File Path |
169+
|-----------|------|---------|-----------|
170+
| `statestore` | State Store | Redis (default) | `statestore/default.yaml` |
171+
| `statestore-redis` | State Store | Redis | `statestore/redis.yaml` |
172+
| `statestore-postgres` | State Store | PostgreSQL | `statestore/postgres.yaml` |
173+
| `pubsub-redis` | Pub/Sub | Redis | `pubsub/redis.yaml` |
174+
| `secretstore-env` | Secret Store | Environment Variables | `secretstore/env.yaml` |
175+
| `http-binding` | Binding | HTTP | `bindings/http.yaml` |
176+
| `configuration` | Configuration | Tracing/Metrics | `configuration/default.yaml` |
177177

178178
### Testing Dapr Components
179179

.devcontainer/dapr-components/README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,38 @@
22

33
Dapr component configurations for OpenAI Agents SDK development environment.
44

5+
## Directory Structure
6+
7+
Components are organized by type in subdirectories:
8+
9+
```text
10+
dapr-components/
11+
├── bindings/
12+
│ └── http.yaml # HTTP output binding
13+
├── configuration/
14+
│ └── default.yaml # Tracing and metrics config
15+
├── pubsub/
16+
│ └── redis.yaml # Event-driven messaging
17+
├── secretstore/
18+
│ └── env.yaml # Environment variable secrets
19+
├── statestore/
20+
│ ├── default.yaml # Default Redis state store
21+
│ ├── redis.yaml # Redis state store (named)
22+
│ └── postgres.yaml # PostgreSQL state store
23+
└── README.md
24+
```
25+
526
## Components
627

728
| Component | File | Purpose |
829
|-----------|------|---------|
9-
| Redis State Store | `statestore.yaml`, `statestore-redis.yaml` | Default state storage |
10-
| PostgreSQL State Store | `statestore-postgres.yaml` | Alternative state storage |
11-
| Redis Pub/Sub | `pubsub-redis.yaml` | Event-driven messaging |
12-
| HTTP Binding | `bindings-http.yaml` | HTTP output binding |
13-
| Environment Secrets | `secretstore-env.yaml` | Environment variable secrets |
14-
| Dapr Configuration | `configuration.yaml` | Tracing and metrics config |
30+
| Redis State Store (default) | `statestore/default.yaml` | Default state storage |
31+
| Redis State Store (named) | `statestore/redis.yaml` | Named Redis state storage |
32+
| PostgreSQL State Store | `statestore/postgres.yaml` | Alternative state storage |
33+
| Redis Pub/Sub | `pubsub/redis.yaml` | Event-driven messaging |
34+
| HTTP Binding | `bindings/http.yaml` | HTTP output binding |
35+
| Environment Secrets | `secretstore/env.yaml` | Environment variable secrets |
36+
| Dapr Configuration | `configuration/default.yaml` | Tracing and metrics config |
1537

1638
## Environment Variables
1739

@@ -54,11 +76,13 @@ python examples/memory/dapr_session_example.py
5476

5577
## Customization
5678

57-
1. Create YAML file in this directory
79+
1. Create YAML file in appropriate subdirectory (e.g., `statestore/mongodb.yaml` for a new state store)
5880
2. Follow Dapr component schema: `apiVersion`, `kind`, `metadata`, `spec`
5981
3. Use environment variable substitution for sensitive data
6082
4. Restart Dapr sidecar: `docker compose restart dapr-sidecar`
6183

84+
**Note**: Dapr automatically discovers components in subdirectories. No configuration changes needed in `docker-compose.yml`.
85+
6286
## References
6387

6488
- [State Stores](https://docs.dapr.io/reference/components-reference/supported-state-stores/)

0 commit comments

Comments
 (0)