Modifying the DatabaseBackup configuration on VMware

You can modify the DatabaseBackup configuration in the Management Cluster CR.

About this task

Modifying the DatabaseBackup configuration requires a reconfiguration of the database and a brief downtime.

Procedure

  1. Connect to the management subsystem using SSH:
    ssh ip_address -l apicadm
  2. Get necessary credentials:
    sudo -i
  3. Edit the management CR
    
    protocol: objstore
    databaseBackup:
    s3provider: ibm
    host: s3.eu-gb.cloud-object-storage.appdomain.cloud/eu-standard
    path: apic-backup
    credentials: mgmt-backup-secret
    schedule: "0 3 * * *"
    restartDB:
      accept: true
      
    Note:

    If you have an APIConnectCluster custom resource installed, do not modify the ManagementCluster CR. Instead, modify the APIConnectCluster CR.

    You can verify if you have an apiconnectcluster CR with the command

    $ kubectl get apiconnectcluster -n <your-namespace>
    
    • A new parameter restartDB is required when changing the backup configuration.
    • When accept is true and the new configuration differs, the Operator stops the database and any dependent services, applies the change, and restarts the stopped components.
    • restartDB is not required for initial deployments, only for modifications after the cluster is deployed.
    • Operator restarts the database with new backup configurations.
    • Operator creates an upgrade CR because postgres db is re-created as part of database backup configuration change.
    • The new upgrade CR goes to completed as soon postgres comes up.
    • For example:

      When you change database backup configurations after upgrading API Connect, the operator restarts all components related to the postgres database. The operator also creates an upgrade CR, and reaches the completed state as soon as all postgres database components, such as pgbouncer and the postgres database, are in Running state

      NAME                                                            STATUS     MESSAGE                                                    A
      GE
      managementdbupgrade.management.apiconnect.ibm.com/m1-up-g6lcb   Complete   Upgrade is Complete (DB Schema/data are up-to-date)        1
      6m
      managementdbupgrade.management.apiconnect.ibm.com/m1-up-zqkk5   Complete   Fresh install is Complete (DB Schema/data are up-to-date)