Skip to content
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

chore: improve features/backup.mdx #167

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions apps/docs/content/features/backup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,26 @@ Zerops provides data backup for certain services.

Whether a service supports backups is specified on the documentation page of each service. Technical details about backup implementation for each service are also described on their respective service pages.

## Supported Services and Formats

Zerops supports backups for these services with the following formats:

- **MariaDB**: `.xb.zip` (using mariabackup with xbstream format)
- **PostgreSQL**: `.dump` (using pg_dump with custom format)
- **Qdrant**: `snapshot`
- **NATS**: `.tar.gz`
- **Elasticsearch**: `.gz`
- **Meilisearch**: `.dump`
- **Shared Storage**: `.tar.gz`

## Backup File Naming

Backup files follow a consistent naming convention:
`backup-{serviceName}-{dateTime}.{extension}`

For example:
`backup-db-2024-11-04-120007.dump`

## Frequency and volume

By default, your data is backed up automatically **every day** between 00:00:00 UTC and 01:00:00 UTC, unless you update your settings:
Expand All @@ -21,6 +41,16 @@ Following changes are available in Zerops GUI. Go to the service detail and choo
- download a backup
- delete a backup

### Using CLI

You can also manage backups programmatically using the Zerops CLI:

```bash
zcli backup serviceName
```

This command triggers a backup for the specified service and waits until the backup is either completed or fails.

### Limits

- Each backup is stored for a maximum period of **1 month**
Expand Down