-
Notifications
You must be signed in to change notification settings - Fork 201
docs: backup and restore specification #1610
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1610 +/- ##
==========================================
+ Coverage 85.29% 85.32% +0.03%
==========================================
Files 133 133
Lines 5882 5882
==========================================
+ Hits 5017 5019 +2
+ Misses 616 614 -2
Partials 249 249 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
a67cd77
to
7e33f88
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feature is somewhat confusing. I understand the motivation, but it does not accurately reflect backup/restore. A possible suggestion is to use dump
/publish
instead
If you think of it reading and writing tgz files, I think backup/restore works pretty well. Names are hard, the equivalent docker command would be save/load. |
This reduces the number of commands to create a tar archive (single of multiple) which is awesome. For e.g.
This might complicate the commands, but contextually might makes more sense. |
99093f6
to
cc044df
Compare
@TerryHowe Thank you for revising it. Will review this proposal doc again. |
This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 30 days. |
ed103fc
to
b3504a0
Compare
Co-authored-by: Andrew Block <andy.block@gmail.com> Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
b3504a0
to
e1ba0c9
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Co-authored-by: Feynman Zhou <feynmanzhou@microsoft.com> Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive specification for new oras backup
and oras restore
commands, detailing user scenarios, command syntax, flags, and expected behaviors.
- Introduces a proposal document outlining motivations and real-world scenarios
- Defines
oras backup
andoras restore
commands with full flag reference - Describes CLI UX examples for multi-repo, air-gapped, and repository-level workflows
Comments suppressed due to low confidence (2)
docs/proposals/backup-restore.md:172
- Remove the stray 'oras' after 'Disable progress bars.'.
* `--no-tty`: Disable progress bars.oras
docs/proposals/backup-restore.md:192
- The note refers to
--output
but should mention--input
for the restore command.
> Note: If the flag `--output` is not specified, the default input directory is set to the current directory ".".
c63131f
to
7b47268
Compare
I reverted this to the last good commit. There were too many issues with those other updates. |
Just discussed with @TerryHowe about this PR. The consensus is that we will merge this PR then I will go ahead to open a follow up PR to enrich the spec. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM as the initial attempt of oras backup/restore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @TerryHowe . LGTM with merging this PR as an initial version. I will open a follow up PR to enrich the doc.
@TerryHowe this looks good. One final question. What happens when you attempt to back up the same repository with two separate versions? Since there is the potential to have overlapping concerns/files (like the |
@sabre1041 Would you mind clarifying "two separate versions" in the context of backup a repo? |
@sabre1041 BTW, if overall looks good as the initial version, you may also want to approve this PR as you requested changes previously. |
With OCI file layout it just adds another manifest in one blob directory:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What this PR does / why we need it:
Specification for the way the
oras backup
andoras restore
commands will work.Which issue(s) this PR fixes:
Partial: #1366