docs: backup and restore specification #1610
Conversation
TerryHowe
requested review from
sajayantony,
shizhMSFT,
SteveLasker,
qweeah and
Wwwsylvia
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1610 +/- ##
==========================================
+ Coverage 84.30% 84.37% +0.06%
==========================================
Files 120 120
Lines 5449 5460 +11
==========================================
+ Hits 4594 4607 +13
+ Misses 608 606 -2
Partials 247 247 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Terry Howe <[email protected]>
TerryHowe
force-pushed
the
backup-restore-spec
branch
from
a67cd77 to
7e33f88
Compare
| @@ -0,0 +1,107 @@ | |||
| # Backup and Restore Commands | |||
There was a problem hiding this comment.
Should there be a problem statement that is included within this proposal that illustrates why this feature is needed?
docs/proposals/backup-restore.md
Outdated
|
|
||
| This document describes how the backup and restore commands will work and how the feature will be rolled out. | ||
| The proposal is to create the feature as a minimum viable product and follow that up with non breaking features to the commands. | ||
| The initial implementation will be the easiest implementation that is useful. |
| @@ -0,0 +1,107 @@ | |||
| # Backup and Restore Commands | |||
|
|
|||
| This document describes how the backup and restore commands will work and how the feature will be rolled out. | |||
There was a problem hiding this comment.
What are we backing up and restoring?
There was a problem hiding this comment.
Added something in a new paragraph above this.
docs/proposals/backup-restore.md
Outdated
|
|
||
| ### oras backup | ||
|
|
||
| The backup command will initially only support reading a list of files from the command line and writing to a directory: |
There was a problem hiding this comment.
List of files or list or artifacts?
| Initially, the restore command will only support reading a directory and writing to a registry: | ||
|
|
||
| ```bash | ||
| oras restore --input ./mirror localhost:15000/my-mirror |
There was a problem hiding this comment.
Will there be flags to support authentication and TLS for the remote registry?
There was a problem hiding this comment.
Yes, all the normal registry flags. I added some text about that.
|
|
||
| ## Compressed Tar File Support | ||
|
|
||
| After the command supports directory write and read, support will be added for write and read to a compressed tar file. |
There was a problem hiding this comment.
Is this trying to state that future enhancements after the initial release will add support for compressed archives?
Co-authored-by: Andrew Block <[email protected]> Signed-off-by: Terry Howe <[email protected]>
Co-authored-by: Andrew Block <[email protected]> Signed-off-by: Terry Howe <[email protected]>
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. |
Co-authored-by: Andrew Block <[email protected]> Signed-off-by: Terry Howe <[email protected]>
Co-authored-by: Andrew Block <[email protected]> Signed-off-by: Terry Howe <[email protected]>
Signed-off-by: Terry Howe <[email protected]>
What this PR does / why we need it:
Specification for the way the
oras backupandoras restorecommands will work.Which issue(s) this PR fixes:
Partial: #1366