Publish updated main docs, 1696934211

docs/_print/index.html

@@ -93,26 +93,12 @@
 <li><a href="/docs/configuration/output/#syslogngoutput">SyslogNGOutput</a> - Defines a syslog-ng Output for a logging flow, where the log messages are sent using Fluentd. This is a namespaced resource. See also <code>SyslogNGClusterOutput</code>. To configure Fluentd outputs, see <code>output</code>.</li><li><a href="/docs/configuration/flow/#syslogngflow">SyslogNGFlow</a> - Defines a syslog-ng logging flow using <code>filters</code> and <code>outputs</code>. Basically, the flow routes the selected log messages to the specified outputs. This is a namespaced resource. See also <code>SyslogNGClusterFlow</code>. To configure Fluentd flows, see <code>flow</code>.</li><li><a href="/docs/configuration/output/#syslogngoutput">SyslogNGClusterOutput</a> - Defines a syslog-ng output that is available from all flows and clusterflows. The operator evaluates clusteroutputs in the <code>controlNamespace</code> only unless <code>allowClusterResourcesFromAllNamespaces</code> is set to true.</li><li><a href="/docs/configuration/flow/#syslogngflow">SyslogNGClusterFlow</a> - Defines a syslog-ng logging flow that collects logs from all namespaces by default. The operator evaluates clusterflows in the <code>controlNamespace</code> only unless <code>allowClusterResourcesFromAllNamespaces</code> is set to true. To configure Fluentd clusterflows, see <code>clusterflow</code>.</li></ul></li></ul><p>For the detailed CRD documentation, see <a href="/docs/configuration/crds/">List of CRDs</a>.</p><p><img src="/docs/img/logging-operator-v2-architecture.png" alt="Logging operator architecture"></p><h2 id="quickstart">Quickstart</h2><p>See our <a href="/docs/quickstarts/">Quickstart guides</a>.</p><h2 id="support">Support</h2><p>If you encounter problems while using the Logging operator the documentation does not address, <a href="https://github.com/kube-logging/logging-operator/issues">open an issue</a> or talk to us on <a href="https://discord.gg/9ACY4RDsYN">Discord</a> or <a href="https://emergingtechcommunity.slack.com/">Slack</a>.</p></div></div><div class="td-content" style="page-break-before:always">
 <h1 id="pg-ddbb0ea047ddeaf6e0d24960a53a83c8">1 - What's new</h1><h2 id="version-44">Version 4.4</h2><p>The following are the highlights and main changes of Logging operator 4.4. For a complete list of changes and bugfixes, see the <a href="https://github.com/kube-logging/logging-operator/releases/tag/4.4.0">Logging operator 4.4 releases page</a>.</p><h3 id="new-syslog-ng-features">New syslog-ng features</h3><p>When using syslog-ng as the log aggregator, you can now use the following new outputs:</p><ul>
 <li><a href="/docs/configuration/plugins/syslog-ng-outputs/elasticsearch/">ElasticSearch</a></li><li><a href="/docs/configuration/plugins/syslog-ng-outputs/loki/">Grafana Loki</a></li><li><a href="/docs/configuration/plugins/syslog-ng-outputs/mongodb/">MongoDB</a></li><li><a href="/docs/configuration/plugins/syslog-ng-outputs/redis/">Redis</a></li><li><a href="/docs/configuration/plugins/syslog-ng-outputs/s3/">Amazon S3</a></li><li><a href="/docs/configuration/plugins/syslog-ng-outputs/splunk_hec/">Splunk HEC</a></li><li>The <a href="/docs/configuration/plugins/syslog-ng-outputs/http/">HTTP</a> output now supports the <code>log-fifo-size</code>, <code>response-action</code>, and <code>timeout</code> fields.</li></ul><p>You can now use the <code>metrics-probe()</code> parser of syslog-ng in syslogNGFLow and SyslogNGClusterFlow. For details, see <a href="/docs/configuration/plugins/syslog-ng-filters/parser/#metricsprobe">MetricsProbe</a>.</p><h3 id="multitenancy-with-namespace-based-routing">Multitenancy with namespace-based routing</h3><p>Logging operator now supports namespace based routing for efficient aggregator-level multi-tenancy.</p><p>In the project repository you can:</p><ul>
-<li>find an <a href="https://github.com/kube-logging/logging-operator/blob/master/docs/multi-tenancy.md">overview about multitenancy</a>.</li><li>find more detailed information about the new <a href="https://github.com/kube-logging/logging-operator/blob/master/docs/logging-route.md">LoggingRoute</a> resource that enables this new behaviour.</li><li>find a <a href="https://github.com/kube-logging/logging-operator/tree/master/config/samples/multitenant-routing">simple example</a> to demonstrate the new behaviour</li></ul><p>On a side note, nodegroup level isolation for hard multitenancy is also supported, see the <a href="/docs/examples/multitenancy/">Nodegroup-based multitenancy</a> example.</p><h3 id="forwarder-logs">Forwarder logs</h3><p>Fluent-bit now doesn&rsquo;t process the logs of the Fluentd and syslog-ng forwarders by default to avoid infinitely growing message loops. With this change, you can access Fluentd and syslog-ng logs simply by running <code>kubectl logs &lt;name-of-forwarder-pod></code></p><p>In a future Logging operator version the logs of the aggregators will also be available for routing to external outputs.</p><h3 id="timeout-based-configuration-checks">Timeout-based configuration checks</h3><p>You can now use timeout-based configuration strategies for both syslog-ng and Fluentd. For example:</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">apiVersion</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">logging.banzaicloud.io/v1beta1</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">kind</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Logging</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">metadata</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">name</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">all-to-file</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">
+<li>find an <a href="https://github.com/kube-logging/logging-operator/blob/master/docs/multi-tenancy.md">overview about multitenancy</a>.</li><li>find more detailed information about the new <a href="https://github.com/kube-logging/logging-operator/blob/master/docs/logging-route.md">LoggingRoute</a> resource that enables this new behaviour.</li><li>find a <a href="https://github.com/kube-logging/logging-operator/tree/master/config/samples/multitenant-routing">simple example</a> to demonstrate the new behaviour</li></ul><p>On a side note, nodegroup level isolation for hard multitenancy is also supported, see the <a href="/docs/examples/multitenancy/">Nodegroup-based multitenancy</a> example.</p><h3 id="forwarder-logs">Forwarder logs</h3><p>Fluent-bit now doesn&rsquo;t process the logs of the Fluentd and syslog-ng forwarders by default to avoid infinitely growing message loops. With this change, you can access Fluentd and syslog-ng logs simply by running <code>kubectl logs &lt;name-of-forwarder-pod></code></p><p>In a future Logging operator version the logs of the aggregators will also be available for routing to external outputs.</p><h3 id="timeout-based-configuration-checks">Timeout-based configuration checks</h3><p>Timeout-based configuration checks are different from the normal method: they start a Fluentd or syslog-ng instance
+without the dry-run or syntax-check flags, so output plugins or destination drivers actually try to establish
+connections and will fail if there are any issues , for example, with the credentials.</p><p>Add the following to you <code>Logging</code> resource spec:</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">configCheck</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">strategy</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">StartWithTimeout</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">timeoutSeconds</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:700">5</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">syslogNG</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </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">controlNamespace</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
-</span></span></span></code></pre></div><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">apiVersion</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">logging.banzaicloud.io/v1beta1</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">kind</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">Logging</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">metadata</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">name</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">all-to-file</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">configCheck</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">strategy</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">StartWithTimeout</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">timeoutSeconds</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#0000cf;font-weight:700">5</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 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">controlNamespace</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">default</span><span style="color:#f8f8f8;text-decoration:underline">
 </span></span></span></code></pre></div><h3 id="istio-support">Istio support</h3><p>For jobs/individual pods that run to completion, Istio sidecar injection needs to be disabled, otherwise the affected pods would live forever with the running sidecar container. Configuration checkers and Fluentd drainer pods can be configured with the label <code>sidecar.istio.io/inject</code> set to <code>false</code>. You can configure Fluentd drainer labels in the Logging spec.</p><h3 id="improved-buffer-metrics">Improved buffer metrics</h3><p>The buffer metrics are now available for both the Fluentd and the SyslogNG based aggregators.</p><p>The sidecar configuration has been rewritten to add a new metric and improve performance by avoiding unnecessary cardinality.</p><p>The name of the metric has been changed as well, but the original metric was kept in place to avoid breaking existing clients.</p><p><strong>Metrics currently supported by the sidecar</strong></p><p>Old</p><pre tabindex="0"><code>+# HELP node_buffer_size_bytes Disk space used [deprecated]
 +# TYPE node_buffer_size_bytes gauge
 +node_buffer_size_bytes{entity=&#34;/buffers&#34;} 32253

docs/configuration/crds/extensions/eventtailer_types/index.html

@@ -40,7 +40,7 @@
 Default: -">
 <meta property="og:type" content="article">
 <meta property="og:url" content="https://kube-logging.dev/docs/configuration/crds/extensions/eventtailer_types/"><meta property="article:section" content="docs">
-<meta property="article:modified_time" content="2023-10-04T11:27:35+02:00"><meta property="og:site_name" content="Logging operator">
+<meta property="article:modified_time" content="2023-10-10T12:36:50+02:00"><meta property="og:site_name" content="Logging operator">
 <meta itemprop="name" content="EventTailer">
 <meta itemprop="description" content="EventTailerSpec EventTailerSpec defines the desired state of EventTailer
 controlNamespace (string, required) The resources of EventTailer will be placed into this namespace
@@ -53,7 +53,7 @@
 Default: -
 containerOverrides (*types.ContainerBase, optional) Override container fields for the given statefulset
 Default: -">
-<meta itemprop="dateModified" content="2023-10-04T11:27:35+02:00">
+<meta itemprop="dateModified" content="2023-10-10T12:36:50+02:00">
 <meta itemprop="wordCount" content="128">
 <meta itemprop="keywords" content><meta name="twitter:card" content="summary">
 <meta name="twitter:title" content="EventTailer">
@@ -586,7 +586,7 @@
 </li></ol></nav><div class="td-content">
 <h1>EventTailer</h1><header class="article-meta">
 </header><h2 id="eventtailerspec">EventTailerSpec</h2><p>EventTailerSpec defines the desired state of EventTailer</p><h3 id="eventtailerspec-controlnamespace">controlNamespace (string, required)</h3><p>The resources of EventTailer will be placed into this namespace</p><p>Default: -</p><h3 id="eventtailerspec-positionvolume">positionVolume (volume.KubernetesVolume, optional)</h3><p>Volume definition for tracking fluentbit file positions (optional)</p><p>Default: -</p><h3 id="eventtailerspec-workloadmetaoverrides">workloadMetaOverrides (*types.MetaBase, optional)</h3><p>Override metadata of the created resources</p><p>Default: -</p><h3 id="eventtailerspec-workloadoverrides">workloadOverrides (*types.PodSpecBase, optional)</h3><p>Override podSpec fields for the given statefulset</p><p>Default: -</p><h3 id="eventtailerspec-containeroverrides">containerOverrides (*types.ContainerBase, optional)</h3><p>Override container fields for the given statefulset</p><p>Default: -</p><h2 id="eventtailerstatus">EventTailerStatus</h2><p>EventTailerStatus defines the observed state of EventTailer</p><h2 id="eventtailer">EventTailer</h2><p>EventTailer is the Schema for the eventtailers API</p><h3 id="eventtailer-">(metav1.TypeMeta, required)</h3><p>Default: -</p><h3 id="eventtailer-metadata">metadata (metav1.ObjectMeta, optional)</h3><p>Default: -</p><h3 id="eventtailer-spec">spec (EventTailerSpec, optional)</h3><p>Default: -</p><h3 id="eventtailer-status">status (EventTailerStatus, optional)</h3><p>Default: -</p><h2 id="eventtailerlist">EventTailerList</h2><p>EventTailerList contains a list of EventTailer</p><h3 id="eventtailerlist-">(metav1.TypeMeta, required)</h3><p>Default: -</p><h3 id="eventtailerlist-metadata">metadata (metav1.ListMeta, optional)</h3><p>Default: -</p><h3 id="eventtailerlist-items">items ([]EventTailer, required)</h3><p>Default: -</p><div class="text-muted mt-5 pt-3 border-top">
-Last modified October 4, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/c97e7f5ea44b142b08aca59872411ee4ec5b24a3">Merge pull request #188 from kube-logging/tailer-webhook (c97e7f5)</a>
+Last modified October 10, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/01621fd177b21a37f50de519f3d1197d5f50ba4c">Merge pull request #193 from kube-logging/timeout-based-configcheck (01621fd)</a>
 </div></div></main></div></div><footer class="bg-dark py-5 row d-print-none">
 <div class="container-fluid mx-sm-5">
 <div class="row">