5.0 preparations

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

@@ -0,0 +1,86 @@
+name: Publish version 5.0
+
+env:
+  doc_versionnumber: "5.0"
+
+on:
+  push:
+    branches:
+      - release-5.0
+  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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        with:
+          ref: release-5.0
+          submodules: 'recursive'
+
+      - name: Set up Pages
+        id: pages
+        uses: actions/configure-pages@1f0c5cde4bc74cd7e1254d0cb4de8d49e9068c7d # v4.0.0
+
+      - name: Set up Hugo
+        uses: peaceiris/actions-hugo@16361eb4acea8698b220b76c0d4e84e1fd22c61d # v2.6.0
+        with:
+          hugo-version: '0.110.0'
+          extended: true
+
+      - name: Set up Node
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+        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@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+        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 = "4.11.0"
+  version = "5.0"
   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 (4.11.0)"
+  version = "latest (5.0)"
   githubbranch = "master"
   url = ""
+[[params.versions]]
+  version = "4.11.0"
+  githubbranch = "release-4.11"
+  url = ""
 [[params.versions]]
   version = "4.10"
   githubbranch = "release-4.10"
@@ -216,7 +220,7 @@ twitter = "AxoflowIO"
 # Cascade version number to every doc page (needed to create sections for pagefind search)
 # Update this parameter when creating a new version
 [[cascade]]
-body_attribute = 'data-pagefind-filter="section:4.11"'
+body_attribute = 'data-pagefind-filter="section:5.0"'
 [cascade._target]
   path = '/docs/**'
 

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

@@ -23,7 +23,7 @@ For more information please click on the name
 | **[OutputSpec](output_types/)** | OutputSpec defines the desired state of Output | v1beta1 |
 | **[SyslogNGClusterFlow](syslogng_clusterflow_types/)** | SyslogNGClusterFlow is the Schema for the syslog-ng clusterflows API | v1beta1 |
 | **[SyslogNGClusterOutput](syslogng_clusteroutput_types/)** | SyslogNGClusterOutput is the Schema for the syslog-ng clusteroutputs API | v1beta1 |
-| **[SyslogNG](syslogng_types/)** | SyslogNG is a reference to the desired SyslogNG state | v1beta1 |
+| **[SyslogNG](syslogng_types/)** | SyslogNG is a standalone reference to the desired SyslogNG configuration | v1beta1 |
 | **[SyslogNGFlowSpec](syslogng_flow_types/)** | SyslogNGFlowSpec is the Kubernetes spec for SyslogNGFlows | v1beta1 |
 | **[SyslogNGOutputSpec](syslogng_output_types/)** | SyslogNGOutputSpec defines the desired state of SyslogNGOutput | v1beta1 |
 | **[SyslogNGSpec](syslogng_types/)** | SyslogNGSpec defines the desired state of SyslogNG | v1beta1 |

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

@@ -140,6 +140,9 @@ ServiceMonitorConfig defines the ServiceMonitor properties
 
 Security defines Fluentd, FluentbitAgent deployment security properties
 
+### createOpenShiftSCC (*bool, optional) {#security-createopenshiftscc}
+
+
 ### podSecurityContext (*corev1.PodSecurityContext, optional) {#security-podsecuritycontext}
 
 

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

@@ -92,9 +92,6 @@ Filter definition for FlowSpec
 ### elasticsearch_genid (*filter.ElasticsearchGenId, optional) {#filter-elasticsearch_genid}
 
 
-### enhanceK8s (*filter.EnhanceK8s, optional) {#filter-enhancek8s}
-
-
 ### geoip (*filter.GeoIP, optional) {#filter-geoip}
 
 
@@ -119,9 +116,6 @@ Filter definition for FlowSpec
 ### stdout (*filter.StdOutFilterConfig, optional) {#filter-stdout}
 
 
-### sumologic (*filter.SumoLogic, optional) {#filter-sumologic}
-
-
 ### tag_normaliser (*filter.TagNormaliser, optional) {#filter-tag_normaliser}
 
 

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

@@ -128,6 +128,9 @@ Disable Kubernetes metadata filter
 ### enableUpstream (bool, optional) {#fluentbitspec-enableupstream}
 
 
+### enabledIPv6 (bool, optional) {#fluentbitspec-enabledipv6}
+
+
 ### envVars ([]corev1.EnvVar, optional) {#fluentbitspec-envvars}
 
 
@@ -151,6 +154,11 @@ Set the flush time in seconds.nanoseconds. The engine loop uses a Flush timeout
 
 Default: 1
 
+### forceHotReloadAfterGrace (bool, optional) {#fluentbitspec-forcehotreloadaftergrace}
+
+HotReload pauses all inputs and waits until they finish. In certain situations this is unacceptable, for example, if an output is down for a longer time. An undocumented option called "Hot_Reload.Ensure_Thread_Safety Off" can be used at the [SERVICE] config to force hotreload after the grace period. Note that it might result in a SIGSEGV, but worst case kubelet will restart the container. See https://github.com/fluent/fluent-bit/pull/7509 
+
+
 ### forwardOptions (*ForwardOptions, optional) {#fluentbitspec-forwardoptions}
 
 
@@ -583,6 +591,12 @@ When a monitored file reach it buffer capacity due to a very long line (Buffer_M
 
 Default: Off
 
+### storage.pause_on_chunks_overlimit (string, optional) {#inputtail-storage.pause_on_chunks_overlimit}
+
+Specifies whether to pause or drop data when the buffer is full. This helps to make sure we apply backpressure on the input if enabled, see https://docs.fluentbit.io/manual/administration/backpressure
+
+Default: on
+
 ### storage.type (string, optional) {#inputtail-storage.type}
 
 Specify the buffering mechanism to use. It can be memory or filesystem.

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

@@ -25,6 +25,9 @@ BufferStorageVolume is by default configured as PVC using FluentdPvcSpec [volume
 ### bufferVolumeImage (ImageSpec, optional) {#fluentdspec-buffervolumeimage}
 
 
+### bufferVolumeLivenessProbe (*corev1.Probe, optional) {#fluentdspec-buffervolumelivenessprobe}
+
+
 ### bufferVolumeMetrics (*Metrics, optional) {#fluentdspec-buffervolumemetrics}
 
 
@@ -65,6 +68,9 @@ Overrides the default logging level configCheck setup. This field is not used di
 Allows Time object in buffer's MessagePack serde [more info]( https://docs.fluentd.org/deployment/system-config#enable_msgpack_time_support) 
 
 
+### enabledIPv6 (bool, optional) {#fluentdspec-enabledipv6}
+
+
 ### envVars ([]corev1.EnvVar, optional) {#fluentdspec-envvars}
 
 

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

@@ -86,6 +86,11 @@ Reference to the logging system. Each of the `loggingRef`s can manage a fluentbi
 InlineNodeAgent Configuration Deprecated, will be removed with next major version 
 
 
+### routeConfig (*RouteConfig, optional) {#loggingspec-routeconfig}
+
+RouteConfig determines whether to use loggingRoutes or to create resources based on the logging resource that can be managed by the Telemetry Controller. 
+
+
 ### skipInvalidResources (bool, optional) {#loggingspec-skipinvalidresources}
 
 Whether to skip invalid Flow and ClusterFlow resources 
@@ -125,6 +130,24 @@ Configure timeout in seconds if strategy is StartWithTimeout
 
 
 
+## RouteConfig
+
+### disableLoggingRoute (bool, optional) {#routeconfig-disableloggingroute}
+
+If DisableLoggingRoute is set to true, the logging route controller should remove the given tenant from the status of the logging resource. 
+
+
+### enableTelemetryControllerRoute (bool, optional) {#routeconfig-enabletelemetrycontrollerroute}
+
+If EnableTelemtryControllerRoute set to true, the operator will create the corresponding Tenant, Subscription, and Output based on the logging resource. 
+
+
+### tenantLabels (map[string]string, optional) {#routeconfig-tenantlabels}
+
+TenantLabels is a map of labels that will be added to the tenant object so it can be matched with TelemetryController's TenantSelector ref: https://github.com/kube-logging/telemetry-controller/blob/main/api/telemetry/v1alpha1/collector_types.go 
+
+
+
 ## LoggingStatus
 
 LoggingStatus defines the observed state of Logging

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

@@ -89,9 +89,6 @@ OutputSpec defines the desired state of Output
 ### splunkHec (*output.SplunkHecOutput, optional) {#outputspec-splunkhec}
 
 
-### sumologic (*output.SumologicOutput, optional) {#outputspec-sumologic}
-
-
 ### syslog (*output.SyslogOutputConfig, optional) {#outputspec-syslog}
 
 

content/docs/configuration/plugins/filters/detect_exceptions.md

@@ -26,7 +26,7 @@ filters:
 
 ### force_line_breaks (bool, optional) {#detectexceptions-force_line_breaks}
 
-Force line breaks between each lines when combining exception stacks.
+Force line breaks between each line when combining exception stacks.
 
 Default: false