appfim/nginx_custom_error_pages

Nginx Ingress自定义错误页面（Appf IM定制版）镜像文档

镜像概述

本镜像为Appf IM环境定制，用于在Nginx Ingress控制器中提供自定义错误页面。基于https://github.com/kubernetes/ingress-nginx/tree/master/images/custom-error-pages%E7%9A%84custom-error-pages%E9%95%9C%E5%83%8F%E4%BF%AE%E6%94%B9%EF%BC%8C%E4%BB%A5%E9%80%82%E9%85%8DAppf IM的特定需求和品牌风格。

核心功能与特性

• 自定义错误页面：提供可定制的HTTP错误页面（如404、500等状态码），支持品牌化样式与内容展示
• Appf IM适配：针对Appf IM环境的界面风格、交互逻辑进行优化调整
• Nginx Ingress集成：与Nginx Ingress控制器无缝集成，通过标准Ingress配置即可启用
• 基于官方项目：继承kubernetes/ingress-nginx项目custom-error-pages镜像的基础功能与稳定性

使用场景

适用于Appf IM环境中，通过Nginx Ingress控制器对外提供服务时，需要向用户展示符合Appf IM品牌规范的自定义错误页面的场景，提升用户体验与系统专业性。

使用方法

前提条件

• Kubernetes集群已部署Nginx Ingress控制器
• 具备集群管理权限，可部署服务及配置Ingress资源

部署步骤

1. 部署自定义错误页面服务
   将本镜像部署为Kubernetes Service，示例Deployment配置：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: appf-im-nginx-error-pages
  namespace: appf-im
spec:
  replicas: 1
  selector:
    matchLabels:
      app: appf-im-nginx-error-pages
  template:
    metadata:
      labels:
        app: appf-im-nginx-error-pages
    spec:
      containers:
      - name: error-pages
        image: [镜像仓库地址]/appf-im-nginx-error-pages:latest  # 替换为实际镜像地址
        ports:
        - containerPort: 8080
---
apiVersion: v1
kind: Service
metadata:
  name: appf-im-nginx-error-pages
  namespace: appf-im
spec:
  selector:
    app: appf-im-nginx-error-pages
  ports:
  - port: 80
    targetPort: 8080

2. 配置Nginx Ingress使用自定义错误页面
   在Appf IM相关的Ingress资源中，通过nginx.ingress.kubernetes.io/custom-http-errors注解指定错误状态码，并通过nginx.ingress.kubernetes.io/default-backend或nginx.ingress.kubernetes.io/error-page-url指向上述服务：

yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: appf-im-ingress
  namespace: appf-im
  annotations:
    nginx.ingress.kubernetes.io/custom-http-errors: "404,500,503"
    nginx.ingress.kubernetes.io/default-backend: appf-im-nginx-error-pages  # 指向自定义错误页面服务
spec:
  ingressClassName: nginx
  rules:
  - host: appf-im.example.com
    http:
      paths:
      - path: /
        pathType: Prefix
        backend:
          service:
            name: appf-im-service
            port:
              number: 80

注意事项

• 确保镜像已推送至集群可访问的镜像仓库
• 根据Appf IM实际需求调整错误页面内容（需重新构建镜像）
• 部署前验证Nginx Ingress控制器版本与本镜像兼容性（建议使用与kubernetes/ingress-nginx原项目相同版本基线）