toccoag/openshift-nginx

openshift-nginx

镜像概述

openshift-nginx是一个为OpenShift环境设计的Nginx反向代理镜像，主要用于与在同一OpenShift pod中运行的Nice应用配合使用。该镜像提供了灵活的响应头配置和IP访问控制功能，以满足特定的部署需求。

警告：由于缓存头设置不正确（bug #66771），Nice版本<2.13需使用limited-caching分支的配置。

核心功能与特性

1. 自定义响应头：

   • 支持为2XX状态码的响应设置特定头信息
   • 支持为所有状态码的响应设置通用头信息
   • 适配OpenShift环境变量命名限制（使用双下划线代替连字符）

2. IP访问限制：

   • 通过环境变量配置IP白名单
   • 支持IP地址、CIDR网段和IP范围格式
   • 未配置时默认允许所有IP访问

使用场景

• 在OpenShift集群中部署Nice应用时作为反向代理
• 需要为应用响应添加自定义HTTP头的场景
• 需要限制特定IP或IP段访问应用的场景

使用方法与配置说明

设置响应头

重要说明

OpenShift当前不允许环境变量的键中包含连字符（-），需使用双下划线（__）代替（见下方示例）。

为2XX状态码响应设置头

通过前缀为NGINX_HEADER_的环境变量设置，格式如下：

bash
NGINX_HEADER_My__Header=header-content

上述配置将创建名为My-Header、值为header-content的响应头，仅对2XX状态码的响应生效。

为所有状态码响应设置头

通过前缀为NGINX_ALWAYS_HEADER_的环境变量设置，格式如下：

bash
NGINX_ALWAYS_HEADER_My__Header=header-content

上述配置将创建名为My-Header、值为header-content的响应头，对所有状态码的响应生效。

限制IP访问

通过IP_WHITELIST环境变量配置IP白名单，支持IP地址、CIDR网段和IP范围，多个值用空格分隔：

bash
IP_WHITELIST='81.55.33.3 40.22.0.0/16 1.5.5.5-1.5.5.7'

• IP地址：如81.55.33.3
• CIDR网段：如40.22.0.0/16（表示40.22.0.0-40.22.255.255）
• IP范围：如1.5.5.5-1.5.5.7（表示1.5.5.5、1.5.5.6、1.5.5.7）

注意：若IP_WHITELIST未设置或为空，默认允许所有IP地址访问。

部署示例

Docker Run命令

bash
docker run -d \
  -e NGINX_HEADER_My__Header=HelloWorld \
  -e NGINX_ALWAYS_HEADER_Server=openshift-nginx \
  -e IP_WHITELIST='192.168.1.0/24 10.0.0.1-10.0.0.10' \
  --name openshift-nginx \
  docker.xuanyuan.run/tocco/openshift-nginx

Docker Compose配置

yaml
version: '3'
services:
  nginx:
    image: tocco/openshift-nginx
    environment:
      - NGINX_HEADER_Access__Control__Allow__Origin=*
      - NGINX_ALWAYS_HEADER_X__Powered__By=openshift-nginx
      - IP_WHITELIST=8.8.8.8 192.168.0.0/16
    ports:
      - "80:80"