ingress-nginx-helm/examples/canary/index.html

174 lines
36 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/examples/canary/ rel=canonical><link href=../openpolicyagent/ rel=prev><link href=../../developer-guide/getting-started/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.4.5"><title>Canary Deployments - 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=#canary 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> Canary Deployments </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="m
2023-06-09 11:59:15 +00:00
<span class=s2>---</span>
<span class=s2># Deployment</span>
<span class=s2>apiVersion: apps/v1</span>
<span class=s2>kind: Deployment</span>
<span class=s2>metadata:</span>
<span class=s2> name: production</span>
<span class=s2> labels:</span>
<span class=s2> app: production</span>
<span class=s2>spec:</span>
<span class=s2> replicas: 1</span>
<span class=s2> selector:</span>
<span class=s2> matchLabels:</span>
<span class=s2> app: production</span>
<span class=s2> template:</span>
<span class=s2> metadata:</span>
<span class=s2> labels:</span>
<span class=s2> app: production</span>
<span class=s2> spec:</span>
<span class=s2> containers:</span>
<span class=s2> - name: production</span>
2025-01-13 08:13:17 +00:00
<span class=s2> image: registry.k8s.io/ingress-nginx/e2e-test-echo:v1.1.1@sha256:a1e0152e2eeab26e3f6fd3986f3d82b17bc7711717cae5392dcd18dd447ba6ef</span>
2023-06-09 11:59:15 +00:00
<span class=s2> ports:</span>
<span class=s2> - containerPort: 80</span>
<span class=s2> env:</span>
<span class=s2> - name: NODE_NAME</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: spec.nodeName</span>
<span class=s2> - name: POD_NAME</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: metadata.name</span>
<span class=s2> - name: POD_NAMESPACE</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: metadata.namespace</span>
<span class=s2> - name: POD_IP</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: status.podIP</span>
<span class=s2>---</span>
<span class=s2># Service</span>
<span class=s2>apiVersion: v1</span>
<span class=s2>kind: Service</span>
<span class=s2>metadata:</span>
<span class=s2> name: production</span>
<span class=s2> labels:</span>
<span class=s2> app: production</span>
<span class=s2>spec:</span>
<span class=s2> ports:</span>
<span class=s2> - port: 80</span>
<span class=s2> targetPort: 80</span>
<span class=s2> protocol: TCP</span>
<span class=s2> name: http</span>
<span class=s2> selector:</span>
<span class=s2> app: production</span>
2023-10-12 19:31:18 +00:00
<span class=s2>&quot;</span><span class=w> </span><span class=p>|</span><span class=w> </span>kubectl<span class=w> </span>apply<span class=w> </span>-f<span class=w> </span>-
</code></pre></div> <h2 id=create-the-canary-deployment-and-service>Create the canary deployment and service<a class=headerlink href=#create-the-canary-deployment-and-service title="Permanent link"></a></h2> <p>This is the canary deployment that will take a weighted amount of requests instead of the main deployment</p> <div class=highlight><pre><span></span><code><span class=nb>echo</span><span class=w> </span><span class=s2>&quot;</span>
2023-06-09 11:59:15 +00:00
<span class=s2>---</span>
<span class=s2># Deployment</span>
<span class=s2>apiVersion: apps/v1</span>
<span class=s2>kind: Deployment</span>
<span class=s2>metadata:</span>
<span class=s2> name: canary</span>
<span class=s2> labels:</span>
<span class=s2> app: canary</span>
<span class=s2>spec:</span>
<span class=s2> replicas: 1</span>
<span class=s2> selector:</span>
<span class=s2> matchLabels:</span>
<span class=s2> app: canary</span>
<span class=s2> template:</span>
<span class=s2> metadata:</span>
<span class=s2> labels:</span>
<span class=s2> app: canary</span>
<span class=s2> spec:</span>
<span class=s2> containers:</span>
<span class=s2> - name: canary</span>
2025-01-13 08:13:17 +00:00
<span class=s2> image: registry.k8s.io/ingress-nginx/e2e-test-echo:v1.1.1@sha256:a1e0152e2eeab26e3f6fd3986f3d82b17bc7711717cae5392dcd18dd447ba6ef</span>
2023-06-09 11:59:15 +00:00
<span class=s2> ports:</span>
<span class=s2> - containerPort: 80</span>
<span class=s2> env:</span>
<span class=s2> - name: NODE_NAME</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: spec.nodeName</span>
<span class=s2> - name: POD_NAME</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: metadata.name</span>
<span class=s2> - name: POD_NAMESPACE</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: metadata.namespace</span>
<span class=s2> - name: POD_IP</span>
<span class=s2> valueFrom:</span>
<span class=s2> fieldRef:</span>
<span class=s2> fieldPath: status.podIP</span>
<span class=s2>---</span>
<span class=s2># Service</span>
<span class=s2>apiVersion: v1</span>
<span class=s2>kind: Service</span>
<span class=s2>metadata:</span>
<span class=s2> name: canary</span>
<span class=s2> labels:</span>
<span class=s2> app: canary</span>
<span class=s2>spec:</span>
<span class=s2> ports:</span>
<span class=s2> - port: 80</span>
<span class=s2> targetPort: 80</span>
<span class=s2> protocol: TCP</span>
<span class=s2> name: http</span>
<span class=s2> selector:</span>
<span class=s2> app: canary</span>
2023-10-12 19:31:18 +00:00
<span class=s2>&quot;</span><span class=w> </span><span class=p>|</span><span class=w> </span>kubectl<span class=w> </span>apply<span class=w> </span>-f<span class=w> </span>-
</code></pre></div> <h2 id=create-ingress-pointing-to-your-main-deployment>Create Ingress Pointing To Your Main Deployment<a class=headerlink href=#create-ingress-pointing-to-your-main-deployment title="Permanent link"></a></h2> <p>Next you will need to expose your main deployment with an ingress resource, note there are no canary specific annotations on this ingress</p> <div class=highlight><pre><span></span><code><span class=nb>echo</span><span class=w> </span><span class=s2>&quot;</span>
2023-06-09 11:59:15 +00:00
<span class=s2>---</span>
<span class=s2># Ingress</span>
<span class=s2>apiVersion: networking.k8s.io/v1</span>
<span class=s2>kind: Ingress</span>
<span class=s2>metadata:</span>
<span class=s2> name: production</span>
<span class=s2> annotations:</span>
<span class=s2>spec:</span>
<span class=s2> ingressClassName: nginx</span>
<span class=s2> rules:</span>
<span class=s2> - host: echo.prod.mydomain.com</span>
<span class=s2> http:</span>
<span class=s2> paths:</span>
<span class=s2> - pathType: Prefix</span>
<span class=s2> path: /</span>
<span class=s2> backend:</span>
<span class=s2> service:</span>
<span class=s2> name: production</span>
<span class=s2> port:</span>
<span class=s2> number: 80</span>
2023-10-12 19:31:18 +00:00
<span class=s2>&quot;</span><span class=w> </span><span class=p>|</span><span class=w> </span>kubectl<span class=w> </span>apply<span class=w> </span>-f<span class=w> </span>-
</code></pre></div> <h2 id=create-ingress-pointing-to-your-canary-deployment>Create Ingress Pointing To Your Canary Deployment<a class=headerlink href=#create-ingress-pointing-to-your-canary-deployment title="Permanent link"></a></h2> <p>You will then create an Ingress that has the canary specific configuration, please pay special notice of the following:</p> <ul> <li>The host name is identical to the main ingress host name</li> <li>The <code>nginx.ingress.kubernetes.io/canary: "true"</code> annotation is required and defines this as a canary annotation (if you do not have this the Ingresses will clash)</li> <li>The <code>nginx.ingress.kubernetes.io/canary-weight: "50"</code> annotation dictates the weight of the routing, in this case there is a "50%" chance a request will hit the canary deployment over the main deployment <div class=highlight><pre><span></span><code><span class=nb>echo</span><span class=w> </span><span class=s2>&quot;</span>
2023-06-09 11:59:15 +00:00
<span class=s2>---</span>
<span class=s2># Ingress</span>
<span class=s2>apiVersion: networking.k8s.io/v1</span>
<span class=s2>kind: Ingress</span>
<span class=s2>metadata:</span>
<span class=s2> name: canary</span>
<span class=s2> annotations:</span>
<span class=s2> nginx.ingress.kubernetes.io/canary: \&quot;true\&quot;</span>
<span class=s2> nginx.ingress.kubernetes.io/canary-weight: \&quot;50\&quot;</span>
<span class=s2>spec:</span>
<span class=s2> ingressClassName: nginx</span>
<span class=s2> rules:</span>
<span class=s2> - host: echo.prod.mydomain.com</span>
<span class=s2> http:</span>
<span class=s2> paths:</span>
<span class=s2> - pathType: Prefix</span>
<span class=s2> path: /</span>
<span class=s2> backend:</span>
<span class=s2> service:</span>
<span class=s2> name: canary</span>
<span class=s2> port:</span>
<span class=s2> number: 80</span>
2023-10-12 19:31:18 +00:00
<span class=s2>&quot;</span><span class=w> </span><span class=p>|</span><span class=w> </span>kubectl<span class=w> </span>apply<span class=w> </span>-f<span class=w> </span>-
</code></pre></div></li> </ul> <h2 id=testing-your-setup>Testing your setup<a class=headerlink href=#testing-your-setup title="Permanent link"></a></h2> <p>You can use the following command to test your setup (replacing INGRESS_CONTROLLER_IP with your ingresse controllers IP Address)</p> <div class=highlight><pre><span></span><code><span class=k>for</span><span class=w> </span>i<span class=w> </span><span class=k>in</span><span class=w> </span><span class=k>$(</span>seq<span class=w> </span><span class=m>1</span><span class=w> </span><span class=m>10</span><span class=k>)</span><span class=p>;</span><span class=w> </span><span class=k>do</span><span class=w> </span>curl<span class=w> </span>-s<span class=w> </span>--resolve<span class=w> </span>echo.prod.mydomain.com:80:<span class=nv>$INGRESS_CONTROLLER_IP</span><span class=w> </span>echo.prod.mydomain.com<span class=w> </span><span class=p>|</span><span class=w> </span>grep<span class=w> </span><span class=s2>&quot;Hostname&quot;</span><span class=p>;</span><span class=w> </span><span class=k>done</span>
</code></pre></div> <p>You will get the following output showing that your canary setup is working as expected:</p> <div class=highlight><pre><span></span><code>Hostname:<span class=w> </span>production-5c5f65d859-phqzc
Hostname:<span class=w> </span>canary-6697778457-zkfjf
Hostname:<span class=w> </span>canary-6697778457-zkfjf
Hostname:<span class=w> </span>production-5c5f65d859-phqzc
Hostname:<span class=w> </span>canary-6697778457-zkfjf
Hostname:<span class=w> </span>production-5c5f65d859-phqzc
Hostname:<span class=w> </span>production-5c5f65d859-phqzc
Hostname:<span class=w> </span>production-5c5f65d859-phqzc
Hostname:<span class=w> </span>canary-6697778457-zkfjf
Hostname:<span class=w> </span>production-5c5f65d859-phqzc
</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>