Persistent Volumes and Persistent Volumes Claims values

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

By default, HCL Compass helm charts are set to persist the data configuration files to the following mounted folders:
  • hcl-compass data, config, and logs folders.
  • hcl-compass search configuration and data folders.
  • hcl-compass elasticsearch data folder.
The below table shows the settings of the Persistent Volumes (PV) and Persistent Volumes Claims (PVCs) for hcl-compass, full text search, and elasticsearch.
Table 1. PV and PVCs Values Chart
Parameter Description Default value
persistence.enabled This parameter enables persistence volume claim for HCL Compass. This parameter is required if you plan to enable or disable the persistence volume forHCL Compass. Accepted values are:
  • True: enables the persistence volume for HCL Compass.
  • False: disables the persistence volume for HCL Compass.
 true
persistence.compass.enabled This parameter enables persistence volume claim for the hcl-compass pod container. This parameter is required if you plan to enable or disable the persistence volume for the HCL Compass pod container folder. Accepted values are:
  • True: enables the persistence volume for the HCL Compass pod container folder.
  • False: disables the persistence volume for the HCL Compass pod container folder.
 true
persistence.compass.data.enabled This parameter enables persistence volume claim for the hcl-compass pod container data folder. This parameter is required if you plan to enable or disable the persistence volume for HCL Compass data folders. Accepted values are:
  • True: enables the persistence volume for HCL Compass data folders.
  • False: disables the persistence volume for HCL Compass data folders.
 true
persistence.compass.data.accessModes Persistence Volume access mdoes. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ReadWriteOnce
persistence.compass.data.size Persistence Volume size. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true.

2Gi
persistence.compass.data.reclaimPolicy Persistence Volume reclaim policy. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. Retain
persistence.compass.data.existingClaim Persistence Volume existing claim. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ""
persistence.compass.config.enabled This parameter enables persistence volume claim for the hcl-compass pod container config folder. This parameter is required if you plan to enable or disable the persistence volume for HCL Compass config folders. Accepted values are:
  • True: enables the persistence volume for HCL Compass config folders.
  • False: disables the persistence volume for HCL Compass config folders.
 true
persistence.compass.config.accessModes Persistence Volume access mdoes. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ReadWriteOnce
persistence.compass.config.size Persistence Volume size. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. 2Gi
persistence.compass.config.reclaimPolicy Persistence Volume reclaim policy. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. Retain
persistence.compass.config.existingClaim Persistence Volume existing claim. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ""
persistence.compass.logs.enabled This parameter enables persistence volume claim for the hcl-compass pod container logs folder. This parameter is required if you plan to enable or disable the persistence volume for HCL Compass logs folders. Accepted values are:
  • True: enables the persistence volume for HCL Compass logs folders.
  • False: disables the persistence volume for HCL Compass logs folders.
 true
persistence.compass.logs.accessModes Persistence Volume access modes. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ReadWriteOnce
persistence.compass.logs.size Persistence Volume existing size. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. 2Gi
persistence.compass.logs.reclaimPolicy Persistence Volume reclaim policy. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. Retain
persistence.compass.logs.existingClaim Persistence Volume existing claim. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ""
persistence.search.enabled This parameter enables persistence volume claim for the hcl-compass pod container search folder. This parameter is required if you plan to enable or disable the persistence volume for HCL Compass search folders. Accepted values are:
  • True: enables the persistence volume for HCL Compass search folders.
  • False: disables the persistence volume for HCL Compass search folders.
 true
persistence.search.accessModes Persistence Volume access modes. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ReadWriteOnce
persistence.search.size Persistence Volume size. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. 2Gi
persistence.search.reclaimPolicy Persistence Volume reclaim policy. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. Retain
persistence.search.existingClaim Persistence Volume existing claim. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ""
persistence.elasticsearch.enabled This parameter enables persistence volume claim for the hcl-compass-elasticsearch pod container data folder. This parameter is required if you plan to enable or disable the persistence volume for the hcl-compass-elasticsearch folder. Accepted values are:
  • True: enables the persistence volume for the hcl-compass-elasticsearch folder.
  • False: disables the persistence volume for the hcl-compass-elasticsearch folder.
 true
persistence.elasticsearch.accessModes Persistence Volume access modes. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ReadWriteOnce
persistence.elasticsearch.size Persistence Volume size. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. 2Gi
persistence.elasticsearch.reclaimPolicy Persistence Volume reclaim size. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. Retain
persistence.elasticsearch.existingClaim Persistence Volume existing claim. This parameter is required if persistence.enabled=true and persistence.compass.enabled=true. ""
persistence.storageClass If defined, sets the storageClassName. This parameter is required if persistence.enabled=true and Storage Class will be used. ""
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-compass/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-compass/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-compass/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-compass/config/analytics.properties file.
  • False: disables the analytics.properties configmap
 false