docs: add scenario doc for Backup and Restore of OCI Artifacts and Images#1778
Merged
Conversation
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1778 +/- ##
=======================================
Coverage 85.58% 85.58%
=======================================
Files 137 137
Lines 6006 6006
=======================================
Hits 5140 5140
Misses 615 615
Partials 251 251 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
4 tasks
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a standalone scenarios document for portable backup and restore workflows in the oras CLI, splitting off use cases from a larger specification.
- Introduces real-world scenarios demonstrating backup/restore needs across air-gapped, isolated, and multi-cloud environments
- Illustrates existing workflow gaps and motivates unified commands in
oras - Links to relevant GitHub issues and recommends proper
oras copyusage
Comments suppressed due to low confidence (2)
docs/proposals/backup-restore-scenarios.md:48
- [nitpick] This reads as two sentence fragments. Consider combining into one clear sentence, e.g., 'Dave, a security engineer at a FinTech company, needs to create a snapshot of the image and its referrers in an air-gapped environment by running the following flow:'.
Dave, a security engineer at a FinTech company. To create a snapshot of the image and its referrers in an air-gapped environment, Dave needs to run the following flow:
docs/proposals/backup-restore-scenarios.md:95
- [nitpick] The title references
oras pull/push, but the recommended solution usesoras copy. For clarity, consider updating the scenario title to mentionoras copyor general backup commands.
### Scenario 4: Uploading and Downloading Image With Referrers Using `oras pull/push`
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Wwwsylvia
reviewed
Jul 14, 2025
sajayantony
reviewed
Jul 21, 2025
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
sajayantony
approved these changes
Jul 23, 2025
6 tasks
6 tasks
6 tasks
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
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.
What this PR does / why we need it:
I splited the spec "Backup and Restore of OCI Artifacts and Images" from a single doc #1767 into two separate PRs, one for scenarios and another one for proposals with CLI design.
The scenarios part could be easily merged as it does not have controversial comments and we almost aligned. The proposal with CLI design needs further discussion and consensus.