noobaa DB backup - design doc and API changes

Signed-off-by: Danny Zaken <[email protected]>

Author: dannyzaken

.gitignore

@@ -15,4 +15,7 @@ build-releases/
 # NooBaa config file
 noobaa.cfg.yaml
 
+# ignore any DS_Store file created by macos
+.DS_Store
+
 *.IGNORE

deploy/crds/noobaa.io_noobaas.yaml

@@ -1203,6 +1203,40 @@ spec:
               dbSpec:
                 description: DBSpec (optional) DB spec for a managed postgres cluster
                 properties:
+                  dbBackup:
+                    description: |-
+                      DBBackup (optional) configure automatic scheduled backups of the database volume.
+                      Currently, only volume snapshots are supported.
+                    properties:
+                      schedule:
+                        description: Schedule the schedule for the database backup
+                          in cron format.
+                        pattern: ^(@(annually|yearly|monthly|weekly|daily|hourly))|((((\d+,)+\d+|(\d+(\/|-)\d+)|\d+|\*)
+                          ?){5,7})$
+                        type: string
+                      volumeSnapshot:
+                        description: |-
+                          VolumeSnapshot the volume snapshot backup configuration.
+                          Currntly this is the only supported backup method and hence it is required.
+                        properties:
+                          maxSnapshots:
+                            description: MaxSnapshots the maximum number of snapshots
+                              to keep.
+                            minimum: 1
+                            type: integer
+                          volumeSnapshotClass:
+                            description: VolumeSnapshotClass the volume snapshot class
+                              for the database volume.
+                            minLength: 1
+                            type: string
+                        required:
+                        - maxSnapshots
+                        - volumeSnapshotClass
+                        type: object
+                    required:
+                    - schedule
+                    - volumeSnapshot
+                    type: object
                   dbConf:
                     additionalProperties:
                       type: string
@@ -1215,6 +1249,18 @@ spec:
                       Increasing the size of the volume is supported if the underlying storage class supports volume expansion.
                       The new size should be larger than actualVolumeSize in dbStatus for the volume to be resized.
                     type: string
+                  dbRecovery:
+                    description: DBRecovery (optional) configure database recovery
+                      from snapshot
+                    properties:
+                      volumeSnapshotName:
+                        description: VolumeSnapshotName specifies the name of the
+                          volume snapshot to recover from
+                        minLength: 1
+                        type: string
+                    required:
+                    - volumeSnapshotName
+                    type: object
                   dbResources:
                     description: DBResources (optional) overrides the default resource
                       requirements for the db container
@@ -1982,6 +2028,29 @@ spec:
                     description: ActualVolumeSize is the actual size of the postgres
                       cluster volume. This can be different than the requested size
                     type: string
+                  backupStatus:
+                    description: BackupStatus reports the status of database backups
+                    properties:
+                      availableSnapshots:
+                        description: AvailableSnapshots list of available snapshot
+                          names
+                        items:
+                          type: string
+                        type: array
+                      lastBackupTime:
+                        description: LastBackupTime timestamp of the last successful
+                          backup
+                        format: date-time
+                        type: string
+                      nextBackupTime:
+                        description: NextBackupTime timestamp of the next scheduled
+                          backup
+                        format: date-time
+                        type: string
+                      totalSnapshots:
+                        description: TotalSnapshots current number of snapshots
+                        type: integer
+                    type: object
                   currentPgMajorVersion:
                     description: CurrentPgMajorVersion is the major version of the
                       postgres cluster
@@ -1992,6 +2061,21 @@ spec:
                   dbCurrentImage:
                     description: DBCurrentImage is the image of the postgres cluster
                     type: string
+                  recoveryStatus:
+                    description: RecoveryStatus reports the status of database recovery
+                    properties:
+                      recoveryTime:
+                        description: RecoveryTime timestamp when recovery was initiated
+                        format: date-time
+                        type: string
+                      snapshotName:
+                        description: SnapshotName name of the snapshot being recovered
+                          from
+                        type: string
+                      status:
+                        description: Status current recovery status
+                        type: string
+                    type: object
                 type: object
               endpoints:
                 description: |-