fix(helm): fixed ingress paths mapping #12932

vlad-diachenko · 2024-05-10T09:23:13Z

What this PR does / why we need it:

fix(helm): added mapping between Loki components and deployment modes to properly configure pure ingress when it's used without gateway/ngingx

Which issue(s) this PR fixes:
Fixes #12582

Special notes for your reviewer:

Ingress manifest for different modes:

deploymentMode: SingleBinary

# Source: loki/templates/ingress.yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: chart-name-loki
  namespace: gel
  labels:
    helm.sh/chart: loki-6.5.1
    app.kubernetes.io/name: loki
    app.kubernetes.io/instance: chart-name
    app.kubernetes.io/version: "3.0.0"
    app.kubernetes.io/managed-by: Helm
spec:
  rules:
    - host: "loki.example.com"
      http:
        paths:          
          - path: /api/prom/push
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/push
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /otlp/v1/logs
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /api/prom/query
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /api/prom/label
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /api/prom/series
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /api/prom/tail
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/query
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/query_range
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/tail
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/label
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/labels
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/series
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/index/stats
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume_range
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/format_query
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/detected_fields
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/detected_labels
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/patterns
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /api/prom/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /api/prom/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /api/prom/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /loki/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /prometheus/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100
          - path: /prometheus/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki
                port:
                  number: 3100

deploymentMode: SimpleScalable

---
# Source: loki/templates/ingress.yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: chart-name-loki
  namespace: gel
  labels:
    helm.sh/chart: loki-6.5.1
    app.kubernetes.io/name: loki
    app.kubernetes.io/instance: chart-name
    app.kubernetes.io/version: "3.0.0"
    app.kubernetes.io/managed-by: Helm
spec:
  rules:
    - host: "loki.example.com"
      http:
        paths:          
          - path: /api/prom/query
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/label
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/series
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/tail
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/query
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/query_range
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/tail
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/label
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/labels
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/series
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/index/stats
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume_range
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/format_query
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/detected_fields
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/detected_labels
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/patterns
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/push
            pathType: Prefix
            backend:
              service:
                name: loki-write
                port:
                  number: 3100
          - path: /loki/api/v1/push
            pathType: Prefix
            backend:
              service:
                name: loki-write
                port:
                  number: 3100
          - path: /otlp/v1/logs
            pathType: Prefix
            backend:
              service:
                name: loki-write
                port:
                  number: 3100
          - path: /api/prom/rules
            pathType: Prefix
            backend:
              service:
                name: loki-backend
                port:
                  number: 3100
          - path: /api/prom/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: loki-backend
                port:
                  number: 3100
          - path: /api/prom/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: loki-backend
                port:
                  number: 3100
          - path: /loki/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: loki-backend
                port:
                  number: 3100
          - path: /prometheus/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: loki-backend
                port:
                  number: 3100
          - path: /prometheus/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: loki-backend
                port:
                  number: 3100

deploymentMode: Distributed

---
# Source: loki/templates/ingress.yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: chart-name-loki
  namespace: gel
  labels:
    helm.sh/chart: loki-6.5.2
    app.kubernetes.io/name: loki
    app.kubernetes.io/instance: chart-name
    app.kubernetes.io/version: "3.0.0"
    app.kubernetes.io/managed-by: Helm
spec:
  rules:
    - host: "loki.example.com"
      http:
        paths:          
          - path: /api/prom/push
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-distributor
                port:
                  number: 3100
          - path: /loki/api/v1/push
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-distributor
                port:
                  number: 3100
          - path: /otlp/v1/logs
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-distributor
                port:
                  number: 3100
          - path: /api/prom/query
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /api/prom/label
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /api/prom/series
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /api/prom/tail
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/query
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/query_range
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/tail
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/label
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/labels
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/series
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/index/stats
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume_range
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/format_query
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/detected_fields
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/detected_labels
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /loki/api/v1/patterns
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-query-frontend
                port:
                  number: 3100
          - path: /api/prom/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-ruler
                port:
                  number: 3100
          - path: /api/prom/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-ruler
                port:
                  number: 3100
          - path: /api/prom/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-ruler
                port:
                  number: 3100
          - path: /loki/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-ruler
                port:
                  number: 3100
          - path: /prometheus/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-ruler
                port:
                  number: 3100
          - path: /prometheus/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: chart-name-loki-ruler
                port:
                  number: 3100

deploymentMode: SimpleScalable && read.legacyReadTarget: true

---
# Source: loki/templates/ingress.yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: chart-name-loki
  namespace: gel
  labels:
    helm.sh/chart: loki-6.5.1
    app.kubernetes.io/name: loki
    app.kubernetes.io/instance: chart-name
    app.kubernetes.io/version: "3.0.0"
    app.kubernetes.io/managed-by: Helm
spec:
  rules:
    - host: "loki.example.com"
      http:
        paths:          
          - path: /api/prom/query
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/label
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/series
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/tail
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/query
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/query_range
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/tail
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/label
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/labels
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/series
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/index/stats
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/index/volume_range
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/format_query
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/detected_fields
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/detected_labels
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/patterns
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/rules
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /loki/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /prometheus/api/v1/rules
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /prometheus/api/v1/alerts
            pathType: Prefix
            backend:
              service:
                name: loki-read
                port:
                  number: 3100
          - path: /api/prom/push
            pathType: Prefix
            backend:
              service:
                name: loki-write
                port:
                  number: 3100
          - path: /loki/api/v1/push
            pathType: Prefix
            backend:
              service:
                name: loki-write
                port:
                  number: 3100
          - path: /otlp/v1/logs
            pathType: Prefix
            backend:
              service:
                name: loki-write
                port:
                  number: 3100

Checklist

Reviewed the CONTRIBUTING.md guide (required)
Documentation added
Tests updated
Title matches the required conventional commits format, see here
- Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

… to properly configure pure ingress when it's used without gateway/ngingx Signed-off-by: Vladyslav Diachenko <[email protected]>

Signed-off-by: Vladyslav Diachenko <[email protected]>

kavirajk

Not an helm chart expert. But changes looks reasonable to me. Thanks @vlad-diachenko for fixing it.

Approving to unblock

fix(helm): added mapping between Loki components and deployment modes…

33447c4

… to properly configure pure ingress when it's used without gateway/ngingx Signed-off-by: Vladyslav Diachenko <[email protected]>

vlad-diachenko requested a review from a team as a code owner May 10, 2024 09:23

vlad-diachenko added type/enhancement Something existing could be improved area/helm labels May 10, 2024

pull-request-size bot added the size/M label May 10, 2024

updated docs and bumped chart version

2c6baba

Signed-off-by: Vladyslav Diachenko <[email protected]>

pull-request-size bot added size/L and removed size/M labels May 10, 2024

github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label May 10, 2024

vlad-diachenko and others added 3 commits May 10, 2024 16:00

removed unused definition

794941f

Signed-off-by: Vladyslav Diachenko <[email protected]>

Merge branch 'main' into vlad.diachenko/fixed-ingress-paths

4065bd4

fixed parameter's name that led to empty service name in the mapping

5a9f76d

Signed-off-by: Vladyslav Diachenko <[email protected]>

kavirajk approved these changes May 10, 2024

View reviewed changes

MichelHollands approved these changes May 10, 2024

View reviewed changes

vlad-diachenko merged commit 5ada92b into main May 10, 2024
61 checks passed

vlad-diachenko deleted the vlad.diachenko/fixed-ingress-paths branch May 10, 2024 15:16

loki-gh-app bot mentioned this pull request May 13, 2024

chore(k202): release 3.1.0 #12945

Closed

anindyameister mentioned this pull request May 18, 2024

[Helm] Loki 3.0 helm chart distributed mode doesn't work for ingress without gateway #12844

Closed

loki-gh-app bot mentioned this pull request May 20, 2024

chore(k203): release 3.1.0 #12988

Closed

This was referenced May 27, 2024

chore(k204): release 3.1.0 #13037

Closed

chore(k205): release 3.1.0 #13102

Closed

This was referenced Jun 10, 2024

chore(k206): release 3.1.0 #13184

Closed

chore(k207): release 3.1.0 #13225

Merged

loki-gh-app bot mentioned this pull request Jun 24, 2024

chore(k208): release 3.1.0 #13291

Closed

loki-gh-app bot mentioned this pull request Jul 1, 2024

chore(k209): release 3.1.0 #13356

Closed

grafanabot mentioned this pull request Jul 2, 2024

chore: [main] chore(k207): release 3.1.0 #13391

Open

This was referenced Jul 3, 2024

chore(release-3.1.x): release 3.0.1 #13402

Closed

chore(k210): release 3.1.0 #13435

Closed

chore(k210): release 3.1.0 #13462

Closed

RodrigoCMoraes mentioned this pull request Jul 12, 2024

incognia inloco/loki#22

Closed

loki-gh-app bot mentioned this pull request Jul 15, 2024

chore(k211): release 3.1.0 #13521

Closed

loki-gh-app bot mentioned this pull request Jul 22, 2024

chore(k212): release 3.1.0 #13595

Closed

mraboosk pushed a commit to mraboosk/loki that referenced this pull request Oct 7, 2024

fix(helm): fixed ingress paths mapping (grafana#12932)

ed32e1a

loki-gh-app bot mentioned this pull request Oct 18, 2024

chore(release-3.1.x): release 3.1.3 #14531

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(helm): fixed ingress paths mapping #12932

fix(helm): fixed ingress paths mapping #12932

vlad-diachenko commented May 10, 2024 •

edited

Loading

kavirajk left a comment

fix(helm): fixed ingress paths mapping #12932

fix(helm): fixed ingress paths mapping #12932

Conversation

vlad-diachenko commented May 10, 2024 • edited Loading

kavirajk left a comment

Choose a reason for hiding this comment

vlad-diachenko commented May 10, 2024 •

edited

Loading