NGINX Ingress Custom Errors Not Served

You encounter a nginx configuration issue that prevents your workflow from completing. This guide walks through the fix step by step.

Wrong ❌

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/custom-http-errors: "404,503"
    nginx.ingress.kubernetes.io/error-backend: "my-error-service"
spec:
  rules:
    - host: example.com
      http:
        paths:
          - path: /
            pathType: Prefix
            backend: { service: { name: app-service, port: { number: 80 } } }

Wrong Output

Custom error pages not served. Default NGINX 404 page appears. Error backend not reachable.

Right ✅

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/custom-http-errors: "404,503"
spec:
  rules:
    - host: example.com
      http:
        paths:
          - path: /
            pathType: Prefix
            backend: { service: { name: app-service, port: { number: 80 } } }
---
apiVersion: v1
kind: Service
metadata: { name: error-pages }
spec:
  ports: [{ port: 80, targetPort: 8080 }]
  selector: { app: error-pages }
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata: { name: error-pages-ingress }
spec:
  ingressClassName: nginx
  rules:
    - host: example.com
      http:
        paths:
          - path: /error-pages
            pathType: Prefix
            backend: { service: { name: error-pages, port: { number: 80 } } }

Right Output

Custom error pages served for 404 and 503. Branded error experience.

Prevention

• Deploy a dedicated error service before referencing it.
• Use custom-http-errors for specific status codes.
• Ensure the error service is in the same namespace.
• Test by hitting non-existent paths.
• Design error pages with branding and helpful links.

DodaTech applies similar defensive patterns across Doda Browser, DodaZIP, and Durga Antivirus Pro infrastructure for production reliability.

Common Mistakes with ingress custom errors

1. Mixing let bindings with <- bindings in do notation, producing type errors
2. Overlapping type class instances that cause GHC to reject the program with ambiguous dispatch errors
3. Non-exhaustive pattern matches that compile with warnings then crash at runtime

These mistakes appear frequently in real-world NGINX code. DodaTech's contributors have identified these patterns through analysis of open-source projects and production systems.

Practice Exercise

Write a pure function that safely divides two integers using Maybe, then test it with edge cases like division by zero and negative numbers.

This exercise reinforces the concepts covered in this guide. Try implementing it before checking online solutions.

FAQ

This quick fix is part of the DodaTech infrastructure engineering series. Learn more at DodaTech tutorials.