mirror of
https://github.com/apple/container.git
synced 2026-07-15 05:57:01 +00:00
Kathryn Baldauf
16f2630126
We're working on making a pure swift container image build system that leverages containerization. This PR represents our initial design and initial work towards this goal. The native builder is still in active development and most of the implementation has not been started or completed. We will be opening a series of issues that represent various (but not necessarily all) pieces of work that need to be done here. There are docs included in this PR that describe the overall design of each component and outline some of our goals. The easiest way to view the docs by themselves (since this is a massive PR) is to look at the docs commit in the `Commits` tab. We'd love any feedback! @wlan0 --------- Signed-off-by: Kathryn Baldauf <k_baldauf@apple.com>
39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
# Swift Native Builder Documentation
|
|
|
|
Welcome to the Swift Native Builder documentation. These docs contain detailed information about the project's architecture and design decisions.
|
|
|
|
## Documentation Structure
|
|
|
|
### Core Documentation
|
|
|
|
- [**Design.md**](./Design.md) - Complete architectural design and implementation details
|
|
- High-level architecture overview
|
|
- Component descriptions (Parser, Scheduler, Executor, CAS)
|
|
- Security model and extensibility
|
|
|
|
### Component Documentation
|
|
|
|
- [**ContainerBuildIR**](./ContainerBuildIR/) - Intermediate Representation documentation
|
|
- Core types and operations
|
|
- Build graph structure
|
|
- Validation and analysis tools
|
|
|
|
- [**ContainerBuildExecutor**](./ContainerBuildExecutor/) - Execution layer documentation
|
|
- Executor architecture and patterns
|
|
|
|
- [**ContainerBuildCache**](./ContainerBuildCache/) - Caching layer documentation
|
|
- ContentStore-based cache architecture
|
|
- OCI-compliant cache entry format
|
|
- Eviction policies and index management
|
|
|
|
## Quick Links
|
|
|
|
- [Project README](../README.md) - Getting started and overview
|
|
- [Examples](../Sources/ContainerBuildDemo/) - Sample code and usage patterns
|
|
|
|
## Contributing
|
|
|
|
When adding new documentation:
|
|
1. Place architectural documents in this docs folder
|
|
2. Component-specific documentation goes under `docs/<component-name>/`
|
|
3. Update this README with links to new documents |