Discrepancy between Logstash Helm Chart and docs for pipelinesRef

[wescran]

Bug Report

What did you do?
I have a found a discrepancy between the helm chart for Logstash and what the documentation describes for configuring pipelines using pipelinesRef

What did you expect to see?
As per the Logstash helm chart, the pipelinesRef object shows that the format should be:

pipelinesRef:
  secretRef:
    secretName: <secret>

However the Logstash ECK docs define the correct usage.

  pipelinesRef:
    secretName: <secret>

I expected to see some sort of error when using the incorrect format.

What did you see instead? Under which circumstances?
Nothing. I was confused as to why my logstash deployment was not using my configured pipelines. I discovered there was an error when I looked at the logstash resource. It only showed an empty object for pipelinesRef

spec:
  count: 1
  elasticsearchRefs:
  - clusterName: eck
    name: elasticsearch
  monitoring:
    logs: {}
    metrics: {}
  pipelinesRef: {}

I looked at the template for the logstash helm chart, and it technically accepts any yaml after the pipelinesRef key

  {{- with .Values.pipelinesRef }}
  pipelinesRef:
    {{- toYaml . | nindent 4 }}
  {{- end }}

And the test fails to catch this as well as it uses the incorrect definition.

  - it: should render pipelinesRef properly
    set:
      pipelinesRef:
        secretRef:
          secretName: pipelineLogstashSecretName
    asserts:
      - equal:
          path: spec.pipelinesRef.secretRef.secretName
          value: pipelineLogstashSecretName