project rootWorkspace layout
The root joins generated services, contracts, local infrastructure and operations into one reproducible workspace.
When to use
Use this reference when generating, reviewing or operating a Service Architect project.
Behavior
- Each lowercased whitespace-free Service.name becomes a deployable service directory.
- Each Module.name becomes a module directory whose contents depend on references from public types, connectors and public functions.
- A module referenced by an HTTP connector receives OpenAPI contracts; a module referenced by a gRPC connector receives protobuf contracts.
- A module referenced by public types receives shared type and serde code.
- graph stores the generated project topology snapshot.
- scripts contains merge, Kubernetes, dependency-cache and Temporal orchestration.
- kubernetes contains project-level chart values and local cluster configuration.
- Each service owns its own graph snapshot, configuration, docs, dashboards and Helm chart.
Generated root directories
Common directories and files emitted for the canonical graph.
<normalize(Service.name)>/MixedIndependent service project with generated runtime wiring and preserved business functions.
<Module.name>/Generated + extensionUser-named module. It may contain shared types, public functions, OpenAPI schemas, protobuf schemas or any combination selected by graph references.
<Module.name>/openapi/Generated schema sourcePresent when an HTTP connector references this Module through DataConnector.module.
<Module.name>/proto/Generated schema sourcePresent when a gRPC connector references this Module through DataConnector.module.
graph/<normalize(Project.name)>.generated.yamlGeneratedFull project graph snapshot used for inspection and traceability.
scripts/*.generated.*GeneratedWorkspace automation for merge, Kubernetes, cache and Temporal.
kubernetes/GeneratedLocal k3s, registry and infrastructure values.
docker-compose.ymlOverwrite listCanonical local runtime topology.
docker-compose.*.generated.ymlGeneratedSpecialized runtime, build, integration or dependency-cache topology.
dependency-cache/GeneratedNexus and Git mirror configuration and documentation.
spec/PreservedBusiness tasks, implementation guidance and progress material.
.servicegen/Tool stateMerge logs and generated migration checklists.
Workspace tree template
<normalize(Project.name)>/
Makefile + make.generated.mk
graph/<normalize(Project.name)>.generated.yaml
docker-compose.yml
scripts/ + kubernetes/ + dependency-cache/
<normalize(Service A.name)>/
<normalize(Service B.name)>/
<Module A.name>/
<Module B.name>/