Skip to content

Commit

Permalink
added example
Browse files Browse the repository at this point in the history
  • Loading branch information
mueckinger committed Jan 6, 2024
1 parent f583daf commit 4eaeb66
Showing 1 changed file with 37 additions and 2 deletions.
39 changes: 37 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This chart installs `rustic backup` as [Kubernetes CronJob](https://kubernetes.i
hostname: <myHost>

rustic:
encryption_secret: <encryptionSecret>
encryption_secret: <myEncryptionSecret>
backup_volume:
hostPath:
path: /path/to/backupfolder
Expand Down Expand Up @@ -50,4 +50,39 @@ If there is already an initialized restic repository in the Bucket omit `--set r
helm install rustic rustic/rustic -f values.yml
```

### Examples
### Examples

```yaml
cronjob:
schedule: "0 3 * * *" # Use standard cron syntax here

hostname: <myHost>

rustic:
encryption_secret: <myEncryptionSecret>
backup_volume:
hostPath:
path: /path/to/backupfolder

# Persisting the cache locally improves backup speed an minimizes expensive data transfer from the bucket. If not, rustic has to pull the metadata from the (hot) repository on each backup run.
persistence:
hostPath:
path: /path/to/cachefolder

# One of rustic's greatest features is that you can use it with cold or "glacier" storage. Therefore you need to define two buckets/repositories. The `repo_hot` only holds the backend's metadata like config, keys, snapshots, index and tree blobs, which are required for browsing and managing the repo. This part is quite small. The `repo` holds the full repository including data and metadata.
s3:
repo:
endpoint: s3.fr-par.scw.cloud
access_key_id: <myS3AccessKeyID>
secret_access_key: <mySecretS3AccessKey>
region: fr-par
storage_class: GLACIER # Replace with your provider's cold and cheap storage class
bucket: <myColdBucket>
repo_hot:
endpoint: s3.fr-par.scw.cloud
access_key_id: <myS3AccessKeyID>
secret_access_key: <mySecretS3AccessKey>
region: fr-par
storage_class: ONEZONE_IA # Replace with your provider's hot storage class
bucket: <myHotBucket>
```

0 comments on commit 4eaeb66

Please sign in to comment.