Backups

Backups are enabled by default. The keycloak instance will be backed up daily at a randomly chosen time between 22:00 and 4:00.

You can specify a different backup time and interval using the following backup configuration:

apiVersion: vshn.appcat.vshn.io/v1
kind: VSHNKeycloak
metadata:
  name: keycloak-app1-prod
  namespace: <your-namespace>
spec:
  parameters:
    ...
    backup:
      schedule: 0 22 * * * (1)
    ...
1 The schedules for your backups.

Retention

A Keycloak instance has two independent backup components: the Keycloak application (via K8up) and the backing PostgreSQL database (via Barman Cloud).

Keycloak application backup retention defaults to 6 daily backups. To change it, configure the backup.retention field:

apiVersion: vshn.appcat.vshn.io/v1
kind: VSHNKeycloak
metadata:
  name: keycloak-app1-prod
  namespace: <your-namespace>
spec:
  parameters:
    ...
    backup:
      retention:
        keepDaily: 14 (1)
    ...
1 Number of daily backups to retain (default: 6). Additional retention options are keepLast, keepHourly, keepWeekly, keepMonthly, and keepYearly.

PostgreSQL backup retention defaults to 6 days. To change it, configure the postgreSQLParameters.backup.retention field:

apiVersion: vshn.appcat.vshn.io/v1
kind: VSHNKeycloak
metadata:
  name: keycloak-app1-prod
  namespace: <your-namespace>
spec:
  parameters:
    ...
    postgreSQLParameters:
      backup:
        retention: 14 (1)
    ...
1 Number of days to retain PostgreSQL backups (default: 6).

Disable Backups

To disable backups, set the backup.enabled field to false for both the Keycloak instance and the PostgreSQL database:

apiVersion: vshn.appcat.vshn.io/v1
kind: VSHNKeycloak
metadata:
  name: keycloak-app1-prod
  namespace: <your-namespace>
spec:
  parameters:
    ...
    backup:
      enabled: false
    postgreSQLParameters:
      backup:
        enabled: false
    ...

If backups were previously enabled, existing backups will be retained until their retention period expires.

Disabling backups is meant for test instances only. It is not recommended to disable backups for production instances.