Publish updated main docs, 1720009452

kube-logging · Jul 3, 2024 · 9e251cb · 9e251cb
1 parent 9ed93cf
commit 9e251cb
Show file tree

Hide file tree

Showing 488 changed files with 795 additions and 615 deletions.
diff --git a/404.html b/404.html
@@ -23,7 +23,6 @@
 <meta itemprop="description" content="Documentation for the Logging operator"><meta name="twitter:card" content="summary">
 <meta name="twitter:title" content="404 Page not found">
 <meta name="twitter:description" content="Documentation for the Logging operator">
-<meta name="twitter:site" content="@AxoflowIO">
 <link rel="preload" href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" as="style">
 <link href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" rel="stylesheet" integrity>
 <script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK" crossorigin="anonymous"></script>
@@ -35,6 +34,8 @@
         await import('/pagefind/pagefind-highlight.js');
         new PagefindHighlight({ highlightParam: "highlight" });
     </script>
+<script>window.__SJ_MESSAGE__="We collect cookies to analyze our website traffic and performance. We never collect any personal data.",window.__SJ_ACCEPT_BTN_TEXT__="Accept",window.__SJ_REJECT_BTN_TEXT__="Reject"</script>
+<script src="https://cdn.jsdelivr.net/gh/sprucejoy/cookie-consent-autoblock-gdpr/cookie-consent.js" crossorigin="anonymous"></script>
 <script async src="https://www.googletagmanager.com/gtag/js?id=G-LM8C8QXCN7"></script>
 <script>var dnt=navigator.doNotTrack||window.doNotTrack||navigator.msDoNotTrack,doNotTrack=dnt=="1"||dnt=="yes";if(!doNotTrack){window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag("js",new Date),gtag("config","G-LM8C8QXCN7")}</script>
 </head><body class="td-404">

diff --git a/_print/index.html b/_print/index.html
@@ -26,7 +26,6 @@
 <meta name="twitter:image" content="https://kube-logging.dev/_print/featured-background.jpg">
 <meta name="twitter:title" content="Logging operator">
 <meta name="twitter:description" content="Documentation for the Logging operator">
-<meta name="twitter:site" content="@AxoflowIO">
 <link rel="preload" href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" as="style">
 <link href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" rel="stylesheet" integrity>
 <script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK" crossorigin="anonymous"></script>
@@ -38,6 +37,8 @@
         await import('/pagefind/pagefind-highlight.js');
         new PagefindHighlight({ highlightParam: "highlight" });
     </script>
+<script>window.__SJ_MESSAGE__="We collect cookies to analyze our website traffic and performance. We never collect any personal data.",window.__SJ_ACCEPT_BTN_TEXT__="Accept",window.__SJ_REJECT_BTN_TEXT__="Reject"</script>
+<script src="https://cdn.jsdelivr.net/gh/sprucejoy/cookie-consent-autoblock-gdpr/cookie-consent.js" crossorigin="anonymous"></script>
 <script async src="https://www.googletagmanager.com/gtag/js?id=G-LM8C8QXCN7"></script>
 <script>var dnt=navigator.doNotTrack||window.doNotTrack||navigator.msDoNotTrack,doNotTrack=dnt=="1"||dnt=="yes";if(!doNotTrack){window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag("js",new Date),gtag("config","G-LM8C8QXCN7")}</script>
 </head><body class="td-home">

diff --git a/categories/index.html b/categories/index.html
@@ -24,7 +24,6 @@
 <meta itemprop="description" content="Documentation for the Logging operator"><meta name="twitter:card" content="summary">
 <meta name="twitter:title" content="Categories">
 <meta name="twitter:description" content="Documentation for the Logging operator">
-<meta name="twitter:site" content="@AxoflowIO">
 <link rel="preload" href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" as="style">
 <link href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" rel="stylesheet" integrity>
 <script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK" crossorigin="anonymous"></script>
@@ -36,6 +35,8 @@
         await import('/pagefind/pagefind-highlight.js');
         new PagefindHighlight({ highlightParam: "highlight" });
     </script>
+<script>window.__SJ_MESSAGE__="We collect cookies to analyze our website traffic and performance. We never collect any personal data.",window.__SJ_ACCEPT_BTN_TEXT__="Accept",window.__SJ_REJECT_BTN_TEXT__="Reject"</script>
+<script src="https://cdn.jsdelivr.net/gh/sprucejoy/cookie-consent-autoblock-gdpr/cookie-consent.js" crossorigin="anonymous"></script>
 <script async src="https://www.googletagmanager.com/gtag/js?id=G-LM8C8QXCN7"></script>
 <script>var dnt=navigator.doNotTrack||window.doNotTrack||navigator.msDoNotTrack,doNotTrack=dnt=="1"||dnt=="yes";if(!doNotTrack){window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag("js",new Date),gtag("config","G-LM8C8QXCN7")}</script>
 </head><body class="td-taxonomy">

diff --git a/docs/_print/index.html b/docs/_print/index.html
@@ -25,7 +25,6 @@
 <meta itemprop="description" content="Documentation for the Logging operator"><meta name="twitter:card" content="summary">
 <meta name="twitter:title" content="Logging operator">
 <meta name="twitter:description" content="Documentation for the Logging operator">
-<meta name="twitter:site" content="@AxoflowIO">
 <link rel="preload" href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" as="style">
 <link href="/scss/main.min.0ac1972f1be3dceb59c9889080c88edf91cadcbb9f766d7fc1b69112b37f2bf7.css" rel="stylesheet" integrity>
 <script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK" crossorigin="anonymous"></script>
@@ -37,6 +36,8 @@
         await import('/pagefind/pagefind-highlight.js');
         new PagefindHighlight({ highlightParam: "highlight" });
     </script>
+<script>window.__SJ_MESSAGE__="We collect cookies to analyze our website traffic and performance. We never collect any personal data.",window.__SJ_ACCEPT_BTN_TEXT__="Accept",window.__SJ_REJECT_BTN_TEXT__="Reject"</script>
+<script src="https://cdn.jsdelivr.net/gh/sprucejoy/cookie-consent-autoblock-gdpr/cookie-consent.js" crossorigin="anonymous"></script>
 <script async src="https://www.googletagmanager.com/gtag/js?id=G-LM8C8QXCN7"></script>
 <script>var dnt=navigator.doNotTrack||window.doNotTrack||navigator.msDoNotTrack,doNotTrack=dnt=="1"||dnt=="yes";if(!doNotTrack){window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag("js",new Date),gtag("config","G-LM8C8QXCN7")}</script>
 </head><body class="td-section">
@@ -105,7 +106,7 @@
 <h1 id="pg-ddbb0ea047ddeaf6e0d24960a53a83c8">1 - What's new</h1><h2 id="version-47">Version 4.7</h2><p>The following are the highlights and main changes of Logging operator 4.7. For a complete list of changes and bugfixes, see the <a href="https://github.com/kube-logging/logging-operator/releases/tag/4.7.0">Logging operator 4.7 releases page</a> and the <a href="https://axoflow.com/logging-operator-4.7-release-announcement">Logging operator 4.7 release blog post</a>.</p><h3 id="breaking-change-for-fluentd">Breaking change for Fluentd</h3><p>When using the Fluentd aggregator, Logging operator has overridden the default <code>chunk_limit_size</code> for the Fluentd disk buffers. Since Fluentd updated the default value to a much saner default, Logging operator won&rsquo;t override that to avoid creating too many small buffer chunks. (Having too many small chunks can lead to <code>too many open files</code> errors.)</p><p>This isn&rsquo;t an intrusive breaking change, it only affects your deployments if you intentionally or accidentally depended on this value.</p><h3 id="json-output-format-for-fluentd">JSON output format for Fluentd</h3><p>In addition to the default text format, Fluentd can now format the output as JSON:</p><div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="display:flex"><span><span style="color:#204a87;font-weight:700">spec</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline">
 </span></span></span><span style="display:flex"><span><span style="color:#f8f8f8;text-decoration:underline">  </span><span style="color:#204a87;font-weight:700">fluentd</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline">
 </span></span></span><span style="display:flex"><span><span style="color:#f8f8f8;text-decoration:underline">    </span><span style="color:#204a87;font-weight:700">logFormat</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">json</span><span style="color:#f8f8f8;text-decoration:underline">
-</span></span></span></code></pre></div><h3 id="disk-buffer-support-for-more-outputs">Disk buffer support for more outputs</h3><p>Enabling disk buffers wasn&rsquo;t available for some of the outputs, this has been fixed for: <a href="/docs/configuration/plugins/outputs/gelf/">Gelf</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/elasticsearch/">Elasticsearch</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/openobserve/">OpenObserve</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/s3/">S3</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/splunk_hec/">Splunk HEC</a>.</p><h3 id="compression-support-for-elasticsearch">Compression support for Elasticsearch</h3><p>The <a href="/docs/configuration/plugins/outputs/elasticsearch/#elasticsearch-compression_level">Elasticsearch output of the Fluentd aggregator</a> now supports compressing the output data using gzip. You can use the <code>compression_level</code> option use <code>default_compression</code>, <code>best_compression</code>, or <code>best_speed</code>. By default, compression is disabled.</p><h3 id="protected-clusteroutputs-for-fluentd">Protected ClusterOutputs for Fluentd</h3><p>By default, ClusterOutputs can be referenced in any Flow. In certain scenarios, this means that users can send logs from Flows to the ClusterOutput possibly spamming the output with user logs. From now on, you can set the <code>protected</code> flag for ClusterOutputs and prevent Flows from sending logs to the protected ClusterOutput.</p><h3 id="configcheck-settings-for-aggregators">ConfigCheck settings for aggregators</h3><p>You can now specify <code>configCheck</code> settings globally in the Loggings CRD, and override them if needed on the aggregator level in the <a href="/docs/configuration/crds/v1beta1/fluentd_types/">Fluentd</a> or <a href="/docs/configuration/crds/v1beta1/syslogng_types/">SyslogNG</a> CRD.</p><h3 id="limit-connections-for-fluent-bit">Limit connections for Fluent Bit</h3><p>You can now limit the number of TCP connections that each Fluent Bit worker can open towards the aggregator endpoints. The <code>max_worker_connections</code> is set to unlimited by default, and should be used together with the <code>Workers</code> option (which defaults to 2 according to the <a href="https://docs.fluentbit.io/manual/pipeline/outputs/tcp-and-tls#:~:text=double-,Workers,-Enables%20dedicated%20thread">Fluent Bit documentation</a>). The following example uses a single worker with a single connection:</p><div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="display:flex"><span><span style="color:#204a87;font-weight:700">kind</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">FluentbitAgent</span><span style="color:#f8f8f8;text-decoration:underline">
+</span></span></span></code></pre></div><h3 id="disk-buffer-support-for-more-outputs">Disk buffer support for more outputs</h3><p>Enabling disk buffers wasn&rsquo;t available for some of the outputs, this has been fixed for: <a href="/docs/configuration/plugins/outputs/gelf/">Gelf</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/elasticsearch/">Elasticsearch</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/openobserve/">OpenObserve</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/s3/">S3</a>, <a href="/docs/configuration/plugins/syslog-ng-outputs/splunk_hec/">Splunk HEC</a>.</p><h3 id="compression-support-for-elasticsearch">Compression support for Elasticsearch</h3><p>The <a href="/docs/configuration/plugins/outputs/elasticsearch/#elasticsearch-compression_level">Elasticsearch output of the Fluentd aggregator</a> now supports compressing the output data using gzip. You can use the <code>compression_level</code> option to set <code>default_compression</code>, <code>best_compression</code>, or <code>best_speed</code>. By default, compression is disabled.</p><h3 id="protected-clusteroutputs-for-fluentd">Protected ClusterOutputs for Fluentd</h3><p>By default, ClusterOutputs can be referenced in any Flow. In certain scenarios, this means that users can send logs from Flows to the ClusterOutput, possibly spamming the output with user logs. From now on, you can set the <code>protected</code> flag for ClusterOutputs and prevent Flows from sending logs to the protected ClusterOutput.</p><h3 id="configcheck-settings-for-aggregators">ConfigCheck settings for aggregators</h3><p>You can now specify <code>configCheck</code> settings globally in the Loggings CRD, and override them if needed on the aggregator level in the <a href="/docs/configuration/crds/v1beta1/fluentd_types/">Fluentd</a> or <a href="/docs/configuration/crds/v1beta1/syslogng_types/">SyslogNG</a> CRD.</p><h3 id="limit-connections-for-fluent-bit">Limit connections for Fluent Bit</h3><p>You can now limit the number of TCP connections that each Fluent Bit worker can open toward the aggregator endpoints. The <code>max_worker_connections</code> is set to unlimited by default, and should be used together with the <code>Workers</code> option (which defaults to 2 according to the <a href="https://docs.fluentbit.io/manual/pipeline/outputs/tcp-and-tls#:~:text=double-,Workers,-Enables%20dedicated%20thread">Fluent Bit documentation</a>). The following example uses a single worker with a single connection:</p><div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-yaml" data-lang="yaml"><span style="display:flex"><span><span style="color:#204a87;font-weight:700">kind</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">FluentbitAgent</span><span style="color:#f8f8f8;text-decoration:underline">
 </span></span></span><span style="display:flex"><span><span style="color:#f8f8f8;text-decoration:underline"></span><span style="color:#204a87;font-weight:700">spec</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline">
 </span></span></span><span style="display:flex"><span><span style="color:#f8f8f8;text-decoration:underline">  </span><span style="color:#204a87;font-weight:700">network</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline">
 </span></span></span><span style="display:flex"><span><span style="color:#f8f8f8;text-decoration:underline">    </span><span style="color:#204a87;font-weight:700">maxWorkerConnections</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:700">1</span><span style="color:#f8f8f8;text-decoration:underline">