docs consolidation work
This commit is contained in:
46
docs/modules/mirror/README.md
Normal file
46
docs/modules/mirror/README.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Mirror
|
||||
|
||||
**Status:** Implemented
|
||||
**Source:** `src/Mirror/`
|
||||
**Owner:** Platform Team
|
||||
|
||||
## Purpose
|
||||
|
||||
Mirror creates offline package mirrors and advisory snapshots for air-gapped deployments. Enables deterministic, offline-first operation by capturing point-in-time snapshots of external package repositories and vulnerability feeds.
|
||||
|
||||
## Components
|
||||
|
||||
**Services:**
|
||||
- `StellaOps.Mirror.Creator` - Mirror creation and management tool
|
||||
|
||||
**Scripts:**
|
||||
- `make-thin-v1.sh` - Thin mirror creation script
|
||||
- `schedule-export-center-run.sh` - Integration with ExportCenter for scheduled exports
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration is typically provided via CLI arguments or environment variables.
|
||||
|
||||
Key features:
|
||||
- Package repository mirroring (distro mirrors, language ecosystems)
|
||||
- Advisory feed snapshots (CSAF, OSV, NVD)
|
||||
- Thin mirror creation (metadata-only for bandwidth optimization)
|
||||
- Integration with ExportCenter for bundle creation
|
||||
- Air-gap bundle generation
|
||||
|
||||
## Dependencies
|
||||
|
||||
- ExportCenter (for bundle packaging)
|
||||
- AirGap (for import/validation)
|
||||
- External package repositories and advisory feeds (as mirror sources)
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- AirGap Module: `../airgap/`
|
||||
- ExportCenter: `../export-center/`
|
||||
- Offline Kit: `../../24_OFFLINE_KIT.md`
|
||||
- Operations: `./operations/` (if exists)
|
||||
|
||||
## Current Status
|
||||
|
||||
Mirror.Creator implemented with thin mirror support. Integrated with ExportCenter for air-gap bundle generation. Used for offline deployment preparation.
|
||||
Reference in New Issue
Block a user