ingress-nginx-helm/user-guide/multiple-ingress/index.html

52 lines
34 KiB
HTML
Raw Permalink Normal View History

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/user-guide/multiple-ingress/ rel=canonical><link href=../monitoring/ rel=prev><link href=../tls/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.4.5"><title>Multiple Ingress controllers - 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=#multiple-ingress-controllers 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> Multiple Ingress controllers </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 t
2021-11-15 20:21:51 +00:00
<span class=nt>spec</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>template</span><span class=p>:</span>
<span class=w> </span><span class=nt>spec</span><span class=p>:</span>
<span class=w> </span><span class=nt>containers</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">ingress-nginx-internal-controller</span>
<span class=w> </span><span class=nt>args</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">/nginx-ingress-controller</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=s>&#39;--election-id=ingress-controller-leader&#39;</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=s>&#39;--controller-class=k8s.io/internal-ingress-nginx&#39;</span>
2024-01-27 07:45:59 +00:00
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=s>&#39;--ingress-class=k8s.io/internal-nginx&#39;</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class="w w-Error"> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
2021-11-15 20:21:51 +00:00
</code></pre></div> <p>Then use the same value in the IngressClass:</p> <div class=highlight><pre><span></span><code><span class=c1># ingress-nginx IngressClass</span>
2023-10-12 19:31:18 +00:00
<span class=nt>apiVersion</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">networking.k8s.io/v1</span>
<span class=nt>kind</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">IngressClass</span>
2021-11-15 20:21:51 +00:00
<span class=nt>metadata</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">internal-nginx</span>
2021-11-15 20:21:51 +00:00
<span class=nt>spec</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>controller</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">k8s.io/internal-ingress-nginx</span>
<span class=w> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
</code></pre></div> <p>And refer to that IngressClass in your Ingress:</p> <div class=highlight><pre><span></span><code><span class=nt>apiVersion</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">networking.k8s.io/v1</span>
<span class=nt>kind</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">Ingress</span>
2021-11-15 20:21:51 +00:00
<span class=nt>metadata</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">my-ingress</span>
2021-11-15 20:21:51 +00:00
<span class=nt>spec</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>ingressClassName</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">internal-nginx</span>
<span class=w> </span><span class="l l-Scalar l-Scalar-Plain">...</span>
2021-11-15 20:21:51 +00:00
</code></pre></div> <p>or if installing with Helm:</p> <div class=highlight><pre><span></span><code><span class=nt>controller</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>electionID</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">ingress-controller-leader</span>
2024-07-01 09:12:46 +00:00
<span class=w> </span><span class=nt>ingressClass</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">internal-nginx</span><span class=w> </span><span class=c1># default: nginx</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>ingressClassResource</span><span class=p>:</span>
<span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">internal-nginx</span><span class=w> </span><span class=c1># default: nginx</span>
<span class=w> </span><span class=nt>enabled</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
<span class=w> </span><span class=nt>default</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">false</span>
<span class=w> </span><span class=nt>controllerValue</span><span class=p>:</span><span class=w> </span><span class=s>&quot;k8s.io/internal-ingress-nginx&quot;</span><span class=w> </span><span class=c1># default: k8s.io/ingress-nginx</span>
2021-11-15 20:21:51 +00:00
</code></pre></div> <div class="admonition important"> <p class=admonition-title>Important</p> <p>When running multiple ingress-nginx controllers, it will only process an unset class annotation if one of the controllers uses the default <code>--controller-class</code> value (see <code>IsValid</code> method in <code>internal/ingress/annotations/class/main.go</code>), otherwise the class annotation becomes required.</p> <p>If <code>--controller-class</code> is set to the default value of <code>k8s.io/ingress-nginx</code>, the controller will monitor Ingresses with no class annotation <em>and</em> Ingresses with annotation class set to <code>nginx</code>. Use a non-default value for <code>--controller-class</code>, to ensure that the controller only satisfied the specific class of Ingresses.</p> </div> <h2 id=using-the-kubernetesioingressclass-annotation-in-deprecation>Using the kubernetes.io/ingress.class annotation (in deprecation)<a class=headerlink href=#using-the-kubernetesioingressclass-annotation-in-deprecation title="Permanent link"></a></h2> <p>If you're running multiple ingress controllers where one or more do not support IngressClasses, you must specify the annotation <code>kubernetes.io/ingress.class: "nginx"</code> in all ingresses that you would like ingress-nginx to claim.</p> <p>For instance,</p> <div class=highlight><pre><span></span><code><span class=nt>metadata</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
<span class=w> </span><span class=nt>annotations</span><span class=p>:</span>
<span class=w> </span><span class=nt>kubernetes.io/ingress.class</span><span class=p>:</span><span class=w> </span><span class=s>&quot;gce&quot;</span>
2022-01-17 00:58:25 +00:00
</code></pre></div> <p>will target the GCE controller, forcing the Ingress-NGINX controller to ignore it, while an annotation like:</p> <div class=highlight><pre><span></span><code><span class=nt>metadata</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
<span class=w> </span><span class=nt>annotations</span><span class=p>:</span>
<span class=w> </span><span class=nt>kubernetes.io/ingress.class</span><span class=p>:</span><span class=w> </span><span class=s>&quot;nginx&quot;</span>
2022-01-17 00:58:25 +00:00
</code></pre></div> <p>will target the Ingress-NGINX controller, forcing the GCE controller to ignore it.</p> <p>You can change the value "nginx" to something else by setting the <code>--ingress-class</code> flag:</p> <div class=highlight><pre><span></span><code><span class=nt>spec</span><span class=p>:</span>
2023-10-12 19:31:18 +00:00
<span class=w> </span><span class=nt>template</span><span class=p>:</span>
<span class=w> </span><span class=nt>spec</span><span class=p>:</span>
<span class=w> </span><span class=nt>containers</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">ingress-nginx-internal-controller</span>
<span class=w> </span><span class=nt>args</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">/nginx-ingress-controller</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">--ingress-class=internal-nginx</span>
</code></pre></div> <p>then setting the corresponding <code>kubernetes.io/ingress.class: "internal-nginx"</code> annotation on your Ingresses.</p> <p>To reiterate, setting the annotation to any value which does not match a valid ingress class will force the Ingress-Nginx Controller to ignore your Ingress. If you are only running a single Ingress-Nginx Controller, this can be achieved by setting the annotation to any value except "nginx" or an empty string.</p> <p>Do this if you wish to use one of the other Ingress controllers at the same time as the NGINX controller.</p> </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>