Deploy GitHub Pages

user-guide/nginx-configuration/annotations/index.html

@@ -905,6 +905,13 @@
     Enable Rewrite Log
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#enable-opentracing" class="md-nav__link">
+    Enable Opentracing
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -1868,6 +1875,13 @@
     Enable Rewrite Log
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#enable-opentracing" class="md-nav__link">
+    Enable Opentracing
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -2301,6 +2315,10 @@ table below.</p>
 <td>"true" or "false"</td>
 </tr>
 <tr>
+<td><a href="#enable-opentracing">nginx.ingress.kubernetes.io/enable-opentracing</a></td>
+<td>"true" or "false"</td>
+</tr>
+<tr>
 <td><a href="#lua-resty-waf">nginx.ingress.kubernetes.io/lua-resty-waf</a></td>
 <td>string</td>
 </tr>
@@ -2827,6 +2845,12 @@ Note that rewrite logs are sent to the error_log file at the notice level. To en
 <div class="codehilite"><pre><span></span><span class="nt">nginx.ingress.kubernetes.io/enable-rewrite-log</span><span class="p">:</span> <span class="s">&quot;true&quot;</span>
 </pre></div>
 
+<h3 id="enable-opentracing">Enable Opentracing<a class="headerlink" href="#enable-opentracing" title="Permanent link"> ¶</a></h3>
+<p>Opentracing can be enabled or disabled globally through the ConfigMap but this will sometimes need to be overridden
+to enable it or disable it for a specific ingress (e.g. to turn off tracing of external health check endpoints)</p>
+<div class="codehilite"><pre><span></span><span class="nt">nginx.ingress.kubernetes.io/enable-opentracing</span><span class="p">:</span> <span class="s">&quot;true&quot;</span>
+</pre></div>
+
 <h3 id="x-forwarded-prefix-header">X-Forwarded-Prefix Header<a class="headerlink" href="#x-forwarded-prefix-header" title="Permanent link"> ¶</a></h3>
 <p>To add the non-standard <code class="codehilite">X-Forwarded-Prefix</code> header to the upstream request with a string value, the following annotation can be used:</p>
 <div class="codehilite"><pre><span></span><span class="nt">nginx.ingress.kubernetes.io/x-forwarded-prefix</span><span class="p">:</span> <span class="s">&quot;/path&quot;</span>
@@ -2893,10 +2917,15 @@ setting the following annotation:
 <p>Note: If you use both <code class="codehilite">enable-owasp-core-rules</code> and <code class="codehilite">modsecurity-snippet</code> annotations together, only the
 <code class="codehilite">modsecurity-snippet</code> will take effect. If you wish to include the <a href="https://www.modsecurity.org/CRS/Documentation/">OWASP Core Rule Set</a> or
 <a href="https://github.com/SpiderLabs/ModSecurity/blob/v3/master/modsecurity.conf-recommended">recommended configuration</a> simply use the include
-statement:
+statement:</p>
+<p>nginx 0.24.1 and below
 <div class="codehilite"><pre><span></span><span class="nt">nginx.ingress.kubernetes.io/modsecurity-snippet</span><span class="p">:</span> <span class="p p-Indicator">|</span>
 <span class="l l-Scalar l-Scalar-Plain">Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf</span>
 <span class="l l-Scalar l-Scalar-Plain">Include /etc/nginx/modsecurity/modsecurity.conf</span>
+</pre></div>
+nginx 0.25.0 and above
+<div class="codehilite"><pre><span></span><span class="nt">nginx.ingress.kubernetes.io/modsecurity-snippet</span><span class="p">:</span> <span class="p p-Indicator">|</span>
+<span class="l l-Scalar l-Scalar-Plain">Include /etc/nginx/owasp-modsecurity-crs/nginx-modsecurity.conf</span>
 </pre></div></p>
 <h3 id="influxdb">InfluxDB<a class="headerlink" href="#influxdb" title="Permanent link"> ¶</a></h3>
 <p>Using <code class="codehilite">influxdb-*</code> annotations we can monitor requests passing through a Location by sending them to an InfluxDB backend exposing the UDP socket

user-guide/nginx-configuration/configmap/index.html

@@ -4401,7 +4401,7 @@ Supported codes are <a href="https://developer.mozilla.org/docs/Web/HTTP/Status/
 <em><strong>default:</strong></em> 308</p>
 <blockquote>
 <p><strong>Why the default code is 308?</strong></p>
-<p><a href="https://tools.ietf.org/html/rfc7238">RFC 7238</a> was created to define the 308 (Permanent Redirect) status code that is similar to 301 (Moved Permanently) but it keeps the payload in the redirect. This is important if the we send a redirect in methods like POST.</p>
+<p><a href="https://tools.ietf.org/html/rfc7238">RFC 7238</a> was created to define the 308 (Permanent Redirect) status code that is similar to 301 (Moved Permanently) but it keeps the payload in the redirect. This is important if we send a redirect in methods like POST.</p>
 </blockquote>
 <h2 id="proxy-buffering">proxy-buffering<a class="headerlink" href="#proxy-buffering" title="Permanent link"> ¶</a></h2>
 <p>Enables or disables <a href="http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_buffering">buffering of responses from the proxied server</a>.</p>

user-guide/third-party-addons/opentracing/index.html

@@ -1258,6 +1258,13 @@ By default this feature is disabled.</p>
 <div class="codehilite"><pre><span></span><span class="n">data</span><span class="o">:</span>
   <span class="n">enable</span><span class="o">-</span><span class="n">opentracing</span><span class="o">:</span> <span class="s2">&quot;true&quot;</span>
 </pre></div></p>
+<p>To enable or disable instrumentation for a single Ingress, use
+the <code class="codehilite">enable-opentracing</code> annotation:
+<div class="codehilite"><pre><span></span><span class="n">kind</span><span class="o">:</span> <span class="n">Ingress</span>
+<span class="n">metadata</span><span class="o">:</span>
+  <span class="n">annotations</span><span class="o">:</span>
+    <span class="n">nginx</span><span class="o">.</span><span class="na">ingress</span><span class="o">.</span><span class="na">kubernetes</span><span class="o">.</span><span class="na">io</span><span class="o">/</span><span class="n">enable</span><span class="o">-</span><span class="n">opentracing</span><span class="o">:</span> <span class="s2">&quot;true&quot;</span>
+</pre></div></p>
 <p>We must also set the host to use when uploading traces:</p>
 <p><div class="codehilite"><pre><span></span>zipkin-collector-host: zipkin.default.svc.cluster.local
 jaeger-collector-host: jaeger-agent.default.svc.cluster.local