Persistent volume claims to be backed up

For different capabilities in IBM Cloud Pak® for Business Automation, there are different persistent volume claims that need to be backed up.

To see the different persistent volume claims (PVC) that you might need to back up in a IBM Cloud Pak for Business Automation environment, see the following tables:

IBM Automation Decision Services persistent volume claims

For an IBM Automation Decision Services environment, there are some persistent volume claims (PVC) that must be backed up. The following table shows the PVCs from the custom resource template, and whether they need to be backed up or replicated.
Table 1. IBM Automation Decision Services persistent volume claims to back up
Component Custom resource template persistent volume claim name Description Requires to be backed up or replicated
Automation Decision Services crname-ads-runtime-storage-pvc

Automation Decision Services runtime storage

This PVC must be backed up only when you use it. When you configure a S3 compatible storage, you must back up the S3 storage.

Yes
IBM Business Automation Studio   Business Automation Studio server storage No
Business Teams Service ibm-bts-cnpg-crname-cp4ba-bts-number Business Teams Service user data Yes

IBM Business Automation Workflow persistent volume claims

For a Business Automation Workflow environment, there are some persistent volume claims (PVC) that must be backed up. When Business Automation Workflow is deployed, IBM FileNet® Content Manager is also deployed. The following table shows the PVCs from the custom resource template, and whether they need to be backed up or replicated. If logs are required, back up the log-related PVCs,

Table 2. Business Automation Workflow persistent volume claims to back up
Component Custom resource template persistent volume claim name Description Needs to be backed up or replicated
Business Automation Workflow, Process Federation Server, Resource Registry icp4adeploy-bawins1-baw-logs-storage-pvc Logs for the following components:
  • init job
  • Java Message Service (JMS) server
  • Business Automation Workflow servers. Multiple Business Automation Workflow pods write logs here.
No
  icp4adeploy-bawins1-baw-dump-storage-pvc Java core heapdump for servers. Multiple Business Automation Workflow pods write dump files here. No
  icp4adeploy-bawins1-baw-file-storage-pvc Other generic files that are used by Business Automation Workflow servers. If you uploaded customization to the /opt/ibm/bawfile path, back up and restore this PVC definition and the PV content. See description.
  icp4adeploy-bawins1-baw-jms-data-vc-icp4adeploy-bawins1-baw-jms-0 Message store for JMS. The formula to build the PVC name is
<meta.name>-<baw_instance_name>-baw-jms-data-vc-<meta.name>-<baw_instance_name>-baw-jms-0
, where meta.name is the name of the Cloud Pak for Business Automation deployment and baw_instance_name is the name of the Business Automation Workflow instance. Both are found in the Cloud Pak for Business Automation CR.
Yes
  icp4adeploy-dba-rr-pvc Backup data file for Resource Registry No
  icp4adeploy-elasticsearch-snapshot-storage-pvc-data Backup data file for Elasticsearch No
  data-icp4adeploy-elasticsearch-statefulset-0 Index data for Elasticsearch No
  icp4adeploy-pfs-logs-pvc Log files for Process Federation Server. Multiple Process Federation Server pods write log files here. No
  icp4adeploy-workspace-aaeae-file-pvc Temporary files for the application engine No
Business Automation Studio icp4adeploy-bastudio-dump-pvc Business Automation Studio server Java core and heap dump files. No
  icp4adeploy-bastudio-files-pvc Business Automation Studio server generic files. If customizations were uploaded to the /opt/ibm/bawfile path, you should back up and restore this PVC definition and PV content. See description
  icp4adeploy-bastudio-index-pvc Business Automation Studio server search index files. No
  jms-pvc-icp4adeploy-bastudio-deployment-0 Business Automation Studio server JMS message store. Yes
Content Management Interoperability Services cmis-cfgstore Configuration files volume No
  cmis-logstore Logs. Multiple Content Management Interoperability Services pods write logs here. No
Content Platform Engine cpe-bootstrapstore For upgrading Content Platform Engine No
  cpe-cfgstore Liberty configuration files No
  cpe-filestore System-based advanced storage device or file store. Multiple Content Platform Engine pods write content here. Yes
  cpe-fnlogstore FileNet logs. Multiple Content Platform Engine pods write logs here. No
  cpe-icmrulesstore IBM Case Manager rules No
  cpe-logstore Liberty logs. Multiple Content Platform Engine pods write logs here. No
  cpe-textextstore Temporary working space No
GraphQL API graphql-cfgstore Configuration files No
  graphql-logstore Logs. Multiple GraphQL pods write logs here. No

IBM FileNet Content Manager persistent volume claims

For an IBM FileNet Content Manager environment, there are some persistent volume claims (PVC) that must be backed up. The following table shows the PVCs from the custom resource template, and whether they need to be backed up or replicated.

Table 3. IBM FileNet Content Manager persistent volume claims to back up
Component Custom resource template persistent volume claim name Description Needs to be backed up or replicated
Content Management Interoperability Services cmis-cfgstore Configuration files volume No
  cmis-logstore Log volume No
Content Platform Engine cpe-bootstrapstore For upgrading Content Platform Engine No
  cpe-cfgstore Configuration files No
  cpe-filestore Advanced storage volume Yes
  cpe-fnlogstore FileNet log volume No
  cpe-icmrulesstore IBM Case Manager rules No
  cpe-logstore Liberty log No
  cpe-textextstore Text extraction No
Content Search Services css-cfgstore Configuration files No
  css-tempstore Temporary extraction No
  css-logstore Log No
  css-customstore Custom configuration No
  css-indexstore Index Yes
GraphQL API graphql-cfgstore Configuration files No
  graphql-logstore Liberty log No

IBM Automation Document Processing persistent volume claims

For an IBM Automation Document Processing environment, there are some persistent volume claims (PVC) that must be backed up. The following table shows the PVCs from the custom resource template, and whether they need to be backed up or replicated.

Table 4. IBM Automation Document Processing persistent volume claims to back up
Component Custom resource template persistent volume claim name Description Needs to be backed up or replicated
Document Processing cdra-cfgstore Document Processing Repository API Configuration files No
  cdra-datastore Document Processing Repository API data volume No
  cdra-logstore Document Processing Repository API log store No
  cds-logstore Document Processing Designer service log store No
  cpds-cfgstore Document Processing Deployment Service configuration store No
  cpds-logstore Document Processing Deployment Service log store No
Content Platform Engine cpe-bootstrapstore For upgrading Content Platform Engine No
  cpe-cfgstore Liberty configuration files No
  cpe-filestore System-based advanced storage device or file store. Multiple Content Platform Engine pods write content here. Yes
  cpe-fnlogstore FileNet logs. Multiple Content Platform Engine pods write logs here. No
  cpe-icmrulesstore IBM Case Manager rules No
  cpe-logstore Liberty logs. Multiple Content Platform Engine pods write logs here. No
  cpe-textextstore Temporary working space No
  gitgateway-cfgstore Configuration files volume No
  gitgateway-datastore Gitgateway data volume No
  gitgateway-logstore Gitgateway log volume No
GraphQL API graphql-cfgstore Configuration files No
  graphql-logstore Logs. Multiple GraphQL pods write logs here. No
  ibm-bts-cnpg-crname-cp4ba-bts-number Business Teams Service user data Yes
  ibm-zen-cs-mongo-backup mongo backup Yes
  ibm-zen-objectstore-backup-pvc objectstore backup Yes
IBM Business Automation Navigator icn-asperastore IBM Business Automation Navigator storage for Aspera. No
  icn-cfgstore Business Automation Navigator Liberty configuration. Yes
  icn-logstore Liberty and Business Automation Navigator logs. Multiple IBM Content Navigator pods write logs here. No
  icn-pluginstore Business Automation Navigator custom plug-ins. No
  icn-vw-cachestore Business Automation Navigator storage for the Daeja ViewONE cache. No
  icn-vw-logstore Business Automation Navigator viewer logs for the Daeja ViewONE. No
Business Automation Studio icp4adeploy-bastudio-dump-pvc Business Automation Studio server Java core and heap dump files. No
  icp4adeploy-bastudio-files-pvc Business Automation Studio server generic files. If customizations were uploaded to the /opt/ibm/bawfile path, you should back up and restore this PVC definition and PV content. See description
  icp4adeploy-bastudio-index-pvc Business Automation Studio server search index files. No
  -jms-pvc-icp4adeploy-bastudio-deployment-0 Business Automation Studio server JMS message store. Yes
  icp4adeploy-dba-rr-pvc Backup data file for Resource Registry No
  icp4adeploy-pbkae-file-pvc Temporary files for application engine No
  icp4adeploy-workspace-aaeae-file-pvc Temporary files for the application engine No
  mongo-datastore Data volume for mongo Yes
  viewone-cacherootstore ViewONE cache store No
  viewone-configstore Configuration files for ViewONE No
  viewone-customerfontsstore ViewONE font filestore No
  viewone-docrepositoryrootstore ViewONE document store No
  viewone-externalresourcepathstore ViewONE extstore No
  viewone-logsstore ViewONE logstore Yes
  viewone-workingpathstore ViewONE workstore No
  zen-metastore-edb-1 Zen EDB stores all the data No
  operator-shared-pvc JDBC drivers No
  cp4a-shared-log-pvc PVC created for storing logs No