Skip to content

Commit

Permalink
Publish updated main docs, 1722849231
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 5, 2024
1 parent 3aa6dc5 commit b8d32fd
Show file tree
Hide file tree
Showing 510 changed files with 503 additions and 437 deletions.
24 changes: 23 additions & 1 deletion docs/_print/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4341,7 +4341,29 @@ <h1 id="pg-e55dcde4fa90369f23e1167b78e14986">6.4 - Fluent Bit log collector</h1>
</span></span></span><span style="display:flex"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:700">path</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">&#34;&#34;</span><span style="color:#f8f8f8;text-decoration:underline">
</span></span></span></code></pre></div></li><li>
<p>Delete the <strong>spec.fluentbit</strong> section from the Logging resource, then apply the Logging and the FluentbitAgent CRDs.</p></li></ol><h2 id="examples">Examples</h2><p>The following sections show you some examples on configuring Fluent Bit. For the detailed list of available parameters, see <a href="/docs/configuration/crds/v1beta1/fluentbit_types/">FluentbitSpec</a>.</p><blockquote>
<p>Note: These examples use the traditional method that configures the Fluent Bit deployment using <strong>spec.fluentbit</strong> section of <a href="/docs/logging-infrastructure/logging/">The Logging custom resource</a>.</p></blockquote><h2 id="filters">Filters</h2><h3 id="kubernetes-filterkubernetes">Kubernetes (filterKubernetes)</h3><p>Fluent Bit Kubernetes Filter allows you to enrich your log files with Kubernetes metadata. 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">
<p>Note: These examples use the traditional method that configures the Fluent Bit deployment using <strong>spec.fluentbit</strong> section of <a href="/docs/logging-infrastructure/logging/">The Logging custom resource</a>.</p></blockquote><h2 id="containerd-log-fields">Containerd log fields</h2><p>The following example defines a custom Fluent Bit parser that places the parsed containerd log messages into the <code>log</code> field instead of the <code>message</code> field to be backwards compatible with docker container runtimes.</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">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">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">containerd</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">inputTail</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">Parser</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">cri-log-key</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:#8f5902;font-style:italic"># Parser that populates `log` instead of `message` to enable the Kubernetes filter&#39;s Merge_Log feature to work</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:#8f5902;font-style:italic"># Mind the indentation, otherwise Fluent Bit will parse the whole message into the `log` key</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">customParsers</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000;font-weight:700">|</span><span style="color:#8f5902;font-style:italic">
</span></span></span><span style="display:flex"><span><span style="color:#8f5902;font-style:italic"> [PARSER]
</span></span></span><span style="display:flex"><span><span style="color:#8f5902;font-style:italic"> Name cri-log-key
</span></span></span><span style="display:flex"><span><span style="color:#8f5902;font-style:italic"> Format regex
</span></span></span><span style="display:flex"><span><span style="color:#8f5902;font-style:italic"> Regex ^(?&lt;time&gt;[^ ]+) (?&lt;stream&gt;stdout|stderr) (?&lt;logtag&gt;[^ ]*) (?&lt;log&gt;.*)$
</span></span></span><span style="display:flex"><span><span style="color:#8f5902;font-style:italic"> Time_Key time
</span></span></span><span style="display:flex"><span><span style="color:#8f5902;font-style:italic"> Time_Format %Y-%m-%dT%H:%M:%S.%L%z</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:#8f5902;font-style:italic"># Required key remap if one wants to rely on the existing auto-detected log key in the fluentd parser and concat filter otherwise should be omitted</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">filterModify</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">rules</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">Rename</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">key</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">log</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">value</span><span style="color:#000;font-weight:700">:</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#000">message</span><span style="color:#f8f8f8;text-decoration:underline">
</span></span></span></code></pre></div><h2 id="filters">Filters</h2><h3 id="kubernetes-filterkubernetes">Kubernetes (filterKubernetes)</h3><p>Fluent Bit Kubernetes Filter allows you to enrich your log files with Kubernetes metadata. 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">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">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">default</span><span style="color:#f8f8f8;text-decoration:underline">
Expand Down
6 changes: 3 additions & 3 deletions docs/commercial-support/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@
Axoflow If your company offers support for Logging operator and would like to be listed on this page, open a documentation issue.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://kube-logging.dev/docs/commercial-support/"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2024-07-31T12:09:02+02:00"><meta property="og:site_name" content="Logging operator">
<meta property="article:modified_time" content="2024-08-05T11:13:51+02:00"><meta property="og:site_name" content="Logging operator">
<meta itemprop="name" content="Commercial support for the Logging operator">
<meta itemprop="description" content="If you encounter problems while using the Logging operator the documentation does not address, open an issue or talk to us on Discord or on the CNCF Slack.
The following companies provide commercial support for the Logging operator:
Axoflow If your company offers support for Logging operator and would like to be listed on this page, open a documentation issue.">
<meta itemprop="dateModified" content="2024-07-31T12:09:02+02:00">
<meta itemprop="dateModified" content="2024-08-05T11:13:51+02:00">
<meta itemprop="wordCount" content="60">
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Commercial support for the Logging operator">
Expand Down Expand Up @@ -588,7 +588,7 @@
<h1>Commercial support for the Logging operator</h1><header class="article-meta">
</header><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 on the <a href="/docs/community/">CNCF Slack</a>.</p><p>The following companies provide commercial support for the Logging operator:</p><ul>
<li><a href="https://axoflow.com/">Axoflow</a></li></ul><p>If your company offers support for Logging operator and would like to be listed on this page, open a <a href="https://github.com/kube-logging/kube-logging.github.io/issues/new?title=Commercial%20support%20for%20Logging%20operator">documentation issue</a>.</p><div class="text-muted mt-5 pt-3 border-top">
Last modified July 31, 2024: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/b8ba9e481983e8f7723d43e67b069605d065d8ce">Merge pull request #249 from crazyelectron-io/patch-1 (b8ba9e4)</a>
Last modified August 5, 2024: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/95602333e2977bb83c20e25e0ac4bee82b851059">Merge pull request #250 from kube-logging/containerd-fix-to-fluentbit-examples (9560233)</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">
Expand Down
6 changes: 3 additions & 3 deletions docs/community/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@
If you&rsquo;d like to contribute, see our contribution guidelines for details.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://kube-logging.dev/docs/community/"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2024-07-31T12:09:02+02:00"><meta property="og:site_name" content="Logging operator">
<meta property="article:modified_time" content="2024-08-05T11:13:51+02:00"><meta property="og:site_name" content="Logging operator">
<meta itemprop="name" content="Community">
<meta itemprop="description" content="If you have questions about Logging operator or its components, get in touch with us on Slack!
First, register on the CNCF Slack, then visit the #logging-operator Slack channel.
Alternatively, you can also find us on Discord.
If you&rsquo;d like to contribute, see our contribution guidelines for details.">
<meta itemprop="dateModified" content="2024-07-31T12:09:02+02:00">
<meta itemprop="dateModified" content="2024-08-05T11:13:51+02:00">
<meta itemprop="wordCount" content="48">
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
<meta name="twitter:title" content="Community">
Expand Down Expand Up @@ -591,7 +591,7 @@
</li></ol></nav><div class="td-content">
<h1>Community</h1><header class="article-meta">
</header><p>If you have questions about Logging operator or its components, get in touch with us on Slack!</p><p>First, <a href="https://communityinviter.com/apps/cloud-native/cncf">register on the CNCF Slack</a>, then <a href="https://cloud-native.slack.com/archives/C06DW57NWSJ">visit the #logging-operator Slack channel</a>.</p><p>Alternatively, you can also find us on <a href="https://discord.gg/9ACY4RDsYN">Discord</a>.</p><p>If you&rsquo;d like to contribute, see our <a href="https://github.com/kube-logging/logging-operator/blob/master/CONTRIBUTING.md">contribution guidelines</a> for details.</p><div class="text-muted mt-5 pt-3 border-top">
Last modified July 31, 2024: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/b8ba9e481983e8f7723d43e67b069605d065d8ce">Merge pull request #249 from crazyelectron-io/patch-1 (b8ba9e4)</a>
Last modified August 5, 2024: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/95602333e2977bb83c20e25e0ac4bee82b851059">Merge pull request #250 from kube-logging/containerd-fix-to-fluentbit-examples (9560233)</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">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,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/eventtailer_types/"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2024-07-31T12:09:02+02:00"><meta property="og:site_name" content="Logging operator">
<meta property="article:modified_time" content="2024-08-05T11:13:51+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
containerOverrides (*types.ContainerBase, optional) Override container fields for the given statefulset
Expand All @@ -41,7 +41,7 @@
positionVolume (volume.KubernetesVolume, optional) Volume definition for tracking fluentbit file positions (optional)
workloadOverrides (*types.PodSpecBase, optional) Override podSpec fields for the given statefulset
workloadMetaOverrides (*types.MetaBase, optional) Override metadata of the created resources">
<meta itemprop="dateModified" content="2024-07-31T12:09:02+02:00">
<meta itemprop="dateModified" content="2024-08-05T11:13:51+02:00">
<meta itemprop="wordCount" content="117">
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
<meta name="twitter:title" content="EventTailer">
Expand Down Expand Up @@ -618,7 +618,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-containeroverrides">containerOverrides (*types.ContainerBase, optional)</h3><p>Override container fields for the given statefulset</p><h3 id="eventtailerspec-controlnamespace">controlNamespace (string, required)</h3><p>The resources of EventTailer will be placed into this namespace</p><h3 id="eventtailerspec-image">image (*tailer.ImageSpec, optional)</h3><p>Override image related fields for the given statefulset, highest precedence</p><h3 id="eventtailerspec-positionvolume">positionVolume (volume.KubernetesVolume, optional)</h3><p>Volume definition for tracking fluentbit file positions (optional)</p><h3 id="eventtailerspec-workloadoverrides">workloadOverrides (*types.PodSpecBase, optional)</h3><p>Override podSpec fields for the given statefulset</p><h3 id="eventtailerspec-workloadmetaoverrides">workloadMetaOverrides (*types.MetaBase, optional)</h3><p>Override metadata of the created resources</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><h3 id="eventtailer-metadata">metadata (metav1.ObjectMeta, optional)</h3><h3 id="eventtailer-spec">spec (EventTailerSpec, optional)</h3><h3 id="eventtailer-status">status (EventTailerStatus, optional)</h3><h2 id="eventtailerlist">EventTailerList</h2><p>EventTailerList contains a list of EventTailer</p><h3 id="eventtailerlist-">(metav1.TypeMeta, required)</h3><h3 id="eventtailerlist-metadata">metadata (metav1.ListMeta, optional)</h3><h3 id="eventtailerlist-items">items ([]EventTailer, required)</h3><div class="text-muted mt-5 pt-3 border-top">
Last modified July 31, 2024: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/b8ba9e481983e8f7723d43e67b069605d065d8ce">Merge pull request #249 from crazyelectron-io/patch-1 (b8ba9e4)</a>
Last modified August 5, 2024: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/95602333e2977bb83c20e25e0ac4bee82b851059">Merge pull request #250 from kube-logging/containerd-fix-to-fluentbit-examples (9560233)</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">
Expand Down
Loading

0 comments on commit b8d32fd

Please sign in to comment.