Skip to content

ARCHITECTURE.md

Latest commit

 

History

History
44 lines (37 loc) · 1.67 KB

ARCHITECTURE.md

File metadata and controls

44 lines (37 loc) · 1.67 KB
Raw

Architecture

For provider lifecycle behavior, see docs/provider-runtime.md. It links to the upstream Pulumi engine and AWS Cloud Control API contracts and documents how AWS Native connects them.

Module Map

  • provider/pkg/: core provider runtime logic
  • provider/cmd/pulumi-resource-aws-native/: provider entrypoint and generated schema artifacts
  • provider/cmd/pulumi-gen-aws-native/: schema ingestion and generation logic
  • provider/cmd/cf2pulumi/: CloudFormation-to-Pulumi conversion CLI
  • provider/tools/ref-parser/: reference metadata generation helper
  • meta/: metadata inputs (ref-db.json, regions.json)
  • examples/: integration examples/tests
  • sdk/: generated SDK outputs for each language
  • aws-cloudformation-schema/, aws-cloudformation-user-guide/: upstream submodule inputs

Generation Flow

  • CloudFormation schemas/docs inputs
  • pulumi-gen-aws-native codegen
  • provider schema and metadata artifacts
  • language SDK generators
  • sdk/** outputs

Ownership Boundaries

  • Hand-written behavior should be implemented in provider/pkg/** and selected provider/cmd/**.
  • Generated SDKs in sdk/** must be regenerated, not manually edited.
  • CI workflow/toolchain files are generated from ci-mgmt inputs.

Common Change Patterns

Provider runtime bug fix:

  • Edit provider/pkg/**
  • Add/update tests in provider/pkg/**/*_test.go
  • Run make lint && make test_provider_fast

Schema/codegen behavior change:

  • Edit provider/cmd/pulumi-gen-aws-native/** and/or meta/**
  • Run make codegen && make generate_schema
  • If SDK surface changed, run make local_generate

CI config change:

  • Edit .ci-mgmt.yaml
  • Run make ci-mgmt