Skip to content

Explain how to choose the archive store in the README - #164

Merged
baokhang83 merged 3 commits into
mainfrom
docs/choosing-the-store
Nov 18, 2026
Merged

baokhang83 merged 3 commits into
mainfrom
docs/choosing-the-store

Conversation

@baokhang83

@baokhang83 baokhang83 commented Nov 18, 2026 •

Copy link
Copy Markdown
Owner

Summary

The README told users that warmup.mnemo.io/store is "a repository for caches, not for your application image", but not how to choose one.

  • README, Step 1: the existing line now includes an example value and links to the new section. The quick start flow is unchanged.
  • docs/configuration.md, new "Choosing the store" section after Annotations:
    • The value format: oci:// plus a repository path with no tag. mnemo-warmup adds the fp- tags itself.
    • Use one cache-only repository per application, with its own lifecycle policy and tag immutability off.
    • A table of example values for GHCR, Docker Hub, Harbor, ECR and Artifact Registry, showing which ones need the repository created first. It is marked illustrative: these rows are not tested with mnemo-warmup.
    • Credentials: the trainer needs push, pods need pull.
    • A wrong store or refused login fails silently (uncached start, trainer exits 0), so check the trainer log after the first run.

Docs only, no code changes.

🤖 Generated with Claude Code

baokhang83 and others added 3 commits November 18, 2026 10:00
New users had no guidance on what to put in warmup.mnemo.io/store.
Add a short section under Step 1: the value format, one cache-only
repository per application, which registries need the repository
created first, the credentials it needs, and that a wrong store or
refused login silently falls back to an uncached start.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The full section interrupted the three-step flow. Keep one line with an
example in Step 1 and move the details to docs/configuration.md.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@baokhang83
baokhang83 merged commit 1b258f8 into main Nov 18, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant