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

73 lines
31 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/PREREQUISITES/ rel=canonical><link href=../ rel=prev><link href=../affinity/cookie/ rel=next><link rel=icon href=../../assets/images/favicon.png><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.4.5"><title>Prerequisites - 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=#prerequisites 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> Prerequisites </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=C
2021-01-11 15:59:14 +00:00
<span class=go>Generating a 2048 bit RSA private key</span>
<span class=go>................+++</span>
<span class=go>................+++</span>
<span class=go>writing new private key to &#39;tls.key&#39;</span>
<span class=go>-----</span>
2023-10-12 19:31:18 +00:00
<span class=gp>$ </span>kubectl<span class=w> </span>create<span class=w> </span>secret<span class=w> </span>tls<span class=w> </span>tls-secret<span class=w> </span>--key<span class=w> </span>tls.key<span class=w> </span>--cert<span class=w> </span>tls.crt
2021-01-11 15:59:14 +00:00
<span class=go>secret &quot;tls-secret&quot; created</span>
2021-11-12 19:35:44 +00:00
</code></pre></div> <p>Note: If using CA Authentication, described below, you will need to sign the server certificate with the CA.</p> <h2 id=client-certificate-authentication>Client Certificate Authentication<a class=headerlink href=#client-certificate-authentication title="Permanent link"></a></h2> <p>CA Authentication also known as Mutual Authentication allows both the server and client to verify each others identity via a common CA.</p> <p>We have a CA Certificate which we usually obtain from a Certificate Authority and use that to sign both our server certificate and client certificate. Then every time we want to access our backend, we must pass the client certificate.</p> <p>These instructions are based on the following <a href=https://medium.com/@awkwardferny/configuring-certificate-based-mutual-authentication-with-kubernetes-ingress-nginx-20e7e38fdfca>blog</a></p> <p><strong>Generate the CA Key and Certificate:</strong></p> <div class=highlight><pre><span></span><code><span class=go>openssl req -x509 -sha256 -newkey rsa:4096 -keyout ca.key -out ca.crt -days 356 -nodes -subj &#39;/CN=My Cert Authority&#39;</span>
2021-01-11 15:59:14 +00:00
</code></pre></div> <p><strong>Generate the Server Key, and Certificate and Sign with the CA Certificate:</strong></p> <div class=highlight><pre><span></span><code><span class=go>openssl req -new -newkey rsa:4096 -keyout server.key -out server.csr -nodes -subj &#39;/CN=mydomain.com&#39;</span>
<span class=go>openssl x509 -req -sha256 -days 365 -in server.csr -CA ca.crt -CAkey ca.key -set_serial 01 -out server.crt</span>
</code></pre></div> <p><strong>Generate the Client Key, and Certificate and Sign with the CA Certificate:</strong></p> <div class=highlight><pre><span></span><code><span class=go>openssl req -new -newkey rsa:4096 -keyout client.key -out client.csr -nodes -subj &#39;/CN=My Client&#39;</span>
<span class=go>openssl x509 -req -sha256 -days 365 -in client.csr -CA ca.crt -CAkey ca.key -set_serial 02 -out client.crt</span>
2023-10-12 19:31:18 +00:00
</code></pre></div> <p>Once this is complete you can continue to follow the instructions <a href=../auth/client-certs/#creating-certificate-secrets>here</a></p> <h2 id=test-http-service>Test HTTP Service<a class=headerlink href=#test-http-service title="Permanent link"></a></h2> <p>All examples that require a test HTTP Service use the standard http-svc pod, which you can deploy as follows</p> <div class=highlight><pre><span></span><code><span class=gp>$ </span>kubectl<span class=w> </span>create<span class=w> </span>-f<span class=w> </span>https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/docs/examples/http-svc.yaml
2021-01-11 15:59:14 +00:00
<span class=go>service &quot;http-svc&quot; created</span>
<span class=go>replicationcontroller &quot;http-svc&quot; created</span>
2023-10-12 19:31:18 +00:00
<span class=gp>$ </span>kubectl<span class=w> </span>get<span class=w> </span>po
2021-01-11 15:59:14 +00:00
<span class=go>NAME READY STATUS RESTARTS AGE</span>
<span class=go>http-svc-p1t3t 1/1 Running 0 1d</span>
2023-10-12 19:31:18 +00:00
<span class=gp>$ </span>kubectl<span class=w> </span>get<span class=w> </span>svc
2021-01-11 15:59:14 +00:00
<span class=go>NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE</span>
<span class=go>http-svc 10.0.122.116 &lt;pending&gt; 80:30301/TCP 1d</span>
2023-10-12 19:31:18 +00:00
</code></pre></div> <p>You can test that the HTTP Service works by exposing it temporarily</p> <div class=highlight><pre><span></span><code><span class=gp>$ </span>kubectl<span class=w> </span>patch<span class=w> </span>svc<span class=w> </span>http-svc<span class=w> </span>-p<span class=w> </span><span class=s1>&#39;{&quot;spec&quot;:{&quot;type&quot;: &quot;LoadBalancer&quot;}}&#39;</span>
2021-01-11 15:59:14 +00:00
<span class=go>&quot;http-svc&quot; patched</span>
2023-10-12 19:31:18 +00:00
<span class=gp>$ </span>kubectl<span class=w> </span>get<span class=w> </span>svc<span class=w> </span>http-svc
2021-01-11 15:59:14 +00:00
<span class=go>NAME CLUSTER-IP EXTERNAL-IP PORT(S) AGE</span>
<span class=go>http-svc 10.0.122.116 &lt;pending&gt; 80:30301/TCP 1d</span>
2023-10-12 19:31:18 +00:00
<span class=gp>$ </span>kubectl<span class=w> </span>describe<span class=w> </span>svc<span class=w> </span>http-svc
2021-01-11 15:59:14 +00:00
<span class=go>Name: http-svc</span>
<span class=go>Namespace: default</span>
<span class=go>Labels: app=http-svc</span>
<span class=go>Selector: app=http-svc</span>
<span class=go>Type: LoadBalancer</span>
<span class=go>IP: 10.0.122.116</span>
<span class=go>LoadBalancer Ingress: 108.59.87.136</span>
<span class=go>Port: http 80/TCP</span>
<span class=go>NodePort: http 30301/TCP</span>
<span class=go>Endpoints: 10.180.1.6:8080</span>
<span class=go>Session Affinity: None</span>
<span class=go>Events:</span>
<span class=go> FirstSeen LastSeen Count From SubObjectPath Type Reason Message</span>
<span class=go> --------- -------- ----- ---- ------------- -------- ------ -------</span>
<span class=go> 1m 1m 1 {service-controller } Normal Type ClusterIP -&gt; LoadBalancer</span>
<span class=go> 1m 1m 1 {service-controller } Normal CreatingLoadBalancer Creating load balancer</span>
<span class=go> 16s 16s 1 {service-controller } Normal CreatedLoadBalancer Created load balancer</span>
2023-10-12 19:31:18 +00:00
<span class=gp>$ </span>curl<span class=w> </span><span class=m>108</span>.59.87.136
2021-01-11 15:59:14 +00:00
<span class=go>CLIENT VALUES:</span>
<span class=go>client_address=10.240.0.3</span>
<span class=go>command=GET</span>
<span class=go>real path=/</span>
<span class=go>query=nil</span>
<span class=go>request_version=1.1</span>
<span class=go>request_uri=http://108.59.87.136:8080/</span>
<span class=go>SERVER VALUES:</span>
<span class=go>server_version=nginx: 1.9.11 - lua: 10001</span>
<span class=go>HEADERS RECEIVED:</span>
<span class=go>accept=*/*</span>
<span class=go>host=108.59.87.136</span>
<span class=go>user-agent=curl/7.46.0</span>
<span class=go>BODY:</span>
<span class=go>-no body in request-</span>
2023-10-12 19:31:18 +00:00
<span class=gp>$ </span>kubectl<span class=w> </span>patch<span class=w> </span>svc<span class=w> </span>http-svc<span class=w> </span>-p<span class=w> </span><span class=s1>&#39;{&quot;spec&quot;:{&quot;type&quot;: &quot;NodePort&quot;}}&#39;</span>
2021-01-11 15:59:14 +00:00
<span class=go>&quot;http-svc&quot; patched</span>
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>