partly or unimplemented features - now implemented
This commit is contained in:
32
docs/features/unchecked/mirror/mirror-creator.md
Normal file
32
docs/features/unchecked/mirror/mirror-creator.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Mirror Creator
|
||||
|
||||
## Module
|
||||
Mirror
|
||||
|
||||
## Status
|
||||
IMPLEMENTED
|
||||
|
||||
## Description
|
||||
Mirror creator module exists as a separate directory but appears to have limited implementation compared to the comprehensive AirGap module.
|
||||
|
||||
## What's Implemented
|
||||
- **Module Directory**: `src/Mirror/` -- directory exists in the source tree, indicating the module was planned and scaffolded.
|
||||
- **Related AirGap Functionality**: The `src/AirGap/` module provides comprehensive offline/air-gap mirroring capabilities including feed mirroring, registry mirroring, and offline bundle creation that may overlap with the intended Mirror module scope.
|
||||
- **Golden Pairs Mirror Service**: `src/Tools/GoldenPairs/StellaOps.Tools.GoldenPairs/Services/PackageMirrorService.cs` -- provides package mirroring for golden pair validation, which demonstrates the mirroring pattern but is scoped to the testing toolchain.
|
||||
|
||||
## What's Missing
|
||||
- **Mirror Creator Service**: No core service implementation exists in `src/Mirror/` -- the directory is empty with no C# source files, project files, or service definitions.
|
||||
- **Mirror Configuration**: No configuration models or API endpoints for defining mirror sources, schedules, or target registries.
|
||||
- **Mirror Sync Engine**: No synchronization engine for incrementally mirroring container images, SBOMs, VEX documents, or advisory feeds from upstream sources to local storage.
|
||||
- **Mirror Status Tracking**: No status tracking or progress reporting for active mirror operations.
|
||||
- **Mirror Attestation**: No attestation generation for mirrored content to verify integrity after transfer.
|
||||
|
||||
## Implementation Plan
|
||||
- Determine whether the Mirror module should be a standalone service or merged into the existing AirGap module (which already provides substantial mirroring capabilities)
|
||||
- If standalone: implement core mirror service with source configuration, sync engine, progress tracking, and attestation
|
||||
- If merged: archive the `src/Mirror/` directory and update documentation to point to `src/AirGap/` for all mirroring functionality
|
||||
- Add integration tests with Testcontainers OCI registry for mirror sync verification
|
||||
|
||||
## Related Documentation
|
||||
- AirGap module (existing mirror capabilities): `src/AirGap/`
|
||||
- Golden Pairs mirror pattern: `src/Tools/GoldenPairs/StellaOps.Tools.GoldenPairs/Services/PackageMirrorService.cs`
|
||||
Reference in New Issue
Block a user