Persistent Volumes and Persistent Volumes Claims values

This topic shows the settings of the Persistent Volumes (PV) and Persistent Volumes Claims (PVCs) for hcl-devopsplan, full text search, and elasticsearch.

By default, DevOps Plan helm chart sets the persistent volume. If your Kubernetes environment does not provide for default StorageClass, then you must create your own default StorageClass and set the StorageClass name to persistence.storageClass or set persistence.enabled=false

The below table shows the settings of the Persistent Volumes (PV), Persistent Volumes Claims (PVCs), and Storage Class parameters and default value settings. You can update these values based on your requirement.

Table 1. hcl-devopsplan pod: data, config, share, and logs folders
Parameter	Description	Default value
persistence.enabled	This parameter enables persistence volume claim for DevOps Plan. This parameter is required if you plan to enable or disable the persistence volume forDevOps Plan. Accepted values are: `True`: enables the persistence volume for DevOps Plan. `False`: disables the persistence volume for DevOps Plan.	true
persistence.ccm.enabled	This parameter enables persistence volume claim for the hcl-devopsplan pod container. This parameter is required if you plan to enable or disable the persistence volume for the DevOps Plan pod container folder. Accepted values are: `True`: enables the persistence volume for the DevOps Plan pod container folder. `False`: disables the persistence volume for the DevOps Plan pod container folder.	true
persistence.ccm.data.enabled	This parameter enables persistence volume claim for the hcl-devopsplan pod container data folder. This parameter is required if you plan to enable or disable the persistence volume for DevOps Plan data folders. Accepted values are: `True`: enables the persistence volume for DevOps Plan data folders. `False`: disables the persistence volume for DevOps Plan data folders.	true
persistence.ccm.data.accessModes	Persistence Volume access mdoes. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	ReadWriteOnce
persistence.ccm.data.size	Persistence Volume size. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	2Gi
persistence.ccm.data.reclaimPolicy	Persistence Volume reclaim policy. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	Retain
persistence.ccm.data.existingClaim	Persistence Volume existing claim. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	""
persistence.ccm.config.enabled	This parameter enables persistence volume claim for the hcl-devopsplan pod container config folder. This parameter is required if you plan to enable or disable the persistence volume for DevOps Plan config folders. Accepted values are: `True`: enables the persistence volume for DevOps Plan config folders. `False`: disables the persistence volume for DevOps Plan config folders.	true
persistence.ccm.config.accessModes	Persistence Volume access mdoes. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	ReadWriteOnce
persistence.ccm.config.size	Persistence Volume size. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	2Gi
persistence.ccm.config.reclaimPolicy	Persistence Volume reclaim policy. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	Retain
persistence.ccm.config.existingClaim	Persistence Volume existing claim. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	""
persistence.ccm.logs.enabled	This parameter enables persistence volume claim for the hcl-devopsplan pod container logs folder. This parameter is required if you plan to enable or disable the persistence volume for DevOps Plan logs folders. Accepted values are: `True`: enables the persistence volume for DevOps Plan logs folders. `False`: disables the persistence volume for DevOps Plan logs folders.	true
persistence.ccm.logs.accessModes	Persistence Volume access modes. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	ReadWriteOnce
persistence.ccm.logs.size	Persistence Volume existing size. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	2Gi
persistence.ccm.logs.reclaimPolicy	Persistence Volume reclaim policy. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	Retain
persistence.ccm.logs.existingClaim	Persistence Volume existing claim. This parameter is required if `persistence.enabled=true` and `persistence.ccm.enabled=true`.	""
persistence.annotations	If defined, sets the annotations for PVC. This parameter is required if `persistence.enabled=true`.	""
persistence.properties.application.enabled	This parameter enables the applicaion.properties configmap. If set to true, it will update the values of the application.properties file based on the settings in the hcl-devopsplan/config/application.properties file. Accepted values are: `True`: enables the application.properties configmap and updating the application.properties file values based on the settings in the hcl-devopsplan/config/application.properties file. `False`: disables the application.properties configmap	false
persistence.properties.analytics.enabled	This parameter enables the analytics.properties configmap. If set to true, it will update the values of the analytics.properties file based on the settings in the hcl-devopsplan/config/analytics.properties file. Accepted values are: `True`: enables the analytics.properties configmap and updating the analytics.properties file values based on the settings in the hcl-devopsplan/config/analytics.properties file. `False`: disables the analytics.properties configmap	false

Table 2. hcl-devopsplan analytics pod: data, config, share, and logs folders
Parameter	Description	Default value
persistence.analytics.enabled	This parameter enables persistence.analytics volume claim. This parameter is required if you plan to enable or disable the persistence.analytics volume. Accepted values are: `True`: enables the persistence.analytics volume. `False`: disables the persistence.analytics volume.	true
persistence.analytics.data.enabled	This parameter enables persistence.analytics volume claim for the analytics server container data folder. This parameter is required if you plan to enable or disable the persistence.analytics volume for the analytics server data folders. Accepted values are: `True`: enables the persistence.analytics volume for the analytics server data folders. `False`: disables the persistence.analytics volume for the analytics server data folders.	true
persistence.analytics.data.accessModes	persistence.analytics Volume access modes. This parameter is required if `persistence.analytics.enabled=true`.	ReadWriteOnce
persistence.analytics.data.size	persistence.analytics Volume size. This parameter is required if `persistence.analytics.enabled=true`.	2Gi
persistence.analytics.data.reclaimPolicy	persistence.analytics Volume reclaim policy. This parameter is required if `persistence.analytics.enabled=true`.	Retain
persistence.analytics.data.existingClaim	persistence.analytics Volume existing claim. This parameter is required if `persistence.analytics.enabled=true`.	""
persistence.analytics.config.enabled	This parameter enables persistence.analytics volume claim for the analytics server container config folder. This parameter is required if you plan to enable or disable the persistence.analytics volume for the analytics server container config folder. Accepted values are: `True`: enables the persistence.analytics volume for the analytics server container config folder. `False`: disables the persistence.analytics volume for the analytics server container config folder.	true
persistence.analytics.config.accessModes	persistence.analytics Volume access modes. This parameter is required if `persistence.analytics.enabled=true`.	ReadWriteOnce
persistence.analytics.config.size	persistence.analytics Volume size. This parameter is required if `persistence.analytics.enabled=true`.	2Gi
persistence.analytics.config.reclaimPolicy	persistence.analytics Volume reclaim policy. This parameter is required if `persistence.analytics.enabled=true`.	Retain
persistence.analytics.config.existingClaim	persistence.analytics Volume existing claim. This parameter is required if `persistence.analytics.enabled=true`.	""
persistence.analytics.logs.enabled	This parameter enables persistence.analytics volume claim for the analytics server container logs folder. This parameter is required if you plan to enable or disable the persistence.analytics volume for the analytics server container logs folder. Accepted values are: `True`: enables the persistence.analytics volume for the analytics server container logs folder. `False`: disables the persistence.analytics volume for the analytics server container logs folder.	true
persistence.analytics.logs.accessModes	persistence.analytics Volume access modes. This parameter is required if `persistence.analytics.enabled=true`.	ReadWriteOnce
persistence.analytics.logs.size	persistence.analytics Volume size. This parameter is required if `persistence.analytics.enabled=true`.	2Gi
persistence.analytics.logs.reclaimPolicy	persistence.analytics Volume reclaim policy. This parameter is required if `persistence.analytics.enabled=true`.	Retain
persistence.analytics.logs.existingClaim	persistence.analytics Volume existing claim. This parameter is required if `persistence.analytics.enabled=true`.	""

Table 3. hcl-devopsplan postgresql pod: data folder
Parameter	Description	Default value
persistence.postgreql.enabled	This parameter enables persistence.postgresql volume claim for the postgresql data folder. This parameter is required if you plan to enable or disable the persistence.postgresql volume for the postgresql data folder. Accepted values are: `True`: enables the persistence.postgreql volume for the postgresql data folder. `False`: disables the persistence.postgreql volume for the postgresql data folder.	true
persistence.postgresql.accessModes	persistence.postgresql Volume access modes. This parameter is required if `persistence.postgresql.enabled=true`.	ReadWriteOnce
persistence.postgresql.size	persistence.postgresql Volume size. This parameter is required if `persistence.postgresql.enabled=true`.	2Gi
persistence.postgresql.reclaimPolicy	persistence.postgresql Volume reclaim policy. This parameter is required if `persistence.postgresql.enabled=true`.	Retain
persistence.postgresql.existingClaim	persistence.postgresql Volume existing claim. This parameter is required if `persistence.postgresql.enabled=true`.	""

Table 4. hcl-devopsplan opensearch pod: data folder
Parameter	Description	Default value
persistence.opensearch.enabled	This parameter enables persistence volume claim for the opensearch pod data folder. This parameter is required if you plan to enable or disable the persistence volume for the opensearch folder. Accepted values are: `True`: enables the persistence volume for the opensearch data folder. `False`: disables the persistence volume for the opensearch data folder.	true
persistence.opensearch.accessModes	Persistence Volume access modes. This parameter is required if `persistence.enabled=true`.	ReadWriteOnce
persistence.opensearch.size	Persistence Volume Volume size. This parameter is required if `persistence.enabled=true`.	2Gi
persistence.opensearch.reclaimPolicy	Persistence Volume Volume reclaim policy. This parameter is required if `persistence.enabled=true`.	Retain
persistence.opensearch.existingClaim	Persistence Volume Volume existing claim. This parameter is required if `persistence.enabled=true`.	""

Table 5. hcl-devopsplan keycloak pod: data folder
Parameter	Description	Default value
persistence.keycloak.enabled	This parameter enables persistence volume claim for the keycloak pod container data folder. This parameter is required if you plan to enable or disable the persistence volume for the keycloak data folder. Accepted values are: `True`: enables the persistence volume for the keycloak data folder. `False`: disables the persistence volume for the keycloak data folder.	true
persistence.keycloak.accessModes	Persistence Volume access modes. This parameter is required if `persistence.enabled=true`.	ReadWriteOnce
persistence.keycloak.size	Persistence Volume size. This parameter is required if `persistence.enabled=true`.	2Gi
persistence.keycloak.reclaimPolicy	Persistence Volume reclaim policy. This parameter is required if `persistence.enabled=true`.	Retain
persistence.keycloak.existingClaim	Persistence Volume existing claim. This parameter is required if `persistence.enabled=true`.	""

Table 6. Storage Class parameters
Parameter	Description	Default value
persistence.storageClass	If defined, sets the global storageClassName. This parameter is required if `persistence.enabled=true` and Storage Class will be used.	""
persistence.ccm.storageClass	Sets the storageClassName for the devopsplan pods. This paraeter is required if the defauly storage class does not support the ReadWriteMany (RWX) accessMode.	ibmc-file-gold-gid
persistence.analytics.storageClass	Sets the storageClassName for the devopsplan-analytics PVC	""
persistence.postgresql.storageClass	Sets the storageClassName for the devopsplan-postgresql PVC	""
persistence.opensearch.storageClass	Sets the storageClassName for the devopsplan-opensearch PVC	""
persistence.keycloak.storageClass	Sets the storageClassName for the devopsplan-keycloak PVC	""