Merge pull request #290 from kube-logging/5.4-preparations

5.4 preparations

Author: fekete-robert

.github/workflows/publish-version-5.4.yaml

@@ -0,0 +1,86 @@
+name: Publish version 5.4
+
+env:
+  doc_versionnumber: "5.4"
+
+on:
+  push:
+    branches:
+      - release-5.4
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pages: write
+      id-token: write
+    
+    concurrency:
+      group: "pages"
+      cancel-in-progress: false
+    
+    environment:
+      name: github-pages-test
+      url: ${{ steps.deployment.outputs.page_url }}
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          ref: release-5.4
+          submodules: 'recursive'
+
+      - name: Set up Pages
+        id: pages
+        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
+
+      - name: Set up Hugo
+        uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3.0.0
+        with:
+          hugo-version: '0.110.0'
+          extended: true
+
+      - name: Set up Node
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: |
+          cd themes/docsy
+          npm install
+
+      - name: Set up PostCSS
+        run: npm install --save-dev autoprefixer postcss-cli postcss
+
+      - name: Build
+        run: hugo --environment production --baseURL ${{ steps.pages.outputs.base_url }}/${{ env.doc_versionnumber }}/
+
+      # - name: Upload artifact
+      #   uses: actions/upload-pages-artifact@64bcae551a7b18bcb9a09042ddf1960979799187 # v1.0.8
+      #   with:
+      #     path: ./public/
+
+      - name: Checkout code to update
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          ref: 'gh-pages-test'
+          path: 'tmp/gh-pages'
+      # - name: Display file structure
+      #   run: ls -R
+      - name: Copy built site to GH pages
+        run: |
+          rm -rf tmp/gh-pages/${{ env.doc_versionnumber }}
+          mkdir -p tmp/gh-pages/${{ env.doc_versionnumber }}
+          mv public/* tmp/gh-pages/${{ env.doc_versionnumber }}
+      - name: Commit & Push changes
+        uses: actions-js/push@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          message: 'Publish updated docs for ${{ env.doc_versionnumber }}, ${{ github.event.repository.pushed_at}}'
+          branch: 'gh-pages-test'
+          directory: 'tmp/gh-pages'

config/_default/config.toml

@@ -65,7 +65,7 @@ weight = 1
   # Used in the "version-banner" partial to display a version number for the 
   # current doc set.
 
-  version = "5.3"
+  version = "5.4"
   version_menu = "Releases"
   version_menu_canonicallinks = true
   version_menu_pagelinks = true
@@ -169,9 +169,13 @@ twitter = "AxoflowIO"
 #######################
 # Add your release versions here
 [[params.versions]]
-  version = "latest (5.3)"
+  version = "latest (5.4)"
   githubbranch = "master"
   url = ""
+[[params.versions]]
+  version = "5.3"
+  githubbranch = "release-5.3"
+  url = "/5.3/"
 [[params.versions]]
   version = "5.2"
   githubbranch = "release-5.2"

content/docs/configuration/crds/v1beta1/_index.md

@@ -8,6 +8,7 @@ For more information please click on the name
 
 | Name | Description | Version |
 |---|---|---|
+| **[AxoSyslog](axosyslog_types/)** | AxoSyslog is the schema for the AxoSyslogs API. | v1beta1 |
 | **[EventTailer](../extensions/eventtailer_types/)** | Eventtailer's main goal is to listen kubernetes events and transmit their changes to stdout. This way the logging-operator is able to process them. | extensions |
 | **[HostTailer](../extensions/hosttailer_types/)** | HostTailer's main goal is to tail custom files and transmit their changes to stdout. This way the logging-operator is able to process them. | extensions |
 | **[ClusterFlow](clusterflow_types/)** | ClusterFlow is the Schema for the clusterflows API | v1beta1 |

content/docs/configuration/crds/v1beta1/axosyslog_types.md

@@ -0,0 +1,122 @@
+---
+title: AxoSyslog
+weight: 200
+generated_file: true
+---
+
+AxoSyslog is the schema for the AxoSyslogs API.
+
+Available in Logging operator version 5.4 and later.
+
+###  (metav1.TypeMeta, required) {#axosyslog-}
+
+
+### metadata (metav1.ObjectMeta, optional) {#axosyslog-metadata}
+
+
+### spec (AxoSyslogSpec, optional) {#axosyslog-spec}
+
+
+### status (AxoSyslogStatus, optional) {#axosyslog-status}
+
+
+
+## AxoSyslogSpec
+
+AxoSyslogSpec defines the desired state of AxoSyslog.
+
+### destinations ([]Destination, optional) {#axosyslogspec-destinations}
+
+Destinations is a list of destinations to be rendered in the AxoSyslog configuration. 
+
+
+### logPaths ([]LogPath, optional) {#axosyslogspec-logpaths}
+
+LogPaths is a list of log paths to be rendered in the AxoSyslog configuration. 
+
+
+
+## LogPath
+
+LogPath defines a single log path that will be rendered in the AxoSyslog configuration.
+
+### destination (string, optional) {#logpath-destination}
+
+Name of a destination to be used in the log path. 
+
+
+### filterx (string, optional) {#logpath-filterx}
+
+FilterX block to be rendered within the log path. 
+
+
+
+## Destination
+
+Destination defines a single destination that will be rendered in the AxoSyslog configuration.
+
+### config (string, optional) {#destination-config}
+
+Config is the configuration for the destination. 
+
+
+### name (string, optional) {#destination-name}
+
+Name of the destination. 
+
+
+
+## AxoSyslogStatus
+
+AxoSyslogStatus defines the observed state of AxoSyslog.
+
+### problems ([]string, optional) {#axosyslogstatus-problems}
+
+Problems with the AxoSyslog resource. 
+
+
+### problemsCount (int, optional) {#axosyslogstatus-problemscount}
+
+Number of problems with the AxoSyslog resource. 
+
+
+### sources ([]Source, optional) {#axosyslogstatus-sources}
+
+Sources configured for AxoSyslog. 
+
+
+
+## Source
+
+Source represents the log sources for AxoSyslog.
+
+### otlp (*OTLPSource, optional) {#source-otlp}
+
+OTLP specific configuration. 
+
+
+
+## OTLPSource
+
+OTLPSource contains configuration for OpenTelemetry Protocol sources.
+
+### endpoint (string, optional) {#otlpsource-endpoint}
+
+Endpoint for the OTLP source. 
+
+
+
+## AxoSyslogList
+
+AxoSyslogList contains a list of AxoSyslog
+
+###  (metav1.TypeMeta, required) {#axosysloglist-}
+
+
+### metadata (metav1.ListMeta, optional) {#axosysloglist-metadata}
+
+
+### items ([]AxoSyslog, required) {#axosysloglist-items}
+
+
+

content/docs/configuration/crds/v1beta1/fluentbit_types.md

@@ -127,9 +127,16 @@ Disable Kubernetes metadata filter
 
 ### disableVarLibDockerContainers (*bool, optional) {#fluentbitspec-disablevarlibdockercontainers}
 
+Available in Logging operator version 5.4 and later.
+
 DisableVarLibDockerContainers controls whether the /var/lib/docker/containers volume is mounted. If true, the volume is NOT mounted. If false (default), the volume is mounted.
 
 
+### disableVarLog (*bool, optional) {#fluentbitspec-disablevarlog}
+
+DisableVarLog controls whether the /var/log volume is mounted. If true, the volume is NOT mounted. If false (default), the volume is mounted. 
+
+
 ### enableUpstream (bool, optional) {#fluentbitspec-enableupstream}
 
 
@@ -675,6 +682,30 @@ Allow Kubernetes Pods to suggest a pre-defined Parser (read more about it in Kub
 
 Default: Off
 
+Important: When enabling this setting, you must also configure
+`inputTail.multiline.parser` with appropriate parsers (typically including `cri` for
+Container Runtime Interface logs). Without this configuration, the annotation-based
+parsing will not work correctly.
+
+#### Example Configuration
+
+```yaml
+apiVersion: logging.banzaicloud.io/v1beta1
+kind: FluentbitAgent
+metadata:
+ name: example-fluentbit
+spec:
+ inputTail:
+   multiline.parser: [cri]  # Required when K8S-Logging.Parser is enabled
+ filterKubernetes:
+   K8S-Logging.Parser: "On"
+   Merge_Log_Key: "parsed"  # Optional but recommended to prevent key conflicts
+
+   # Once configured, you can use annotations on your pods:
+   annotations:
+     fluentbit.io/parser: "my-custom-parser"
+```
+
 ### Keep_Log (string, optional) {#filterkubernetes-keep_log}
 
 When Keep_Log is disabled, the log field is removed from the incoming message once it has been successfully merged (Merge_Log must be enabled as well).

content/docs/configuration/crds/v1beta1/output_types.md

@@ -47,6 +47,9 @@ OutputSpec defines the desired state of Output
 ### kinesisStream (*output.KinesisStreamOutputConfig, optional) {#outputspec-kinesisstream}
 
 
+### lmLogs (*output.LMLogsOutputConfig, optional) {#outputspec-lmlogs}
+
+
 ### logdna (*output.LogDNAOutput, optional) {#outputspec-logdna}
 
 

content/docs/configuration/plugins/outputs/elasticsearch.md

@@ -109,6 +109,12 @@ Specify an existing index template for the data stream. If not present, a new te
 
 Default: data_stream_name
 
+### data_stream_template_use_index_patterns_wildcard (*bool, optional) {#elasticsearch-data_stream_template_use_index_patterns_wildcard}
+
+https://github.com/uken/fluent-plugin-elasticsearch?tab=readme-ov-file#data_stream_template_use_index_patterns_wildcard 
+
+Default: true
+
 ### default_elasticsearch_version (string, optional) {#elasticsearch-default_elasticsearch_version}
 
 This parameter changes that ES plugin assumes default Elasticsearch version.

content/docs/configuration/plugins/outputs/forward.md

@@ -17,6 +17,11 @@ Default: 190
 [Buffer](../buffer/) 
 
 
+### compress (string, optional) {#forwardoutput-compress}
+
+Fluentd supports transparent data compression, the only value accepted is "gzip" 
+
+
 ### connect_timeout (int, optional) {#forwardoutput-connect_timeout}
 
 The timeout time for socket connect. When the connection timed out during establishment, Errno::ETIMEDOUT is raised.