Publish updated main docs, 1696407536

docs/_print/index.html

@@ -113,7 +113,7 @@ <h1 id="pg-ddbb0ea047ddeaf6e0d24960a53a83c8">1 - What's new</h1><h2 id="version-
 </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 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]
+</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
 </code></pre><p>New</p><pre tabindex="0"><code>+# HELP logging_buffer_files File count

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-03T14:06:48+02:00"><meta property="og:site_name" content="Logging operator">
+<meta property="article:modified_time" content="2023-10-04T10:18:55+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-03T14:06:48+02:00">
+<meta itemprop="dateModified" content="2023-10-04T10:18:55+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 3, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/6f1bbb975c27d1ce06e33c0afa8afe1450d66653">Merge pull request #189 from kube-logging/istio-labels (6f1bbb9)</a>
+Last modified October 4, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/34f0f3854e3b92d05d453ad56da39cb6ca17edb4">Merge pull request #190 from kube-logging/whatsnew-buffer-metrics (34f0f38)</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">

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

@@ -34,7 +34,7 @@
 workloadMetaOverrides (*types.MetaBase, optional) Override metadata of the created resources">
 <meta property="og:type" content="article">
 <meta property="og:url" content="https://kube-logging.dev/docs/configuration/crds/extensions/hosttailer_types/"><meta property="article:section" content="docs">
-<meta property="article:modified_time" content="2023-10-03T14:06:48+02:00"><meta property="og:site_name" content="Logging operator">
+<meta property="article:modified_time" content="2023-10-04T10:18:55+02:00"><meta property="og:site_name" content="Logging operator">
 <meta itemprop="name" content="HostTailer">
 <meta itemprop="description" content="HostTailerSpec HostTailerSpec defines the desired state of HostTailer
 fileTailers ([]FileTailer, optional) List of file tailers.
@@ -44,7 +44,7 @@
 enableRecreateWorkloadOnImmutableFieldChange (bool, optional) EnableRecreateWorkloadOnImmutableFieldChange enables the operator to recreate the daemonset (and possibly other resource in the future) in case there is a change in an immutable field that otherwise couldn&rsquo;t be managed with a simple update.
 Default: -
 workloadMetaOverrides (*types.MetaBase, optional) Override metadata of the created resources">
-<meta itemprop="dateModified" content="2023-10-03T14:06:48+02:00">
+<meta itemprop="dateModified" content="2023-10-04T10:18:55+02:00">
 <meta itemprop="wordCount" content="366">
 <meta itemprop="keywords" content><meta name="twitter:card" content="summary">
 <meta name="twitter:title" content="HostTailer">
@@ -578,7 +578,7 @@
 </li></ol></nav><div class="td-content">
 <h1>HostTailer</h1><header class="article-meta">
 </header><h2 id="hosttailerspec">HostTailerSpec</h2><p>HostTailerSpec defines the desired state of HostTailer</p><h3 id="hosttailerspec-filetailers">fileTailers ([]FileTailer, optional)</h3><p>List of <a href="#filetailer">file tailers</a>.</p><p>Default: -</p><h3 id="hosttailerspec-systemdtailers">systemdTailers ([]SystemdTailer, optional)</h3><p>List of <a href="#systemdtailer">systemd tailers</a>.</p><p>Default: -</p><h3 id="hosttailerspec-enablerecreateworkloadonimmutablefieldchange">enableRecreateWorkloadOnImmutableFieldChange (bool, optional)</h3><p>EnableRecreateWorkloadOnImmutableFieldChange enables the operator to recreate the daemonset (and possibly other resource in the future) in case there is a change in an immutable field that otherwise couldn&rsquo;t be managed with a simple update.</p><p>Default: -</p><h3 id="hosttailerspec-workloadmetaoverrides">workloadMetaOverrides (*types.MetaBase, optional)</h3><p>Override metadata of the created resources</p><p>Default: -</p><h3 id="hosttailerspec-workloadoverrides">workloadOverrides (*types.PodSpecBase, optional)</h3><p>Override podSpec fields for the given daemonset</p><p>Default: -</p><h2 id="hosttailerstatus">HostTailerStatus</h2><p>HostTailerStatus defines the observed state of <a href="#hosttailer">HostTailer</a>.</p><h2 id="hosttailer">HostTailer</h2><p>HostTailer is the Schema for the hosttailers API</p><h3 id="hosttailer-">(metav1.TypeMeta, required)</h3><p>Default: -</p><h3 id="hosttailer-metadata">metadata (metav1.ObjectMeta, optional)</h3><p>Default: -</p><h3 id="hosttailer-spec">spec (HostTailerSpec, optional)</h3><p>Default: -</p><h3 id="hosttailer-status">status (HostTailerStatus, optional)</h3><p>Default: -</p><h2 id="hosttailerlist">HostTailerList</h2><p>HostTailerList contains a list of <a href="#hosttailer">HostTailers</a>.</p><h3 id="hosttailerlist-">(metav1.TypeMeta, required)</h3><p>Default: -</p><h3 id="hosttailerlist-metadata">metadata (metav1.ListMeta, optional)</h3><p>Default: -</p><h3 id="hosttailerlist-items">items ([]HostTailer, required)</h3><p>Default: -</p><h2 id="filetailer">FileTailer</h2><p>FileTailer configuration options</p><h3 id="filetailer-name">name (string, required)</h3><p>Name for the tailer</p><p>Default: -</p><h3 id="filetailer-path">path (string, optional)</h3><p>Path to the loggable file</p><p>Default: -</p><h3 id="filetailer-disabled">disabled (bool, optional)</h3><p>Disable tailing the file</p><p>Default: -</p><h3 id="filetailer-buffer_max_size">buffer_max_size (string, optional)</h3><p>Set the limit of the buffer size per active filetailer</p><p>Default: -</p><h3 id="filetailer-buffer_chunk_size">buffer_chunk_size (string, optional)</h3><p>Set the buffer chunk size per active filetailer</p><p>Default: -</p><h3 id="filetailer-skip_long_lines">skip_long_lines (string, optional)</h3><p>Skip long line when exceeding Buffer_Max_Size</p><p>Default: -</p><h3 id="filetailer-read_from_head">read_from_head (bool, optional)</h3><p>Start reading from the head of new log files</p><p>Default: -</p><h3 id="filetailer-buffer_max_size">buffer_max_size (string, optional)</h3><p>Set the limit of the buffer size per active filetailer</p><p>Default: -</p><h3 id="filetailer-buffer_chunk_size">buffer_chunk_size (string, optional)</h3><p>Set the buffer chunk size per active filetailer</p><p>Default: -</p><h3 id="filetailer-skip_long_lines">skip_long_lines (string, optional)</h3><p>Skip long line when exceeding Buffer_Max_Size</p><p>Default: -</p><h3 id="filetailer-read_from_head">read_from_head (bool, optional)</h3><p>Start reading from the head of new log files</p><p>Default: -</p><h3 id="filetailer-containeroverrides">containerOverrides (*types.ContainerBase, optional)</h3><p>Override container fields for the given tailer</p><p>Default: -</p><h2 id="systemdtailer">SystemdTailer</h2><p>SystemdTailer configuration options</p><h3 id="systemdtailer-name">name (string, required)</h3><p>Name for the tailer</p><p>Default: -</p><h3 id="systemdtailer-path">path (string, optional)</h3><p>Override systemd log path</p><p>Default: -</p><h3 id="systemdtailer-disabled">disabled (bool, optional)</h3><p>Disable component</p><p>Default: -</p><h3 id="systemdtailer-systemdfilter">systemdFilter (string, optional)</h3><p>Filter to select systemd unit example: kubelet.service</p><p>Default: -</p><h3 id="systemdtailer-maxentries">maxEntries (int, optional)</h3><p>Maximum entries to read when starting to tail logs to avoid high pressure</p><p>Default: -</p><h3 id="systemdtailer-containeroverrides">containerOverrides (*types.ContainerBase, optional)</h3><p>Override container fields for the given tailer</p><p>Default: -</p><div class="text-muted mt-5 pt-3 border-top">
-Last modified October 3, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/6f1bbb975c27d1ce06e33c0afa8afe1450d66653">Merge pull request #189 from kube-logging/istio-labels (6f1bbb9)</a>
+Last modified October 4, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/34f0f3854e3b92d05d453ad56da39cb6ca17edb4">Merge pull request #190 from kube-logging/whatsnew-buffer-metrics (34f0f38)</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">

docs/configuration/crds/extensions/index.html

@@ -546,7 +546,7 @@ <h5>
 <h5>
 <a href="/docs/configuration/crds/extensions/hosttailer_types/">HostTailer</a>
 </h5><p></p></div></div><div class="text-muted mt-5 pt-3 border-top">
-Last modified October 3, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/6f1bbb975c27d1ce06e33c0afa8afe1450d66653">Merge pull request #189 from kube-logging/istio-labels (6f1bbb9)</a>
+Last modified October 4, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/34f0f3854e3b92d05d453ad56da39cb6ca17edb4">Merge pull request #190 from kube-logging/whatsnew-buffer-metrics (34f0f38)</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">

docs/configuration/crds/index.html

@@ -544,7 +544,7 @@ <h5>
 <h5>
 <a href="/docs/configuration/crds/extensions/">Logging extensions CRDs</a>
 </h5><p></p></div></div><div class="text-muted mt-5 pt-3 border-top">
-Last modified October 3, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/6f1bbb975c27d1ce06e33c0afa8afe1450d66653">Merge pull request #189 from kube-logging/istio-labels (6f1bbb9)</a>
+Last modified October 4, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/34f0f3854e3b92d05d453ad56da39cb6ca17edb4">Merge pull request #190 from kube-logging/whatsnew-buffer-metrics (34f0f38)</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">

docs/configuration/crds/v1beta1/clusterflow_types/index.html

@@ -44,7 +44,7 @@
 ClusterExclude namespaces ([]string, optional) Default: -">
 <meta property="og:type" content="article">
 <meta property="og:url" content="https://kube-logging.dev/docs/configuration/crds/v1beta1/clusterflow_types/"><meta property="article:section" content="docs">
-<meta property="article:modified_time" content="2023-10-03T14:06:48+02:00"><meta property="og:site_name" content="Logging operator">
+<meta property="article:modified_time" content="2023-10-04T10:18:55+02:00"><meta property="og:site_name" content="Logging operator">
 <meta itemprop="name" content="ClusterFlow">
 <meta itemprop="description" content="ClusterFlow ClusterFlow is the Schema for the clusterflows API
 (metav1.TypeMeta, required) Default: -
@@ -59,7 +59,7 @@
 hosts ([]string, optional) Default: -
 container_names ([]string, optional) Default: -
 ClusterExclude namespaces ([]string, optional) Default: -">
-<meta itemprop="dateModified" content="2023-10-03T14:06:48+02:00">
+<meta itemprop="dateModified" content="2023-10-04T10:18:55+02:00">
 <meta itemprop="wordCount" content="160">
 <meta itemprop="keywords" content><meta name="twitter:card" content="summary">
 <meta name="twitter:title" content="ClusterFlow">
@@ -600,7 +600,7 @@
 </li></ol></nav><div class="td-content">
 <h1>ClusterFlow</h1><header class="article-meta">
 </header><h2 id="clusterflow">ClusterFlow</h2><p>ClusterFlow is the Schema for the clusterflows API</p><h3 id="clusterflow-">(metav1.TypeMeta, required)</h3><p>Default: -</p><h3 id="clusterflow-metadata">metadata (metav1.ObjectMeta, optional)</h3><p>Default: -</p><h3 id="clusterflow-spec">spec (ClusterFlowSpec, optional)</h3><p>Name of the logging cluster to be attached</p><p>Default: -</p><h3 id="clusterflow-status">status (FlowStatus, optional)</h3><p>Default: -</p><h2 id="clustermatch">ClusterMatch</h2><h3 id="clustermatch-select">select (*ClusterSelect, optional)</h3><p>Default: -</p><h3 id="clustermatch-exclude">exclude (*ClusterExclude, optional)</h3><p>Default: -</p><h2 id="clusterselect">ClusterSelect</h2><h3 id="clusterselect-namespaces">namespaces ([]string, optional)</h3><p>Default: -</p><h3 id="clusterselect-labels">labels (map[string]string, optional)</h3><p>Default: -</p><h3 id="clusterselect-hosts">hosts ([]string, optional)</h3><p>Default: -</p><h3 id="clusterselect-container_names">container_names ([]string, optional)</h3><p>Default: -</p><h2 id="clusterexclude">ClusterExclude</h2><h3 id="clusterexclude-namespaces">namespaces ([]string, optional)</h3><p>Default: -</p><h3 id="clusterexclude-labels">labels (map[string]string, optional)</h3><p>Default: -</p><h3 id="clusterexclude-hosts">hosts ([]string, optional)</h3><p>Default: -</p><h3 id="clusterexclude-container_names">container_names ([]string, optional)</h3><p>Default: -</p><h2 id="clusterflowspec">ClusterFlowSpec</h2><p>ClusterFlowSpec is the Kubernetes spec for ClusterFlows</p><h3 id="clusterflowspec-selectors">selectors (map[string]string, optional)</h3><p>Deprecated</p><p>Default: -</p><h3 id="clusterflowspec-match">match ([]ClusterMatch, optional)</h3><p>Default: -</p><h3 id="clusterflowspec-filters">filters ([]Filter, optional)</h3><p>Default: -</p><h3 id="clusterflowspec-loggingref">loggingRef (string, optional)</h3><p>Default: -</p><h3 id="clusterflowspec-outputrefs">outputRefs ([]string, optional)</h3><p>Deprecated</p><p>Default: -</p><h3 id="clusterflowspec-globaloutputrefs">globalOutputRefs ([]string, optional)</h3><p>Default: -</p><h3 id="clusterflowspec-flowlabel">flowLabel (string, optional)</h3><p>Default: -</p><h3 id="clusterflowspec-includelabelinrouter">includeLabelInRouter (*bool, optional)</h3><p>Default: -</p><h2 id="clusterflowlist">ClusterFlowList</h2><p>ClusterFlowList contains a list of ClusterFlow</p><h3 id="clusterflowlist-">(metav1.TypeMeta, required)</h3><p>Default: -</p><h3 id="clusterflowlist-metadata">metadata (metav1.ListMeta, optional)</h3><p>Default: -</p><h3 id="clusterflowlist-items">items ([]ClusterFlow, required)</h3><p>Default: -</p><div class="text-muted mt-5 pt-3 border-top">
-Last modified October 3, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/6f1bbb975c27d1ce06e33c0afa8afe1450d66653">Merge pull request #189 from kube-logging/istio-labels (6f1bbb9)</a>
+Last modified October 4, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/34f0f3854e3b92d05d453ad56da39cb6ca17edb4">Merge pull request #190 from kube-logging/whatsnew-buffer-metrics (34f0f38)</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">