Periodic Tungsten Fabric database backups

MOSK enables you to perform the automatic TF data backup in the JSON format using the tf-dbbackup-job cron job. By default, it is disabled.

Warning

Use the tf-dbbackup-job cron job only if your cluster is not affected by issue 53831. The issue causes some container images silently truncate any Cassandra column family that has more than 5000 rows during export, without any error or warning, which can drop real user data. Until the cluster is updated to a release that includes the fix, use the manual backup procedure in Manually back up TF data in the JSON format instead, which includes a hot fix that prevents the truncation.

To verify whether your container image is affected:

Inside the api container of the tf-config pod, change the directory to the Python config management packages:
- Since MOSK 25.1:
```
cd /usr/lib/python3.6/site-packages/cfgm_common
```
- Before MOSK 25.1:
```
cd /usr/lib/python2.7/site-packages/cfgm_common
```
Verify whether db_json_exim.py contains the affected code:
```
grep -n "current_rows" db_json_exim.py
```

If the output contains the line range = session.execute(cql).current_rows, the container image is affected.

To back up the TF databases, enable tf-dbBackup in the TF Operator custom resource:

API v2 Available since MOSK 24.1

spec:
  features:
     dbBackup:
        enabled: true

API v1alpha1 Removed in MOSK 25.1

spec:
  controllers:
    tf-dbBackup:
      enabled: true

By default, the tf-dbbackup-job job is scheduled for weekly execution, allocating PVC of 5 Gi size for storing backups and keeping 5 previous backups. To configure the backup parameters according to the needs of your cluster, use the following structure:

API v2 Available since MOSK 24.1

spec:
  features:
     dbBackup:
        enabled: true
        dataCapacity: 30Gi
        schedule: "0 0 13 * 5"
        storedBackups: 10

API v1alpha1 Removed in MOSK 25.1

spec:
  controllers:
    tf-dbBackup:
      enabled: true
      dataCapacity: 30Gi
      schedule: "0 0 13 * 5"
      storedBackups: 10

To temporarily disable tf-dbbackup-job, suspend the job:

API v2 Available since MOSK 24.1

spec:
  features:
     dbBackup:
        enabled: true
        suspend: true

API v1alpha1 Removed in MOSK 25.1

spec:
  controllers:
    tf-dbBackup:
      enabled: true
      suspend: true

To delete the tf-dbbackup-job job, disable tf-dbBackup in the TF Operator custom resource:

API v2 Available since MOSK 24.1

spec:
  features:
     dbBackup:
        enabled: false

API v1alpha1 Removed in MOSK 25.1

spec:
  controllers:
    tf-dbBackup:
      enabled: false