Skip to content

Commit 2cf2848

Browse files
Publish updated main docs, 1738930495
1 parent 4c2a8e1 commit 2cf2848

File tree

520 files changed

+441
-457
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

520 files changed

+441
-457
lines changed

announcements/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
<h1>Announcements</h1><header class="article-meta">
9898
</header><div class="section-index">
9999
</div><div class="text-muted mt-5 pt-3 border-top">
100-
Last modified February 4, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/1c6b50e472cf8efccb3d63d289f2f0b1e1d19f6c">Merge 0d58575fbf0fb8742ed46a19754cdfafddfb1761 into 592c23b5e62ee0edf754f424bd7d1e68d57998e0 (1c6b50e)</a>
100+
Last modified February 7, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/d5fb6a4e032c542065e0b23d0c6d1ddf5baae22c">Merge pull request #277 from vfaergestad/docs-dup-line (d5fb6a4)</a>
101101
</div></div></main></div></div><footer class="bg-dark py-5 row d-print-none">
102102
<div class="container-fluid mx-sm-5">
103103
<div class="row">

docs/_print/index.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,12 +1265,8 @@ <h1 id="pg-1af6b8a7150b57e6f6af4991d03afabf">4.5 - Routing your logs with syslog
12651265
</span></span></span></code></pre></div></div><div class="td-content" style="page-break-before:always">
12661266
<h1 id="pg-ac7f8f2de0bfec29f800c2742a2d0127">4.6 - Kubernetes events, node logs, and logfiles</h1><p>The Logging extensions part of the Logging operator solves the following problems:</p><ul>
12671267
<li>Collect Kubernetes events to provide insight into what is happening inside a cluster, such as decisions made by the scheduler, or why some pods were evicted from the node.</li><li>Collect logs from the nodes like <code>kubelet</code> logs.</li><li>Collect logs from files on the nodes, for example, <code>audit</code> logs, or the <code>systemd</code> journal.</li><li>Collect logs from legacy application log files.</li></ul><p>Starting with Logging operator version 3.17.0, logging-extensions are open source and part of Logging operator.</p><h2 id="features">Features</h2><p>Logging-operator handles the new features the well-known way: it uses custom resources to access the features. This way a simple <code>kubectl apply</code> with a particular parameter set initiates a new feature. Extensions supports three different custom resource types:</p><ul>
1268-
<li>
1269-
<p>Logging-operator handles the new features the well-known way: it uses custom resources to access the features. This way a simple <code>kubectl apply</code> with a particular parameter set initiates a new feature. Extensions supports three different custom resource types:</p></li><li>
1270-
<p><a href="/docs/configuration/extensions/kubernetes-event-tailer/">Event-tailer</a> listens for Kubernetes events and transmits their changes to stdout, so the Logging operator can process them.</p></li><li>
1271-
<p><a href="/docs/configuration/extensions/kubernetes-host-tailer/">Host-tailer</a> tails custom files and transmits their changes to stdout. This way the Logging operator can process them.
1272-
Kubernetes host tailer allows you to tail logs like <code>kubelet</code>, <code>audit</code> logs, or the <code>systemd</code> journal from the nodes.</p></li><li>
1273-
<p><a href="/docs/configuration/extensions/tailer-webhook/">Tailer-webhook</a> is a different approach for the same problem: parsing legacy application&rsquo;s log file. Instead of running a <code>host-tailer</code> instance on every node, <code>tailer-webhook</code> attaches a <code>sidecar container</code> to the pod, and reads the specified file(s).</p></li></ul><blockquote>
1268+
<li><a href="/docs/configuration/extensions/kubernetes-event-tailer/">Event-tailer</a> listens for Kubernetes events and transmits their changes to stdout, so the Logging operator can process them.</li><li><a href="/docs/configuration/extensions/kubernetes-host-tailer/">Host-tailer</a> tails custom files and transmits their changes to stdout. This way the Logging operator can process them.
1269+
Kubernetes host tailer allows you to tail logs like <code>kubelet</code>, <code>audit</code> logs, or the <code>systemd</code> journal from the nodes.</li><li><a href="/docs/configuration/extensions/tailer-webhook/">Tailer-webhook</a> is a different approach for the same problem: parsing legacy application&rsquo;s log file. Instead of running a <code>host-tailer</code> instance on every node, <code>tailer-webhook</code> attaches a <code>sidecar container</code> to the pod, and reads the specified file(s).</li></ul><blockquote>
12741270
<p>Check our <a href="https://github.com/kube-logging/logging-operator/tree/master/config/samples/extensions">configuration snippets</a> for examples.</p></blockquote></div><div class="td-content" style="page-break-before:always">
12751271
<h1 id="pg-04413fd144b07886f11cf231a5113cbc">4.6.1 - Kubernetes Event Tailer</h1><p>Kubernetes events are objects that provide insight into what is happening inside a cluster, such as what decisions were made by the scheduler or why some pods were evicted from the node. Event tailer listens for Kubernetes events and transmits their changes to stdout, so the Logging operator can process them.</p><p><img src="../logging-extensions-event-tailer.png" alt="Event tailer"></p><p>The operator handles this CR and generates the following required resources:</p><ul>
12761272
<li>ServiceAccount: new account for <code>event-tailer</code></li><li>ClusterRole: sets the <code>event-tailer's</code> roles</li><li>ClusterRoleBinding: links the account with the roles</li><li>ConfigMap: contains the configuration for the <code>event-tailer</code> pod</li><li>StatefulSet: manages the lifecycle of the <code>event-tailer</code> pod, which uses the <code>banzaicloud/eventrouter:v0.1.0</code> image to tail events</li></ul><h2 id="create-event-tailer">Create event tailer</h2><ol>

docs/commercial-support/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@
2424
Axoflow If your company offers support for Logging operator and would like to be listed on this page, open a documentation issue.">
2525
<meta property="og:type" content="article">
2626
<meta property="og:url" content="https://kube-logging.dev/docs/commercial-support/"><meta property="article:section" content="docs">
27-
<meta property="article:modified_time" content="2025-02-04T09:30:56+00:00"><meta property="og:site_name" content="Logging operator">
27+
<meta property="article:modified_time" content="2025-02-07T13:14:55+01:00"><meta property="og:site_name" content="Logging operator">
2828
<meta itemprop="name" content="Commercial support for the Logging operator">
2929
<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.
3030
The following companies provide commercial support for the Logging operator:
3131
Axoflow If your company offers support for Logging operator and would like to be listed on this page, open a documentation issue.">
32-
<meta itemprop="dateModified" content="2025-02-04T09:30:56+00:00">
32+
<meta itemprop="dateModified" content="2025-02-07T13:14:55+01:00">
3333
<meta itemprop="wordCount" content="60">
3434
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
3535
<meta name="twitter:title" content="Commercial support for the Logging operator">
@@ -588,7 +588,7 @@
588588
<h1>Commercial support for the Logging operator</h1><header class="article-meta">
589589
</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>
590590
<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">
591-
Last modified February 4, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/1c6b50e472cf8efccb3d63d289f2f0b1e1d19f6c">Merge 0d58575fbf0fb8742ed46a19754cdfafddfb1761 into 592c23b5e62ee0edf754f424bd7d1e68d57998e0 (1c6b50e)</a>
591+
Last modified February 7, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/d5fb6a4e032c542065e0b23d0c6d1ddf5baae22c">Merge pull request #277 from vfaergestad/docs-dup-line (d5fb6a4)</a>
592592
</div></div></main></div></div><footer class="bg-dark py-5 row d-print-none">
593593
<div class="container-fluid mx-sm-5">
594594
<div class="row">

docs/community/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@
2626
If you&rsquo;d like to contribute, see our contribution guidelines for details.">
2727
<meta property="og:type" content="article">
2828
<meta property="og:url" content="https://kube-logging.dev/docs/community/"><meta property="article:section" content="docs">
29-
<meta property="article:modified_time" content="2025-02-04T09:30:56+00:00"><meta property="og:site_name" content="Logging operator">
29+
<meta property="article:modified_time" content="2025-02-07T13:14:55+01:00"><meta property="og:site_name" content="Logging operator">
3030
<meta itemprop="name" content="Community">
3131
<meta itemprop="description" content="If you have questions about Logging operator or its components, get in touch with us on Slack!
3232
First, register on the CNCF Slack, then visit the #logging-operator Slack channel.
3333
Alternatively, you can also find us on Discord.
3434
If you&rsquo;d like to contribute, see our contribution guidelines for details.">
35-
<meta itemprop="dateModified" content="2025-02-04T09:30:56+00:00">
35+
<meta itemprop="dateModified" content="2025-02-07T13:14:55+01:00">
3636
<meta itemprop="wordCount" content="48">
3737
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
3838
<meta name="twitter:title" content="Community">
@@ -591,7 +591,7 @@
591591
</li></ol></nav><div class="td-content">
592592
<h1>Community</h1><header class="article-meta">
593593
</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">
594-
Last modified February 4, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/1c6b50e472cf8efccb3d63d289f2f0b1e1d19f6c">Merge 0d58575fbf0fb8742ed46a19754cdfafddfb1761 into 592c23b5e62ee0edf754f424bd7d1e68d57998e0 (1c6b50e)</a>
594+
Last modified February 7, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/d5fb6a4e032c542065e0b23d0c6d1ddf5baae22c">Merge pull request #277 from vfaergestad/docs-dup-line (d5fb6a4)</a>
595595
</div></div></main></div></div><footer class="bg-dark py-5 row d-print-none">
596596
<div class="container-fluid mx-sm-5">
597597
<div class="row">

docs/configuration/_print/index.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -627,12 +627,8 @@ <h1 id="pg-1af6b8a7150b57e6f6af4991d03afabf">5 - Routing your logs with syslog-n
627627
</span></span></span></code></pre></div></div><div class="td-content" style="page-break-before:always">
628628
<h1 id="pg-ac7f8f2de0bfec29f800c2742a2d0127">6 - Kubernetes events, node logs, and logfiles</h1><p>The Logging extensions part of the Logging operator solves the following problems:</p><ul>
629629
<li>Collect Kubernetes events to provide insight into what is happening inside a cluster, such as decisions made by the scheduler, or why some pods were evicted from the node.</li><li>Collect logs from the nodes like <code>kubelet</code> logs.</li><li>Collect logs from files on the nodes, for example, <code>audit</code> logs, or the <code>systemd</code> journal.</li><li>Collect logs from legacy application log files.</li></ul><p>Starting with Logging operator version 3.17.0, logging-extensions are open source and part of Logging operator.</p><h2 id="features">Features</h2><p>Logging-operator handles the new features the well-known way: it uses custom resources to access the features. This way a simple <code>kubectl apply</code> with a particular parameter set initiates a new feature. Extensions supports three different custom resource types:</p><ul>
630-
<li>
631-
<p>Logging-operator handles the new features the well-known way: it uses custom resources to access the features. This way a simple <code>kubectl apply</code> with a particular parameter set initiates a new feature. Extensions supports three different custom resource types:</p></li><li>
632-
<p><a href="/docs/configuration/extensions/kubernetes-event-tailer/">Event-tailer</a> listens for Kubernetes events and transmits their changes to stdout, so the Logging operator can process them.</p></li><li>
633-
<p><a href="/docs/configuration/extensions/kubernetes-host-tailer/">Host-tailer</a> tails custom files and transmits their changes to stdout. This way the Logging operator can process them.
634-
Kubernetes host tailer allows you to tail logs like <code>kubelet</code>, <code>audit</code> logs, or the <code>systemd</code> journal from the nodes.</p></li><li>
635-
<p><a href="/docs/configuration/extensions/tailer-webhook/">Tailer-webhook</a> is a different approach for the same problem: parsing legacy application&rsquo;s log file. Instead of running a <code>host-tailer</code> instance on every node, <code>tailer-webhook</code> attaches a <code>sidecar container</code> to the pod, and reads the specified file(s).</p></li></ul><blockquote>
630+
<li><a href="/docs/configuration/extensions/kubernetes-event-tailer/">Event-tailer</a> listens for Kubernetes events and transmits their changes to stdout, so the Logging operator can process them.</li><li><a href="/docs/configuration/extensions/kubernetes-host-tailer/">Host-tailer</a> tails custom files and transmits their changes to stdout. This way the Logging operator can process them.
631+
Kubernetes host tailer allows you to tail logs like <code>kubelet</code>, <code>audit</code> logs, or the <code>systemd</code> journal from the nodes.</li><li><a href="/docs/configuration/extensions/tailer-webhook/">Tailer-webhook</a> is a different approach for the same problem: parsing legacy application&rsquo;s log file. Instead of running a <code>host-tailer</code> instance on every node, <code>tailer-webhook</code> attaches a <code>sidecar container</code> to the pod, and reads the specified file(s).</li></ul><blockquote>
636632
<p>Check our <a href="https://github.com/kube-logging/logging-operator/tree/master/config/samples/extensions">configuration snippets</a> for examples.</p></blockquote></div><div class="td-content" style="page-break-before:always">
637633
<h1 id="pg-04413fd144b07886f11cf231a5113cbc">6.1 - Kubernetes Event Tailer</h1><p>Kubernetes events are objects that provide insight into what is happening inside a cluster, such as what decisions were made by the scheduler or why some pods were evicted from the node. Event tailer listens for Kubernetes events and transmits their changes to stdout, so the Logging operator can process them.</p><p><img src="../logging-extensions-event-tailer.png" alt="Event tailer"></p><p>The operator handles this CR and generates the following required resources:</p><ul>
638634
<li>ServiceAccount: new account for <code>event-tailer</code></li><li>ClusterRole: sets the <code>event-tailer's</code> roles</li><li>ClusterRoleBinding: links the account with the roles</li><li>ConfigMap: contains the configuration for the <code>event-tailer</code> pod</li><li>StatefulSet: manages the lifecycle of the <code>event-tailer</code> pod, which uses the <code>banzaicloud/eventrouter:v0.1.0</code> image to tail events</li></ul><h2 id="create-event-tailer">Create event tailer</h2><ol>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
workloadMetaOverrides (*types.MetaBase, optional) Override metadata of the created resources">
3333
<meta property="og:type" content="article">
3434
<meta property="og:url" content="https://kube-logging.dev/docs/configuration/crds/extensions/eventtailer_types/"><meta property="article:section" content="docs">
35-
<meta property="article:modified_time" content="2025-02-04T09:30:56+00:00"><meta property="og:site_name" content="Logging operator">
35+
<meta property="article:modified_time" content="2025-02-07T13:14:55+01:00"><meta property="og:site_name" content="Logging operator">
3636
<meta itemprop="name" content="EventTailer">
3737
<meta itemprop="description" content="EventTailerSpec EventTailerSpec defines the desired state of EventTailer
3838
containerOverrides (*types.ContainerBase, optional) Override container fields for the given statefulset
@@ -41,7 +41,7 @@
4141
positionVolume (volume.KubernetesVolume, optional) Volume definition for tracking fluentbit file positions (optional)
4242
workloadOverrides (*types.PodSpecBase, optional) Override podSpec fields for the given statefulset
4343
workloadMetaOverrides (*types.MetaBase, optional) Override metadata of the created resources">
44-
<meta itemprop="dateModified" content="2025-02-04T09:30:56+00:00">
44+
<meta itemprop="dateModified" content="2025-02-07T13:14:55+01:00">
4545
<meta itemprop="wordCount" content="117">
4646
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
4747
<meta name="twitter:title" content="EventTailer">
@@ -618,7 +618,7 @@
618618
</li></ol></nav><div class="td-content">
619619
<h1>EventTailer</h1><header class="article-meta">
620620
</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">
621-
Last modified February 4, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/1c6b50e472cf8efccb3d63d289f2f0b1e1d19f6c">Merge 0d58575fbf0fb8742ed46a19754cdfafddfb1761 into 592c23b5e62ee0edf754f424bd7d1e68d57998e0 (1c6b50e)</a>
621+
Last modified February 7, 2025: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/d5fb6a4e032c542065e0b23d0c6d1ddf5baae22c">Merge pull request #277 from vfaergestad/docs-dup-line (d5fb6a4)</a>
622622
</div></div></main></div></div><footer class="bg-dark py-5 row d-print-none">
623623
<div class="container-fluid mx-sm-5">
624624
<div class="row">

0 commit comments

Comments
 (0)