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:
Travis Bot 2020-01-11 21:14:03 +00:00
parent b5886c0b05
commit 69dc7f04ad
7 changed files with 204 additions and 63 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
deploy/index.html
View file

@ -1461,7 +1461,7 @@ To change this behavior use the flag <code class="codehilite">--watch-namespace<
</pre></div></p>
</div>
<p>The following <strong>Mandatory Command</strong> is required for all deployments.</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/mandatory.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/mandatory.yaml</span>
</pre></div>
<div class="admonition tip">
@ -1473,7 +1473,7 @@ To change this behavior use the flag <code class="codehilite">--watch-namespace<
<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>Create a service</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/cloud-generic.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/cloud-generic.yaml</span>
</pre></div>
<h4 id="minikube">minikube<a class="headerlink" href="#minikube" title="Permanent link"></a></h4>
@ -1511,16 +1511,16 @@ Please check the <a href="https://aws.amazon.com/elasticloadbalancing/details/">
<p>For L4:</p>
<p>Check that no change is necessary with regards to the ELB idle timeout. In some scenarios, users may want to modify the ELB idle timeout, so please check the <a href="#elb-idle-timeouts">ELB Idle Timeouts section</a> for additional information. If a change is required, users will need to update the value of <code class="codehilite">service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout</code> in <code class="codehilite">provider/aws/service-l4.yaml</code></p>
<p>Then execute:</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/aws/service-l4.yaml</span>
<span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/aws/patch-configmap-l4.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/aws/service-l4.yaml</span>
<span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/aws/patch-configmap-l4.yaml</span>
</pre></div>
<p>For L7:</p>
<p>Change line of the file <code class="codehilite">provider/aws/service-l7.yaml</code> replacing the dummy id with a valid one <code class="codehilite">&quot;arn:aws:acm:us-west-2:XXXXXXXX:certificate/XXXXXX-XXXXXXX-XXXXXXX-XXXXXXXX&quot;</code></p>
<p>Check that no change is necessary with regards to the ELB idle timeout. In some scenarios, users may want to modify the ELB idle timeout, so please check the <a href="#elb-idle-timeouts">ELB Idle Timeouts section</a> for additional information. If a change is required, users will need to update the value of <code class="codehilite">service.beta.kubernetes.io/aws-load-balancer-connection-idle-timeout</code> in <code class="codehilite">provider/aws/service-l7.yaml</code></p>
<p>Then execute:</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/aws/service-l7.yaml</span>
<span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/aws/patch-configmap-l7.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/aws/service-l7.yaml</span>
<span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/aws/patch-configmap-l7.yaml</span>
</pre></div>
<p>This example creates an ELB with just two listeners, one in port 80 and another in port 443</p>
@ -1532,21 +1532,21 @@ Please check the <a href="https://aws.amazon.com/elasticloadbalancing/details/">
<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/classic/config-idle-timeout.html">official AWS documentation</a>.</p>
<h5 id="network-load-balancer-nlb">Network Load Balancer (NLB)<a class="headerlink" href="#network-load-balancer-nlb" title="Permanent link"></a></h5>
<p>This type of load balancer is supported since v1.10.0 as an ALPHA feature.</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/aws/service-nlb.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/aws/service-nlb.yaml</span>
</pre></div>
<h4 id="gce-gke">GCE-GKE<a class="headerlink" href="#gce-gke" title="Permanent link"></a></h4>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/cloud-generic.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/cloud-generic.yaml</span>
</pre></div>
<p><strong>Important Note:</strong> proxy protocol is not supported in GCE/GKE</p>
<h4 id="azure">Azure<a class="headerlink" href="#azure" title="Permanent link"></a></h4>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/cloud-generic.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/cloud-generic.yaml</span>
</pre></div>
<h4 id="bare-metal">Bare-metal<a class="headerlink" href="#bare-metal" title="Permanent link"></a></h4>
<p>Using <a href="https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport">NodePort</a>:</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/provider/baremetal/service-nodeport.yaml</span>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/provider/baremetal/service-nodeport.yaml</span>
</pre></div>
<div class="admonition tip">

2
examples/psp/index.html
View file

@ -1160,7 +1160,7 @@ you will need to provide the Deployment with the permissions to create pods.</p>
<div class="codehilite"><pre><span></span><span class="go">kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/examples/psp/psp.yaml</span>
</pre></div></p>
<p>Now that the pod security policy is applied, we can continue as usual by applying the
<a href="https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.26.2/deploy/static/mandatory.yaml">mandatory.yaml</a>
<a href="https://raw.githubusercontent.com/kubernetes/ingress-nginx/nginx-0.27.0/deploy/static/mandatory.yaml">mandatory.yaml</a>
according to the <a href="../../deploy/">Installation Guide</a>.</p>
<p>Note: PSP permissions must be granted before to the creation of the Deployment and the ReplicaSet.
If the Deployment or ReplicaSet already exist, they will receive the PSP permissions

2
search/search_index.json
View file

File diff suppressed because one or more lines are too long

100
sitemap.xml
View file

@ -2,252 +2,252 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://kubernetes.github.io/ingress-nginx/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/how-it-works/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/troubleshooting/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/kubectl-plugin/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/development/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/deploy/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/deploy/baremetal/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/deploy/rbac/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/deploy/validating-webhook/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/deploy/upgrade/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/basic-usage/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/custom-template/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/log-format/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/cli-arguments/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/custom-errors/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/default-backend/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/exposing-tcp-udp-services/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/fcgi-services/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/ingress-path-matching/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/external-articles/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/miscellaneous/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/monitoring/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/multiple-ingress/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/tls/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/third-party-addons/modsecurity/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/user-guide/third-party-addons/opentracing/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/PREREQUISITES/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/affinity/cookie/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/auth/basic/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/auth/client-certs/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/auth/external-auth/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/customization/configuration-snippets/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/customization/custom-configuration/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/customization/custom-errors/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/customization/custom-headers/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/customization/external-auth-headers/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/customization/ssl-dh-param/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/customization/sysctl/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/docker-registry/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/grpc/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/multi-tls/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/rewrite/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/static-ip/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/tls-termination/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://kubernetes.github.io/ingress-nginx/examples/psp/</loc>
<lastmod>2020-01-05</lastmod>
<lastmod>2020-01-11</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>

BIN
sitemap.xml.gz
View file

Binary file not shown.

137
user-guide/nginx-configuration/configmap/index.html
View file

@ -1319,6 +1319,48 @@
jaeger-tracer-baggage-header-prefix
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-collector-host" class="md-nav__link">
datadog-collector-host
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-collector-port" class="md-nav__link">
datadog-collector-port
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-service-name" class="md-nav__link">
datadog-service-name
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-operation-name-override" class="md-nav__link">
datadog-operation-name-override
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-priority-sampling" class="md-nav__link">
datadog-priority-sampling
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-sample-rate" class="md-nav__link">
datadog-sample-rate
</a>
</li>
<li class="md-nav__item">
@ -2903,6 +2945,48 @@
jaeger-tracer-baggage-header-prefix
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-collector-host" class="md-nav__link">
datadog-collector-host
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-collector-port" class="md-nav__link">
datadog-collector-port
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-service-name" class="md-nav__link">
datadog-service-name
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-operation-name-override" class="md-nav__link">
datadog-operation-name-override
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-priority-sampling" class="md-nav__link">
datadog-priority-sampling
</a>
</li>
<li class="md-nav__item">
<a href="#datadog-sample-rate" class="md-nav__link">
datadog-sample-rate
</a>
</li>
<li class="md-nav__item">
@ -3761,6 +3845,36 @@ Same for numbers, like "100".</p>
<td align="left">uberctx-</td>
</tr>
<tr>
<td align="left"><a href="#datadog-collector-host">datadog-collector-host</a></td>
<td align="left">string</td>
<td align="left">""</td>
</tr>
<tr>
<td align="left"><a href="#datadog-collector-port">datadog-collector-port</a></td>
<td align="left">int</td>
<td align="left">8126</td>
</tr>
<tr>
<td align="left"><a href="#datadog-service-name">datadog-service-name</a></td>
<td align="left">service</td>
<td align="left">"nginx"</td>
</tr>
<tr>
<td align="left"><a href="#datadog-operation-name-override">datadog-operation-name-override</a></td>
<td align="left">service</td>
<td align="left">"nginx.handle"</td>
</tr>
<tr>
<td align="left"><a href="#datadog-priority-sampling">datadog-priority-sampling</a></td>
<td align="left">bool</td>
<td align="left">"true"</td>
</tr>
<tr>
<td align="left"><a href="#datadog-sample-rate">datadog-sample-rate</a></td>
<td align="left">float</td>
<td align="left">1.0</td>
</tr>
<tr>
<td align="left"><a href="#main-snippet">main-snippet</a></td>
<td align="left">string</td>
<td align="left">""</td>
@ -4196,7 +4310,14 @@ To create a ticket: <code class="codehilite">openssl rand 80 | openssl enc -A -b
</blockquote>
<h2 id="use-geoip2">use-geoip2<a class="headerlink" href="#use-geoip2" title="Permanent link"></a></h2>
<p>Enables the <a href="https://github.com/leev/ngx_http_geoip2_module">geoip2 module</a> for NGINX.
<em><strong>default:</strong></em> false</p>
Since <code class="codehilite">0.27.0</code> and due to a <a href="https://blog.maxmind.com/2019/12/18/significant-changes-to-accessing-and-using-geolite2-databases">change in the MaxMind databases</a> a license is required to have access to the databases.
For this reason, it is required to define a new flag <code class="codehilite">--maxmind-license-key</code> in the ingress controller deployment to download the databases needed during the initialization of the ingress controller.
Alternatively, it is possible to use a volume to mount the files <code class="codehilite">/etc/nginx/geoip/GeoLite2-City.mmdb</code> and <code class="codehilite">/etc/nginx/geoip/GeoLite2-ASN.mmdb</code>, avoiding the overhead of the download.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>If the feature is enabled but the files are missing, GeoIP2 will not be enabled.</p>
</div>
<p><em><strong>default:</strong></em> false</p>
<h2 id="enable-brotli">enable-brotli<a class="headerlink" href="#enable-brotli" title="Permanent link"></a></h2>
<p>Enables or disables compression of HTTP responses using the <a href="https://github.com/google/ngx_brotli">"brotli" module</a>.
The default mime type list to compress is: <code class="codehilite">application/xml+rss application/atom+xml application/javascript application/x-javascript application/json application/rss+xml application/vnd.ms-fontobject application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/svg+xml image/x-icon text/css text/plain text/x-component</code>. <em><strong>default:</strong></em> is disabled</p>
@ -4327,6 +4448,20 @@ Leave blank to use default value (localhost). <em><strong>default:</strong></em>
<p>Specifies the header name used to submit baggage if there is no root span. <em><strong>default:</strong></em> jaeger-baggage</p>
<h2 id="jaeger-tracer-baggage-header-prefix">jaeger-tracer-baggage-header-prefix<a class="headerlink" href="#jaeger-tracer-baggage-header-prefix" title="Permanent link"></a></h2>
<p>Specifies the header prefix used to propagate baggage. <em><strong>default:</strong></em> uberctx-</p>
<h2 id="datadog-collector-host">datadog-collector-host<a class="headerlink" href="#datadog-collector-host" title="Permanent link"></a></h2>
<p>Specifies the datadog agent host to use when uploading traces. It must be a valid URL.</p>
<h2 id="datadog-collector-port">datadog-collector-port<a class="headerlink" href="#datadog-collector-port" title="Permanent link"></a></h2>
<p>Specifies the port to use when uploading traces. <em><strong>default:</strong></em> 8126</p>
<h2 id="datadog-service-name">datadog-service-name<a class="headerlink" href="#datadog-service-name" title="Permanent link"></a></h2>
<p>Specifies the service name to use for any traces created. <em><strong>default:</strong></em> nginx</p>
<h2 id="datadog-operation-name-override">datadog-operation-name-override<a class="headerlink" href="#datadog-operation-name-override" title="Permanent link"></a></h2>
<p>Overrides the operation naem to use for any traces crated. <em><strong>default:</strong></em> nginx.handle</p>
<h2 id="datadog-priority-sampling">datadog-priority-sampling<a class="headerlink" href="#datadog-priority-sampling" title="Permanent link"></a></h2>
<p>Specifies to use client-side sampling.
If true disables client-side sampling (thus ignoring <code class="codehilite">sample_rate</code>) and enables distributed priority sampling, where traces are sampled based on a combination of user-assigned priorities and configuration from the agent. <em><strong>default:</strong></em> true</p>
<h2 id="datadog-sample-rate">datadog-sample-rate<a class="headerlink" href="#datadog-sample-rate" title="Permanent link"></a></h2>
<p>Specifies sample rate for any traces created.
This is effective only when <code class="codehilite">datadog-priority-sampling</code> is <code class="codehilite">false</code> <em><strong>default:</strong></em> 1.0</p>
<h2 id="main-snippet">main-snippet<a class="headerlink" href="#main-snippet" title="Permanent link"></a></h2>
<p>Adds custom configuration to the main section of the nginx configuration.</p>
<h2 id="http-snippet">http-snippet<a class="headerlink" href="#http-snippet" title="Permanent link"></a></h2>

6
user-guide/third-party-addons/opentracing/index.html
View file

@ -1326,6 +1326,12 @@ datadog-service-name
# specifies the operation name to use for any traces collected, Default: nginx.handle
datadog-operation-name-override
# Specifies to use client-side sampling for distributed priority sampling and ignore sample rate, Default: true
datadog-priority-sampling
# specifies sample rate for any traces created, Default: 1.0
datadog-sample-rate
</pre></div></p>
<p>All these options (including host) allow environment variables, such as <code class="codehilite">$HOSTNAME</code> or <code class="codehilite">$HOST_IP</code>. In the case of Jaeger, if you have a Jaeger agent running on each machine in your cluster, you can use something like <code class="codehilite">$HOST_IP</code> (which can be 'mounted' with the <code class="codehilite">status.hostIP</code> fieldpath, as described <a href="https://kubernetes.io/docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/#capabilities-of-the-downward-api">here</a>) to make sure traces will be sent to the local agent.</p>
<h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link"></a></h2>