Backing up data from your storage system by using IBM Storage Fusion recipes

Do the following steps to back up data from the storage system:

1. Configure general backup and restore from the IBM Storage Fusion user interface.
   1. Create a backup storage location to store the backup data.
      This location can be any s3 compatible storage or Microsoft Azure Blob storage.
2. Configure Cloud Pak for Business Automation and IBM Fusion specific backup and restore.
   1. Export the Cloud Pak for Business Automation namespace to the NAMESPACE variable.
      Example:

      export NAMESPACE=<namespace>

   2. Apply the labels to select the resources in the recipe.
      1. Open the downloaded cert-kubernetes package and change the directory to the FusionRecipes folder.
      2. Verify that you are in the Fusion Recipes folder by issuing a pwd command that must have a path cert-kubernetes/FusionRecipes
      3. Go to the namespace for the operator.

         oc project ${NAMESPACE}

      4. If IBM Business Automation Workflow is installed, update the Cloud Pak for Business Automation namespace in the labels_baw_template.sh script by running the following commands:

         awk -v CP4BA_NAMESPACE="$NAMESPACE" '{gsub(/\$REPLACE_NAMESPACE/, CP4BA_NAMESPACE)}1' scripts/labels_baw_template.sh > scripts/labels_baw.sh 

         chmod +x ./scripts/labels_baw.sh

         ./scripts/labels_baw.sh

         If FileNet Content Manager is installed, you can run the labels_fncm.sh script directly.

         ./scripts/labels_fncm.sh

         From 24.0.0-IF006 If Automation Decision Services is installed, you can run the labels_ads.sh script directly.

         ./scripts/labels_ads.sh

         From 24.0.0-IF006 If Operational Decision Manager is installed, you can run the labels_odm.sh script directly.

         ./scripts/labels_odm.sh

   3. Update the cluster role in the transaction-manager-ibm-backup-restore so you can check the custom resource, such as Ready status. This step is needed during a restore on the target cluster (that is, when you do a restore).
      If Business Automation Workflow, Automation Decision Services, or Operational Decision Manager is installed, run the following command.

      oc get clusterrole transaction-manager-ibm-backup-restore -o json | jq '.rules += [{"verbs":["get","list"],"apiGroups":["icp4a.ibm.com"],"resources":["icp4aclusters"]}]' | oc apply -f -

      If FileNet Content Manager is installed, run the following command.

      oc get clusterrole transaction-manager-ibm-backup-restore -o json | jq '.rules += [{"verbs":["get","list"],"apiGroups":["icp4a.ibm.com"],"resources":["contents"]}]' | oc apply -f -

   4. Edit the Fusion application to include these namespaces under the includedNamespaces: openshift-config, openshift-marketplace

      oc edit fapp $NAMESPACE -n ibm-spectrum-fusion-ns

      spec:
        enableDR: false
        includedNamespaces:
        - <NAMESPACE>
        - openshift-marketplace
        - openshift-config

   5. Create the resources for the Zen service backup.
      Get the storage classes to update in yamls/zen/zen5-backup-pvc.yaml.

      oc get sc

      Update the storage class in yamls/zen/zen5-backup-pvc.yaml.
      Replace all instances of namespace with the correct <zenservice namespace> in the following yaml files:

      • zen5-backup-deployment.yaml
      • zen5-backup-pvc.yaml
      • zen5-br-scripts-cm.yaml
      • zen5-role.yaml
      • zen5-rolebinding.yaml
      • zen5-sa.yaml
      Replace <zenservice name> with the correct service name in zen5-backup-deployment.yaml.
      From 24.0.0-IF007Set the ZenService namespace and service name by replacing <zenservice namespace> and <zenservice name> in the YAML files and apply all required zen resources by running the following command:

      ./apply-zen-files.sh $NAMESPACE <zenservice-name>

   6. Run the script to update the labels in the recipe if you updated the database name during installation. Example, db-name=${ICN_DB_NAME}, db-name={BAW_DB_NAME}, db-name={BAS_DB_NAME}.

      chmod +x ./scripts/update_labels.sh

      Go to the namespace for the operator.

      oc project ${NAMESPACE}

      ./scripts/update_labels.sh

   7. Update the Cloud Pak for Business Automation namespace in the following recipes and then apply.
      Important: If you want to use the PostgreSQL based common services recipes, use -v1.
      If FileNet Content Manager is installed, run the following commands:

      awk -v CP4BA_NAMESPACE="$NAMESPACE" '{gsub(/\$REPLACE_NAMESPACE/, CP4BA_NAMESPACE)}1' cp4ba-fncm-backup-restore-template.yaml > cp4ba-fncm-backup-restore.yaml

      oc apply -f cp4ba-fncm-backup-restore.yaml

      If Business Automation Workflow Authoring is installed, run the following commands:

      awk -v CP4BA_NAMESPACE="$NAMESPACE" '{gsub(/\$REPLACE_NAMESPACE/, CP4BA_NAMESPACE)}1' cp4ba-baw-authorize-backup-restore-template.yaml > cp4ba-baw-authorize-backup-restore.yaml

      oc apply -f cp4ba-baw-authorize-backup-restore.yaml 

      If Business Automation Workflow Runtime is installed, run the following commands:

      awk -v CP4BA_NAMESPACE="$NAMESPACE" '{gsub(/\$REPLACE_NAMESPACE/, CP4BA_NAMESPACE)}1' cp4ba-baw-runtime-backup-restore-template.yaml > cp4ba-baw-runtime-backup-restore.yaml

      oc apply -f cp4ba-baw-runtime-backup-restore.yaml 

      From 24.0.0-IF006 If Automation Decision Services is installed, run the following commands:

      awk -v CP4BA_NAMESPACE="$NAMESPACE" '{gsub(/\$REPLACE_NAMESPACE/, CP4BA_NAMESPACE)}1' cp4ba-ads-backup-restore-template.yaml > cp4ba-ads-backup-restore.yaml

      oc apply -f cp4ba-ads-backup-restore.yaml

      From 24.0.0-IF006 If Operational Decision Manager is installed, run the following commands:

      awk -v CP4BA_NAMESPACE="$NAMESPACE" '{gsub(/\$REPLACE_NAMESPACE/, CP4BA_NAMESPACE)}1' cp4ba-odm-backup-restore-template.yaml > cp4ba-odm-backup-restore.yaml

      oc apply -f cp4ba-odm-backup-restore.yaml

   8. Create a backup policy by using the Fusion user interface (UI) or the command-line interface (CLI). However, the result is the same if you use either Fusion UI or CLI to create the backup policy.
      This policy defines:

      • The frequency of the backup that shows how often it runs.
      • Retention that shows how long backups are kept.
      • Location of the backups that shows the backup storage location that is configured in the previous step.
      From the Fusion UI: See Create a backup policy.
      From the CLI:
      • Get the Fusion <POLICY_NAME> <FBSL_NAME> <RETENTION_PERIOD> <RETENTION_UNIT>

        oc get fbp -A 

      • Get the Fusion backup storage location.

        oc get fbsl -n ibm-spectrum-fusion-ns

      • Run the following script:

        /scripts/setup/fbackup_policy.sh <POLICY_NAME> <FBSL_NAME> <RETENTION_PERIOD> <RETENTION_UNIT> <CRON_EXPRESSION> <TIMEZONE>

        Example:

        ./scripts/setup/fbackup_policy.sh baw-runtime-policy my-bucket 10 days "00 0 1 * *" UTC

   9. Assign a backup policy to the Cloud Pak for Business Automation application from the Fusion UI and verify it.
      Note: Cloud Pak for Business Automation is installed in the $NAMESPACE namespace. So, $NAMESPACE is the application that needs to be protected.
      From the Fusion UI, click Back up and restore > Backed up applications > Protect apps > Select a cluster > Select application > Next > Select a backup policy > Assign.
      Optional: From the CLI, check whether the policy assignment is created.

      oc get fpa -A

   10. Patch the recipes for FileNet Content Manager, Business Automation Workflow Authoring, Business Automation Workflow Runtime, Automation Decision Services, or Operational Decision Manager. Example:

       oc -n ibm-spectrum-fusion-ns patch policyassignment baw-authoring-baw-authoring-policy-apps.ocp4xdcd.cp.fyre.ibm.com --type merge -p '{"spec":{"recipe":{"name":"cp4ba-baw-authorize-backup-restore-recipe", "namespace":"ibm-spectrum-fusion-ns"}}}'

   11. Update the policy assignment from the CLI.
       1. Get the Fusion <POLICY_ASSIGNMENT_NAME> <APPLICATION> <BACKUP_POLICY> <FBSL_NAME> <RECIPE_NAME>

          oc get fpa -A

       2. Create the backup policy assignment with the custom recipe. /scripts/setup/fbackuppolicy_assignment.sh <POLICY_ASSIGNMENT_NAME> <APPLICATION> <BACKUP_POLICY> <FBSL_NAME> <RECIPE_NAME>
          Example:

          ./scripts/setup/fbackuppolicy_assignment.sh baw-runtime-fpa baw-runtime baw-runtime-policy my-bucket cp4ba-baw-runtime-backup-restore-recipe 

   12. Initiate a backup from the Fusion UI by clicking Back up and restore > Backed up applications. From the list, select the application and click Actions > Backup now.