diff --git a/README.md b/README.md index 054f61b..0e9334a 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,52 @@ # K3s cluster -| Name | Usage | Accessibility | Host | DB type | Automated backups | Configured | -| -- | -- | -- | -- | -- | -- | -- | -| therbron.com | Personal website | Public | Socrates | - | Nothing to backup | No | -| Traefik | Reverse proxy and load balancer | Public* | Socrates | - | Git configuration | Yes | -| Adguard | DNS ad blocker and custom DNS server | Private | Socrates | - |
?
| Yes | -| Owncloud Infinity Scale | File hosting webUI | Public | Plato | PostgreSQL |
?
| No | -| Home assistant | Home automation and monitoring | Private | Pythagoras-a | PostgreSQL |
?
| No | -| Vikunja | To-do and Kanban boards | Public | Pythagoras-b | - |
?
| No (To be integrated in Gitlab) | -| Gitlab | Version control system | Public | Pythagoras-b | PostgreSQL |
?
| No | -| Wiki | Documentation manager | Public | Pythagoras-b | - |
?
| No (Migrate to VuePress and Gitlab) | -| Vaultwarden | Password manager | Public | Pythagoras-b | PostgreSQL |
?
| No | -| Synapse | Matrix server - Message centralizer | Public | Pythagoras-b | PostgreSQL |
?
| No | -| PaperlessNG | PDF viewer and organiser | Public | Pythagoras-b | PostgreSQL |
?
| No | -| Raspsnir | Bachelor memorial website | Public | Pythagoras-b | PostgreSQL |
?
| No | -| Jellyfin | Media streaming | Public | Archimedes | - |
?
| No | -| Sonarr | TV shows collection manager | Private | Plato | SQLite** |
?
| No | -| Radarr | Movie collection manager | Private | Plato | SQLite** |
?
| No | -| Jackett | Torrent indexer | Private | Plato | - |
?
| No | -| Deluge | Torrent client | Private | Plato | - |
?
| No | -| Minecraft | Vanilla minecraft server for friends | Public | Archimedes | - | Longhorn snapshots | Yes | -| Satisfactory | Satisfactory server for friends | Public | Archimedes | - | Longhorn snapshots | No | -| Space engineers | Space engineers server for friends | Public | Archimedes | - | Longhorn snapshots | No | +| Name | Usage | Accessibility | Host | DB type | Additional data | Backup configuration | Log management | Status | +|-------------------------|--------------------------------------|---------------|--------------|------------|----------------------|----------------------|----------------|--------------------------------| +| therbron.com | Personal website | Public | Socrates | - | - | - | Not configured | Awaiting configuration | +| Traefik | Reverse proxy and load balancer | Public* | Socrates | - | - | - | Not configured | Yes | +| Adguard | DNS ad blocker and custom DNS server | Private | Socrates | - | - | - | Not configured | Yes | +| Owncloud Infinity Scale | File hosting webUI | Public | Plato | PostgreSQL | Drive files | None | Not configured | Awaiting configuration | +| Home assistant | Home automation and monitoring | Private | Pythagoras-a | PostgreSQL | - | None | Not configured | Awaiting configuration | +| Vikunja | To-do and Kanban boards | Public | Pythagoras-b | - | - | - | Not configured | Migrate to Gitlab | +| Gitlab | Version control system | Public | Pythagoras-b | PostgreSQL | User created content | None | Not configured | Awaiting configuration | +| Wiki | Documentation manager | Public | Pythagoras-b | - | - | - | Not configured | Migrate to VuePress and Gitlab | +| Vaultwarden | Password manager | Public | Pythagoras-b | PostgreSQL | - | None | Not configured | Awaiting configuration | +| Synapse | Matrix server - Message centralizer | Public | Pythagoras-b | PostgreSQL | User medias | None | Not configured | Awaiting configuration | +| PaperlessNG | PDF viewer and organiser | Public | Pythagoras-b | PostgreSQL | - | - | Not configured | Research migration into OCIS | +| Raspsnir | Bachelor memorial website | Public | Pythagoras-b | PostgreSQL | - | None | Not configured | Awaiting configuration | +| Jellyfin | Media streaming | Public | Archimedes | - | - | - | Not configured | Awaiting configuration | +| Sonarr | TV shows collection manager | Private | Plato | SQLite** | Internal backups | None | Not configured | Awaiting configuration | +| Radarr | Movie collection manager | Private | Plato | SQLite** | Internal backups | None | Not configured | Awaiting configuration | +| Jackett | Torrent indexer | Private | Plato | - |
?
| None | Not configured | Awaiting configuration | +| Deluge | Torrent client | Private | Plato | - |
?
| - | Not configured | Awaiting configuration | +| Minecraft | Vanilla minecraft server for friends | Public | Archimedes | - | Game map | None | Not configured | Yes | +| Satisfactory | Satisfactory server for friends | Public | Archimedes | - | Game map | None | Not configured | Awaiting configuration | +| Space engineers | Space engineers server for friends | Public | Archimedes | - | Game map | None | Not configured | Awaiting configuration | \* Configuration panel only available internally
** Current implementation only support SQLite, making manual backups a necessity +## Backup management +### Databases +All services needing a database to function come with a sidecar pod running a crontab to automate individual database backups. +These backups are saved into a longhorn volume, to benefit from general snapshots later one. +Each sidecar pod can only mount the backup folder it has been linked with, and cannot see other services' backups. + +### Additional data +All additional data needing to be backed up is mounted to a longhorn volume, to also benefit from scheduled backups. + +Example : +``` +longhorn +└───backups + └───vaultwarden + │ └───.sql + │ │ ... + └───gitlab + └───.sql + │ ... +``` + ## Completed - Add TLS certificates for every http applications