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

Deploy GitHub Pages

Browse source
This commit is contained in:
aledbf 2020-04-18 22:17:27 +00:00
parent 9f7ee47045
commit 0c99e91640
3 changed files with 71 additions and 94 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

163
deploy/index.html
View file

@ -419,14 +419,7 @@
Contents Contents
</a> </a>
</li> <nav class="md-nav" aria-label="Contents">
<li class="md-nav__item">
<a href="#prerequisite-generic-deployment-command" class="md-nav__link">
Prerequisite Generic Deployment Command
</a>
<nav class="md-nav" aria-label="Prerequisite Generic Deployment Command">
<ul class="md-nav__list"> <ul class="md-nav__list">
<li class="md-nav__item"> <li class="md-nav__item">
@ -467,8 +460,8 @@
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#tls-termination-in-the-load-balancer-elb" class="md-nav__link"> <a href="#tls-termination-in-aws-load-balancer-elb" class="md-nav__link">
TLS termination in the Load Balancer (ELB) TLS termination in AWS Load Balancer (ELB)
</a> </a>
</li> </li>
@ -535,19 +528,13 @@
Using Helm Using Helm
</a> </a>
<nav class="md-nav" aria-label="Using Helm"> </li>
<ul class="md-nav__list">
<li class="md-nav__item">
<li class="md-nav__item">
<a href="#detect-installed-version_1" class="md-nav__link"> <a href="#detect-installed-version_1" class="md-nav__link">
Detect installed version: Detect installed version:
</a> </a>
</li>
</ul>
</nav>
</li> </li>
</ul> </ul>
@ -1288,14 +1275,7 @@
Contents Contents
</a> </a>
</li> <nav class="md-nav" aria-label="Contents">
<li class="md-nav__item">
<a href="#prerequisite-generic-deployment-command" class="md-nav__link">
Prerequisite Generic Deployment Command
</a>
<nav class="md-nav" aria-label="Prerequisite Generic Deployment Command">
<ul class="md-nav__list"> <ul class="md-nav__list">
<li class="md-nav__item"> <li class="md-nav__item">
@ -1336,8 +1316,8 @@
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#tls-termination-in-the-load-balancer-elb" class="md-nav__link"> <a href="#tls-termination-in-aws-load-balancer-elb" class="md-nav__link">
TLS termination in the Load Balancer (ELB) TLS termination in AWS Load Balancer (ELB)
</a> </a>
</li> </li>
@ -1404,19 +1384,13 @@
Using Helm Using Helm
</a> </a>
<nav class="md-nav" aria-label="Using Helm"> </li>
<ul class="md-nav__list">
<li class="md-nav__item">
<li class="md-nav__item">
<a href="#detect-installed-version_1" class="md-nav__link"> <a href="#detect-installed-version_1" class="md-nav__link">
Detect installed version: Detect installed version:
</a> </a>
</li>
</ul>
</nav>
</li> </li>
</ul> </ul>
@ -1440,45 +1414,31 @@
<h1 id="installation-guide">Installation Guide<a class="headerlink" href="#installation-guide" title="Permanent link"></a></h1> <h1 id="installation-guide">Installation Guide<a class="headerlink" href="#installation-guide" title="Permanent link"></a></h1>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>The default configuration watches Ingress object from <strong>all the namespaces</strong>.</p>
<p>To change this behavior use the flag <code>--watch-namespace</code> to limit the scope to a particular namespace.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If multiple Ingresses define paths for the same host, the ingress controller <strong>merges the definitions</strong>.</p>
</div>
<h2 id="contents">Contents<a class="headerlink" href="#contents" title="Permanent link"></a></h2> <h2 id="contents">Contents<a class="headerlink" href="#contents" title="Permanent link"></a></h2>
<ul> <ul>
<li><a href="#prerequisite-generic-deployment-command">Prerequisite Generic Deployment Command</a></li> <li><a href="#provider-specific-steps">Provider Specific Steps</a></li>
<li><a href="#provider-specific-steps">Provider Specific Steps</a><ul>
<li><a href="#docker-for-mac">Docker for Mac</a></li> <li><a href="#docker-for-mac">Docker for Mac</a></li>
<li><a href="#minikube">minikube</a></li> <li><a href="#minikube">minikube</a></li>
<li><a href="#aws">AWS</a></li> <li><a href="#aws">AWS</a></li>
<li><a href="#gce-gke">GCE - GKE</a></li> <li><a href="#gce-gke">GCE - GKE</a></li>
<li><a href="#azure">Azure</a></li> <li><a href="#azure">Azure</a></li>
<li><a href="#bare-metal">Bare-metal</a></li> <li><a href="#bare-metal">Bare-metal</a></li>
</ul>
</li>
<li><a href="#verify-installation">Verify installation</a></li> <li><a href="#verify-installation">Verify installation</a></li>
<li><a href="#detect-installed-version">Detect installed version</a></li> <li><a href="#detect-installed-version">Detect installed version</a></li>
<li><a href="#using-helm">Using Helm</a></li> <li><a href="#using-helm">Using Helm</a></li>
</ul> </ul>
<h2 id="prerequisite-generic-deployment-command">Prerequisite Generic Deployment Command<a class="headerlink" href="#prerequisite-generic-deployment-command" title="Permanent link"></a></h2>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>The default configuration watches Ingress object from <em>all the namespaces</em>.
To change this behavior use the flag <code>--watch-namespace</code> to limit the scope to a particular namespace.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If multiple Ingresses define different paths for the same host, the ingress controller will merge the definitions.</p>
</div>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>If you're using GKE you need to initialize your user as a cluster-admin with the following command:
<div class="highlight"><pre><span></span><code><span class="go">kubectl create clusterrolebinding cluster-admin-binding \</span>
<span class="go"> --clusterrole cluster-admin \</span>
<span class="go"> --user $(gcloud config get-value account)</span>
</code></pre></div></p>
</div>
<h3 id="provider-specific-steps">Provider Specific Steps<a class="headerlink" href="#provider-specific-steps" title="Permanent link"></a></h3> <h3 id="provider-specific-steps">Provider Specific Steps<a class="headerlink" href="#provider-specific-steps" title="Permanent link"></a></h3>
<p>There are cloud provider specific yaml files.</p>
<h4 id="docker-for-mac">Docker for Mac<a class="headerlink" href="#docker-for-mac" title="Permanent link"></a></h4> <h4 id="docker-for-mac">Docker for Mac<a class="headerlink" href="#docker-for-mac" title="Permanent link"></a></h4>
<p>Kubernetes is available in Docker for Mac (from <a href="https://docs.docker.com/docker-for-mac/release-notes/#stable-releases-of-2018">version 18.06.0-ce</a>)</p> <p>Kubernetes is available in Docker for Mac (from <a href="https://docs.docker.com/docker-for-mac/release-notes/#stable-releases-of-2018">version 18.06.0-ce</a>)</p>
<p>Create a service</p>
<div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml</span> <div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml</span>
</code></pre></div> </code></pre></div>
@ -1488,16 +1448,16 @@ To change this behavior use the flag <code>--watch-namespace</code> to limit the
</code></pre></div> </code></pre></div>
<p>For development:</p> <p>For development:</p>
<ol> <ul>
<li>Disable the ingress addon:</li> <li>Disable the ingress addon:</li>
</ol> </ul>
<div class="highlight"><pre><span></span><code><span class="go">minikube addons disable ingress</span> <div class="highlight"><pre><span></span><code><span class="go">minikube addons disable ingress</span>
</code></pre></div> </code></pre></div>
<ol> <ul>
<li>Execute <code>make dev-env</code></li> <li>Execute <code>make dev-env</code></li>
<li>Confirm the <code>nginx-ingress-controller</code> deployment exists:</li> <li>Confirm the <code>nginx-ingress-controller</code> deployment exists:</li>
</ol> </ul>
<div class="highlight"><pre><span></span><code><span class="gp">$</span> kubectl get pods -n ingress-nginx <div class="highlight"><pre><span></span><code><span class="gp">$</span> kubectl get pods -n ingress-nginx
<span class="go">NAME READY STATUS RESTARTS AGE</span> <span class="go">NAME READY STATUS RESTARTS AGE</span>
<span class="go">nginx-ingress-controller-fdcdcd6dd-vvpgs 1/1 Running 0 11s</span> <span class="go">nginx-ingress-controller-fdcdcd6dd-vvpgs 1/1 Running 0 11s</span>
@ -1509,43 +1469,59 @@ To change this behavior use the flag <code>--watch-namespace</code> to limit the
<div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/deploy.yaml</span> <div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/aws/deploy.yaml</span>
</code></pre></div> </code></pre></div>
<h5 id="tls-termination-in-the-load-balancer-elb">TLS termination in the Load Balancer (ELB)<a class="headerlink" href="#tls-termination-in-the-load-balancer-elb" title="Permanent link"></a></h5> <h5 id="tls-termination-in-aws-load-balancer-elb">TLS termination in AWS Load Balancer (ELB)<a class="headerlink" href="#tls-termination-in-aws-load-balancer-elb" title="Permanent link"></a></h5>
<p>In some scenarios is not possible to terminate TLS in the ingress controller but in the Load Balancer. <p>In some scenarios is required to terminate TLS in the Load Balancer and not in the ingress controller.</p>
For this purpose we provide a template:</p> <p>For this purpose we provide a template:</p>
<ol> <ul>
<li>Download <a href="https://raw.githubusercontent.com/kubernetes/ingress-nginx/204739fb6650c48fd41dc9505f8fd9ef6bc768e1/deploy/static/provider/aws/deploy-tls-termination.yaml">deploy-tls-termination.yaml</a></li> <li>Download <a href="https://raw.githubusercontent.com/kubernetes/ingress-nginx/204739fb6650c48fd41dc9505f8fd9ef6bc768e1/deploy/static/provider/aws/deploy-tls-termination.yaml">deploy-tls-termination.yaml</a></li>
</ol> </ul>
<div class="highlight"><pre><span></span><code><span class="go">wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/204739fb6650c48fd41dc9505f8fd9ef6bc768e1/deploy/static/provider/aws/deploy-tls-termination.yaml</span> <div class="highlight"><pre><span></span><code><span class="go">wget https://raw.githubusercontent.com/kubernetes/ingress-nginx/204739fb6650c48fd41dc9505f8fd9ef6bc768e1/deploy/static/provider/aws/deploy-tls-termination.yaml</span>
</code></pre></div> </code></pre></div>
<ol> <ul>
<li> <li>
<p>Change:</p> <p>Edit the file and change:</p>
</li> </li>
<li> <li>
<p>Set the VPC CIDR: <code>proxy-real-ip-cidr: XXX.XXX.XXX/XX</code></p> <p>VPC CIDR in use for the Kubernetes cluster:</p>
</li> </li>
<li> </ul>
<p>Change the AWS Certificate Manager (ACM) ID <code>service.beta.kubernetes.io/aws-load-balancer-ssl-cert: arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX</code></p> <p><code>proxy-real-ip-cidr: XXX.XXX.XXX/XX</code></p>
</li> <ul>
<li> <li>AWS Certificate Manager (ACM) ID</li>
<p>Deploy the manifests:</p> </ul>
</li> <p><code>arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX</code></p>
</ol> <ul>
<li>Deploy the manifest:</li>
</ul>
<div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f deploy-tls-termination.yaml</span> <div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f deploy-tls-termination.yaml</span>
</code></pre></div> </code></pre></div>
<h5 id="nlb-idle-timeouts">NLB Idle Timeouts<a class="headerlink" href="#nlb-idle-timeouts" title="Permanent link"></a></h5> <h5 id="nlb-idle-timeouts">NLB Idle Timeouts<a class="headerlink" href="#nlb-idle-timeouts" title="Permanent link"></a></h5>
<p>In some scenarios users will need to modify the value of the NLB idle timeout. Users need to ensure the idle timeout is less than the <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout">keepalive_timeout</a> that is configured for NGINX. <p>In some scenarios users will need to modify the value of the NLB idle timeout. Users need to ensure the idle timeout is less than the <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout">keepalive_timeout</a> that is configured for NGINX.
By default NGINX <code>keepalive_timeout</code> is set to <code>75s</code>.</p> By default NGINX <code>keepalive_timeout</code> is set to <code>75s</code>.</p>
<p>The default NLB idle timeout will work for most scenarios, unless the NGINX <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout">keepalive_timeout</a> has been modified, in which case <code>service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout</code> will need to be modified to ensure it is less than the <code>keepalive_timeout</code> the user has configured.</p> <p>The default NLB idle timeout works for most scenarios, unless the NGINX <a href="http://nginx.org/en/docs/http/ngx_http_core_module.html#keepalive_timeout">keepalive_timeout</a> has been modified, in which case the annotation</p>
<p><em>Please Note: An idle timeout of <code>3600s</code> is recommended when using WebSockets.</em></p> <p><code>service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout</code> value must be modified to ensure it is less than the configured <code>keepalive_timeout</code>.</p>
<p>More information with regards to idle timeouts for your Load Balancer can be found in the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#connection-idle-timeout">official AWS documentation</a>.</p> <div class="admonition note">
<p>An idle timeout of <code>3600</code> is recommended when using WebSockets</p>
</div>
<p>More information with regards to timeouts for can be found in the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#connection-idle-timeout">official AWS documentation</a></p>
<h4 id="gce-gke">GCE-GKE<a class="headerlink" href="#gce-gke" title="Permanent link"></a></h4> <h4 id="gce-gke">GCE-GKE<a class="headerlink" href="#gce-gke" title="Permanent link"></a></h4>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>Initialize your user as a cluster-admin with the following command:
<div class="highlight"><pre><span></span><code><span class="go">kubectl create clusterrolebinding cluster-admin-binding \</span>
<span class="go"> --clusterrole cluster-admin \</span>
<span class="go"> --user $(gcloud config get-value account)</span>
</code></pre></div></p>
</div>
<div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml</span> <div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml</span>
</code></pre></div> </code></pre></div>
<p><strong>Important Note:</strong> proxy protocol is not supported in GCE/GKE</p> <div class="admonition warning important">
<p class="admonition-title">Warning</p>
<p>Proxy protocol is not supported in GCE/GKE</p>
</div>
<h4 id="azure">Azure<a class="headerlink" href="#azure" title="Permanent link"></a></h4> <h4 id="azure">Azure<a class="headerlink" href="#azure" title="Permanent link"></a></h4>
<div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml</span> <div class="highlight"><pre><span></span><code><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/cloud/deploy.yaml</span>
</code></pre></div> </code></pre></div>
@ -1561,11 +1537,12 @@ By default NGINX <code>keepalive_timeout</code> is set to <code>75s</code>.</p>
</div> </div>
<h3 id="verify-installation">Verify installation<a class="headerlink" href="#verify-installation" title="Permanent link"></a></h3> <h3 id="verify-installation">Verify installation<a class="headerlink" href="#verify-installation" title="Permanent link"></a></h3>
<p>To check if the ingress controller pods have started, run the following command:</p> <p>To check if the ingress controller pods have started, run the following command:</p>
<div class="highlight"><pre><span></span><code><span class="go">kubectl get pods --all-namespaces -l app.kubernetes.io/name=ingress-nginx --watch</span> <div class="highlight"><pre><span></span><code><span class="go">kubectl get pods -n ingress-nginx \</span>
<span class="go"> -l app.kubernetes.io/name=ingress-nginx --watch</span>
</code></pre></div> </code></pre></div>
<p>Once the operator pods are running, you can cancel the above command by typing <code>Ctrl+C</code>. <p>Once the ingress controller pods are running, you can cancel the command typing <code>Ctrl+C</code>.</p>
Now, you are ready to create your first ingress.</p> <p>Now, you are ready to create your first ingress.</p>
<h3 id="detect-installed-version">Detect installed version<a class="headerlink" href="#detect-installed-version" title="Permanent link"></a></h3> <h3 id="detect-installed-version">Detect installed version<a class="headerlink" href="#detect-installed-version" title="Permanent link"></a></h3>
<p>To detect which version of the ingress controller is running, exec into the pod and run <code>nginx-ingress-controller version</code> command.</p> <p>To detect which version of the ingress controller is running, exec into the pod and run <code>nginx-ingress-controller version</code> command.</p>
<div class="highlight"><pre><span></span><code><span class="go">POD_NAMESPACE=ingress-nginx</span> <div class="highlight"><pre><span></span><code><span class="go">POD_NAMESPACE=ingress-nginx</span>
@ -1577,16 +1554,16 @@ Now, you are ready to create your first ingress.</p>
<h2 id="using-helm">Using Helm<a class="headerlink" href="#using-helm" title="Permanent link"></a></h2> <h2 id="using-helm">Using Helm<a class="headerlink" href="#using-helm" title="Permanent link"></a></h2>
<p>NGINX Ingress controller can be installed via <a href="https://helm.sh/">Helm</a> using the chart from the project repository. <p>NGINX Ingress controller can be installed via <a href="https://helm.sh/">Helm</a> using the chart from the project repository.
To install the chart with the release name <code>ingress-nginx</code>:</p> To install the chart with the release name <code>ingress-nginx</code>:</p>
<div class="highlight"><pre><span></span><code><span class="go">helm repo add k8s-ingress-nginx https://kubernetes.github.io/ingress-nginx/</span> <div class="highlight"><pre><span></span><code><span class="go">helm repo add ingress-nginx https://kubernetes.github.io/ingress-nginx</span>
<span class="go">helm install ingress-nginx k8s-ingress-nginx</span> <span class="go">helm install ingress-nginx</span>
</code></pre></div> </code></pre></div>
<p>If you are using <a href="https://v2.helm.sh/">Helm 2</a> then specify release name using <code>--name</code> flag</p> <p>If you are using <a href="https://v2.helm.sh/">Helm 2</a> then specify release name using <code>--name</code> flag</p>
<div class="highlight"><pre><span></span><code><span class="go">helm repo add k8s-ingress-nginx https://kubernetes.github.io/ingress-nginx/</span> <div class="highlight"><pre><span></span><code><span class="go">helm repo add https://kubernetes.github.io/ingress-nginx/</span>
<span class="go">helm install k8s-ingress-nginx --name ingress-nginx</span> <span class="go">helm install --name ingress-nginx</span>
</code></pre></div> </code></pre></div>
<h3 id="detect-installed-version_1">Detect installed version:<a class="headerlink" href="#detect-installed-version_1" title="Permanent link"></a></h3> <h2 id="detect-installed-version_1">Detect installed version:<a class="headerlink" href="#detect-installed-version_1" title="Permanent link"></a></h2>
<div class="highlight"><pre><span></span><code><span class="go">POD_NAME=$(kubectl get pods -l app.kubernetes.io/name=ingress-nginx -o jsonpath=&#39;{.items[0].metadata.name}&#39;)</span> <div class="highlight"><pre><span></span><code><span class="go">POD_NAME=$(kubectl get pods -l app.kubernetes.io/name=ingress-nginx -o jsonpath=&#39;{.items[0].metadata.name}&#39;)</span>
<span class="go">kubectl exec -it $POD_NAME -- /nginx-ingress-controller --version</span> <span class="go">kubectl exec -it $POD_NAME -- /nginx-ingress-controller --version</span>
</code></pre></div> </code></pre></div>

2
search/search_index.json
View file

File diff suppressed because one or more lines are too long

BIN
sitemap.xml.gz
View file

Binary file not shown.