docs: Add a doc for devworkspace backup feature#3028
docs: Add a doc for devworkspace backup feature#3028dkwon17 merged 5 commits intoeclipse-che:mainfrom
Conversation
Allda
requested review from
a team,
deerskindoll,
gtrivedi88 and
mkuznyetsov
as code owners
|
🎊 Navigate the preview: https://69a5b2744100f410d2c409ed--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
Allda
force-pushed
the
backup-doc
branch
3 times, most recently
from
84931c4 to
a7da9ea
Compare
Signed-off-by: Ales Raszka <araszka@redhat.com>
|
@akurinnoy I added a doc for the backup feature. Once you have a dashboard available, could you create another PR with a doc for the dashboard? |
| [id="devworkspace-backup"] | ||
| = Workspace backup for {prod} | ||
|
|
||
| Starting from {prod} version v7.115.0, the {devworkspace} backup job allows for periodic backups of {devworkspace} data to a specified backup location. |
There was a problem hiding this comment.
@gtrivedi88 ptal, and recommend how the docs should be downstreamed e.g. 7.115 - > Dev Spaces 3.27
There was a problem hiding this comment.
@ibuziuk As for downstreaming, when this is merged and we carve out a 7.115 branch in main. The pipeline watcher which watches for the changes in upstream branch for specific release versions, will create a issue in Gitlab.
At the very begining of every release, in the attributes we have to define the upstream branches (7.114.x, and 7.115.x) which will make downstream (3.27) and then schedule a pipieline, which will keep watching for those branches for content updates.
Let me know if you have questions
Yep, that is why I pinged @akurinnoy earlier in this PR to address the restore doc once the dashboard is finished #3028 (comment) |
Signed-off-by: Ales Raszka <araszka@redhat.com>
|
@ibuziuk I addressed your notes. Can this be merged? The restore feature will be documented in a separate PR. |
|
@Allda I have concern about |
Signed-off-by: Ales Raszka <araszka@redhat.com>
Signed-off-by: Ales Raszka <araszka@redhat.com>
| * *`oras.extraArgs`*: (Optional) Additional arguments to pass to the `oras` CLI tool during push and pull operations. | ||
|
|
||
|
|
||
| There are several configuration options to customize the logic: |
There was a problem hiding this comment.
I feel this is a big topic and we can have multiple .adoc files.
Please see my comment here: #3029 (comment)
I see we have a mix of concept and procedures in one .adoc file.
There was a problem hiding this comment.
I split the doc into multiple as suggested.
Signed-off-by: Ales Raszka <araszka@redhat.com>
|
@ibuziuk Can you please merge it? I don't have permission to do it. Thanks. |
7 participants
What does this pull request change?
The pull request adds documentation for a backup feature introduced in the recent devworkspace operator.
What issues does this pull request fix or reference?
eclipse-che/che#23570
Specify the version of the product this pull request applies to
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.