rabbitmq.md

This section configures RabbitMQ as the message queue. You can either:

• Deploy a local RabbitMQ instance inside the cluster (general.mq.local: true) or

• Connect to an external RabbitMQ instance (general.mq.local: false).

Basic Configuration

Property	Description
general.mq.enabled: false	Enable (true) or disable (false) RabbitMQ.
general.mq.local: true	If true, a RabbitMQ StatefulSet will be deployed inside the cluster.
general.mq.mq_endpoint: "rabbitmq.example.com"	The fully qualified domain name (FQDN) of an external RabbitMQ instance. Ignored if local: true
general.mq.port: "5672"	The RabbitMQ connection port (default: 5672).

Note

• If general.mq.local: false, all other RabbitMQ properties (such as storage and policies) will be ignored because the external RabbitMQ is expected to be pre-configured.
• If general.mq.local: true, only 1 replica of rabbitmq will be deployed. in addition we do not support more than 1 replica of rabbitmq with local. such behavior will result in unexpected behavior.

Queue Configuration

• general.mq.queue_name: "mixpanel-events" – The name of the RabbitMQ queue.
  • Changing this value creates a new queue (and a corresponding Dead Letter Queue).
  • Old queues will not be deleted automatically.
  • New messages will be sent to the new queue.

Policy Configuration

The following policy applies to all queues matching the regex pattern specified:

general:
  mq:
    policy:
      queue_regex_pattern: "^mixpanel-events.*"
      message_ttl: 600000000
      max_length: 2000
      overflow: "reject-publish"
      max_length_bytes: 1000000

Property	Description
queue_regex_pattern	Regex pattern to match queues for policy application.
message_ttl: 600000000	Time-to-live (TTL) for messages in milliseconds (~7 days).
max_length: 2000	Maximum number of messages allowed in the queue.
overflow: "reject-publish"	Behavior when max_length is reached (reject-publish prevents new messages).
max_length_bytes: 1000000	Maximum total size of all messages (500 bytes × 2000 messages).

This configuration prevents queue overload and ensures messages are retained only as needed.

Storage Configuration (Only if general.mq.local: true)

general:
  mq:
    persistentVolumeClaimRetentionPolicy:
      whenDeleted: "Retain"
      whenScaled: "Retain"
    storageClassName: "gp3"
    storage: "10Gi"
    pvc_name: ""

Property	Description
storageClassName: "gp3"	The storage class for the PersistentVolumeClaim (PVC).
storage: "10Gi"	Amount of storage allocated for RabbitMQ.
pvc_name: ""	PVC name (default: {{ .Release.Name }}-mq-data).
persistentVolumeClaimRetentionPolicy	Controls PVC retention when the StatefulSet is deleted or scaled down.

Warning

To disable persistent storage, set storage: "0" (all data will be lost on pod restart). creates deployment instead of statefulset.

Metrics Configuration

• general.mq.metrics: false – If true, enables the RabbitMQ Prometheus plugin.
• Metrics are exposed on port 15692 via the RabbitMQ service.

To collect these metrics using Prometheus autodiscovery, add the following annotations to rabbitmq deployment (only applicable when general.mq.local: true):

deployments:
  rabbitmq:
    service:
      annotations:
        prometheus.io/scrape: 'true'
        prometheus.io/path: '/metrics'
        prometheus.io/port: '15692'

Pod Configuration

Below is the default RabbitMQ pod configuration. configuration is defined under deployments.rabbitmq in the values.yaml

deployments:
  rabbitmq:
    loglevel: info
    useJsonLogFormat: false
    image:
      repository: lightruncom/rabbitmq
      tag: 3.12.14-alpine
      pullPolicy: IfNotPresent
    resources:
      cpu: 500m
      memory: 1Gi
    podLabels: {}
    podAnnotations: {}
    service:
      annotations: {}
      labels: {}
      ## prometheus autodiscovery annotations could be added to the service
    nodeSelector: {}
    podSecurityContext:
      # when using PVC , it is necessarily to set fsGroup so pod will have write permission to the mounted volume
      # fsGroup should be aligned with runAsUser of the container
      fsGroup: 1000000
    containerSecurityContext: {}
    initContainers:
      rabbitmq_config:
        resources:
          cpu: 100m
          memory: 128Mi
        image:
          repository: lightruncom/chart-helper
          tag: latest
          pullPolicy: ""
    # EmptyDir is used for rabbitmq data when mq.storage is set to 0
    emptyDir:
      sizeLimit: 5Gi
    affinity: {}
    lifecycle:
      postStart:
        exec:
          command:
            - "/bin/sh"
            - "-c"
            - |
              rabbitmqctl wait --pid 1 --timeout 60 && \
              rabbitmqctl list_users | grep -q $RABBITMQ_DEFAULT_USER || \
              (rabbitmqctl add_user $RABBITMQ_DEFAULT_USER $RABBITMQ_DEFAULT_PASS && \
              rabbitmqctl set_user_tags $RABBITMQ_DEFAULT_USER administrator && \
              rabbitmqctl set_permissions -p / $RABBITMQ_DEFAULT_USER ".*" ".*" ".*")
    # The postStart lifecycle hook ensures proper RabbitMQ user setup:
    # 1. Waits for RabbitMQ to be ready (up to 60 seconds)
    # 2. Checks if the default user exists
    # 3. If user doesn't exist:
    #    - Creates the default user with provided credentials
    #    - Sets user as administrator
    #    - Grants full permissions on all vhosts
    livenessProbe:
      initialDelaySeconds: 60
      periodSeconds: 45
      timeoutSeconds: 15
      successThreshold: 1
      failureThreshold: 3
    readinessProbe:
      initialDelaySeconds: 20
      periodSeconds: 45
      timeoutSeconds: 10
      successThreshold: 1
      failureThreshold: 3

Example Configurations

1️) Deploy a Local RabbitMQ Instance with 10Gi Storage

general:
  mq:
    enabled: true
    local: true
    storageClassName: "gp3"
    storage: "10Gi"
    metrics: true

2️) Connect to an External RabbitMQ Instance

general:
  mq:
    enabled: true
    local: false
    mq_endpoint: "rabbitmq.external.example.com"
    port: 5672