Skip to content

Commit

Permalink
Publish updated main docs, 2023-12-27T16:00:19Z
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 27, 2023
1 parent e134d40 commit b2d8a6b
Show file tree
Hide file tree
Showing 319 changed files with 411 additions and 411 deletions.
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="2023-12-27T16:59:11+01:00"><meta property="og:site_name" content="Logging operator">
<meta property="article:modified_time" content="2023-12-27T16:00:22+00: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="2023-12-27T16:59:11+01:00">
<meta itemprop="dateModified" content="2023-12-27T16:00:22+00: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 @@ -585,7 +585,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 December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/4435f2183d86539fc9cacced91ff631c5ad94dfb">Merge pull request #204 from kube-logging/updates-for-4.5 (4435f21)</a>
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/66b10dad83878cc9f39a5dff1457d3b37c7a55e7">Merge c6b83f9e829b88ef1f1f1331bd93f87c9a06a213 into 93cf918f74f8421587622b32cecdd81e585de744 (66b10da)</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 @@ -28,14 +28,14 @@
workloadOverrides (*types.PodSpecBase, optional) Override podSpec fields for the given daemonset">
<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-12-27T16:59:11+01:00"><meta property="og:site_name" content="Logging operator">
<meta property="article:modified_time" content="2023-12-27T16:00:22+00: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
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.
fileTailers ([]FileTailer, optional) List of file tailers.
image (tailer.ImageSpec, optional) systemdTailers ([]SystemdTailer, optional) List of systemd tailers.
workloadOverrides (*types.PodSpecBase, optional) Override podSpec fields for the given daemonset">
<meta itemprop="dateModified" content="2023-12-27T16:59:11+01:00">
<meta itemprop="dateModified" content="2023-12-27T16:00:22+00:00">
<meta itemprop="wordCount" content="284">
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
<meta name="twitter:title" content="HostTailer">
Expand Down Expand Up @@ -581,7 +581,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-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><h3 id="hosttailerspec-filetailers">fileTailers ([]FileTailer, optional)</h3><p>List of <a href="#filetailer">file tailers</a>.</p><h3 id="hosttailerspec-image">image (tailer.ImageSpec, optional)</h3><h3 id="hosttailerspec-systemdtailers">systemdTailers ([]SystemdTailer, optional)</h3><p>List of <a href="#systemdtailer">systemd tailers</a>.</p><h3 id="hosttailerspec-workloadoverrides">workloadOverrides (*types.PodSpecBase, optional)</h3><p>Override podSpec fields for the given daemonset</p><h3 id="hosttailerspec-workloadmetaoverrides">workloadMetaOverrides (*types.MetaBase, optional)</h3><p>Override metadata of the created resources</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><h3 id="hosttailer-metadata">metadata (metav1.ObjectMeta, optional)</h3><h3 id="hosttailer-spec">spec (HostTailerSpec, optional)</h3><h3 id="hosttailer-status">status (HostTailerStatus, optional)</h3><h2 id="hosttailerlist">HostTailerList</h2><p>HostTailerList contains a list of <a href="#hosttailer">HostTailers</a>.</p><h3 id="hosttailerlist-">(metav1.TypeMeta, required)</h3><h3 id="hosttailerlist-metadata">metadata (metav1.ListMeta, optional)</h3><h3 id="hosttailerlist-items">items ([]HostTailer, required)</h3><h2 id="filetailer">FileTailer</h2><p>FileTailer configuration options</p><h3 id="filetailer-buffer_chunk_size">buffer_chunk_size (string, optional)</h3><p>Set the buffer chunk size per active filetailer</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><h3 id="filetailer-containeroverrides">containerOverrides (*types.ContainerBase, optional)</h3><p>Override container fields for the given tailer</p><h3 id="filetailer-disabled">disabled (bool, optional)</h3><p>Disable tailing the file</p><h3 id="filetailer-image">image (*tailer.ImageSpec, optional)</h3><p>Override image field for the given trailer</p><h3 id="filetailer-name">name (string, required)</h3><p>Name for the tailer</p><h3 id="filetailer-path">path (string, optional)</h3><p>Path to the loggable file</p><h3 id="filetailer-read_from_head">read_from_head (bool, optional)</h3><p>Start reading from the head of new log files</p><h3 id="filetailer-skip_long_lines">skip_long_lines (string, optional)</h3><p>Skip long line when exceeding Buffer_Max_Size</p><h2 id="systemdtailer">SystemdTailer</h2><p>SystemdTailer configuration options</p><h3 id="systemdtailer-containeroverrides">containerOverrides (*types.ContainerBase, optional)</h3><p>Override container fields for the given tailer</p><h3 id="systemdtailer-disabled">disabled (bool, optional)</h3><p>Disable component</p><h3 id="systemdtailer-image">image (*tailer.ImageSpec, optional)</h3><p>Override image field for the given trailer</p><h3 id="systemdtailer-maxentries">maxEntries (int, optional)</h3><p>Maximum entries to read when starting to tail logs to avoid high pressure</p><h3 id="systemdtailer-name">name (string, required)</h3><p>Name for the tailer</p><h3 id="systemdtailer-path">path (string, optional)</h3><p>Override systemd log path</p><h3 id="systemdtailer-systemdfilter">systemdFilter (string, optional)</h3><p>Filter to select systemd unit example: kubelet.service</p><div class="text-muted mt-5 pt-3 border-top">
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/4435f2183d86539fc9cacced91ff631c5ad94dfb">Merge pull request #204 from kube-logging/updates-for-4.5 (4435f21)</a>
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/66b10dad83878cc9f39a5dff1457d3b37c7a55e7">Merge c6b83f9e829b88ef1f1f1331bd93f87c9a06a213 into 93cf918f74f8421587622b32cecdd81e585de744 (66b10da)</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
2 changes: 1 addition & 1 deletion docs/configuration/crds/extensions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,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 December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/4435f2183d86539fc9cacced91ff631c5ad94dfb">Merge pull request #204 from kube-logging/updates-for-4.5 (4435f21)</a>
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/66b10dad83878cc9f39a5dff1457d3b37c7a55e7">Merge c6b83f9e829b88ef1f1f1331bd93f87c9a06a213 into 93cf918f74f8421587622b32cecdd81e585de744 (66b10da)</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
2 changes: 1 addition & 1 deletion docs/configuration/crds/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,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 December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/4435f2183d86539fc9cacced91ff631c5ad94dfb">Merge pull request #204 from kube-logging/updates-for-4.5 (4435f21)</a>
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/66b10dad83878cc9f39a5dff1457d3b37c7a55e7">Merge c6b83f9e829b88ef1f1f1331bd93f87c9a06a213 into 93cf918f74f8421587622b32cecdd81e585de744 (66b10da)</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/configuration/crds/v1beta1/clusterflow_types/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@
filters ([]Filter, optional) flowLabel (string, optional) globalOutputRefs ([]string, optional) includeLabelInRouter (*bool, optional) loggingRef (string, optional) match ([]ClusterMatch, optional) outputRefs ([]string, optional) Deprecated">
<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-12-27T16:59:11+01:00"><meta property="og:site_name" content="Logging operator">
<meta property="article:modified_time" content="2023-12-27T16:00:22+00: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) metadata (metav1.ObjectMeta, optional) spec (ClusterFlowSpec, optional) Name of the logging cluster to be attached
status (FlowStatus, optional) ClusterMatch select (*ClusterSelect, optional) exclude (*ClusterExclude, optional) ClusterSelect container_names ([]string, optional) hosts ([]string, optional) labels (map[string]string, optional) namespaces ([]string, optional) ClusterExclude container_names ([]string, optional) hosts ([]string, optional) labels (map[string]string, optional) namespaces ([]string, optional) ClusterFlowSpec ClusterFlowSpec is the Kubernetes spec for ClusterFlows
filters ([]Filter, optional) flowLabel (string, optional) globalOutputRefs ([]string, optional) includeLabelInRouter (*bool, optional) loggingRef (string, optional) match ([]ClusterMatch, optional) outputRefs ([]string, optional) Deprecated">
<meta itemprop="dateModified" content="2023-12-27T16:59:11+01:00">
<meta itemprop="dateModified" content="2023-12-27T16:00:22+00:00">
<meta itemprop="wordCount" content="110">
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
<meta name="twitter:title" content="ClusterFlow">
Expand Down Expand Up @@ -579,7 +579,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><h3 id="clusterflow-metadata">metadata (metav1.ObjectMeta, optional)</h3><h3 id="clusterflow-spec">spec (ClusterFlowSpec, optional)</h3><p>Name of the logging cluster to be attached</p><h3 id="clusterflow-status">status (FlowStatus, optional)</h3><h2 id="clustermatch">ClusterMatch</h2><h3 id="clustermatch-select">select (*ClusterSelect, optional)</h3><h3 id="clustermatch-exclude">exclude (*ClusterExclude, optional)</h3><h2 id="clusterselect">ClusterSelect</h2><h3 id="clusterselect-container_names">container_names ([]string, optional)</h3><h3 id="clusterselect-hosts">hosts ([]string, optional)</h3><h3 id="clusterselect-labels">labels (map[string]string, optional)</h3><h3 id="clusterselect-namespaces">namespaces ([]string, optional)</h3><h2 id="clusterexclude">ClusterExclude</h2><h3 id="clusterexclude-container_names">container_names ([]string, optional)</h3><h3 id="clusterexclude-hosts">hosts ([]string, optional)</h3><h3 id="clusterexclude-labels">labels (map[string]string, optional)</h3><h3 id="clusterexclude-namespaces">namespaces ([]string, optional)</h3><h2 id="clusterflowspec">ClusterFlowSpec</h2><p>ClusterFlowSpec is the Kubernetes spec for ClusterFlows</p><h3 id="clusterflowspec-filters">filters ([]Filter, optional)</h3><h3 id="clusterflowspec-flowlabel">flowLabel (string, optional)</h3><h3 id="clusterflowspec-globaloutputrefs">globalOutputRefs ([]string, optional)</h3><h3 id="clusterflowspec-includelabelinrouter">includeLabelInRouter (*bool, optional)</h3><h3 id="clusterflowspec-loggingref">loggingRef (string, optional)</h3><h3 id="clusterflowspec-match">match ([]ClusterMatch, optional)</h3><h3 id="clusterflowspec-outputrefs">outputRefs ([]string, optional)</h3><p>Deprecated</p><h3 id="clusterflowspec-selectors">selectors (map[string]string, optional)</h3><p>Deprecated</p><h2 id="clusterflowlist">ClusterFlowList</h2><p>ClusterFlowList contains a list of ClusterFlow</p><h3 id="clusterflowlist-">(metav1.TypeMeta, required)</h3><h3 id="clusterflowlist-metadata">metadata (metav1.ListMeta, optional)</h3><h3 id="clusterflowlist-items">items ([]ClusterFlow, required)</h3><div class="text-muted mt-5 pt-3 border-top">
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/4435f2183d86539fc9cacced91ff631c5ad94dfb">Merge pull request #204 from kube-logging/updates-for-4.5 (4435f21)</a>
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/66b10dad83878cc9f39a5dff1457d3b37c7a55e7">Merge c6b83f9e829b88ef1f1f1331bd93f87c9a06a213 into 93cf918f74f8421587622b32cecdd81e585de744 (66b10da)</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 @@ -26,13 +26,13 @@
(metav1.TypeMeta, required) metadata (metav1.ListMeta, optional) items ([]ClusterOutput, required) ">
<meta property="og:type" content="article">
<meta property="og:url" content="https://kube-logging.dev/docs/configuration/crds/v1beta1/clusteroutput_types/"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2023-12-27T16:59:11+01:00"><meta property="og:site_name" content="Logging operator">
<meta property="article:modified_time" content="2023-12-27T16:00:22+00:00"><meta property="og:site_name" content="Logging operator">
<meta itemprop="name" content="ClusterOutput">
<meta itemprop="description" content="ClusterOutput ClusterOutput is the Schema for the clusteroutputs API
(metav1.TypeMeta, required) metadata (metav1.ObjectMeta, optional) spec (ClusterOutputSpec, required) status (OutputStatus, optional) ClusterOutputSpec ClusterOutputSpec contains Kubernetes spec for ClusterOutput
(OutputSpec, required) enabledNamespaces ([]string, optional) ClusterOutputList ClusterOutputList contains a list of ClusterOutput
(metav1.TypeMeta, required) metadata (metav1.ListMeta, optional) items ([]ClusterOutput, required) ">
<meta itemprop="dateModified" content="2023-12-27T16:59:11+01:00">
<meta itemprop="dateModified" content="2023-12-27T16:00:22+00:00">
<meta itemprop="wordCount" content="47">
<meta itemprop="keywords" content><meta name="twitter:card" content="summary">
<meta name="twitter:title" content="ClusterOutput">
Expand Down Expand Up @@ -573,7 +573,7 @@
</li></ol></nav><div class="td-content">
<h1>ClusterOutput</h1><header class="article-meta">
</header><h2 id="clusteroutput">ClusterOutput</h2><p>ClusterOutput is the Schema for the clusteroutputs API</p><h3 id="clusteroutput-">(metav1.TypeMeta, required)</h3><h3 id="clusteroutput-metadata">metadata (metav1.ObjectMeta, optional)</h3><h3 id="clusteroutput-spec">spec (ClusterOutputSpec, required)</h3><h3 id="clusteroutput-status">status (OutputStatus, optional)</h3><h2 id="clusteroutputspec">ClusterOutputSpec</h2><p>ClusterOutputSpec contains Kubernetes spec for ClusterOutput</p><h3 id="clusteroutputspec-">(OutputSpec, required)</h3><h3 id="clusteroutputspec-enablednamespaces">enabledNamespaces ([]string, optional)</h3><h2 id="clusteroutputlist">ClusterOutputList</h2><p>ClusterOutputList contains a list of ClusterOutput</p><h3 id="clusteroutputlist-">(metav1.TypeMeta, required)</h3><h3 id="clusteroutputlist-metadata">metadata (metav1.ListMeta, optional)</h3><h3 id="clusteroutputlist-items">items ([]ClusterOutput, required)</h3><div class="text-muted mt-5 pt-3 border-top">
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/4435f2183d86539fc9cacced91ff631c5ad94dfb">Merge pull request #204 from kube-logging/updates-for-4.5 (4435f21)</a>
Last modified December 27, 2023: <a href="https://github.com/kube-logging/kube-logging.github.io/commit/66b10dad83878cc9f39a5dff1457d3b37c7a55e7">Merge c6b83f9e829b88ef1f1f1331bd93f87c9a06a213 into 93cf918f74f8421587622b32cecdd81e585de744 (66b10da)</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 b2d8a6b

Please sign in to comment.