DevFW-CICD/ingress-nginx-helm
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3174 from Shopify/rewrite-regex

Browse source 
Generalize Rewrite Block Creation and Deprecate AddBaseUrl (not backwards compatible)
This commit is contained in:
Kubernetes Prow Robot 2019-01-02 12:30:18 -08:00 committed by GitHub
commit 71cc6df74f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 71 additions and 396 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
docs/examples/rewrite/README.md
View file

@ -15,17 +15,21 @@ Rewriting can be controlled using the following annotations:
|Name|Description|Values| |Name|Description|Values|
| --- | --- | --- | | --- | --- | --- |
|nginx.ingress.kubernetes.io/rewrite-target|Target URI where the traffic must be redirected|string| |nginx.ingress.kubernetes.io/rewrite-target|Target URI where the traffic must be redirected|string|
|nginx.ingress.kubernetes.io/add-base-url|indicates if is required to add a base tag in the head of the responses from the upstream servers|bool|
|nginx.ingress.kubernetes.io/base-url-scheme|Override for the scheme passed to the base tag|string|
|nginx.ingress.kubernetes.io/ssl-redirect|Indicates if the location section is accessible SSL only (defaults to True when Ingress contains a Certificate)|bool| |nginx.ingress.kubernetes.io/ssl-redirect|Indicates if the location section is accessible SSL only (defaults to True when Ingress contains a Certificate)|bool|
|nginx.ingress.kubernetes.io/force-ssl-redirect|Forces the redirection to HTTPS even if the Ingress is not TLS Enabled|bool| |nginx.ingress.kubernetes.io/force-ssl-redirect|Forces the redirection to HTTPS even if the Ingress is not TLS Enabled|bool|
|nginx.ingress.kubernetes.io/app-root|Defines the Application Root that the Controller must redirect if it's in '/' context|string| |nginx.ingress.kubernetes.io/app-root|Defines the Application Root that the Controller must redirect if it's in '/' context|string|
|nginx.ingress.kubernetes.io/use-regex|Indicates if the paths defined on an Ingress use regular expressions|bool| |nginx.ingress.kubernetes.io/use-regex|Indicates if the paths defined on an Ingress use regular expressions|bool|
## Validation ## Examples
### Rewrite Target ### Rewrite Target
!!! attention
Starting in Version 0.2.2, ingress definitions using the annotation `nginx.ingress.kubernetes.io/rewrite-target` are not backwards compatible with previous versions. In Version 0.2.2 and beyond, any substrings within the request URI that need to be passed to the rewritten path must explicitly be defined in a [capture group](https://www.regular-expressions.info/refcapture.html).
!!! note
[Captured groups](https://www.regular-expressions.info/refcapture.html) are saved in numbered placeholders, chronologically, in the form `$1`, `$2` ... `$n`. These placeholders can be used as parameters in the `rewrite-target` annotation.
Create an Ingress rule with a rewrite annotation: Create an Ingress rule with a rewrite annotation:
```console ```console
@ -34,7 +38,7 @@ apiVersion: extensions/v1beta1
kind: Ingress kind: Ingress
metadata: metadata:
annotations: annotations:
nginx.ingress.kubernetes.io/rewrite-target: / nginx.ingress.kubernetes.io/rewrite-target: /$1
name: rewrite name: rewrite
namespace: default namespace: default
spec: spec:
@ -45,53 +49,16 @@ spec:
- backend: - backend:
serviceName: http-svc serviceName: http-svc
servicePort: 80 servicePort: 80
path: /something path: /something/?(.*)
" | kubectl create -f - " | kubectl create -f -
``` ```
Check the rewrite is working In this ingress definition, any characters captured by `(.*)` will be assigned to the placeholder `$1`, which is then used as a parameter in the `rewrite-target` annotation.
``` For example, the ingress definition above will result in the following rewrites:
$ curl -v http://172.17.4.99/something -H 'Host: rewrite.bar.com' - `rewrite.bar.com/something` rewrites to `rewrite.bar.com/`
* Trying 172.17.4.99... - `rewrite.bar.com/something/` rewrites to `rewrite.bar.com/`
* Connected to 172.17.4.99 (172.17.4.99) port 80 (#0) - `rewrite.bar.com/something/new` rewrites to `rewrite.bar.com/new`
> GET /something HTTP/1.1
> Host: rewrite.bar.com
> User-Agent: curl/7.43.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: nginx/1.11.0
< Date: Tue, 31 May 2016 16:07:31 GMT
< Content-Type: text/plain
< Transfer-Encoding: chunked
< Connection: keep-alive
<
CLIENT VALUES:
client_address=10.2.56.9
command=GET
real path=/
query=nil
request_version=1.1
request_uri=http://rewrite.bar.com:8080/
SERVER VALUES:
server_version=nginx: 1.9.11 - lua: 10001
HEADERS RECEIVED:
accept=*/*
connection=close
host=rewrite.bar.com
user-agent=curl/7.43.0
x-forwarded-for=10.2.56.1
x-forwarded-host=rewrite.bar.com
x-forwarded-port=80
x-forwarded-proto=http
x-real-ip=10.2.56.1
BODY:
* Connection #0 to host 172.17.4.99 left intact
-no body in request-
```
### App Root ### App Root

15
docs/user-guide/ingress-path-matching.md
View file

@ -57,11 +57,11 @@ spec:
paths: paths:
- path: /foo/bar - path: /foo/bar
backend: backend:
serviceName: test serviceName: service1
servicePort: 80 servicePort: 80
- path: /foo/bar/ - path: /foo/bar/
backend: backend:
serviceName: test serviceName: service2
servicePort: 80 servicePort: 80
``` ```
@ -79,14 +79,14 @@ spec:
paths: paths:
- path: /foo/bar/.+ - path: /foo/bar/.+
backend: backend:
serviceName: test serviceName: service3
servicePort: 80 servicePort: 80
``` ```
The ingress controller would define the following location blocks, in order of descending length, within the NGINX template for the `test.com` server: The ingress controller would define the following location blocks, in order of descending length, within the NGINX template for the `test.com` server:
```txt ```txt
location ~* "^/foo/bar/.+\/?(?<baseuri>.*)" { location ~* ^/foo/bar/.+ {
... ...
} }
@ -101,13 +101,12 @@ location ~* "^/foo/bar" {
The following request URI's would match the corresponding location blocks: The following request URI's would match the corresponding location blocks:
- `test.com/foo/bar/1` matches `~* "^/foo/bar/.+\/?(?<baseuri>.*)"` - `test.com/foo/bar/1` matches `~* ^/foo/bar/.+` and will go to service 3.
- `test.com/foo/bar/` matches `~* "^/foo/bar/"` - `test.com/foo/bar/` matches `~* ^/foo/bar/` and will go to service 2.
- `test.com/foo/bar` matches `~* "^/foo/bar"` - `test.com/foo/bar` matches `~* ^/foo/bar` and will go to service 1.
**IMPORTANT NOTES**: **IMPORTANT NOTES**:
- paths created under the `rewrite-ingress` are sorted before `\/?(?<baseuri>.*)` is appended. For example if the path defined within `test-ingress-2` was `/foo/.+` then the location block for `^/foo/.+\/?(?<baseuri>.*)` would be the LAST block listed.
- If the `use-regex` OR `rewrite-target` annotation is used on any Ingress for a given host, then the case insensitive regular expression [location modifier](https://nginx.org/en/docs/http/ngx_http_core_module.html#location) will be enforced on ALL paths for a given host regardless of what Ingress they are defined on. - If the `use-regex` OR `rewrite-target` annotation is used on any Ingress for a given host, then the case insensitive regular expression [location modifier](https://nginx.org/en/docs/http/ngx_http_core_module.html#location) will be enforced on ALL paths for a given host regardless of what Ingress they are defined on.
## Warning ## Warning

6
docs/user-guide/nginx-configuration/annotations.md
View file

@ -15,7 +15,6 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz
|Name | type | |Name | type |
|---------------------------|------| |---------------------------|------|
|[nginx.ingress.kubernetes.io/add-base-url](#rewrite)|"true" or "false"|
|[nginx.ingress.kubernetes.io/app-root](#rewrite)|string| |[nginx.ingress.kubernetes.io/app-root](#rewrite)|string|
|[nginx.ingress.kubernetes.io/affinity](#session-affinity)|cookie| |[nginx.ingress.kubernetes.io/affinity](#session-affinity)|cookie|
|[nginx.ingress.kubernetes.io/auth-realm](#authentication)|string| |[nginx.ingress.kubernetes.io/auth-realm](#authentication)|string|
@ -29,7 +28,6 @@ You can add these Kubernetes annotations to specific Ingress objects to customiz
|[nginx.ingress.kubernetes.io/auth-url](#external-authentication)|string| |[nginx.ingress.kubernetes.io/auth-url](#external-authentication)|string|
|[nginx.ingress.kubernetes.io/auth-snippet](#external-authentication)|string| |[nginx.ingress.kubernetes.io/auth-snippet](#external-authentication)|string|
|[nginx.ingress.kubernetes.io/backend-protocol](#backend-protocol)|string|HTTP,HTTPS,GRPC,GRPCS,AJP| |[nginx.ingress.kubernetes.io/backend-protocol](#backend-protocol)|string|HTTP,HTTPS,GRPC,GRPCS,AJP|
|[nginx.ingress.kubernetes.io/base-url-scheme](#rewrite)|string|
|[nginx.ingress.kubernetes.io/canary](#canary)|"true" or "false"| |[nginx.ingress.kubernetes.io/canary](#canary)|"true" or "false"|
|[nginx.ingress.kubernetes.io/canary-by-header](#canary)|string| |[nginx.ingress.kubernetes.io/canary-by-header](#canary)|string|
|[nginx.ingress.kubernetes.io/canary-by-cookie](#canary)|string| |[nginx.ingress.kubernetes.io/canary-by-cookie](#canary)|string|
@ -126,10 +124,6 @@ Currently a maximum of one canary ingress can be applied per Ingress rule.
In some scenarios the exposed URL in the backend service differs from the specified path in the Ingress rule. Without a rewrite any request will return 404. In some scenarios the exposed URL in the backend service differs from the specified path in the Ingress rule. Without a rewrite any request will return 404.
Set the annotation `nginx.ingress.kubernetes.io/rewrite-target` to the path expected by the service. Set the annotation `nginx.ingress.kubernetes.io/rewrite-target` to the path expected by the service.
If the application contains relative links it is possible to add an additional annotation `nginx.ingress.kubernetes.io/add-base-url` that will prepend a [`base` tag](https://developer.mozilla.org/en/docs/Web/HTML/Element/base) in the header of the returned HTML from the backend.
If the scheme of [`base` tag](https://developer.mozilla.org/en/docs/Web/HTML/Element/base) need to be specific, set the annotation `nginx.ingress.kubernetes.io/base-url-scheme` to the scheme such as `http` and `https`.
If the Application Root is exposed in a different path and needs to be redirected, set the annotation `nginx.ingress.kubernetes.io/app-root` to redirect requests for `/`. If the Application Root is exposed in a different path and needs to be redirected, set the annotation `nginx.ingress.kubernetes.io/app-root` to redirect requests for `/`.
!!! example !!! example

13
internal/ingress/annotations/rewrite/main.go
View file

@ -27,11 +27,6 @@ import (
type Config struct { type Config struct {
// Target URI where the traffic must be redirected // Target URI where the traffic must be redirected
Target string `json:"target"` Target string `json:"target"`
// AddBaseURL indicates if is required to add a base tag in the head
// of the responses from the upstream servers
AddBaseURL bool `json:"addBaseUrl"`
// BaseURLScheme override for the scheme passed to the base tag
BaseURLScheme string `json:"baseUrlScheme"`
// SSLRedirect indicates if the location section is accessible SSL only // SSLRedirect indicates if the location section is accessible SSL only
SSLRedirect bool `json:"sslRedirect"` SSLRedirect bool `json:"sslRedirect"`
// ForceSSLRedirect indicates if the location section is accessible SSL only // ForceSSLRedirect indicates if the location section is accessible SSL only
@ -53,12 +48,6 @@ func (r1 *Config) Equal(r2 *Config) bool {
if r1.Target != r2.Target { if r1.Target != r2.Target {
return false return false
} }
if r1.AddBaseURL != r2.AddBaseURL {
return false
}
if r1.BaseURLScheme != r2.BaseURLScheme {
return false
}
if r1.SSLRedirect != r2.SSLRedirect { if r1.SSLRedirect != r2.SSLRedirect {
return false return false
} }
@ -101,8 +90,6 @@ func (a rewrite) Parse(ing *extensions.Ingress) (interface{}, error) {
config.ForceSSLRedirect = a.r.GetDefaultBackend().ForceSSLRedirect config.ForceSSLRedirect = a.r.GetDefaultBackend().ForceSSLRedirect
} }
config.AddBaseURL, _ = parser.GetBoolAnnotation("add-base-url", ing)
config.BaseURLScheme, _ = parser.GetStringAnnotation("base-url-scheme", ing)
config.AppRoot, _ = parser.GetStringAnnotation("app-root", ing) config.AppRoot, _ = parser.GetStringAnnotation("app-root", ing)
config.UseRegex, _ = parser.GetBoolAnnotation("use-regex", ing) config.UseRegex, _ = parser.GetBoolAnnotation("use-regex", ing)

49
internal/ingress/controller/template/template.go
View file

@ -339,19 +339,6 @@ func buildLocation(input interface{}, enforceRegex bool) string {
} }
path := location.Path path := location.Path
if needsRewrite(location) {
if path == slash {
return fmt.Sprintf("~* ^%s", path)
}
// baseuri regex will parse basename from the given location
baseuri := `(?<baseuri>.*)`
if !strings.HasSuffix(path, slash) {
// Not treat the slash after "location path" as a part of baseuri
baseuri = fmt.Sprintf(`\/?%s`, baseuri)
}
return fmt.Sprintf(`~* "^%s%s"`, path, baseuri)
}
if enforceRegex { if enforceRegex {
return fmt.Sprintf(`~* "^%s"`, path) return fmt.Sprintf(`~* "^%s"`, path)
} }
@ -466,48 +453,16 @@ func buildProxyPass(host string, b interface{}, loc interface{}) string {
return defProxyPass return defProxyPass
} }
if !strings.HasSuffix(path, slash) {
path = fmt.Sprintf("%s/", path)
}
if len(location.Rewrite.Target) > 0 { if len(location.Rewrite.Target) > 0 {
var abu string
var xForwardedPrefix string var xForwardedPrefix string
if location.Rewrite.AddBaseURL {
bPath := fmt.Sprintf("%s$escaped_base_uri", path)
regex := `(<(?:H|h)(?:E|e)(?:A|a)(?:D|d)(?:[^">]|"[^"]*")*>)`
scheme := "$scheme"
if len(location.Rewrite.BaseURLScheme) > 0 {
scheme = location.Rewrite.BaseURLScheme
}
abu = fmt.Sprintf(`
set_escape_uri $escaped_base_uri $baseuri;
subs_filter '%v' '$1<base href="%v://$http_host%v">' ro;
`, regex, scheme, bPath)
}
if location.XForwardedPrefix { if location.XForwardedPrefix {
xForwardedPrefix = fmt.Sprintf("proxy_set_header X-Forwarded-Prefix \"%s\";\n", path) xForwardedPrefix = fmt.Sprintf("proxy_set_header X-Forwarded-Prefix \"%s\";\n", path)
} }
if location.Rewrite.Target == slash {
// special case redirect to /
// ie /something to /
return fmt.Sprintf(`
rewrite "(?i)%s(.*)" /$1 break;
rewrite "(?i)%s$" / break;
%v%v %s%s;
%v`, path, location.Path, xForwardedPrefix, proxyPass, proto, upstreamName, abu)
}
return fmt.Sprintf(` return fmt.Sprintf(`
rewrite "(?i)%s(.*)" %s/$1 break; rewrite "(?i)%s" %s break;
rewrite "(?i)%s$" %s/ break; %v%v %s%s;`, path, location.Rewrite.Target, xForwardedPrefix, proxyPass, proto, upstreamName)
%v%v %s%s;
%v`, path, location.Rewrite.Target, location.Path, location.Rewrite.Target, xForwardedPrefix, proxyPass, proto, upstreamName, abu)
} }
// default proxy_pass // default proxy_pass

205
internal/ingress/controller/template/template_test.go
View file

@ -45,8 +45,6 @@ var (
Target string Target string
Location string Location string
ProxyPass string ProxyPass string
AddBaseURL bool
BaseURLScheme string
Sticky bool Sticky bool
XForwardedPrefix bool XForwardedPrefix bool
SecureBackend bool SecureBackend bool
@ -58,8 +56,6 @@ var (
"/", "/",
"proxy_pass https://upstream_balancer;", "proxy_pass https://upstream_balancer;",
false, false,
"",
false,
false, false,
true, true,
false, false,
@ -70,8 +66,6 @@ var (
"/", "/",
"proxy_pass https://upstream_balancer;", "proxy_pass https://upstream_balancer;",
false, false,
"",
false,
false, false,
true, true,
false, false,
@ -81,8 +75,6 @@ var (
"/", "/",
"/", "/",
"proxy_pass https://upstream_balancer;", "proxy_pass https://upstream_balancer;",
false,
"",
true, true,
false, false,
true, true,
@ -94,8 +86,6 @@ var (
"/", "/",
"proxy_pass http://upstream_balancer;", "proxy_pass http://upstream_balancer;",
false, false,
"",
false,
false, false,
false, false,
false, false,
@ -106,8 +96,6 @@ var (
"/", "/",
"proxy_pass http://upstream_balancer;", "proxy_pass http://upstream_balancer;",
false, false,
"",
false,
false, false,
false, false,
false, false,
@ -115,157 +103,10 @@ var (
"redirect / to /jenkins": { "redirect / to /jenkins": {
"/", "/",
"/jenkins", "/jenkins",
"~* ^/", `~* "^/"`,
` `
rewrite "(?i)/(.*)" /jenkins/$1 break; rewrite "(?i)/" /jenkins break;
rewrite "(?i)/$" /jenkins/ break; proxy_pass http://upstream_balancer;`,
proxy_pass http://upstream_balancer;
`,
false,
"",
false,
false,
false,
true,
},
"redirect /something to /": {
"/something",
"/",
`~* "^/something\/?(?<baseuri>.*)"`,
`
rewrite "(?i)/something/(.*)" /$1 break;
rewrite "(?i)/something$" / break;
proxy_pass http://upstream_balancer;
`,
false,
"",
false,
false,
false,
true,
},
"redirect /end-with-slash/ to /not-root": {
"/end-with-slash/",
"/not-root",
`~* "^/end-with-slash/(?<baseuri>.*)"`,
`
rewrite "(?i)/end-with-slash/(.*)" /not-root/$1 break;
rewrite "(?i)/end-with-slash/$" /not-root/ break;
proxy_pass http://upstream_balancer;
`,
false,
"",
false,
false,
false,
true,
},
"redirect /something-complex to /not-root": {
"/something-complex",
"/not-root",
`~* "^/something-complex\/?(?<baseuri>.*)"`,
`
rewrite "(?i)/something-complex/(.*)" /not-root/$1 break;
rewrite "(?i)/something-complex$" /not-root/ break;
proxy_pass http://upstream_balancer;
`,
false,
"",
false,
false,
false,
true,
},
"redirect / to /jenkins and rewrite": {
"/",
"/jenkins",
"~* ^/",
`
rewrite "(?i)/(.*)" /jenkins/$1 break;
rewrite "(?i)/$" /jenkins/ break;
proxy_pass http://upstream_balancer;
set_escape_uri $escaped_base_uri $baseuri;
subs_filter '(<(?:H|h)(?:E|e)(?:A|a)(?:D|d)(?:[^">]|"[^"]*")*>)' '$1<base href="$scheme://$http_host/$escaped_base_uri">' ro;
`,
true,
"",
false,
false,
false,
true,
},
"redirect /something to / and rewrite": {
"/something",
"/",
`~* "^/something\/?(?<baseuri>.*)"`,
`
rewrite "(?i)/something/(.*)" /$1 break;
rewrite "(?i)/something$" / break;
proxy_pass http://upstream_balancer;
set_escape_uri $escaped_base_uri $baseuri;
subs_filter '(<(?:H|h)(?:E|e)(?:A|a)(?:D|d)(?:[^">]|"[^"]*")*>)' '$1<base href="$scheme://$http_host/something/$escaped_base_uri">' ro;
`,
true,
"",
false,
false,
false,
true,
},
"redirect /end-with-slash/ to /not-root and rewrite": {
"/end-with-slash/",
"/not-root",
`~* "^/end-with-slash/(?<baseuri>.*)"`,
`
rewrite "(?i)/end-with-slash/(.*)" /not-root/$1 break;
rewrite "(?i)/end-with-slash/$" /not-root/ break;
proxy_pass http://upstream_balancer;
set_escape_uri $escaped_base_uri $baseuri;
subs_filter '(<(?:H|h)(?:E|e)(?:A|a)(?:D|d)(?:[^">]|"[^"]*")*>)' '$1<base href="$scheme://$http_host/end-with-slash/$escaped_base_uri">' ro;
`,
true,
"",
false,
false,
false,
true,
},
"redirect /something-complex to /not-root and rewrite": {
"/something-complex",
"/not-root",
`~* "^/something-complex\/?(?<baseuri>.*)"`,
`
rewrite "(?i)/something-complex/(.*)" /not-root/$1 break;
rewrite "(?i)/something-complex$" /not-root/ break;
proxy_pass http://upstream_balancer;
set_escape_uri $escaped_base_uri $baseuri;
subs_filter '(<(?:H|h)(?:E|e)(?:A|a)(?:D|d)(?:[^">]|"[^"]*")*>)' '$1<base href="$scheme://$http_host/something-complex/$escaped_base_uri">' ro;
`,
true,
"",
false,
false,
false,
true,
},
"redirect /something to / and rewrite with specific scheme": {
"/something",
"/",
`~* "^/something\/?(?<baseuri>.*)"`,
`
rewrite "(?i)/something/(.*)" /$1 break;
rewrite "(?i)/something$" / break;
proxy_pass http://upstream_balancer;
set_escape_uri $escaped_base_uri $baseuri;
subs_filter '(<(?:H|h)(?:E|e)(?:A|a)(?:D|d)(?:[^">]|"[^"]*")*>)' '$1<base href="http://$http_host/something/$escaped_base_uri">' ro;
`,
true,
"http",
false, false,
false, false,
false, false,
@ -274,14 +115,10 @@ subs_filter '(<(?:H|h)(?:E|e)(?:A|a)(?:D|d)(?:[^">]|"[^"]*")*>)' '$1<base href="
"redirect / to /something with sticky enabled": { "redirect / to /something with sticky enabled": {
"/", "/",
"/something", "/something",
`~* ^/`, `~* "^/"`,
` `
rewrite "(?i)/(.*)" /something/$1 break; rewrite "(?i)/" /something break;
rewrite "(?i)/$" /something/ break; proxy_pass http://upstream_balancer;`,
proxy_pass http://upstream_balancer;
`,
false,
"http",
true, true,
false, false,
false, false,
@ -290,14 +127,10 @@ proxy_pass http://upstream_balancer;
"redirect / to /something with sticky and dynamic config enabled": { "redirect / to /something with sticky and dynamic config enabled": {
"/", "/",
"/something", "/something",
`~* ^/`, `~* "^/"`,
` `
rewrite "(?i)/(.*)" /something/$1 break; rewrite "(?i)/" /something break;
rewrite "(?i)/$" /something/ break; proxy_pass http://upstream_balancer;`,
proxy_pass http://upstream_balancer;
`,
false,
"http",
true, true,
false, false,
false, false,
@ -306,15 +139,11 @@ proxy_pass http://upstream_balancer;
"add the X-Forwarded-Prefix header": { "add the X-Forwarded-Prefix header": {
"/there", "/there",
"/something", "/something",
`~* "^/there\/?(?<baseuri>.*)"`, `~* "^/there"`,
` `
rewrite "(?i)/there/(.*)" /something/$1 break; rewrite "(?i)/there" /something break;
rewrite "(?i)/there$" /something/ break; proxy_set_header X-Forwarded-Prefix "/there";
proxy_set_header X-Forwarded-Prefix "/there/"; proxy_pass http://upstream_balancer;`,
proxy_pass http://upstream_balancer;
`,
false,
"http",
true, true,
true, true,
false, false,
@ -326,8 +155,6 @@ proxy_pass http://upstream_balancer;
`~* "^/something"`, `~* "^/something"`,
"proxy_pass http://upstream_balancer;", "proxy_pass http://upstream_balancer;",
false, false,
"",
false,
false, false,
false, false,
true, true,
@ -385,7 +212,7 @@ func TestBuildLocation(t *testing.T) {
for k, tc := range tmplFuncTestcases { for k, tc := range tmplFuncTestcases {
loc := &ingress.Location{ loc := &ingress.Location{
Path: tc.Path, Path: tc.Path,
Rewrite: rewrite.Config{Target: tc.Target, AddBaseURL: tc.AddBaseURL}, Rewrite: rewrite.Config{Target: tc.Target},
} }
newLoc := buildLocation(loc, tc.enforceRegex) newLoc := buildLocation(loc, tc.enforceRegex)
@ -402,7 +229,7 @@ func TestBuildProxyPass(t *testing.T) {
for k, tc := range tmplFuncTestcases { for k, tc := range tmplFuncTestcases {
loc := &ingress.Location{ loc := &ingress.Location{
Path: tc.Path, Path: tc.Path,
Rewrite: rewrite.Config{Target: tc.Target, AddBaseURL: tc.AddBaseURL, BaseURLScheme: tc.BaseURLScheme}, Rewrite: rewrite.Config{Target: tc.Target},
Backend: defaultBackend, Backend: defaultBackend,
XForwardedPrefix: tc.XForwardedPrefix, XForwardedPrefix: tc.XForwardedPrefix,
} }
@ -768,7 +595,7 @@ func TestBuildUpstreamName(t *testing.T) {
for k, tc := range tmplFuncTestcases { for k, tc := range tmplFuncTestcases {
loc := &ingress.Location{ loc := &ingress.Location{
Path: tc.Path, Path: tc.Path,
Rewrite: rewrite.Config{Target: tc.Target, AddBaseURL: tc.AddBaseURL, BaseURLScheme: tc.BaseURLScheme}, Rewrite: rewrite.Config{Target: tc.Target},
Backend: defaultBackend, Backend: defaultBackend,
XForwardedPrefix: tc.XForwardedPrefix, XForwardedPrefix: tc.XForwardedPrefix,
} }

5
rootfs/etc/nginx/template/nginx.tmpl
View file

@ -1291,11 +1291,6 @@ stream {
proxy_next_upstream {{ buildNextUpstream $location.Proxy.NextUpstream $all.Cfg.RetryNonIdempotent }}; proxy_next_upstream {{ buildNextUpstream $location.Proxy.NextUpstream $all.Cfg.RetryNonIdempotent }};
proxy_next_upstream_tries {{ $location.Proxy.NextUpstreamTries }}; proxy_next_upstream_tries {{ $location.Proxy.NextUpstreamTries }};
{{/* rewrite only works if the content is not compressed */}}
{{ if $location.Rewrite.AddBaseURL }}
{{ $proxySetHeader }} Accept-Encoding "";
{{ end }}
{{/* Add any additional configuration defined */}} {{/* Add any additional configuration defined */}}
{{ $location.ConfigurationSnippet }} {{ $location.ConfigurationSnippet }}

101
test/e2e/annotations/rewrite.go
View file

@ -38,71 +38,6 @@ var _ = framework.IngressNginxDescribe("Annotations - Rewrite", func() {
AfterEach(func() { AfterEach(func() {
}) })
It("should rewrite request URL", func() {
By("setting rewrite-target annotation")
host := "rewrite.foo.com"
annotations := map[string]string{"nginx.ingress.kubernetes.io/rewrite-target": "/"}
expectBodyRequestURI := fmt.Sprintf("request_uri=http://%v:8080/", host)
ing := framework.NewSingleIngress(host, "/something", host, f.IngressController.Namespace, "http-svc", 80, &annotations)
f.EnsureIngress(ing)
f.WaitForNginxServer(host,
func(server string) bool {
return strings.Contains(server, `rewrite "(?i)/something/(.*)" /$1 break;`) &&
strings.Contains(server, `rewrite "(?i)/something$" / break;`)
})
By("sending request to Ingress rule path (lowercase)")
resp, body, errs := gorequest.New().
Get(f.IngressController.HTTPURL+"/something").
Set("Host", host).
End()
Expect(len(errs)).Should(Equal(0))
Expect(resp.StatusCode).Should(Equal(http.StatusOK))
Expect(body).Should(ContainSubstring(expectBodyRequestURI))
By("sending request to Ingress rule path (mixed case)")
resp, body, errs = gorequest.New().
Get(f.IngressController.HTTPURL+"/SomeThing").
Set("Host", host).
End()
Expect(len(errs)).Should(Equal(0))
Expect(resp.StatusCode).Should(Equal(http.StatusOK))
Expect(body).Should(ContainSubstring(expectBodyRequestURI))
})
It("should not redirect to ssl", func() {
host := "rewrite.foo.com"
annotations := map[string]string{"nginx.ingress.kubernetes.io/ssl-redirect": "false"}
ing := framework.NewSingleIngressWithTLS(host, "/", host, f.IngressController.Namespace, "http-svc", 80, &annotations)
f.EnsureIngress(ing)
tlsConfig, err := framework.CreateIngressTLSSecret(
f.KubeClientSet,
ing.Spec.TLS[0].Hosts,
ing.Spec.TLS[0].SecretName,
ing.Namespace)
Expect(err).ToNot(HaveOccurred())
framework.WaitForTLS(f.IngressController.HTTPSURL, tlsConfig)
resp, _, errs := gorequest.New().
Get(f.IngressController.HTTPURL+"/").
Set("Host", host).
RedirectPolicy(noRedirectPolicyFunc).
End()
Expect(len(errs)).Should(Equal(0))
Expect(resp.StatusCode).Should(Equal(http.StatusOK))
})
It("should write rewrite logs", func() { It("should write rewrite logs", func() {
By("setting enable-rewrite-log annotation") By("setting enable-rewrite-log annotation")
@ -130,7 +65,7 @@ var _ = framework.IngressNginxDescribe("Annotations - Rewrite", func() {
logs, err := f.NginxLogs() logs, err := f.NginxLogs()
Expect(err).ToNot(HaveOccurred()) Expect(err).ToNot(HaveOccurred())
Expect(logs).To(ContainSubstring(`"(?i)/something$" matches "/something", client:`)) Expect(logs).To(ContainSubstring(`"(?i)/something" matches "/something", client:`))
Expect(logs).To(ContainSubstring(`rewritten data: "/", args: "",`)) Expect(logs).To(ContainSubstring(`rewritten data: "/", args: "",`))
}) })
@ -166,7 +101,7 @@ var _ = framework.IngressNginxDescribe("Annotations - Rewrite", func() {
f.WaitForNginxServer(host, f.WaitForNginxServer(host,
func(server string) bool { func(server string) bool {
return strings.Contains(server, "location ~* ^/ {") && strings.Contains(server, `location ~* "^/.well-known/acme/challenge" {`) return strings.Contains(server, `location ~* "^/" {`) && strings.Contains(server, `location ~* "^/.well-known/acme/challenge" {`)
}) })
By("making a second request to the non-rewritten location") By("making a second request to the non-rewritten location")
@ -201,7 +136,7 @@ var _ = framework.IngressNginxDescribe("Annotations - Rewrite", func() {
f.WaitForNginxServer(host, f.WaitForNginxServer(host,
func(server string) bool { func(server string) bool {
return strings.Contains(server, `location ~* "^/foo" {`) && strings.Contains(server, `location ~* "^/foo.+\/?(?<baseuri>.*)" {`) return strings.Contains(server, `location ~* "^/foo" {`) && strings.Contains(server, `location ~* "^/foo.+" {`)
}) })
By("ensuring '/foo' matches '~* ^/foo'") By("ensuring '/foo' matches '~* ^/foo'")
@ -242,7 +177,7 @@ var _ = framework.IngressNginxDescribe("Annotations - Rewrite", func() {
f.WaitForNginxServer(host, f.WaitForNginxServer(host,
func(server string) bool { func(server string) bool {
return strings.Contains(server, `location ~* "^/foo/bar/bar" {`) && strings.Contains(server, `location ~* "^/foo/bar/[a-z]{3}\/?(?<baseuri>.*)" {`) return strings.Contains(server, `location ~* "^/foo/bar/bar" {`) && strings.Contains(server, `location ~* "^/foo/bar/[a-z]{3}" {`)
}) })
By("check that '/foo/bar/bar' does not match the longest exact path") By("check that '/foo/bar/bar' does not match the longest exact path")
@ -255,4 +190,32 @@ var _ = framework.IngressNginxDescribe("Annotations - Rewrite", func() {
Expect(resp.StatusCode).Should(Equal(http.StatusOK)) Expect(resp.StatusCode).Should(Equal(http.StatusOK))
Expect(body).Should(ContainSubstring(expectBodyRequestURI)) Expect(body).Should(ContainSubstring(expectBodyRequestURI))
}) })
It("should allow for custom rewrite parameters", func() {
host := "rewrite.bar.com"
By(`creating an ingress definition with the use-regex annotation`)
annotations := map[string]string{
"nginx.ingress.kubernetes.io/use-regex": "true",
"nginx.ingress.kubernetes.io/rewrite-target": "/new/backend/$1",
}
ing := framework.NewSingleIngress("regex", "/foo/bar/(.+)", host, f.IngressController.Namespace, "http-svc", 80, &annotations)
f.EnsureIngress(ing)
f.WaitForNginxServer(host,
func(server string) bool {
return strings.Contains(server, `location ~* "^/foo/bar/(.+)" {`)
})
By("check that '/foo/bar/bar' redirects to cusotm rewrite")
resp, body, errs := gorequest.New().
Get(f.IngressController.HTTPURL+"/foo/bar/bar").
Set("Host", host).
End()
expectBodyRequestURI := fmt.Sprintf("request_uri=http://%v:8080/new/backend/bar", host)
Expect(len(errs)).Should(Equal(0))
Expect(resp.StatusCode).Should(Equal(http.StatusOK))
Expect(body).Should(ContainSubstring(expectBodyRequestURI))
})
}) })

5
test/manifests/configuration-a.json
View file

@ -276,7 +276,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": false, "sslRedirect": false,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -384,7 +383,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": true, "sslRedirect": true,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -463,7 +461,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": false, "sslRedirect": false,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -576,7 +573,6 @@
}, },
"redirect": { "redirect": {
"target": "/", "target": "/",
"addBaseUrl": false,
"sslRedirect": true, "sslRedirect": true,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -655,7 +651,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": false, "sslRedirect": false,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""

5
test/manifests/configuration-b.json
View file

@ -276,7 +276,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": false, "sslRedirect": false,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -384,7 +383,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": true, "sslRedirect": true,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -463,7 +461,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": false, "sslRedirect": false,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -576,7 +573,6 @@
}, },
"redirect": { "redirect": {
"target": "/", "target": "/",
"addBaseUrl": false,
"sslRedirect": true, "sslRedirect": true,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -675,7 +671,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": false, "sslRedirect": false,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""

2
test/manifests/configuration-c.json
View file

@ -128,7 +128,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": false, "sslRedirect": false,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""
@ -229,7 +228,6 @@
}, },
"redirect": { "redirect": {
"target": "", "target": "",
"addBaseUrl": false,
"sslRedirect": true, "sslRedirect": true,
"forceSSLRedirect": false, "forceSSLRedirect": false,
"appRoot": "" "appRoot": ""