在nginx的配置里面有个 proxy_pass 指令

location /name/ {
    proxy_pass http://127.0.0.1/remote/;
}

像上面的配置，proxy_pass 后面加了路径 /remote， 此时会将匹配到该规则的路径中的/name用/remote替换掉（/remote可以写为/，此时相当于截掉路径中的/name）。 有个类似的需求：kubernetes中使用nginx-ingress如何实现？请求url是 http://aa.xxx.net/gateway/a/b ，此url经过nginx-ingress代理后，到达后端的请求路径是/a/b ，截掉其中的gateway，应用怎么配置？。首先想到的是用ingress里面的rewrite注解来解决问题。

我们先看看nginx里面的rewrite。

nginx的rewrite模块

参考 官方文档 ngx_http_rewrite_module模块使用PCRE正则表达式重写请求URI，相关的几个指令有： break、if、return、 rewrite、set 指令按照下面的顺序执行： 1. server块按照顺序执行 2. 执行匹配到的location块内的该模块指令 3. 循环重定向最多10次

break 指令

停止处理当前的ngx_http_rewrite_module指令集。如果在location内的if指令内包含break，则location内的其他指令会继续执行。

rewrite指令

Syntax:	rewrite regex replacement [flag];
Default:	—
Context:	server, location, if

如果指令中指定的正则regex与请求路径部分相匹配，则路径部分将被replacement替换。rewrite按照在配置文件里出现的顺序执行。 示例：

location / {
        rewrite ^/a /b;
        #return 200 okokok;
        rewrite ^/b /c last;
        rewrite ^/d /b;
}
location = /b {
        return 401;
}

location = /c {
        return 402;
}

上面这个配置中，访问http://localhost:port/d会返回401，发生了url重写，能理解吧。 若在 rewrite 中不指定flag，则会继续往下执行 可以用flags选项终止处理后面的指令。如果replacement以http://、https:// 或$scheme开头，则请求不会往后执行，redirect将直接返回给客户端。

flag选项

  • last 停止处理当前配置段里面的 ngx_http_rewrite_module 指令集，且用替换过的uri重新匹配新的location
  • break 选项和 break 指令的效果一样，停止处理当前配置段的ngx_http_rewrite_module指令集，比如rewrite后面还紧跟着return，此时return指令不会被执行，last也是一样   假如把 rewrite ^/d /b 改为 rewrite ^/d /b break，则直接返回404，没有继续往下匹配location
  • redirect，replacement不以 'http://' 等开头的时候，返回临时重定向302   假如把 rewrite ^/d /b 改为 rewrite ^/d /b redirect，会给浏览器返回302重定向，浏览器重新请求 http://x.x.x.x/b
  • permanent，返回永久重定向301   301重定向，浏览器重新发起请求

建议自己试一下，加深理解

完整的重定向url是按照请求的scheme和server_name_in_redirect和port_in_redirect 指令生成的。 在nginx-ingerss中解决文章开头所说那个问题，nginx-ingress rewrite的配置如下。

nginx-ingress里面的rewrite-target注解

官方链接 示例：

...
    nginx.ingress.kubernetes.io/rewrite-target: /$1
...
spec:
  rules:
  - host: aa.xxx.net
    http:
      paths:
      - backend:
          serviceName: svc-gateway
          servicePort: 8080
        path: /gateway/(.*)
      - backend:
          serviceName: svc-ui
          servicePort: 80
        path: /(.*)
  tls:
  - hosts:
    - aa.xxx.net
    secretName: xxx.net

nginx.ingress.kubernetes.io/rewrite-target: /$1 会在每个path（对应每个location）里面添加rewrite指令，且flag标志为break。

在版本0.22.0或更高版本中，需要传递到重写路径的请求URI中的任何子字符串都必须在捕获组中显式定义。第一个组用$1 表示，可以作为rewrite-target的参数。 使用了rewrite-target注解后，所有path被强制使用忽略大小写的正则，类似于nginx配置里面的：

location ~* "^/foo/.*" {
  ...
}

spec.rules.host 字段不像nginx一样支持范匹配和正则，必须写完整的域名， 注意：**ingress-nginx在将其path作为location块写入nginx模板之前，首先按path的长度降序排序，这个长度里面包含了正则字符。**后面就和nginx一样，正则模式下先匹配到的location会直接执行，不往下继续匹配。

扩展阅读：ingress-path-matching Understanding Nginx Server and Location Block Selection Algorithms

第二种方式：

...
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/server-snippet: |
      if ($uri ~* "/gateway/.*") {
          rewrite ^/gateway/(.*) /$1 break;
      }
    nginx.ingress.kubernetes.io/use-regex: "true"
...
spec:
  rules:
  - host: aa.xxx.net
    http:
      paths:
      - backend:
          serviceName: svc-gateway
          servicePort: 8080
        path: /gateway(/|$)(.*)
      - backend:
          serviceName: svc-gateway
          servicePort: 8080
        path: /(admin|bg|auth|monitor)
      - backend:
          serviceName: svc-ui
          servicePort: 80
        path: /
  tls:
  - hosts:
    - aa.xxx.net
    secretName: xxx.net

nginx.ingress.kubernetes.io/server-snippet 注解用于在server块自定义配置，可以写nginx的配置实现更多需求。每个server块只能用一次。