docs: design S3 gateway and phased delivery plan - #162
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an executable design for a separate
crab-s3-gatewaythat maps logicalcrabfs://REPO/REF/KEYaddresses onto S3-compatible repository operations. The plan defines ten implementation phases with context, prerequisites, implementation slices and acceptance criteria; it does not claim gateway support is implemented.The detailed design covers signing and authorization, reads/listing, atomic file mutations, durable multipart registration/completion, execution fencing, crash recovery and resource budgets. Fourteen Mermaid diagrams illustrate the flows and state machines. Phase 9 includes Docker/Compose, EKS/Helm and ECS Fargate/CloudFormation deployment procedures, operational runbooks and environment-specific qualification.
Links the plan from the architecture index and SDK design. SDK prerequisites and source references include work in #160; this PR contains only the gateway documentation and its two cross-links, with no SDK implementation changes. Write visibility, full S3 versioning and other persistent semantic choices remain explicit phase-0 decisions.
Validation: all 14 diagrams parsed successfully with Mermaid 11.15.0; checked all ten phase contracts, local links, Markdown fences and whitespace.
git diff --checkpasses. Diagram layout was not visually rendered; no runtime or deployment tests apply to this documentation-only change.