Storage and resource configuration

Storage for data volumes

Druid uses S3 or HDFS for deep storage, so no extra PersistentVolumeClaims have to be specified.

Resource Requests

Stackable operators handle resource requests in a slightly different manner than Kubernetes. Resource requests are defined on role or role group level. On a role level this means that by default, all workers will use the same resource requests and limits. This can be further specified on role group level (which takes priority to the role level) to apply different resources.

This is an example on how to specify CPU and memory resources using the Stackable Custom Resources:

---
apiVersion: example.stackable.tech/v1alpha1
kind: ExampleCluster
metadata:
  name: example
spec:
  workers: # role-level
    config:
      resources:
        cpu:
          min: 300m
          max: 600m
        memory:
          limit: 3Gi
    roleGroups: # role-group-level
      resources-from-role: # role-group 1
        replicas: 1
      resources-from-role-group: # role-group 2
        replicas: 1
        config:
          resources:
            cpu:
              min: 400m
              max: 800m
            memory:
              limit: 4Gi

In this case, the role group resources-from-role will inherit the resources specified on the role level, resulting in a maximum of 3Gi memory and 600m CPU resources.

The role group resources-from-role-group has a maximum of 4Gi memory and 800m CPU resources (which overrides the role CPU resources).

For Java products the actual used heap memory is lower than the specified memory limit due to other processes in the Container requiring memory to run as well. Currently, 80% of the specified memory limit is passed to the JVM.

For memory, only a limit can be specified, which will be set as memory request and limit in the container. This is to always guarantee a container the full amount memory during Kubernetes scheduling.

A minimal HA setup consisting of 2 Pods of each role has the following resource requirements:

  • 4700m CPU request

  • 13800m CPU limit

  • 11376m memory request and limit

Of course, additional services require additional resources. For Stackable components, see the corresponding documentation on further resource requirements.

Corresponding to the values above, the operator uses the following resource defaults:

spec:
  brokers:
    config:
      resources:
        cpu:
          min: 100m
          max: 400m
        memory:
          limit: 1500Mi
  routers:
    config:
      resources:
        cpu:
          min: 100m
          max: 400m
        memory:
          limit: 512Mi
  historical:
    config:
      resources:
        cpu:
          min: 300m
          max: 1200m
        memory:
          limit: 1500Mi
  middleManagers:
    config:
      resources:
        cpu:
          min: 300m
          max: 1200m
        memory:
          limit: 1Gi
  coordinators:
    config:
      resources:
        cpu:
          min: 100m
          max: 400m
        memory:
          limit: 512Mi

The operator may configure an additional container for log aggregation. This is done when log aggregation is configured as described in Logging. The resources for this container cannot be configured using the mechanism described above. Use podOverrides for this purpose.

You can configure your own resource requests and limits by following the example above.

Historical Resources

In addition to the cpu and memory resources described above, historical Pods also accept a storage resource with the following properties:

  • segmentCache - used to set the maximum size allowed for the historical segment cache locations. See the Druid documentation regarding druid.segmentCache.locations. The operator creates an emptyDir and sets the max_size of the volume to be the value of the capacity property. In addition Druid is configured to keep 7% volume size free. By default, if no segmentCache is configured, the operator creates an emptyDir with a size of 1G and freePercentage of 5.

Example historical configuration with storage resources:

historicals:
  roleGroups:
    default:
      config:
        resources:
          storage:
            segmentCache:
              # The amount of free space to subtract from the capacity setting below. Defaults to 5%
              freePercentage: 7
              emptyDir:
                # The maximum size of the volume used to store the segment cache
                capacity: 2Gi