Documentation
¶
Overview ¶
Package overcast exposes embedded web assets for use by the overcast binary. This file lives at the module root so it can reach both web/dist and docs via straight descendant paths (//go:embed cannot use ../ to climb the tree).
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DocsServicesFS embed.FS
DocsServicesFS contains published docs served by the BFF docs endpoints. Developer-only planning notes under docs/plans and contributor-only docs under docs/dev are intentionally excluded.
View Source
var WebDistFS embed.FS
WebDistFS contains the pre-built SPA static files (web/dist/). Build the web UI before compiling: cd web && pnpm run build
Functions ¶
This section is empty.
Types ¶
This section is empty.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
awsmodelgen
command
Command awsmodelgen converts pinned AWS Smithy JSON AST models into compact static operation metadata.
|
Command awsmodelgen converts pinned AWS Smithy JSON AST models into compact static operation metadata. |
|
compat
command
cmd/compat/embed.go — wires the embedded compat UI into the binary.
|
cmd/compat/embed.go — wires the embedded compat UI into the binary. |
|
overcast
command
Command overcast is the unified CLI for the Overcast AWS emulator.
|
Command overcast is the unified CLI for the Overcast AWS emulator. |
|
overcast-mcp
command
|
|
|
stub-report
command
Command stub-report scans the Overcast codebase for typed operation manifests and prints a summary report per service.
|
Command stub-report scans the Overcast codebase for typed operation manifests and prints a summary report per service. |
|
compat/embed.go — embeds the pre-built compatibility UI into the package.
|
compat/embed.go — embeds the pre-built compatibility UI into the package. |
|
internal
|
|
|
alarmaction
Package alarmaction delivers CloudWatch alarm state transitions to whatever the alarm's action ARNs name.
|
Package alarmaction delivers CloudWatch alarm state transitions to whatever the alarm's action ARNs name. |
|
awsapi
Code generated by cmd/awsmodelgen; DO NOT EDIT.
|
Code generated by cmd/awsmodelgen; DO NOT EDIT. |
|
bff
Package bff implements the browser-facing API layer (BFF) for the Overcast web console.
|
Package bff implements the browser-facing API layer (BFF) for the Overcast web console. |
|
capabilities
Package capabilities declares the emulation status of each AWS API operation.
|
Package capabilities declares the emulation status of each AWS API operation. |
|
clock
Package clock provides a thin re-export of github.com/benbjohnson/clock so the rest of the codebase imports a single internal path and is insulated from upstream API changes.
|
Package clock provides a thin re-export of github.com/benbjohnson/clock so the rest of the codebase imports a single internal path and is insulated from upstream API changes. |
|
config
Package config loads and validates all runtime configuration from environment variables.
|
Package config loads and validates all runtime configuration from environment variables. |
|
containerendpoint
Package containerendpoint keeps AWS resource URLs dialable from inside the containers Overcast starts — Lambda functions, ECS tasks — which are siblings of the Overcast container rather than children of it.
|
Package containerendpoint keeps AWS resource URLs dialable from inside the containers Overcast starts — Lambda functions, ECS tasks — which are siblings of the Overcast container rather than children of it. |
|
dns
Package dns serves the split-horizon hostnames Overcast advertises, to the containers Overcast starts.
|
Package dns serves the split-horizon hostnames Overcast advertises, to the containers Overcast starts. |
|
docker
Package docker provides a thin Docker Engine API client.
|
Package docker provides a thin Docker Engine API client. |
|
docssearch
Package docssearch serves search over the published docs/ tree.
|
Package docssearch serves search over the published docs/ tree. |
|
domainregistry
Package domainregistry tracks the set of user-registered custom domain names that map to overcast resources (API Gateway custom domains today, CloudFront alias names tomorrow) and broadcasts Added / Removed events to subscribed watchers.
|
Package domainregistry tracks the set of user-registered custom domain names that map to overcast resources (API Gateway custom domains today, CloudFront alias names tomorrow) and broadcasts Added / Removed events to subscribed watchers. |
|
events
Package events provides the internal event bus used for cross-service notifications (e.g.
|
Package events provides the internal event bus used for cross-service notifications (e.g. |
|
eventtarget
Package eventtarget resolves and delivers event payloads to AWS target ARNs.
|
Package eventtarget resolves and delivers event payloads to AWS target ARNs. |
|
hostbridge
Package hostbridge wires a stream of domain-registration events from the overcast emulator to the host machine's mDNS responder and local trust store.
|
Package hostbridge wires a stream of domain-registration events from the overcast emulator to the host machine's mDNS responder and local trust store. |
|
hostbridge/mdns
Package mdns defines the Publisher contract used by the overcast host CLI to advertise custom domain names through the operating system's multicast DNS responder (Bonjour on macOS, Avahi on Linux, DNS-SD on Windows).
|
Package mdns defines the Publisher contract used by the overcast host CLI to advertise custom domain names through the operating system's multicast DNS responder (Bonjour on macOS, Avahi on Linux, DNS-SD on Windows). |
|
hostbridge/trust
Package trust owns the Overcast local Certificate Authority: minting it, signing leaf server certificates from it (see ca.go), and installing the CA certificate into the operating system's trust store so browsers and HTTP clients accept Overcast's HTTPS without the usual self-signed-cert dance.
|
Package trust owns the Overcast local Certificate Authority: minting it, signing leaf server certificates from it (see ca.go), and installing the CA certificate into the operating system's trust store so browsers and HTTP clients accept Overcast's HTTPS without the usual self-signed-cert dance. |
|
iampolicy
Package iampolicy implements the AWS IAM policy grammar and AWS's policy evaluation algorithm (explicit deny wins, then allow, otherwise implicit deny).
|
Package iampolicy implements the AWS IAM policy grammar and AWS's policy evaluation algorithm (explicit deny wins, then allow, otherwise implicit deny). |
|
inithooks
Package inithooks discovers and executes user-provided shell scripts at well-known lifecycle stages, compatible with LocalStack's init hook system.
|
Package inithooks discovers and executes user-provided shell scripts at well-known lifecycle stages, compatible with LocalStack's init hook system. |
|
lifecycle
Package lifecycle provides a shared, testable scheduler for async state transitions.
|
Package lifecycle provides a shared, testable scheduler for async state transitions. |
|
logging
Package logging holds Overcast's custom log-level machinery: the TRACE level and its supporting parse/encode helpers.
|
Package logging holds Overcast's custom log-level machinery: the TRACE level and its supporting parse/encode helpers. |
|
middleware
Package middleware provides HTTP middleware for the emulator.
|
Package middleware provides HTTP middleware for the emulator. |
|
protocol
Package protocol provides shared AWS protocol helpers used by all service handlers: error serialisation, request IDs, ARN construction, and response writing.
|
Package protocol provides shared AWS protocol helpers used by all service handlers: error serialisation, request IDs, ARN construction, and response writing. |
|
protocol/codec
Package codec defines the wire-protocol abstraction used by Overcast's typed operation dispatcher.
|
Package codec defines the wire-protocol abstraction used by Overcast's typed operation dispatcher. |
|
protocol/op
Package op defines the typed operation dispatcher used by Overcast's Smithy-aligned services.
|
Package op defines the typed operation dispatcher used by Overcast's Smithy-aligned services. |
|
router
Package router wires together all service handlers into a single HTTP server.
|
Package router wires together all service handlers into a single HTTP server. |
|
services/acm
Package acm provides a basic emulation of AWS Certificate Manager (ACM).
|
Package acm provides a basic emulation of AWS Certificate Manager (ACM). |
|
services/apigateway
Package apigateway provides emulation of Amazon API Gateway (REST v1 + HTTP v2).
|
Package apigateway provides emulation of Amazon API Gateway (REST v1 + HTTP v2). |
|
services/appconfig
Package appconfig provides a basic emulation of AWS AppConfig.
|
Package appconfig provides a basic emulation of AWS AppConfig. |
|
services/appconfigdata
Package appconfigdata provides the AWS AppConfig data plane emulation.
|
Package appconfigdata provides the AWS AppConfig data plane emulation. |
|
services/appregistry
Package appregistry provides emulation of AWS Service Catalog AppRegistry.
|
Package appregistry provides emulation of AWS Service Catalog AppRegistry. |
|
services/appsync
Package appsync provides emulation of AWS AppSync (managed GraphQL).
|
Package appsync provides emulation of AWS AppSync (managed GraphQL). |
|
services/athena
Package athena provides a basic emulation of Amazon Athena.
|
Package athena provides a basic emulation of Amazon Athena. |
|
services/autoscaling
Package autoscaling emulates Amazon EC2 Auto Scaling, including the reconciliation loop that makes a group's DesiredCapacity mean something.
|
Package autoscaling emulates Amazon EC2 Auto Scaling, including the reconciliation loop that makes a group's DesiredCapacity mean something. |
|
services/bedrock
Package bedrock provides a basic emulation of Amazon Bedrock Runtime.
|
Package bedrock provides a basic emulation of Amazon Bedrock Runtime. |
|
services/cloudformation
Package cloudformation provides emulation of AWS CloudFormation.
|
Package cloudformation provides emulation of AWS CloudFormation. |
|
services/cloudfront
Package cloudfront provides emulation of Amazon CloudFront (CDN).
|
Package cloudfront provides emulation of Amazon CloudFront (CDN). |
|
services/cloudtrail
Package cloudtrail provides a metadata-only AWS CloudTrail emulator.
|
Package cloudtrail provides a metadata-only AWS CloudTrail emulator. |
|
services/cloudwatch
Package cloudwatch provides a basic emulation of Amazon CloudWatch (metrics + alarms).
|
Package cloudwatch provides a basic emulation of Amazon CloudWatch (metrics + alarms). |
|
services/cloudwatch/logs
Package logs: migration registration for the logs_events dedicated table (docs/plans/storage-plan.md Phase 2 item 2.3).
|
Package logs: migration registration for the logs_events dedicated table (docs/plans/storage-plan.md Phase 2 item 2.3). |
|
services/cognito
Package cognito provides emulation of Amazon Cognito User Pools (IDP).
|
Package cognito provides emulation of Amazon Cognito User Pools (IDP). |
|
services/dynamodb
Package dynamodb: migration registration for the dynamodb_items and dynamodb_stream_records dedicated tables (docs/plans/storage-plan.md Phase 3 item 3.9).
|
Package dynamodb: migration registration for the dynamodb_items and dynamodb_stream_records dedicated tables (docs/plans/storage-plan.md Phase 3 item 3.9). |
|
services/dynamodbstreams
Package dynamodbstreams implements the AWS DynamoDB Streams API emulator.
|
Package dynamodbstreams implements the AWS DynamoDB Streams API emulator. |
|
services/ec2
Package ec2 provides emulation of Amazon EC2 and VPC operations.
|
Package ec2 provides emulation of Amazon EC2 and VPC operations. |
|
services/ecr
Package ecr provides emulation of Amazon Elastic Container Registry (ECR).
|
Package ecr provides emulation of Amazon Elastic Container Registry (ECR). |
|
services/ecs
Package ecs provides emulation of Amazon Elastic Container Service (ECS).
|
Package ecs provides emulation of Amazon Elastic Container Service (ECS). |
|
services/efs
Package efs provides Amazon Elastic File System (EFS) control-plane emulation.
|
Package efs provides Amazon Elastic File System (EFS) control-plane emulation. |
|
services/eks
Package eks provides Amazon EKS control-plane emulation.
|
Package eks provides Amazon EKS control-plane emulation. |
|
services/elasticache
Package elasticache provides emulation of Amazon ElastiCache.
|
Package elasticache provides emulation of Amazon ElastiCache. |
|
services/eventbridge
Package eventbridge provides emulation of Amazon EventBridge.
|
Package eventbridge provides emulation of Amazon EventBridge. |
|
services/firehose
Package firehose provides a basic emulation of Amazon Data Firehose (formerly Kinesis Data Firehose).
|
Package firehose provides a basic emulation of Amazon Data Firehose (formerly Kinesis Data Firehose). |
|
services/glue
Package glue provides a basic emulation of AWS Glue Data Catalog.
|
Package glue provides a basic emulation of AWS Glue Data Catalog. |
|
services/iam
Package iam provides emulation of AWS Identity and Access Management (IAM).
|
Package iam provides emulation of AWS Identity and Access Management (IAM). |
|
services/kinesis
Package kinesis provides emulation of Amazon Kinesis Data Streams.
|
Package kinesis provides emulation of Amazon Kinesis Data Streams. |
|
services/kms
Package kms provides emulation of AWS Key Management Service (KMS).
|
Package kms provides emulation of AWS Key Management Service (KMS). |
|
services/lambda
Package lambda is a stub — handlers are implemented test-first.
|
Package lambda is a stub — handlers are implemented test-first. |
|
services/msk
Package msk provides emulation of Amazon MSK (Managed Streaming for Kafka).
|
Package msk provides emulation of Amazon MSK (Managed Streaming for Kafka). |
|
services/opensearch
Package opensearch provides a basic emulation of Amazon OpenSearch Service.
|
Package opensearch provides a basic emulation of Amazon OpenSearch Service. |
|
services/organizations
Package organizations provides stub emulation of AWS Organizations.
|
Package organizations provides stub emulation of AWS Organizations. |
|
services/pipes
Package pipes emulates the AWS EventBridge Pipes service.
|
Package pipes emulates the AWS EventBridge Pipes service. |
|
services/rds
Package rds provides emulation of Amazon RDS.
|
Package rds provides emulation of Amazon RDS. |
|
services/route53
Package route53 emulates Amazon Route 53 at inert level: hosted zones, resource record sets, tags, and health checks exist as real metadata with AWS-faithful validation, defaults, and error codes — but no DNS is served.
|
Package route53 emulates Amazon Route 53 at inert level: hosted zones, resource record sets, tags, and health checks exist as real metadata with AWS-faithful validation, defaults, and error codes — but no DNS is served. |
|
services/s3
Package s3 implements the AWS S3 REST API emulator.
|
Package s3 implements the AWS S3 REST API emulator. |
|
services/scheduler
Package scheduler provides emulation of Amazon EventBridge Scheduler.
|
Package scheduler provides emulation of Amazon EventBridge Scheduler. |
|
services/secretsmanager
Package secretsmanager provides emulation of AWS Secrets Manager.
|
Package secretsmanager provides emulation of AWS Secrets Manager. |
|
services/ses
Package ses provides emulation of Amazon Simple Email Service (SES v1).
|
Package ses provides emulation of Amazon Simple Email Service (SES v1). |
|
services/shield
Package shield provides a basic emulation of AWS Shield (DDoS protection).
|
Package shield provides a basic emulation of AWS Shield (DDoS protection). |
|
services/sns
Package sns provides emulation of the Amazon Simple Notification Service.
|
Package sns provides emulation of the Amazon Simple Notification Service. |
|
services/sqs
Package sqs: migration registration for the sqs_messages dedicated table (docs/plans/storage-plan.md item 3.10).
|
Package sqs: migration registration for the sqs_messages dedicated table (docs/plans/storage-plan.md item 3.10). |
|
services/ssm
Package ssm provides emulation of AWS Systems Manager Parameter Store.
|
Package ssm provides emulation of AWS Systems Manager Parameter Store. |
|
services/stepfunctions
Package stepfunctions provides emulation of AWS Step Functions.
|
Package stepfunctions provides emulation of AWS Step Functions. |
|
services/sts
Package sts provides emulation of AWS Security Token Service (STS).
|
Package sts provides emulation of AWS Security Token Service (STS). |
|
services/waf
Package waf provides emulation of AWS WAF v2 (Web Application Firewall).
|
Package waf provides emulation of AWS WAF v2 (Web Application Firewall). |
|
serviceutil
Package serviceutil provides shared, generic utilities used across all service handlers.
|
Package serviceutil provides shared, generic utilities used across all service handlers. |
|
smtp
Package smtp provides a minimal SMTP server for capturing outbound emails in local development, and a Mailer interface for sending emails that works with both the built-in capture server and an external SMTP relay.
|
Package smtp provides a minimal SMTP server for capturing outbound emails in local development, and a Mailer interface for sending emails that works with both the built-in capture server and an external SMTP relay. |
|
state
Package state defines the Store interface and provides four implementations:
|
Package state defines the Store interface and provides four implementations: |
|
tests
|
|
Click to show internal directories.
Click to hide internal directories.