Persistent Volume (PV) requirements

Review the persistent volumes (PVs) required by your API Connect installation.

The PV requirements for API Connect subsystems vary according to the number of subsystem nodes that are deployed, whether you are using two datacenter disaster recovery (2DCDR) Two data center warm-standby deployment on Kubernetes and OpenShift, and other subsystem specific options.

Management subsystem

Management subsystem PV requirements depend on what database backup configuration is used, and if the API discovery feature is enabled.
Table 1. Management PV requirements
Deployment profile Database backup Discovery enabled Number of PVs required
Single replica (n1) local yes 4
Three replica (n3) local yes 12
Single replica (n1) local no 3
Three replica (n3) local no 9
Single replica (n1) sftp yes 4
Three replica (n3) sftp yes 12
Single replica (n1) sftp no 3
Three replica (n3) sftp no 9
Single replica (n1) object-store yes 3
Three replica (n3) object-store yes 9
Single replica (n1) object-store no 2
Three replica (n3) object-store no 6

Gateway subsystem

Only required where tokenManagementService is enabled:

  tokenManagementService:
    enabled: true
    storage:
      storageClassName: $STORAGE_CLASS
      volumeSize: 30Gi

Portal subsystem

Table 2. Portal PV requirements
Deployment profile Number of PVs required
Single node (n1), one datacenter 6
Three nodes (n3), one datacenter 18
Single node (n1), two datacenter 9 per datacenter
Three nodes (n3), two datacenter 27 per datacenter
Single node (n1), two datacenter, where other datacenter is three node (n3) 13 in n1 datacenter, 23 in n3 datacenter
Three node (n3), two datacenter, where other datacenter is single node (n1) 30 in n3 datacenter, 15 in n1 datacenter
The amount of persistent storage space that is used by the developer portal depends on the following factors:
  • The number of portal sites you create. Each portal site uses space in the webVolumeClaimTemplate and databaseVolumeClaimTemplate PVCs. 3 backups of each portal site are stored in the backupVolumeClaimTemplate PVC.
  • The content that you add to your portal sites, such as custom images and documents that you attach to your sites.
  • If debugging tools such as Drupal logs are enabled.
Note: In Openshift disk performance increases with disk size, for example, a 200 Gi PVC has better performance than a 30 Gi PVC. It is recommended that the databaseVolumeClaimTemplate is kept above 200 Gi to avoid performance issues.

Analytics subsystem

The number of PVs needed depends on if you disable local storage, and if you have backups that are configured .
Table 3. Analytics PV requirements
Deployment profile Local storage disabled (ingestion only) Local storage enabled Local storage and backups enabled
Single node (n1) 1 2 3
Three node (n3) 3 6 9
To understand how much storage capacity your analytics subsystem needs, see Estimating storage requirements.