HCL Compass persistent volumes

Learn the default vallue settings for persistent volumes in HCL Compass.

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 default value settings for the persistent volumes are shown below. You can update these values based on your requirements.
hcl-compass:
  persistence:
    ## Enable persistence
    enabled: true
    compass:
      ## Enable persistence for hcl-compass
      enabled: true
      data:
        ## Enable persistence for hcl-compass data folder
        enabled: false
        accessModes:
          - ReadWriteOnce
        size: 2Gi
        reclaimPolicy: Retain
        existingClaim: ""
      config:
        ## Enable persistence for hcl-compass config folder
        enabled: true
        accessModes:
          - ReadWriteOnce
        size: 2Gi
        reclaimPolicy: Retain
        existingClaim: ""
      logs:
        ## Enable persistence for hcl-compass logs folder
        enabled: true
        accessModes:
          - ReadWriteOnce
        size: 2Gi
        reclaimPolicy: Retain
        existingClaim: ""
    search:
      ## Enable persistence for hcl-compass-search-app
      enabled: true
      accessModes:
        - ReadWriteOnce
      size: 2Gi
      reclaimPolicy: Retain
      existingClaim: ""
    elasticsearch:
      ## Enable persistence for hcl-compass-elasticsearch
      enabled: true
      accessModes:
        - ReadWriteOnce
      size: 2Gi
      reclaimPolicy: Retain
      existingClaim: ""
    ## Type of storage class to be used
    ## If defined, storageClassName: <storageClass>
    storageClass: ''
    ## Annotations for PVC
    annotations: {}
    ## Enabling/disabling the application.properties and analytics.properties configmap.
    ## If it is enabled, then it will update the values of the application.properties 
    ## and analytics.properties files as set in the hcl-compass/config/ folder.
    properties:
      application:
        enabled: false
      analytics:
        enabled: false
You can list persistent volumes (PV) and persistent volume claims (PVC) using kubectl get pv and kubectl get pvc commands. 
$ kubectl get pvc --namespace [namespace_name]
$ kubectl get pv --namespace [namespace_name]
You can use kubectl describe pv [pv-name] and kubectl describe pvc [pvc-name] commands to see more detailed information for each PV and PVC.
Note: Note that the HCL Compass solution Helm Chart sets the persisten volume by default. If your Kubernetes environment does not provide default StoreageClass, then you must create your own default StorageClass or disable the persistent volume. If you do not, the HCL Compass pods cannot start.