HelmRelease causes a line break on long values

[ChristianRaoulis]

What happened?

I'm trying to add some prometheus rules to my rabbitmq bitnami helm chart and pulumi seems to add a \n on a point where it causes an unterminated quoted string error on pulumi up

Example

const rabbitMQ = new HelmRelease("rabbitmq", {
   chart:          "rabbitmq",
   version:        "14.1.2",
   repositoryOpts: {
      repo: "https://charts.bitnami.com/bitnami",
   },
   values:         {
      metrics: {
         enabled:        true,
         prometheusRule: {
            enabled:   true,
            rules:     [
               {
                  alert:       "RabbitmqInstancesDifferentVersions",
                  expr:        'count(count(rabbitmq_build_info) by (rabbitmq_version)) > 1',
                  for:         '60m',
                  labels:      {
                     severity: "warning",
                  },
                  annotations: {
                     summary:     'RabbitMQ instances running different versions (instance {{ "{{ $labels.instance }}" }})', // <-- this get's converted to "RabbitMQ instances running different versions (instance {{ \"{{ $labels.instance\n      }}\" }})"
                     description: 'Running different version of RabbitMQ in the same cluster, can lead to failure.\n   VALUE = {{ "{{ $value }}" }}\n LABELS = {{ "{{ $labels }}" }}',
                  },
               },
            ],
         },
      },
   },
});

Output of pulumi about

CLI          
Version      3.107.0
Go Version   go1.22.0
Go Compiler  gc

Plugins
NAME          VERSION
command       0.11.1
keycloak      5.3.2
kubernetes    4.13.1
mongodbatlas  3.16.0
nodejs        unknown
postgresql    3.11.1
random        4.16.2

Host     
OS       Microsoft Windows 11 Enterprise
Version  10.0.22631 Build 22631
Arch     x86_64

This project is written in nodejs: executable='C:\Users\A92615470\AppData\Local\pnpm\node.exe' version='v20.14.0'

Additional context

// In my arg 
RabbitMQ instances running different versions (instance {{ "{{ $labels.instance }}" }})
// In values.yaml
RabbitMQ instances running different versions (instance {{ "{{ $labels.instance\n      }}" }})

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

[rquitales]

Hi @ChristianRaoulis it appears that this is related to an upstream bug regarding line splitting. Please see helm/helm#7704 for additional information.

Note that I am also able to reproduce this issue using Helm CLI (v3.15.2 - latest) and the following values.yaml file:

# helm install bitnami/rabbitmq --values ./values.yml --generate-name
metrics:
  enabled: true
  prometheusRule:
    enabled: true
    rules:
      - alert: RabbitmqInstancesDifferentVersions
        expr: count(count(rabbitmq_build_info) by (rabbitmq_version)) > 1
        for: 60m
        labels:
          severity: warning
        annotations:
          summary: RabbitMQ instances running different versions (instance {{ "{{ $labels.instance }}" }})
          description: |-
            Running different version of RabbitMQ in the same cluster, can lead to failure.
            VALUE = {{ "{{ $value }}" }}
            LABELS = {{ "{{ $labels }}" }}

As a workaround for now, you could employ the suggestion in helm/helm#7704 (comment) by declaring your custom values in a yaml file and referencing it using the valueYamlFiles field.

Example:

# index.ts
const chart = new k8s.helm.v3.Release(
  "rabbitmq",
  {
    chart: "rabbitmq",
    version: "14.1.2",
    repositoryOpts: {
      repo: "https://charts.bitnami.com/bitnami",
    },
    valueYamlFiles: [new pulumi.asset.FileAsset("./values.yml")],
  },
  { provider }
);

#values.yml
metrics:
  enabled: true
  prometheusRule:
    enabled: true
    rules:
      - alert: RabbitmqInstancesDifferentVersions
        expr: |
          count(count(rabbitmq_build_info) by (rabbitmq_version)) > 1
        for: 60m
        labels:
          severity: warning
        annotations:
          summary: |
            RabbitMQ instances running different versions (instance {{ "{{ $labels.instance }}" }})
          description: |
            Running different version of RabbitMQ in the same cluster, can lead to failure.
            VALUE = {{ "{{ $value }}" }}
            LABELS = {{ "{{ $labels }}" }}

Alternatively, you could force a string literal by adding a \n to the end of strings >80 characters.

const rabbitMQ = new HelmRelease("rabbitmq", {
   chart:          "rabbitmq",
   version:        "14.1.2",
   repositoryOpts: {
      repo: "https://charts.bitnami.com/bitnami",
   },
   values:         {
      metrics: {
         enabled:        true,
         prometheusRule: {
            enabled:   true,
            rules:     [
               {
                  alert:       "RabbitmqInstancesDifferentVersions",
                  expr:        'count(count(rabbitmq_build_info) by (rabbitmq_version)) > 1',
                  for:         '60m',
                  labels:      {
                     severity: "warning",
                  },
                  annotations: {
                     summary:     'RabbitMQ instances running different versions (instance {{ "{{ $labels.instance }}" }})\n',
                     description: 'Running different version of RabbitMQ in the same cluster, can lead to failure.\n   VALUE = {{ "{{ $value }}" }}\n LABELS = {{ "{{ $labels }}" }}',
                  },
               },
            ],
         },
      },
   },
});

In the meantime, I'll see what strategies we could implement within our provider to avoid this issue.