2024-09-15 15:04:08 +00:00
<!doctype html> < html lang = en class = no-js > < head > < meta charset = utf-8 > < meta name = viewport content = "width=device-width,initial-scale=1" > < link href = https://kubernetes.github.io/ingress-nginx/examples/rewrite/ rel = canonical > < link href = ../multi-tls/ rel = prev > < link href = ../static-ip/ rel = next > < link rel = icon href = ../../assets/images/favicon.png > < meta name = generator content = "mkdocs-1.5.3, mkdocs-material-9.4.5" > < title > Rewrite - Ingress-Nginx Controller< / title > < link rel = stylesheet href = ../../assets/stylesheets/main.6a10b989.min.css > < link rel = stylesheet href = ../../assets/stylesheets/palette.356b1318.min.css > < link rel = preconnect href = https://fonts.gstatic.com crossorigin > < link rel = stylesheet href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" > < style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style > < link rel = stylesheet href = ../../extra.css > < script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script > < / head > < body dir = ltr data-md-color-scheme = default data-md-color-primary = teal data-md-color-accent = green > < input class = md-toggle data-md-toggle = drawer type = checkbox id = __drawer autocomplete = off > < input class = md-toggle data-md-toggle = search type = checkbox id = __search autocomplete = off > < label class = md-overlay for = __drawer > < / label > < div data-md-component = skip > < a href = #rewrite class = md-skip > Skip to content < / a > < / div > < div data-md-component = announce > < / div > < header class = "md-header md-header--shadow md-header--lifted" data-md-component = header > < nav class = "md-header__inner md-grid" aria-label = Header > < a href = ../.. title = "Ingress-Nginx Controller" class = "md-header__button md-logo" aria-label = "Ingress-Nginx Controller" data-md-component = logo > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" / > < / svg > < / a > < label class = "md-header__button md-icon" for = __drawer > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg > < / label > < div class = md-header__title data-md-component = header-title > < div class = md-header__ellipsis > < div class = md-header__topic > < span class = md-ellipsis > Ingress-Nginx Controller < / span > < / div > < div class = md-header__topic data-md-component = header-topic > < span class = md-ellipsis > Rewrite < / span > < / div > < / div > < / div > < label class = "md-header__button md-icon" for = __search > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg > < / label > < div class = md-search data-md-component = search role = dialog > < label class = md-search__overlay for = __search > < / label > < div class = md-search__inner role = search > < form class = md-search__form name = search > < input type = text class = md-search__input name = query aria-label = Search placeholder = Search autocapitalize = off autocorrect = off autocomplete = off spellcheck = false data-md-component = search-query required > < label class = "md-search__icon md-icon" for = __search > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" / > < / svg > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg > < / label > < nav class = md-search__options aria-label = Search > < button type = reset class = "md-search__icon md-icon" title = Clear aria-label = Clea
2021-08-21 20:43:04 +00:00
< span class = go > apiVersion: networking.k8s.io/v1< / span >
2021-01-11 15:59:14 +00:00
< span class = go > kind: Ingress< / span >
< span class = go > metadata:< / span >
< span class = go > annotations:< / span >
2023-02-15 13:51:16 +00:00
< span class = go > nginx.ingress.kubernetes.io/use-regex: " true" < / span >
2021-01-11 15:59:14 +00:00
< span class = go > nginx.ingress.kubernetes.io/rewrite-target: /$2< / span >
< span class = go > name: rewrite< / span >
< span class = go > namespace: default< / span >
< span class = go > spec:< / span >
2021-11-09 15:45:04 +00:00
< span class = go > ingressClassName: nginx< / span >
2021-01-11 15:59:14 +00:00
< span class = go > rules:< / span >
< span class = go > - host: rewrite.bar.com< / span >
< span class = go > http:< / span >
< span class = go > paths:< / span >
2021-11-02 00:13:54 +00:00
< span class = go > - path: /something(/|$)(.*)< / span >
2023-09-03 21:10:32 +00:00
< span class = go > pathType: ImplementationSpecific< / span >
2021-11-02 00:13:54 +00:00
< span class = go > backend:< / span >
< span class = go > service:< / span >
< span class = go > name: http-svc< / span >
< span class = go > port: < / span >
< span class = go > number: 80< / span >
2021-01-11 15:59:14 +00:00
< span class = go > ' | kubectl create -f -< / span >
< / code > < / pre > < / div > < p > In this ingress definition, any characters captured by < code > (.*)< / code > will be assigned to the placeholder < code > $2< / code > , which is then used as a parameter in the < code > rewrite-target< / code > annotation.< / p > < p > For example, the ingress definition above will result in the following rewrites:< / p > < ul > < li > < code > rewrite.bar.com/something< / code > rewrites to < code > rewrite.bar.com/< / code > < / li > < li > < code > rewrite.bar.com/something/< / code > rewrites to < code > rewrite.bar.com/< / code > < / li > < li > < code > rewrite.bar.com/something/new< / code > rewrites to < code > rewrite.bar.com/new< / code > < / li > < / ul > < h3 id = app-root > App Root< a class = headerlink href = #app-root title = "Permanent link" > ¶< / a > < / h3 > < p > Create an Ingress rule with an app-root annotation: < div class = highlight > < pre > < span > < / span > < code > $ echo "
2021-08-21 20:43:04 +00:00
apiVersion: networking.k8s.io/v1
2020-04-15 17:09:38 +00:00
kind: Ingress
metadata:
annotations:
nginx.ingress.kubernetes.io/app-root: /app1
name: approot
namespace: default
spec:
2021-11-09 15:45:04 +00:00
ingressClassName: nginx
2020-04-15 17:09:38 +00:00
rules:
- host: approot.bar.com
http:
paths:
2021-11-02 00:13:54 +00:00
- path: /
pathType: Prefix
backend:
service:
name: http-svc
port:
number: 80
2020-04-15 17:09:38 +00:00
" | kubectl create -f -
2021-01-11 15:59:14 +00:00
< / code > < / pre > < / div > < / p > < p > Check the rewrite is working< / p > < div class = highlight > < pre > < span > < / span > < code > $ curl -I -k http://approot.bar.com/
2020-04-15 17:09:38 +00:00
HTTP/1.1 302 Moved Temporarily
2018-04-27 00:09:55 +00:00
Server: nginx/1.11.10
2020-04-15 17:09:38 +00:00
Date: Mon, 13 Mar 2017 14:57:15 GMT
2018-04-27 00:09:55 +00:00
Content-Type: text/html
2020-04-15 17:09:38 +00:00
Content-Length: 162
2021-10-01 13:12:32 +00:00
Location: http://approot.bar.com/app1
2018-04-27 00:09:55 +00:00
Connection: keep-alive
2023-10-12 19:31:18 +00:00
< / code > < / pre > < / div > < / article > < / div > < / div > < / main > < footer class = md-footer > < div class = "md-footer-meta md-typeset" > < div class = "md-footer-meta__inner md-grid" > < div class = md-copyright > Made with < a href = https://squidfunk.github.io/mkdocs-material/ target = _blank rel = noopener > Material for MkDocs < / a > < / div > < / div > < / div > < / footer > < / div > < div class = md-dialog data-md-component = dialog > < div class = "md-dialog__inner md-typeset" > < / div > < / div > < script id = __config type = application/json > { "base" : "../.." , "features" : [ "navigation.tabs" , "navigation.tabs.sticky" , "navigation.instant" , "navigation.sections" ] , "search" : "../../assets/javascripts/workers/search.f886a092.min.js" , "translations" : { "clipboard.copied" : "Copied to clipboard" , "clipboard.copy" : "Copy to clipboard" , "search.result.more.one" : "1 more on this page" , "search.result.more.other" : "# more on this page" , "search.result.none" : "No matching documents" , "search.result.one" : "1 matching document" , "search.result.other" : "# matching documents" , "search.result.placeholder" : "Type to start searching" , "search.result.term.missing" : "Missing" , "select.version" : "Select version" } } < / script > < script src = ../../assets/javascripts/bundle.aecac24b.min.js > < / script > < / body > < / html >
