Publish updated docs for 4.5, 2024-03-19T14:47:03Z

kube-logging · Mar 19, 2024 · 9ee52f4 · 9ee52f4
1 parent a6b189d
commit 9ee52f4
Show file tree

Hide file tree

Showing 492 changed files with 120,609 additions and 0 deletions.
diff --git a/4.5/404.html b/4.5/404.html
@@ -0,0 +1,92 @@
+<!doctype html><html itemscope itemtype="http://schema.org/WebPage" lang="en" class="no-js">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no">
+<meta name="generator" content="Hugo 0.110.0">
+<meta name="robots" content="index, follow">
+<link rel="shortcut icon" href="/4.5/favicons/favicon.ico">
+<link rel="apple-touch-icon" href="/4.5/favicons/apple-touch-icon-180x180.png" sizes="180x180">
+<link rel="icon" type="image/png" href="/4.5/favicons/favicon-16x16.png" sizes="16x16">
+<link rel="icon" type="image/png" href="/4.5/favicons/favicon-32x32.png" sizes="32x32">
+<link rel="icon" type="image/png" href="/4.5/favicons/android-36x36.png" sizes="36x36">
+<link rel="icon" type="image/png" href="/4.5/favicons/android-48x48.png" sizes="48x48">
+<link rel="icon" type="image/png" href="/4.5/favicons/android-72x72.png" sizes="72x72">
+<link rel="icon" type="image/png" href="/4.5/favicons/android-96x96.png" sizes="96x96">
+<link rel="icon" type="image/png" href="/4.5/favicons/android-144x144.png" sizes="144x144">
+<link rel="icon" type="image/png" href="/4.5/favicons/android-192x192.png" sizes="192x192">
+<title>404 Page not found | Logging operator</title><meta name="description" content="Documentation for the Logging operator">
+<meta property="og:title" content="404 Page not found">
+<meta property="og:description" content="Documentation for the Logging operator">
+<meta property="og:type" content="website">
+<meta property="og:url" content="https://kube-logging.dev/4.5/404.html"><meta property="og:site_name" content="Logging operator">
+<meta itemprop="name" content="404 Page not found">
+<meta itemprop="description" content="Documentation for the Logging operator"><meta name="twitter:card" content="summary">
+<meta name="twitter:title" content="404 Page not found">
+<meta name="twitter:description" content="Documentation for the Logging operator">
+<meta name="twitter:site" content="@calisti12">
+<link rel="preload" href="/4.5/scss/main.min.d20db6d79e80313ee4aa9c44648bc3348ea0b541c8d2ecc5ca8b144682beb4f8.css" as="style">
+<link href="/4.5/scss/main.min.d20db6d79e80313ee4aa9c44648bc3348ea0b541c8d2ecc5ca8b144682beb4f8.css" rel="stylesheet" integrity>
+<script src="https://code.jquery.com/jquery-3.6.0.min.js" integrity="sha384-vtXRMe3mGCbOeY7l30aIg8H9p3GdeSe4IFlP6G8JMa7o7lXvnz3GFKzPxzJdPfGK" crossorigin="anonymous"></script>
+<link rel="stylesheet" href="/4.5/css/prism.css">
+<script src="/js/w3.js" type="application/x-javascript"></script>
+<link rel="canonical" href="https://kube-logging.dev/">
+<script src="/pagefind/pagefind-highlight.js" type="application/x-javascript"></script>
+<script type="module">
+        await import('/pagefind/pagefind-highlight.js');
+        new PagefindHighlight({ highlightParam: "highlight" });
+    </script>
+</head><body class="td-404">
+<header>
+<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
+<a class="navbar-brand" href="/4.5/"><span class="navbar-brand__logo navbar-logo"><svg viewBox="0 0 3237.738 490.023" id="svg142" sodipodi:docname="logo-new2.svg" inkscape:version="1.2.1 (9c6d41e4, 2022-07-14)" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><defs id="defs146"/><sodipodi:namedview id="namedview144" pagecolor="#505050" bordercolor="#ffffff" borderopacity="1" inkscape:showpageshadow="0" inkscape:pageopacity="0" inkscape:pagecheckerboard="1" inkscape:deskcolor="#505050" showgrid="false" inkscape:zoom=".37340884" inkscape:cx="1620.208" inkscape:cy="243.70071" inkscape:window-width="705" inkscape:window-height="480" inkscape:window-x="0" inkscape:window-y="25" inkscape:window-maximized="0" inkscape:current-layer="svg142"/><g id="Group_2068" data-name="Group 2068" transform="translate(-43577.297 -34456.625)"><g id="Group_2067" data-name="Group 2067" transform="translate(27723.789 24565.273)"><path id="Path_4217" data-name="Path 4217" d="M47842.219 34024.414l-276.027 475.07h71.242l240.227-414.1z" transform="translate(-31703.996 -24123.111)" fill="#d6d7d9" stroke="#d6d7d9" stroke-width="10"/><path id="Path_4218" data-name="Path 4218" d="M47831.324 34080.781l166.754 287.355h-333.035z" transform="translate(-31640.254 -24086.76)" fill="#fff" stroke="#fff" stroke-width="10"/><path id="Path_4220" data-name="Path 4220" d="M47668.742 34274.2l-37.727 64.1h442.43l-37.156-64.1z" transform="translate(-31662.199 -23962.018)" fill="#d6d7d9" stroke="#d6d7d9" stroke-width="10"/><path id="Path_4222" data-name="Path 4222" d="M11294.989 10157.944l311.97-.01-156.218-269.074-78.621 135.83z" transform="translate(4740.338 117.39)" fill="#fff"/><path id="Path_4224" data-name="Path 4224" d="M47787.594 34159.125l-54.391 93.035h108.039z" transform="translate(-31596.297 -24036.238)" fill="#13142c" stroke="#13132d" stroke-width="10"/></g><text id="Logging_Operator" data-name="Logging Operator" transform="translate(45475.035 34799.609)" fill="#fff" font-size="267" font-family="Montserrat-Bold, Montserrat" font-weight="700" letter-spacing=".046em"><tspan x="-1339.806" y="0" id="tspan138">Logging Operator</tspan></text></g></svg></span><span class="navbar-brand__name">Logging operator</span>
+<span class="font-weight-bold navbar-logo navbar-version">4.5.1</span></a>
+<div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
+<ul class="navbar-nav mt-2 mt-lg-0">
+<li class="nav-item mr-4 mb-2 mb-lg-0">
+<a class="nav-link" href="https://github.com/kube-logging/logging-operator" title="Go to GitHub project page" target="_blank"><span>Project page</span></a>
+</li><li class="nav-item mr-4 mb-2 mb-lg-0">
+<a class="nav-link" href="/4.5/docs/" title="Read the documentation"><span>Documentation</span></a>
+</li><li class="nav-item mr-4 mb-2 mb-lg-0">
+<a class="nav-link" href="/4.5/docs/community/" title="Come chat with us!"><span>Community</span></a>
+</li><li class="nav-item dropdown mr-4 d-none d-lg-block">
+<a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
+Releases
+</a>
+<div class="dropdown-menu" aria-labelledby="navbarDropdownMenuLink">
+<div w3-include-html="/04.html/releases.releases" w3-include-html-default='<a class="dropdown-item" href="/docs/releases.releases">Latest</a>'></div><script type="application/x-javascript">w3.includeHTML()</script>
+</div></li></ul></div><div class="navbar-nav d-none d-lg-block">
+<div class="main-menu-search">
+<a href="/search">
+<span class="nav-link"><i class="fa fa-search" aria-hidden="true"></i> Search</span>
+</a>
+</div></div></nav></header><div class="container-fluid td-default td-outer">
+<main role="main" class="td-main">
+<div class="td-content">
+<h1>Not found</h1><p>Oops! This page doesn't exist. Try going back to the <a href="/4.5/">home page</a>.</p></div></main><footer class="bg-dark py-5 row d-print-none">
+<div class="container-fluid mx-sm-5">
+<div class="row">
+<div class="col-6 col-sm-4 text-xs-center order-sm-2">
+</div><div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
+<ul class="list-inline mb-0">
+<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="GitHub" aria-label="GitHub">
+<a class="text-white" target="_blank" rel="noopener" href="https://github.com/kube-logging/logging-operator" aria-label="GitHub">
+<i class="fab fa-github"></i>
+</a>
+</li><li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="Slack" aria-label="Slack">
+<a class="text-white" target="_blank" rel="noopener" href="/docs/community/" aria-label="Slack">
+<i class="fab fa-slack"></i>
+</a>
+</li><li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="Discord" aria-label="Discord">
+<a class="text-white" target="_blank" rel="noopener" href="https://discord.gg/9ACY4RDsYN" aria-label="Discord">
+<i class="fab fa-discord"></i>
+</a>
+</li></ul></div><div class="col-12 col-sm-4 text-center py-2 order-sm-2">
+<small class="text-white"><a class="text-white" href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a> | </small>
+<small class="text-white">&copy; 2024 kube-logging authors | All Rights Reserved</small>
+</div></div></div></footer></div><script src="/4.5/js/main.min.e92b3fb8e89f4169bac5c4b385d0ae639f17b6777e7a9fafce6283caf0539ed3.js" integrity="sha256-6Ss/uOifQWm6xcSzhdCuY58Xtnd+ep+vzmKDyvBTntM=" crossorigin="anonymous"></script>
+<script src='/4.5/js/prism.js'></script>
+<script src='/4.5/js/tabpane-persist.js'></script>
+<script src="/js/tocbot.min.js"></script>
+<script type="text/javascript">tocbot.init({tocSelector:".td-toc",contentSelector:".td-content",headingSelector:"h2, h3, h4",ignoreHiddenElements:!0})</script>
+<script>(function(){var e=document.querySelector("#td-section-nav");addEventListener("beforeunload",function(){localStorage.setItem("menu.scrollTop",e.scrollTop)}),e.scrollTop=localStorage.getItem("menu.scrollTop")})()</script>
+</body></html>
diff --git a/4.5/_print/docs/configuration/extensions/logging-extensions-event-tailer.png b/4.5/_print/docs/configuration/extensions/logging-extensions-event-tailer.png
diff --git a/4.5/_print/docs/configuration/extensions/logging-extensions-host-tailer.png b/4.5/_print/docs/configuration/extensions/logging-extensions-host-tailer.png
diff --git a/4.5/_print/docs/configuration/extensions/logging-extensions-host-tailer2.png b/4.5/_print/docs/configuration/extensions/logging-extensions-host-tailer2.png
diff --git a/4.5/_print/docs/configuration/extensions/logging-extensions-tailer-webhook.png b/4.5/_print/docs/configuration/extensions/logging-extensions-tailer-webhook.png
diff --git a/4.5/_print/docs/examples/logging_flow_geoip.yaml b/4.5/_print/docs/examples/logging_flow_geoip.yaml
@@ -0,0 +1,27 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+  name: geoip-sample
+spec:
+  filters:
+    - tag_normaliser:
+        format: ${namespace_name}.${pod_name}.${container_name}
+    - parser:
+        remove_key_name_field: true
+        parse:
+          type: nginx
+    - geoip:
+        geoip_lookup_keys: remote
+        backend_library: geoip2_c
+        records:
+          - city: ${city.names.en["remote"]}
+            location_array: '''[${location.longitude["remote"]},${location.latitude["remote"]}]'''
+            country: ${country.iso_code["remote"]}
+            country_name: ${country.names.en["remote"]}
+            postal_code:  ${postal.code["remote"]}
+  localOutputRefs:
+    - null-output-sample
+  match:
+    - select:
+        labels:
+          app: nginx
diff --git a/4.5/_print/docs/examples/logging_flow_multiple_output.yaml b/4.5/_print/docs/examples/logging_flow_multiple_output.yaml
@@ -0,0 +1,13 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+  name: flow-sample
+  namespace: default
+spec:
+  localOutputRefs:
+    - gcs-output-sample
+    - s3-output-example
+  match:
+    - select:
+        labels:
+          app: nginx
diff --git a/4.5/_print/docs/examples/logging_flow_single_output.yaml b/4.5/_print/docs/examples/logging_flow_single_output.yaml
@@ -0,0 +1,12 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+  name: flow-sample
+  namespace: default
+spec:
+  localOutputRefs:
+    - forward-output-sample
+  match:
+    - select:
+        labels:
+          app: nginx
diff --git a/4.5/_print/docs/examples/logging_flow_with_dedot.yaml b/4.5/_print/docs/examples/logging_flow_with_dedot.yaml
@@ -0,0 +1,20 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+  name: flow-sample
+  namespace: default
+spec:
+  filters:
+    - parser:
+        remove_key_name_field: true
+        parse:
+          type: nginx
+    - tag_normaliser:
+        format: ${namespace_name}.${pod_name}.${container_name}
+    - dedot: {}
+  localOutputRefs:
+    - s3-output
+  match:
+    - select:
+        labels:
+          app: nginx
diff --git a/4.5/_print/docs/examples/logging_flow_with_filters.yaml b/4.5/_print/docs/examples/logging_flow_with_filters.yaml
@@ -0,0 +1,19 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+  name: flow-sample
+  namespace: default
+spec:
+  filters:
+    - parser:
+        remove_key_name_field: true
+        parse:
+          type: nginx
+    - tag_normaliser:
+        format: ${namespace_name}.${pod_name}.${container_name}
+  localOutputRefs:
+    - s3-output
+  match:
+    - select:
+        labels:
+          app: nginx
diff --git a/4.5/_print/docs/examples/logging_flow_with_multi_format.yaml b/4.5/_print/docs/examples/logging_flow_with_multi_format.yaml
@@ -0,0 +1,23 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Flow
+metadata:
+  name: flow-sample
+spec:
+  filters:
+  - parser:
+      parse:
+        type: multi_format
+        patterns:
+        - format: nginx
+        - format: regexp
+          expression: /^\[(?<logtime>[^\]]*)\] (?<name>[^ ]*) (?<title>[^ ]*) (?<id>\d*)$/
+        - format: none
+      remove_key_name_field: true
+      reserve_data: true
+  localOutputRefs:
+  - s3-output
+  match:
+    - select:
+        labels:
+          app.kubernetes.io/instance: nginx-demo
+          app.kubernetes.io/name: nginx-logging-demo
diff --git a/4.5/_print/docs/examples/logging_logging_simple.yaml b/4.5/_print/docs/examples/logging_logging_simple.yaml
@@ -0,0 +1,8 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Logging
+metadata:
+  name: default-logging-simple
+spec:
+  fluentd: {}
+  fluentbit: {}
+  controlNamespace: default
diff --git a/4.5/_print/docs/examples/logging_logging_tls.yaml b/4.5/_print/docs/examples/logging_logging_tls.yaml
@@ -0,0 +1,18 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Logging
+metadata:
+  name: default-logging-tls
+  namespace: logging
+spec:
+  fluentd:
+    disablePvc: true
+    tls:
+      enabled: true
+      secretName: fluentd-tls
+      sharedKey: asdadas
+  fluentbit:
+    tls:
+      enabled: true
+      secretName: fluentbit-tls
+      sharedKey: asdadas
+  controlNamespace: logging
diff --git a/4.5/_print/docs/examples/logging_output_azurestorage.yaml b/4.5/_print/docs/examples/logging_output_azurestorage.yaml
@@ -0,0 +1,22 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Output
+metadata:
+  name: azure-output-sample
+spec:
+  azurestorage:
+    azure_storage_account:
+      valueFrom:
+        secretKeyRef:
+          name: azurestorage-secret
+          key: azureStorageAccount
+    azure_storage_access_key:
+      valueFrom:
+        secretKeyRef:
+          name: azurestorage-secret
+          key: azureStorageAccessKey
+    azure_container: example-azure-container
+    path: logs/${tag}/%Y/%m/%d/
+    buffer:
+      timekey: 1m
+      timekey_wait: 10s
+      timekey_use_utc: true
diff --git a/4.5/_print/docs/examples/logging_output_cloudwatch.yaml b/4.5/_print/docs/examples/logging_output_cloudwatch.yaml
@@ -0,0 +1,25 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Output
+metadata:
+  name: cloudwatch-output
+  namespace: logging
+spec:
+  cloudwatch:
+    aws_key_id:
+      valueFrom:
+        secretKeyRef:
+          name: logging-cloudwatch
+          key: awsAccessKeyId
+    aws_sec_key:
+      valueFrom:
+        secretKeyRef:
+          name: logging-cloudwatch
+          key: awsSecretAccessKey
+    log_group_name: operator-log-group
+    log_stream_name: operator-log-stream
+    region: us-east-1
+    auto_create_stream: true
+    buffer:
+      timekey: 30s
+      timekey_wait: 30s
+      timekey_use_utc: true
diff --git a/4.5/_print/docs/examples/logging_output_file.yaml b/4.5/_print/docs/examples/logging_output_file.yaml
@@ -0,0 +1,11 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Output
+metadata:
+  name: file-output-sample
+spec:
+  file:
+    path: /tmp/logs/${tag}/%Y/%m/%d/%H.%M
+    buffer:
+      timekey: 1m
+      timekey_wait: 10s
+      timekey_use_utc: true
diff --git a/4.5/_print/docs/examples/logging_output_forward.yaml b/4.5/_print/docs/examples/logging_output_forward.yaml
@@ -0,0 +1,18 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Output
+metadata:
+  name: forward-output-sample
+spec:
+  forward:
+    servers:
+      - host: 127.0.0.1
+        port: 24240
+    tls_cert_path:
+      mountFrom:
+        secretKeyRef:
+          name: fluentd-tls
+          key: tls.crt
+    buffer:
+      timekey: 1m
+      timekey_wait: 10s
+      timekey_use_utc: true
diff --git a/4.5/_print/docs/examples/logging_output_gcs.yaml b/4.5/_print/docs/examples/logging_output_gcs.yaml
@@ -0,0 +1,18 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Output
+metadata:
+  name: gcs-output-sample
+spec:
+  gcs:
+    credentials_json:
+      valueFrom:
+        secretKeyRef:
+          name: gcs-secret
+          key: credentials.json
+    project: logging-example
+    bucket: banzai-log-test
+    path: logs/${tag}/%Y/%m/%d/
+    buffer:
+      timekey: 1m
+      timekey_wait: 10s
+      timekey_use_utc: true
diff --git a/4.5/_print/docs/examples/logging_output_kinesis.yaml b/4.5/_print/docs/examples/logging_output_kinesis.yaml
@@ -0,0 +1,24 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Output
+metadata:
+  name: cloudwatch-output
+  namespace: logging
+spec:
+  cloudwatch:
+    aws_key_id:
+      valueFrom:
+        secretKeyRef:
+          name: logging-s3
+          key: awsAccessKeyId
+    aws_sec_key:
+      valueFrom:
+        secretKeyRef:
+          name: logging-s3
+          key: awsSecretAccessKey
+    stream_name: operator-log-stream
+    region: us-east-1
+    auto_create_stream: true
+    buffer:
+      timekey: 30s
+      timekey_wait: 30s
+      timekey_use_utc: true
diff --git a/4.5/_print/docs/examples/logging_output_null.yaml b/4.5/_print/docs/examples/logging_output_null.yaml
@@ -0,0 +1,6 @@
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: Output
+metadata:
+  name: null-output-sample
+spec:
+  nullout: {}