grafana / k8s-monitoring-helm

Apache License 2.0
230 stars 88 forks source link

Having "true" extra ports for faro receiver #507

Open doanbutar opened 7 months ago

doanbutar commented 7 months ago

As of now, we can't just specify additional ports for Faro, but also need to include Otel ports; otherwise we get a validation error like:

Error: UPGRADE FAILED: execution error at (k8s-monitoring/templates/hooks/validate-configuration.yaml:123:8): OTLP gRPC port not opened on Grafana Alloy.

In order to receive data over this protocol, port 4317 needs to be opened on Alloy. For example, set this in your values file:

alloy:
    extraPorts:
      - name: "otlp-grpc"
        port: 4317
        targetPort: 4317
        protocol: "TCP"
      - name: "otlp-http"
        port: 4318
        targetPort: 4318
        protocol: "TCP"
      - name: "faro"
        port: 12347
        targetPort: 12347
        protocol: "TCP"

This seems like including the settings that are default for k8s-monitoring chart in our helm values. E.g. if for whatever reason this changes in some way (for example, for some reason you chart requires another "required" port), we'll have to change our config.

Makes version upgrades more difficult. Hence the name extra ports seems misleading (though looking at the chart logic I understand why they are called "extra" in the alloy chart). Basically, what would be valuable is having "true" extra ports (in this case "extra" from the k8s-monitoring chart perspective, not from alloy chart).

petewall commented 6 months ago

I am thinking about what we can do here. Honestly, it's a bit of a Helm limitation, but maybe there's something we can do to improve the experience.

petewall commented 2 months ago

The process here will be much improved in version 2.0