makeplane / makeplane/helm-charts

Traefik IngressRoute template doesn't support custom annotations

Open Beginner friendly
#220 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go Template
Stars
23
Forks
31
Avg merge
1d 13h
Merged PRs (30d)
13

Description

When using the Traefik IngressRoute (ingressClass: "traefik"), the template at templates/ingress-traefik.yaml doesn't include any mechanism to add custom annotations to the rendered IngressRoute resource.

The ingress_annotations value only applies to the standard networking.k8s.io/v1 Ingress template (templates/ingress.yaml), not the Traefik CRD template.

This prevents users from adding annotations needed by external tooling, such as:

  • external-dns.alpha.kubernetes.io/hostname (for automatic DNS record creation)
  • external-dns.alpha.kubernetes.io/target
  • kubernetes.io/ingress.class (for IngressRoute class filtering)

Current behavior:

# ingress-traefik.yaml
apiVersion: traefik.io/v1alpha1 
kind: IngressRoute
metadata: 
  name: {{ .Release.Name }}-ingress 
  namespace: {{ .Release.Namespace }} 
spec: 
... 

No annotations are rendered regardless of what's set in ingress_annotations.

Expected behavior:

The Traefik IngressRoute template should support custom annotations, either via the existing ingress_annotations value or a dedicated
traefik.annotations field:

apiVersion: traefik.io/v1alpha1 
kind: IngressRoute
metadata: 
  name: {{ .Release.Name }}-ingress 
  namespace: {{ .Release.Namespace }} 
  {{- with .Values.ingress.ingress_annotations }} 
  annotations:
    {{- toYaml . | nindent 4 }} 
  {{- end }}
spec: 
... 

Workaround:

Disable the chart's ingress (ingress.enabled: false) and maintain a hand-written IngressRoute outside the chart.

Chart version: 1.5.0 (plane-ce)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with templates/ingress-traefik.yaml and compare its metadata with templates/ingress.yaml, then inspect the ingress.ingress_annotations value usage. Render the chart with ingressClass set to traefik and custom annotations configured. Done means the rendered IngressRoute metadata includes those annotations without affecting the standard Ingress template.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
devops, infrastructure
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.