mirror/vorta
1
0
Fork 0
mirror of https://github.com/borgbase/vorta synced 2024-12-22 07:43:09 +00:00
Code Issues Releases Wiki Activity

Sort borgmatic tasks.

real-yfprojects 2023-02-07 21:55:38 +01:00
parent 9a91ea88a9
commit 542ce0231c
No known key found for this signature in database
GPG key ID: 00F630DFDEE25747
1 changed files with 29 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
Google-Summer-of-Code-2023-Ideas.md

@ -312,6 +312,15 @@ Other issues tagged [help wanted](https://github.com/borgbackup/borg/issues?q=is
**Additional details**: Not all Borg sub-commands make sense to wrap. For instance, Borg invokes `borg serve` internally, and there's likely not a good use case for running it via borgmatic. Similarly, some Borg flags like `--info` and `--debug` shouldn't be exposed directly via borgmatic configuration options or command-line flags, because borgmatic uses them implicitly (e.g. via `--verbosity`) without exposing them to the end-user.<br />
**Possible mentors**: [@witten][witten], [@real-yfprojects][real-yfprojects] (backup mentor)
### Bootstrap a borgmatic restore from nothing
**Difficulty**: Medium<br />
**Length**: 80 hours<br />
**Skills required**: Python, Linux, relational database administration basics (PostgreSQL and/or MySQL/MariaDB)<br />
**Description**: borgmatic is great for restoring the occasional accidentally deleted file or database, but it's not as streamlined for the use case of spinning up an entire replacement system from nothing in the case of catastrophic server loss. That's because in order to function, borgmatic needs a configuration file with a list of Borg repositories to restore from, databases to restore, credentials, etc. <br />
**Task outline**: Design and implement a better, more streamlined workflow for bootstrapping the restore of backed up files and databases to a totally blank system. This could include approaches like: 1. Automatically storing borgmatic configuration in a canonical location in any backup archive such that it can be restored or used upon restore, 2. Automatically storing borgmatic database configuration along with each backed up database dump so as to facilitate restore, and/or 3. Implementing a new borgmatic action like `borgmatic bootstrap` to provide the user with an entry point to some of these features. Additionally, update the documentation and tests accordingly.<br />
**Additional details**: See a [related ticket](https://projects.torsion.org/borgmatic-collective/borgmatic/issues/345)<br />
**Possible mentors**: [@witten][witten], [@real-yfprojects][real-yfprojects] (backup mentor)
### Backup and restore SQLite databases
**Difficulty**: Medium<br />
**Length**: 125 hours<br />
@ -321,14 +330,6 @@ Other issues tagged [help wanted](https://github.com/borgbackup/borg/issues?q=is
**Additional details**: See [the ticket](https://projects.torsion.org/borgmatic-collective/borgmatic/issues/295).<br />
**Possible mentors**: [@witten][witten], [@real-yfprojects][real-yfprojects] (backup mentor)
### Bootstrap a borgmatic restore from nothing
**Difficulty**: Medium<br />
**Length**: 80 hours<br />
**Skills required**: Python, Linux, relational database administration basics (PostgreSQL and/or MySQL/MariaDB)<br />
**Description**: borgmatic is great for restoring the occasional accidentally deleted file or database, but it's not as streamlined for the use case of spinning up an entire replacement system from nothing in the case of catastrophic server loss. That's because in order to function, borgmatic needs a configuration file with a list of Borg repositories to restore from, databases to restore, credentials, etc. <br />
**Task outline**: Design and implement a better, more streamlined workflow for bootstrapping the restore of backed up files and databases to a totally blank system. This could include approaches like: 1. Automatically storing borgmatic configuration in a canonical location in any backup archive such that it can be restored or used upon restore, 2. Automatically storing borgmatic database configuration along with each backed up database dump so as to facilitate restore, and/or 3. Implementing a new borgmatic action like `borgmatic bootstrap` to provide the user with an entry point to some of these features. Additionally, update the documentation and tests accordingly.<br />
**Additional details**: See a [related ticket](https://projects.torsion.org/borgmatic-collective/borgmatic/issues/345)<br />
**Possible mentors**: [@witten][witten], [@real-yfprojects][real-yfprojects] (backup mentor)
### Perform ZFS filesystem snapshots
**Difficulty**: Hard<br />
@ -345,15 +346,6 @@ Also see [good first issues](https://projects.torsion.org/borgmatic-collective/b
## DevOps and Packaging
For the [Borg+Borgmatic Docker image](https://github.com/borgmatic-collective/docker-borgmatic) and [Ansible role](https://github.com/borgbase/ansible-role-borgbackup)
### Create a minimal/extended docker image setup
**Difficulty**: Medium<br />
**Length**: 90 hours<br />
**Skills required**: Docker, Linux, Shell<br />
**Description**: A recentish request to have a minimal no-frills base image and then an extended docker image with more tools included. I think we would also include the ability to provide a variable containing a string of additional packages users would like installed. This would then be processed during entry.sh and install any additional tools users wish.<br />
**Task outline**: Develop new multi-stage Docker file and add build workflow based on Github Actions<br />
**Additional details**: See [this issue](https://github.com/borgbackup/borg/issues/6303)<br />
**Possible mentor**: [@grantbevis][grantbevis], [@m3nu][m3nu] (backup mentor)
### Remove antiquated msmtp and ntfy images
**Difficulty**: Easy<br />
**Length**: 25 hours<br />
@ -363,15 +355,6 @@ For the [Borg+Borgmatic Docker image](https://github.com/borgmatic-collective/do
**Additional details**: - <br />
**Possible mentor**: [@grantbevis][grantbevis], [@m3nu][m3nu] (backup mentor)
### Add CI for the docker images
**Difficulty**: Medium<br />
**Length**: 90 hours<br />
**Skills required**: Docker, Linux, Shell<br />
**Description**: Add linting (hadolint) and test builds as we currently only utilise CD to deploy the image to GitHub/Docker Hub registries: Might be worth investigating if we could run the borgmatic unit/integration tests using the docker-borgmatic image as I don't think it does currently @witten ?<br />
**Task outline**: Research Docker linting and testing best-practices and see how similar projects are dealing with it. Then add the same to our release process, likely using Github Actions, but staying platform agnostic where possible.<br />
**Additional details**: - <br />
**Possible mentor**: [@grantbevis][grantbevis], [@m3nu][m3nu] (backup mentor)
### Add Systemd timer in addition to Cron timer
**Difficulty**: Easy<br />
**Length**: 45 hours<br />
@ -381,6 +364,7 @@ For the [Borg+Borgmatic Docker image](https://github.com/borgmatic-collective/do
**Additional details**: See [this issue](https://github.com/borgbase/ansible-role-borgbackup/issues/31)<br />
**Possible mentors**: [@m3nu][m3nu], [@Hofer-Julian][Hofer-Julian], [@grantbevis][grantbevis] (backup mentor)
### Add support for reduced NICE priority
**Difficulty**: Medium<br />
**Length**: 45 hours<br />
@ -399,6 +383,25 @@ For the [Borg+Borgmatic Docker image](https://github.com/borgmatic-collective/do
**Additional details**: See [this issue](https://github.com/borgbase/ansible-role-borgbackup/issues/33) for more.<br />
**Possible mentors**: [@m3nu][m3nu], [@grantbevis][grantbevis] (backup mentor)
### Create a minimal/extended docker image setup
**Difficulty**: Medium<br />
**Length**: 90 hours<br />
**Skills required**: Docker, Linux, Shell<br />
**Description**: A recentish request to have a minimal no-frills base image and then an extended docker image with more tools included. I think we would also include the ability to provide a variable containing a string of additional packages users would like installed. This would then be processed during entry.sh and install any additional tools users wish.<br />
**Task outline**: Develop new multi-stage Docker file and add build workflow based on Github Actions<br />
**Additional details**: See [this issue](https://github.com/borgbackup/borg/issues/6303)<br />
**Possible mentor**: [@grantbevis][grantbevis], [@m3nu][m3nu] (backup mentor)
### Add CI for the docker images
**Difficulty**: Medium<br />
**Length**: 90 hours<br />
**Skills required**: Docker, Linux, Shell<br />
**Description**: Add linting (hadolint) and test builds as we currently only utilise CD to deploy the image to GitHub/Docker Hub registries: Might be worth investigating if we could run the borgmatic unit/integration tests using the docker-borgmatic image as I don't think it does currently @witten ?<br />
**Task outline**: Research Docker linting and testing best-practices and see how similar projects are dealing with it. Then add the same to our release process, likely using Github Actions, but staying platform agnostic where possible.<br />
**Additional details**: - <br />
**Possible mentor**: [@grantbevis][grantbevis], [@m3nu][m3nu] (backup mentor)
[m3nu]: https://github.com/m3nu
[real-yfprojects]: https://github.com/real-yfprojects
[Hofer-Julian]: https://github.com/Hofer-Julian